@azure-tools/typespec-azure-resource-manager 0.27.0

package/lib/decorators.tsp

@@ -0,0 +1,87 @@
+using TypeSpec.Reflection;
+
+namespace Azure.ResourceManager;
+
+/**
+ * `@armProviderNamespace` sets the ARM provider name. It will default to use the
+ * Namespace element value unless an override value is specified.
+ *
+ * @example
+ *
+ * ```typespec
+ * @armProviderNamespace
+ *  namespace Microsoft.Contoso;
+ * ```
+ *
+ * ```typespec
+ * @armProviderNamespace("Microsoft.Contoso")
+ *  namespace Microsoft.ContosoService;
+ * ```
+ *
+ * @param providerNamespace Provider namespace
+ */
+extern dec armProviderNamespace(target: Namespace, providerNamespace?: string);
+
+/**
+ * `@singleton` marks an ARM resource model as a singleton resource.
+ *
+ * Singleton resources only have a single instance with a fixed key name.
+ *  `.../providers/Microsoft.Contoso/monthlyReports/default`
+ *
+ * See more details on [different ARM resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
+ *
+ * @param keyValue The name of the singleton resource. Default name is "default".
+ */
+extern dec singleton(target: object, keyValue?: string | "default");
+
+/**
+ * `@tenantResource` marks an ARM resource model as a Tenant resource/Root resource/Top-Level resource.
+ *
+ * Tenant resources have REST API paths like:
+ *   `/provider/Microsoft.Contoso/FooResources`
+ *
+ * See more details on [different ARM resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
+ */
+extern dec tenantResource(target: object);
+
+/**
+ * `@subscriptionResource` marks an ARM resource model as a subscription resource.
+ *
+ * Subscription resources have REST API paths like:
+ *  `/subscription/{id}/providers/Microsoft.Contoso/employees`
+ *
+ * See more details on [different ARM resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
+ */
+extern dec subscriptionResource(target: object);
+
+/**
+ * `@locationResource` marks an ARM resource model as a location based resource.
+ *
+ * Location based resources have REST API paths like
+ *   `/subscriptions/{subscriptionId}/locations/{location}/providers/Microsoft.Contoso/employees`
+ *
+ * See more details on [different ARM resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
+ */
+extern dec locationResource(target: object);
+
+/**
+ * `@resourceGroupResource` marks an ARM resource model as a resource group level resource.
+ * This is the default option for ARM resources. It is provided for symmetry and clarity, and
+ * you typically do not need to specify it.
+ *
+ *   `/subscription/{id}/resourcegroups/{rg}/providers/Microsoft.Contoso/employees`
+ *
+ * See more details on [different ARM resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
+ */
+extern dec resourceGroupResource(target: object);
+
+/**
+ * `@extensionResource` marks an ARM resource model as an Extension resource.
+ * Extension resource extends other resource types. URL path is appended
+ * to another segment {scope} which refers to another Resource URL.
+ *
+ *   `{resourceUri}/providers/Microsoft.Contoso/accessPermissions`
+ *
+ * See more details on [different ARM resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
+ */
+extern dec extensionResource(target: object);

package/lib/interfaces.tsp

