@azure-tools/typespec-azure-resource-manager 0.38.0 → 0.39.0-dev.1

package/README.md

@@ -82,7 +82,7 @@ Available ruleSets:
 #### `@armCommonTypesVersion`
 
 This decorator is used either on a namespace or a version enum value to indicate
-the version of the ARM common-types to use for refs in emitted Swagger files.
+the version of the Azure Resource Manager common-types to use for refs in emitted Swagger files.
 
 ```typespec
 @Azure.ResourceManager.armCommonTypesVersion(version: valueof string | EnumMember)
@@ -100,7 +100,7 @@ the version of the ARM common-types to use for refs in emitted Swagger files.
 
 #### `@armLibraryNamespace`
 
-`@armLibraryNamespace` designates a namespace as containign ARM Provider information.
+`@armLibraryNamespace` designates a namespace as containign Azure Resource Manager Provider information.
 
 ```typespec
 @Azure.ResourceManager.armLibraryNamespace
@@ -123,7 +123,7 @@ namespace Microsoft.Contoso;
 
 #### `@armProviderNamespace`
 
-`@armProviderNamespace` sets the ARM provider name. It will default to use the
+`@armProviderNamespace` sets the Azure Resource Manager provider name. It will default to use the
 Namespace element value unless an override value is specified.
 
 ```typespec
@@ -155,7 +155,7 @@ namespace Microsoft.ContosoService;
 #### `@armProviderNameValue`
 
 `@armResourceType` sets the value fo the decorated string
-property to the type of the ARM resource.
+property to the type of the Azure Resource Manager resource.
 
 ```typespec
 @Azure.ResourceManager.armProviderNameValue
@@ -328,13 +328,13 @@ clients.
 
 #### `@extensionResource`
 