@@ -0,0 +1,287 @@
+using TypeSpec.Http;
+using TypeSpec.Rest;
+using OpenAPI;
+using Autorest;
+using Azure.ResourceManager.Foundations;
+
+namespace Azure.ResourceManager;
+
+/**
+ * This is the interface that implements the standard ARM operation that returns
+ * all supported RP operations. You should have exactly one declaration for each
+ * ARM service. It implements
+ *   GET "/providers/Microsoft.ContosoProviderHub/operations"
+ */
+interface Operations {
+  @tag("Operations")
+  @autoRoute
+  @armUpdateProviderNamespace
+  @doc("List the operations for the provider")
+  @segment("operations")
+  @get
+  list(
+    ...ApiVersionParameter,
+
+    @path
+    @segment("providers")
+    @doc("The provider namespace (this parameter will not show up in operations).")
+    provider: "Microsoft.ThisWillBeReplaced"
+  ): ArmResponse<OperationListResult> | ErrorResponse;
+}
+
+/**
+ * @deprecated Use Azure.ResourceManager.TrackedResourceOperations instead
+ * A composite interface for resources that include `ResourceInstanceOperations<TResource, TProperties>`
+ * and `ResourceCollectionOperations<TResource>`. It includes: `GET`, `PUT`, `PATCH`, `DELETE`, ListByParent,
+ * ListBySubscription operations. The actual route depends on the resource model.
+ * This is the most common API pattern for Tracked Resources to use.
+ * @template TResource the ArmResource that provides these operations
+ * @template TProperties RP-specific property bag for the resource
+ * @template TBaseParameters The http parameters that are part of the request
+ *
+ */
+
+@deprecated("Use Azure.ResourceManager.TrackedResourceOperations instead")
+interface ResourceOperations<
+  TResource extends ArmResource,
+  TProperties extends object,
+  TBaseParameters = BaseParameters<TResource>
+> extends TrackedResourceOperations<TResource, TProperties, TBaseParameters> {}
+
+/**
+ * A composite interface for resources that include `ResourceInstanceOperations<TResource, TProperties>`
+ * and `ResourceCollectionOperations<TResource>`. It includes: `GET`, `PUT`, `PATCH`, `DELETE`, ListByParent,
+ * ListBySubscription operations. The actual route depends on the resource model.
+ * This is the most common API pattern for Tracked Resources to use.
+ * @template TResource the ArmResource that provides these operations
+ * @template TProperties RP-specific property bag for the resource
+ * @template TBaseParameters The http parameters that are part of the request
+ *
+ */
+
+interface TrackedResourceOperations<
+  TResource extends ArmResource,
+  TProperties extends object,
+  TBaseParameters = BaseParameters<TResource>
+>
+  extends ResourceInstanceOperations<TResource, TProperties, TBaseParameters>,
+    ResourceCollectionOperations<TResource, TBaseParameters> {}
+
+/**
+ * A composite interface for Proxy resources that include `ResourceInstanceOperations<TResource, TProperties>`
+ * and `ResourceListByParent<TResource>`. It includes: `GET`, `PUT`, `PATCH`, `DELETE`, ListByParent operations.
+ *
+ * The actual route depends on the resource model but would have started with
+ *   `/subscriptions/{id}/resourcegroups/{rg}/providers/Microsoft.XXX/...`
+ *
+ * This is the most common API pattern for Proxy Resources to use.
+ */
+interface ProxyResourceOperations<
+  TResource extends ArmResource,
+  TBaseParameters = BaseParameters<TResource>
+>
+  extends ResourceRead<TResource, TBaseParameters>,
+    ResourceCreate<TResource, TBaseParameters>,
+    ResourceDelete<TResource, TBaseParameters>,
+    ResourceListByParent<TResource, TBaseParameters> {}
+
+/**
+ * A composite interface for Tenant resources that include `ResourceInstanceOperations<TResource, TProperties>`
+ * and `ResourceListByParent<TResource>`. It includes: `GET`, `PUT`, `PATCH`, `DELETE`, ListByParent operations.
+ *
+ * The routes are always start at root level:
+ *   `/providers/Microsoft.XXX/...`
+ *
+ * This is the most common API pattern for Tenant Resources to use.
+ */
+interface TenantResourceOperations<TResource extends ArmResource, TProperties extends object>
+  extends TenantResourceRead<TResource>,
+    TenantResourceCreate<TResource>,
+    TenantResourceUpdate<TResource, TProperties>,
+    TenantResourceDelete<TResource>,
+    TenantResourceListByParent<TResource> {}
+
+interface ResourceInstanceOperations<
+  TResource extends ArmResource,
+  TProperties extends object,
+  TBaseParameters = BaseParameters<TResource>,
+  TPatchModel = ResourceUpdateModel<TResource, TProperties>
+>
+  extends ResourceRead<TResource, TBaseParameters>,
+    ResourceCreate<TResource, TBaseParameters>,
+    ResourceUpdate<TResource, TProperties, TBaseParameters>,
+    ResourceDelete<TResource, TBaseParameters> {}
+
+interface ResourceCollectionOperations<
+  TResource extends ArmResource,
+  TBaseParameters = BaseParameters<TResource>
+> extends ResourceListByParent<TResource, TBaseParameters>, ResourceListBySubscription<TResource> {}
+
+interface ResourceListBySubscription<TResource extends ArmResource> {
+  listBySubscription is ArmListBySubscription<TResource>;
+}
+
+interface ResourceListByParent<
+  TResource extends ArmResource,
+  TBaseParameters = BaseParameters<TResource>,
+  TParentName = "",
+  TParentFriendlyName = ""
+> {
+  listByParent is ArmResourceListByParent<
+    TResource,
+    TBaseParameters,
+    TParentName,
+    TParentFriendlyName
+  >;
+}
+
+interface ResourceRead<TResource extends ArmResource, TBaseParameters = BaseParameters<TResource>> {
+  get is ArmResourceRead<TResource, TBaseParameters>;
+}
+
+interface ResourceCreateSync<
+  TResource extends ArmResource,
+  TBaseParameters = BaseParameters<TResource>
+> {
+  createOrUpdate is ArmResourceCreateOrUpdateSync<TResource, TBaseParameters>;
+}
+
+interface ResourceCreateAsync<
+  TResource extends ArmResource,
+  TBaseParameters = BaseParameters<TResource>
+> {
+  createOrUpdate is ArmResourceCreateOrUpdateAsync<TResource, TBaseParameters>;
+}
+
+@doc("Delete a resource using the asynchronous call pattern")
+interface ResourceDeleteAsync<
+  TResource extends ArmResource,
+  TBaseParameters = BaseParameters<TResource>
+> {
+  delete is ArmResourceDeleteAsync<TResource, TBaseParameters>;
+}
+
+@doc("Delete a resource")
+interface ResourceDeleteSync<
+  TResource extends ArmResource,
+  TBaseParameters = BaseParameters<TResource>
+> {
+  delete is ArmResourceDeleteSync<TResource, TBaseParameters>;
+}
+
+@doc("Asynchronous resource update")
+interface ResourceUpdateAsync<
+  TResource extends ArmResource,
+  TProperties extends object,
+  TBaseParameters = BaseParameters<TResource>
+> {
+  update is ArmCustomPatchAsync<
+    TResource,
+    ResourceUpdateModel<TResource, TProperties>,
+    TBaseParameters
+  >;
+}
+
+@doc("Synchronous resource update")
+interface ResourceUpdateSync<
+  TResource extends ArmResource,
+  TProperties extends object,
+  TBaseParameters = BaseParameters<TResource>
+> {
+  update is ArmCustomPatchSync<
+    TResource,
+    ResourceUpdateModel<TResource, TProperties>,
+    TBaseParameters
+  >;
+}
+
+interface ExtensionResourceInstanceOperations<
+  TResource extends ArmResource,
+  TProperties extends object
+>
+  extends ExtensionResourceRead<TResource>,
+    ExtensionResourceCreate<TResource>,
+    ExtensionResourceUpdate<TResource, TProperties>,
+    ExtensionResourceDelete<TResource> {}
+
+interface ExtensionResourceCollectionOperations<TResource extends ArmResource>
+  extends ExtensionResourceList<TResource> {}
+
+interface ExtensionResourceOperations<TResource extends ArmResource, TProperties extends object>
+  extends ExtensionResourceInstanceOperations<TResource, TProperties>,
+    ExtensionResourceCollectionOperations<TResource> {}
+
+alias ResourceCreate<
+  TResource extends ArmResource,
+  TBaseParameters = BaseParameters<TResource>
+> = ResourceCreateAsync<TResource, TBaseParameters>;
+
+alias ResourceUpdate<
+  TResource extends ArmResource,
+  TProperties extends object,
+  TBaseParameters = BaseParameters<TResource>
+> = ResourceUpdateSync<TResource, TProperties, TBaseParameters>;
+
+alias ResourceDelete<
+  TResource extends ArmResource,
+  TBaseParameters = BaseParameters<TResource>
+> = ResourceDeleteAsync<TResource, TBaseParameters>;
+
+alias ProxyResourceUpdate<
+  TResource extends ArmResource,
+  TProperties extends object
+> = ResourceUpdate<TResource, TProperties>;
+
+alias ExtensionResourceRead<TResource extends ArmResource> = ResourceRead<
+  TResource,
+  ExtensionBaseParameters
+>;
+
+alias ExtensionResourceCreate<TResource extends ArmResource> = ResourceCreate<
+  TResource,
+  ExtensionBaseParameters
+>;
+
+alias ExtensionResourceUpdate<
+  TResource extends ArmResource,
+  TProperties extends object
+> = ResourceUpdate<TResource, TProperties, ExtensionBaseParameters>;
+
+alias ExtensionResourceDelete<TResource extends ArmResource> = ResourceDelete<
+  TResource,
+  ExtensionBaseParameters
+>;
+
+alias ExtensionResourceList<TResource extends ArmResource> = ResourceListByParent<
+  TResource,
+  ExtensionBaseParameters,
+  "Extension",
+  "parent"
+>;
+
+alias TenantResourceRead<TResource extends ArmResource> = ResourceRead<
+  TResource,
+  TenantBaseParameters
+>;
+
+alias TenantResourceCreate<TResource extends ArmResource> = ResourceCreateAsync<
+  TResource,
+  TenantBaseParameters
+>;
+
+alias TenantResourceDelete<TResource extends ArmResource> = ResourceDelete<
+  TResource,
+  TenantBaseParameters
+>;
+
+alias TenantResourceUpdate<
+  TResource extends ArmResource,
+  TProperties extends object
+> = ResourceUpdate<TResource, TProperties, TenantBaseParameters>;
+
+alias TenantResourceListByParent<TResource extends ArmResource> = ResourceListByParent<
+  TResource,
+  TenantBaseParameters,
+  "Tenant",
+  "tenant"
+>;

package/lib/models.tsp

@@ -0,0 +1,203 @@
+using TypeSpec.Http;
+using TypeSpec.Rest;
+using OpenAPI;
+using Azure.ResourceManager.Foundations;
+
+namespace Azure.ResourceManager;
+
+//#region Standard Resource Operation Interfaces
+/**
+ * Concrete tracked resource types can be created by aliasing this type using a specific property type.
+ *
+ * See more details on [different ARM resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
+ */
+@doc("Concrete tracked resource types can be created by aliasing this type using a specific property type.")
+@armResourceInternal(TProperties)
+@includeInapplicableMetadataInPayload(false)
+model TrackedResource<TProperties> extends TrackedResourceBase {
+  @doc("The resource-specific properties for this resource.")
+  @visibility("read", "create")
+  @extension("x-ms-client-flatten", true)
+  properties?: TProperties;
+}
+
+/**
+ * Concrete proxy resource types can be created by aliasing this type using a specific property type.
+ *
+ * See more details on [different ARM resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
+ */
+@doc("Concrete proxy resource types can be created by aliasing this type using a specific property type.")
+@armResourceInternal(TProperties)
+@includeInapplicableMetadataInPayload(false)
+model ProxyResource<TProperties> extends ProxyResourceBase {
+  @doc("The resource-specific properties for this resource.")
+  @visibility("read", "create")
+  @extension("x-ms-client-flatten", true)
+  properties?: TProperties;
+}
+
+/**
+ * Concrete extension resource types can be created by aliasing this type using a specific property type.
+ *
+ * See more details on [different ARM resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
+ */
+@extensionResource
+@doc("Concrete extension resource types can be created by aliasing this type using a specific property type.")
+@armResourceInternal(TProperties)
+@includeInapplicableMetadataInPayload(false)
+model ExtensionResource<TProperties> extends ExtensionResourceBase {
+  @doc("The resource-specific properties for this resource.")
+  @visibility("read", "create")
+  @extension("x-ms-client-flatten", true)
+  properties?: TProperties;
+}
+//#region
+
+//#region Standard extraction models
+@copyResourceKeyParameters
+model KeysOf<TResource> {}
+
+@copyResourceKeyParameters("parent")
+model ParentKeysOf<TResource> {}
+
+model ProviderNamespace<TResource> {
+  @path
+  @segment("providers")
+  @assignProviderNameValue(TResource)
+  @doc("The provider namespace for the resource.")
+  provider: "Microsoft.ThisWillBeReplaced";
+}
+//#endregion
+
+//#region Common ARM type definitions
+
+/**
+ * A type definition that refers the id to an ARM resource.
+ *
+ * Sample usage:
+ *   otherArmId: ResourceIdentifier;
+ *   networkId: ResourceIdentifier<[{type:"\\Microsoft.Network\\vnet"}]>
+ *   vmIds: ResourceIdentifier<[{type:"\\Microsoft.Compute\\vm", scopes["*"]}]>
+ */
+@doc("A type definition that refers the id to an ARM resource.")
+@format("arm-id")
+@OpenAPI.extension(
+  "x-ms-arm-id-details",
+  {
+    allowedResources: T,
+  }
+)
+scalar ResourceIdentifier<T extends ResourceIdentifierAllowedResource[] = {}> extends string;
+
+/**
+ * Used in ResourceIdentifier definition to represent a particular type of ARM resource, enabling constraints based on resource type.
+ * See [link](https://github.com/Azure/autorest/tree/main/docs/extensions#schema)
+ */
+@doc("Optional definition represents a particular type of ARM resource which can be referred to by a ResourceIdentifier.")
+model ResourceIdentifierAllowedResource {
+  @doc("The type of resource that is being referred to. For example Microsoft.Network/virtualNetworks or Microsoft.Network/virtualNetworks/subnets. See Example Types for more examples.")
+  type: string;
+
+  @doc("""
+    An array of scopes. If not specified, the default scope is ["ResourceGroup"].
+    See [Allowed Scopes](https://github.com/Azure/autorest/tree/main/docs/extensions#allowed-scopes). 
+    """)
+  scopes?: string[] = [];
+}
+
+/**
+ * Standard terminal provisioning state of resource type. You can spread into your
+ * custom provision state to avoid duplication and ensure consistency
+ *
+ * @example
+ *
+ * ```typespec
+ * enum FooProvisioningState {
+ *   ...ResourceProvisioningState,  // include standard provisioning states
+ *   starting,
+ *   started,
+ *   stopping,
+ *   stopped,
+ * }
+ * ```
+ */
+@doc("The provisioning state of a resource type.")
+@Azure.Core.lroStatus
+enum ResourceProvisioningState {
+  Succeeded,
+  Failed,
+  Canceled,
+}
+
+/**
+ * Standard resource provisioning state model. If you do not have any custom provisioning state,
+ * you can spread this model directly into your resource property model.
+ *
+ * @example
+ *
+ * ```typespec
+ * model FooProperties {
+ *   // Only have standard Succeeded, Failed, Cancelled states
+ *   ...DefaultProvisioningStateProperty,
+ * }
+ * ```
+ */
+@doc("Contains a default provisioningState property to be spread into resource property types")
+model DefaultProvisioningStateProperty {
+  @doc("The provisioning state of the resource.")
+  provisioningState: ResourceProvisioningState;
+}
+
+/**
+ * Standard ARM definition of ManagedServiceIdentity
+ */
+@doc("The managed service identities envelope.")
+model ManagedServiceIdentity {
+  @doc("The managed service identities assigned to this resource.")
+  identity?: ManagedIdentityProperties;
+}
+
+@doc("Managed identity for services that are constrained to system-assigned managed identities.")
+model ManagedSystemAssignedIdentity {
+  @doc("The managed service identities assigned to this resource.")
+  identity?: ManagedSystemIdentityProperties;
+}
+
+@doc("The eTag property envelope.")
+model EntityTag {
+  @doc("If eTag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
+  @visibility("read")
+  eTag?: string;
+}
+
+@doc("The resource kind property envelope.")
+model ResourceKind {
+  @doc("Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.")
+  @pattern("^[-\\w\\._,\\(\\\\\\)]+$")
+  @visibility("read", "create")
+  kind?: string;
+}
+
+@doc("The response of a {name} list operation.", TResource)
+@friendlyName("{name}ListResult", TResource)
+model ResourceListResult<TResource extends ArmResource> is Azure.Core.Page<TResource>;
+
+@doc("The resource plan property envelope.")
+model ResourcePlan {
+  @doc("Details of the resource plan.")
+  plan?: ResourcePlanType;
+}
+
+@doc("The SKU (Stock Keeping Unit) assigned to this resource.")
+model ResourceSku {
+  @doc("The SKU (Stock Keeping Unit) assigned to this resource.")
+  sku?: ResourceSkuType;
+}
+
+@doc("The managedBy property envelope.")
+model ManagedBy {
+  @doc("The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.")
+  managedBy?: string;
+}
+
+//#endregion