-`@extensionResource` marks an ARM resource model as an Extension resource.
+`@extensionResource` marks an Azure Resource Manager 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)
+See more details on [different Azure Resource Manager resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
 
 ```typespec
 @Azure.ResourceManager.extensionResource
@@ -350,12 +350,12 @@ None
 
 #### `@locationResource`
 
-`@locationResource` marks an ARM resource model as a location based resource.
+`@locationResource` marks an Azure Resource Manager 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)
+See more details on [different Azure Resource Manager resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
 
 ```typespec
 @Azure.ResourceManager.locationResource
@@ -371,13 +371,13 @@ None
 
 #### `@resourceGroupResource`
 
-`@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
+`@resourceGroupResource` marks an Azure Resource Manager resource model as a resource group level resource.
+This is the default option for Azure Resource Manager 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)
+See more details on [different Azure Resource Manager resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
 
 ```typespec
 @Azure.ResourceManager.resourceGroupResource
@@ -393,12 +393,12 @@ None
 
 #### `@singleton`
 
-`@singleton` marks an ARM resource model as a singleton resource.
+`@singleton` marks an Azure Resource Manager 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)
+See more details on [different Azure Resource Manager resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
 
 ```typespec
 @Azure.ResourceManager.singleton(keyValue?: valueof string | default)
@@ -416,12 +416,12 @@ See more details on [different ARM resource type here.](https://azure.github.io/
 
 #### `@subscriptionResource`
 
-`@subscriptionResource` marks an ARM resource model as a subscription resource.
+`@subscriptionResource` marks an Azure Resource Manager 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)
+See more details on [different Azure Resource Manager resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
 
 ```typespec
 @Azure.ResourceManager.subscriptionResource
@@ -437,12 +437,12 @@ None
 
 #### `@tenantResource`
 
-`@tenantResource` marks an ARM resource model as a Tenant resource/Root resource/Top-Level resource.
+`@tenantResource` marks an Azure Resource Manager 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)
+See more details on [different Azure Resource Manager resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
 
 ```typespec
 @Azure.ResourceManager.tenantResource
@@ -458,8 +458,8 @@ None
 
 #### `@useLibraryNamespace`
 
-Declare the ARM library namespaces used in this provider.
-This allows sharing ARM resource types across specifications
+Declare the Azure Resource Manager library namespaces used in this provider.
+This allows sharing Azure Resource Manager resource types across specifications
 
 ```typespec
 @Azure.ResourceManager.useLibraryNamespace(...namespaces: Namespace[])
@@ -471,6 +471,6 @@ This allows sharing ARM resource types across specifications
 
 ##### Parameters
 
-| Name       | Type                | Description                                           |
-| ---------- | ------------------- | ----------------------------------------------------- |
-| namespaces | `model Namespace[]` | The namespaces of arm libraries used in this provider |
+| Name       | Type                | Description                                                              |
+| ---------- | ------------------- | ------------------------------------------------------------------------ |
+| namespaces | `model Namespace[]` | The namespaces of Azure Resource Manager libraries used in this provider |

package/lib/arm.foundations.tsp

@@ -17,9 +17,9 @@ A list of REST API operations supported by an Azure Resource Provider. It contai
 model OperationListResult is Azure.Core.Page<Operation>;
 
 /**
- * Base model that defines common properties for all ARM resources.
+ * Base model that defines common properties for all Azure Resource Manager resources.
  */
-@doc("Common properties for all ARM resources.")
+@doc("Common properties for all Azure Resource Manager resources.")
 model ArmResource extends ArmResourceBase {
   @doc("Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}")
   @visibility("read")
@@ -295,11 +295,11 @@ model ErrorAdditionalInfo {
 }
 
 /**
- * Standard type definition for ARM Tags property.
+ * Standard type definition for Azure Resource Manager Tags property.
  *
  * It is included in the TrackedResource template definition.
  */
-@doc("The ARM Resource tags.")
+@doc("The Azure Resource Manager Resource tags.")
 model ArmTagsProperty {
   @doc("Resource tags.")
   tags?: Record<string>;
@@ -636,7 +636,7 @@ model Operation {
   name?: string;
 
   @doc("""
-  Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations.
+  Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for Azure Resource Manager/control-plane operations.
   """)
   @visibility("read")
   isDataAction?: boolean;
@@ -751,3 +751,47 @@ op checkNameAvailability<
   @body
   body: Request,
 ): Response | ErrorResponse;
+
+/**
+ * @dev The base template for Azure Resource Manager Operations.
+ * @param Parameters The parameter object for the operation.
+ * @param Response The response or union of responses for success.
+ * @param ErrorResponse The error response.
+ */
+op ArmReadOperation<Parameters extends {}, Response extends {}, ErrorResponse extends {}>(
+  ...Parameters,
+): Response | ErrorResponse;
+
+/**
+ * @dev The base temlate for Azure Resource Manager PUT Operations.
+ * @param HttpParameters The parameter object for the operation.
+ * @param BodyParameter The body parameter
+ * @param Response The response or union of responses for success.
+ * @param ErrorResponse The error response.
+ */
+op ArmCreateOperation<
+  HttpParameters extends {},
+  BodyParameter extends {},
+  Response extends {},
+  ErrorResponse extends {}
+>(
+  ...HttpParameters,
+  @doc("Resource create parameters.") @body resource: BodyParameter,
+): Response | ErrorResponse;
+
+/**
+ * @dev The base temlate for Azure Resource Manager PATCH Operations.
+ * @param HttpParameters The parameter object for the operation.
+ * @param BodyParameter The body parameter
+ * @param Response The response or union of responses for success.
+ * @param ErrorResponse The error response.
+ */
+op ArmUpdateOperation<
+  HttpParameters extends {},
+  BodyParameter extends {},
+  Response extends {},
+  ErrorResponse extends {}
+>(
+  ...HttpParameters,
+  @doc("The resource properties to be updated.") @body properties: BodyParameter,
+): Response | ErrorResponse;

package/lib/common-types.tsp

@@ -5,14 +5,14 @@ using TypeSpec.Versioning;
 namespace Azure.ResourceManager.CommonTypes;
 
 @Private.armCommonTypesVersions
-@doc("The ARM common-types versions.")
+@doc("The Azure Resource Manager common-types versions.")
 enum Versions {
-  @doc("The ARM v3 common types.")
+  @doc("The Azure Resource Manager v3 common types.")
   v3,
 
-  @doc("The ARM v4 common types.")
+  @doc("The Azure Resource Manager v4 common types.")
   v4,
 
-  @doc("The ARM v5 common types.")
+  @doc("The Azure Resource Manager v5 common types.")
   v5,
 }

package/lib/decorators.tsp

@@ -3,7 +3,7 @@ using TypeSpec.Reflection;
 namespace Azure.ResourceManager;
 
 /**
- * `@armProviderNamespace` sets the ARM provider name. It will default to use the
+ * `@armProviderNamespace` sets the Azure Resource Manager provider name. It will default to use the
  * Namespace element value unless an override value is specified.
  *
  * @example
@@ -25,14 +25,14 @@ namespace Azure.ResourceManager;
 extern dec armProviderNamespace(target: Namespace, providerNamespace?: valueof string);
 
 /**
- * Declare the ARM library namespaces used in this provider.
- * This allows sharing ARM resource types across specifications
- * @param namespaces The namespaces of arm libraries used in this provider
+ * Declare the Azure Resource Manager library namespaces used in this provider.
+ * This allows sharing Azure Resource Manager resource types across specifications
+ * @param namespaces The namespaces of Azure Resource Manager libraries used in this provider
  */
 extern dec useLibraryNamespace(target: Namespace, ...namespaces: Namespace[]);
 
 /**
- * `@armLibraryNamespace` designates a namespace as containign ARM Provider information.
+ * `@armLibraryNamespace` designates a namespace as containign Azure Resource Manager Provider information.
  *
  * @example
  *
@@ -45,72 +45,72 @@ extern dec useLibraryNamespace(target: Namespace, ...namespaces: Namespace[]);
 extern dec armLibraryNamespace(target: Namespace);
 
 /**
- * `@singleton` marks an ARM resource model as a singleton resource.
+ * `@singleton` marks an Azure Resource Manager 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)
+ * See more details on [different Azure Resource Manager 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: Model, keyValue?: valueof string | "default");
 
 /**
- * `@tenantResource` marks an ARM resource model as a Tenant resource/Root resource/Top-Level resource.
+ * `@tenantResource` marks an Azure Resource Manager 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)
+ * See more details on [different Azure Resource Manager resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
  */
 extern dec tenantResource(target: Model);
 
 /**
- * `@subscriptionResource` marks an ARM resource model as a subscription resource.
+ * `@subscriptionResource` marks an Azure Resource Manager 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)
+ * See more details on [different Azure Resource Manager resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
  */
 extern dec subscriptionResource(target: Model);
 
 /**
- * `@locationResource` marks an ARM resource model as a location based resource.
+ * `@locationResource` marks an Azure Resource Manager 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)
+ * See more details on [different Azure Resource Manager resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
  */
 extern dec locationResource(target: Model);
 
 /**
- * `@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
+ * `@resourceGroupResource` marks an Azure Resource Manager resource model as a resource group level resource.
+ * This is the default option for Azure Resource Manager 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)
+ * See more details on [different Azure Resource Manager resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
  */
 extern dec resourceGroupResource(target: Model);
 
 /**
- * `@extensionResource` marks an ARM resource model as an Extension resource.
+ * `@extensionResource` marks an Azure Resource Manager 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)
+ * See more details on [different Azure Resource Manager resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
  */
 extern dec extensionResource(target: Model);
 
 /**
  * `@armResourceType` sets the value fo the decorated string
- * property to the type of the ARM resource.
+ * property to the type of the Azure Resource Manager resource.
  * @param resource The resource to get the type of
  */
 extern dec armProviderNameValue(target: Operation | Model);
@@ -178,7 +178,7 @@ extern dec armResourceOperations(target: Interface, _?: unknown);
 
 /**
  * This decorator is used either on a namespace or a version enum value to indicate
- * the version of the ARM common-types to use for refs in emitted Swagger files.
+ * the version of the Azure Resource Manager common-types to use for refs in emitted Swagger files.
  *
  * @param version The Azure.ResourceManager.CommonTypes.Versions for the desired common-types version or an equivalent string value.
  */

package/lib/interfaces.tsp

@@ -8,9 +8,9 @@ using Azure.ResourceManager.Private;
 namespace Azure.ResourceManager;
 
 /**
- * This is the interface that implements the standard ARM operation that returns
+ * This is the interface that implements the standard Azure Resource Manager operation that returns
  * all supported RP operations. You should have exactly one declaration for each
- * ARM service. It implements
+ * Azure Resource Manager service. It implements
  *   GET "/providers/Microsoft.ContosoProviderHub/operations"
  */
 interface Operations {
@@ -201,7 +201,7 @@ interface ResourceCreateSync<
    * @template Resource The ArmResource to create or update.
    * @template BaseParameters The http parameters that are part of the request
    */
-  createOrUpdate is ArmResourceCreateOrUpdateSync<Resource, BaseParameters>;
+  createOrUpdate is ArmResourceCreateOrReplaceSync<Resource, BaseParameters>;
 }
 
 /**

package/lib/models.tsp

@@ -10,7 +10,7 @@ namespace Azure.ResourceManager;
 /**
  * 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)
+ * See more details on [different Azure Resource Manager resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
  * @template Properties A model containing the provider-specific properties for this resource
  */
 @doc("Concrete tracked resource types can be created by aliasing this type using a specific property type.")
@@ -26,7 +26,7 @@ model TrackedResource<Properties extends {}> extends TrackedResourceBase {
 /**
  * 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)
+ * See more details on [different Azure Resource Manager resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
  * @template Properties A model containing the provider-specific properties for this resource
  */
 @doc("Concrete proxy resource types can be created by aliasing this type using a specific property type.")
@@ -42,7 +42,7 @@ model ProxyResource<Properties extends {}> extends ProxyResourceBase {
 /**
  * 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)
+ * See more details on [different Azure Resource Manager resource type here.](https://azure.github.io/typespec-azure/docs/howtos/ARM/resource-type)
  * @template Properties A model containing the provider-specific properties for this resource
  */
 @extensionResource
@@ -86,10 +86,10 @@ model ProviderNamespace<Resource extends {}> {
 }
 //#endregion
 
-//#region Common ARM type definitions
+//#region Common Azure Resource Manager type definitions
 
 /**
- * A type definition that refers the id to an ARM resource.
+ * A type definition that refers the id to an Azure Resource Manager resource.
  *
  * Sample usage:
  *   otherArmId: ResourceIdentifier;
@@ -97,7 +97,7 @@ model ProviderNamespace<Resource extends {}> {
  *   vmIds: ResourceIdentifier<[{type:"\\Microsoft.Compute\\vm", scopes["*"]}]>
  * @template AllowedResourceTypes An array of allowed resource types for the resource reference
  */
-@doc("A type definition that refers the id to an ARM resource.")
+@doc("A type definition that refers the id to an Azure Resource Manager resource.")
 @format("arm-id")
 @OpenAPI.extension(
   "x-ms-arm-id-details",
@@ -109,10 +109,10 @@ scalar ResourceIdentifier<AllowedResourceTypes extends ResourceIdentifierAllowed
   extends string;
 
 /**
- * Used in ResourceIdentifier definition to represent a particular type of ARM resource, enabling constraints based on resource type.
+ * Used in ResourceIdentifier definition to represent a particular type of Azure Resource Manager 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.")
+@doc("Optional definition represents a particular type of Azure Resource Manager 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;
@@ -173,7 +173,7 @@ model DefaultProvisioningStateProperty {
 }
 
 /**
- * Standard ARM definition of ManagedServiceIdentity
+ * Standard Azure Resource Manager definition of ManagedServiceIdentity
  */
 @doc("The managed service identities envelope.")
 model ManagedServiceIdentity {
@@ -182,7 +182,7 @@ model ManagedServiceIdentity {
 }
 
 /**
- * Standard ARM definition of ManagedServiceIdentity for services
+ * Standard Azure Resource Manager definition of ManagedServiceIdentity for services
  * that only support system-defined identities
  */
 @doc("Managed identity for services that are constrained to system-assigned managed identities.")