@azure-tools/typespec-azure-resource-manager 0.58.0-dev.2 → 0.58.0-dev.4

package/lib/Legacy/operations.tsp

@@ -15,11 +15,26 @@ using Rest;
  * @template ResourceTypeParameter The path parameter for the resource name
  * @template ErrorType Optional. The type of error models used in operations created form this template
  */
-@doc("")
 interface LegacyOperations<
   ParentParameters extends {},
   ResourceTypeParameter extends {},
   ErrorType extends {} = ErrorResponse
+> extends RoutedOperations<ParentParameters, ResourceTypeParameter, ErrorType> {}
+
+/**
+ * An operation template used to build resource operations in which the same resource type
+ * is accessible at multiple, fixed resource paths. Can be used with static routes.
+ * @template ParentParameters The path parameters for the resource parent
+ * @template ResourceTypeParameter The path parameter for the resource name
+ * @template ErrorType Optional. The type of error models used in operations created form this template
+ * @template ResourceRoute Optional. The resource route to use for operations in the interface.
+ */
+@doc("")
+interface RoutedOperations<
+  ParentParameters extends {},
+  ResourceTypeParameter extends {},
+  ErrorType extends {} = ErrorResponse,
+  ResourceRoute extends valueof ArmOperationOptions = #{ useStaticRoute: false }
 > {
   /**
    * A long-running resource CreateOrUpdate (PUT)
@@ -28,10 +43,13 @@ interface LegacyOperations<
    * @template Parameters Optional. Additional parameters after the path parameters
    * @template Response Optional. The success response(s) for the PUT operation
    * @template OptionalRequestBody Optional. Indicates whether the request body is optional
+   * @template OverrideErrortype Optional. The error response, if non-standard.
+   * @template OverrideRouteOptions Optional. The route options for the operation.
    */
-  @autoRoute
   @doc("Create a {name}", Resource)
+  @armOperationRoute(OverrideRouteOptions)
   @armResourceCreateOrUpdate(Resource)
+  @Private.armUpdateProviderNamespace
   @Azure.Core.Foundations.Private.defaultFinalStateVia(#["location", "azure-async-operation"])
   @put
   CreateOrUpdateAsync<
@@ -43,13 +61,15 @@ interface LegacyOperations<
       Resource,
       LroHeaders
     >,
-    OptionalRequestBody extends valueof boolean = false
+    OptionalRequestBody extends valueof boolean = false,
+    OverrideErrortype extends {} = ErrorType,
+    OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
   >(
     ...ParentParameters,
     ...ResourceTypeParameter,
     ...Parameters,
     @doc("Resource create parameters.") @armBodyRoot(OptionalRequestBody) resource: Resource,
-  ): Response | ErrorType;
+  ): Response | OverrideErrortype;
 
   /**
    * A synchronous resource CreateOrUpdate (PUT)
@@ -57,23 +77,28 @@ interface LegacyOperations<
    * @template Parameters Optional. Additional parameters after the path parameters
    * @template Response Optional. The success response(s) for the PUT operation
    * @template OptionalRequestBody Optional. Indicates whether the request body is optional
+   * @template OverrideErrortype Optional. The error response, if non-standard.
+   * @template OverrideRouteOptions Optional. The route options for the operation.
    */
   #suppress "@azure-tools/typespec-azure-core/no-private-usage"
-  @autoRoute
+  @armOperationRoute(OverrideRouteOptions)
   @doc("Create a {name}", Resource)
   @armResourceCreateOrUpdate(Resource)
+  @Private.armUpdateProviderNamespace
   @put
   CreateOrUpdateSync<
     Resource extends Foundations.SimpleResource,
     Parameters extends {} = {},
     Response extends {} = ArmResourceUpdatedResponse<Resource> | ArmResourceCreatedSyncResponse<Resource>,
-    OptionalRequestBody extends valueof boolean = false
+    OptionalRequestBody extends valueof boolean = false,
+    OverrideErrortype extends {} = ErrorType,
+    OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
   >(
     ...ParentParameters,
     ...ResourceTypeParameter,
     ...Parameters,
     @doc("Resource create parameters.") @armBodyRoot(OptionalRequestBody) resource: Resource,
-  ): Response | ErrorType;
+  ): Response | OverrideErrortype;
 
   /**
    * A long-running resource Update (PATCH)
@@ -83,10 +108,13 @@ interface LegacyOperations<
    * @template Parameters Optional. Additional parameters after the path parameters
    * @template Response Optional. The success response(s) for the PATCH operation
    * @template OptionalRequestBody Optional. Indicates whether the request body is optional
+   * @template OverrideErrortype Optional. The error response, if non-standard.
+   * @template OverrideRouteOptions Optional. The route options for the operation.
    */
-  @autoRoute
   @doc("Update a {name}", Resource)
+  @armOperationRoute(OverrideRouteOptions)
   @armResourceUpdate(Resource)
+  @Private.armUpdateProviderNamespace
   @patch(#{ implicitOptionality: false })
   CustomPatchAsync<
     Resource extends Foundations.SimpleResource,
@@ -102,13 +130,15 @@ interface LegacyOperations<
       "Resource update request accepted.",
       LroHeaders
     >,
-    OptionalRequestBody extends valueof boolean = false
+    OptionalRequestBody extends valueof boolean = false,
+    OverrideErrortype extends {} = ErrorType,
+    OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
   >(
     ...ParentParameters,
     ...ResourceTypeParameter,
     ...Parameters,
     @doc("Resource create parameters.") @armBodyRoot(OptionalRequestBody) properties: PatchModel,
-  ): Response | ErrorType;
+  ): Response | OverrideErrortype;
 
   /**
    * A synchronous resource Update (PATCH)
@@ -117,23 +147,28 @@ interface LegacyOperations<
    * @template Parameters Optional. Additional parameters after the path parameters
    * @template Response Optional. The success response(s) for the PATCH operation
    * @template OptionalRequestBody Optional. Indicates whether the request body is optional
+   * @template OverrideErrortype Optional. The error response, if non-standard.
+   * @template OverrideRouteOptions Optional. The route options for the operation.
    */
-  @autoRoute
   @doc("Update a {name}", Resource)
+  @armOperationRoute(OverrideRouteOptions)
   @armResourceUpdate(Resource)
+  @Private.armUpdateProviderNamespace
   @patch(#{ implicitOptionality: false })
   CustomPatchSync<
     Resource extends Foundations.SimpleResource,
     PatchModel extends {} = Azure.ResourceManager.Foundations.TagsUpdateModel<Resource>,
     Parameters extends {} = {},
     Response extends {} = ArmResponse<Resource>,
-    OptionalRequestBody extends valueof boolean = false
+    OptionalRequestBody extends valueof boolean = false,
+    OverrideErrortype extends {} = ErrorType,
+    OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
   >(
     ...ParentParameters,
     ...ResourceTypeParameter,
     ...Parameters,
     @doc("Resource create parameters.") @armBodyRoot(OptionalRequestBody) properties: PatchModel,
-  ): Response | ErrorType;
+  ): Response | OverrideErrortype;
 
   /**
    * Delete a resource asynchronously
@@ -141,72 +176,116 @@ interface LegacyOperations<
    * @template LroHeaders The lro headers for the operation
    * @template Parameters Optional. Additional parameters after the path parameters
    * @template Response Optional. The success response(s) for the delete operation
+   * @template OverrideErrorType Optional. The error response, if non-standard.
+   * @template OverrideRouteOptions Optional. The route options for the operation.
    */
   #suppress "@azure-tools/typespec-azure-core/no-response-body" "Valid"
-  @autoRoute
   @doc("Delete a {name}", Resource)
+  @armOperationRoute(OverrideRouteOptions)
   @delete
   @deletesResource(Resource)
+  @Private.armUpdateProviderNamespace
   @armResourceDelete(Resource)
   DeleteWithoutOkAsync<
     Resource extends Foundations.SimpleResource,
     LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader &
       Azure.Core.Foundations.RetryAfterHeader,
     Parameters extends {} = {},
-    Response extends {} = ArmDeleteAcceptedLroResponse<LroHeaders> | ArmDeletedNoContentResponse
-  >(...ParentParameters, ...ResourceTypeParameter, ...Parameters): Response | ErrorType;
+    Response extends {} = ArmDeleteAcceptedLroResponse<LroHeaders> | ArmDeletedNoContentResponse,
+    OverrideErrorType extends {} = ErrorType,
+    OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
+  >(...ParentParameters, ...ResourceTypeParameter, ...Parameters): Response | OverrideErrorType;
 
   /**
    * Delete a resource synchronously
    * @template Resource The resource being deleted
    * @template Parameters Optional. Additional parameters after the path parameters
    * @template Response Optional. The success response(s) for the delete operation
+   * @template OverrideErrorType Optional. The error response, if non-standard.
+   * @template OverrideRouteOptions Optional. The route options for the operation.
    */
   #suppress "@azure-tools/typespec-azure-core/no-response-body" "Valid"
-  @autoRoute
   @doc("Delete a {name}", Resource)
+  @armOperationRoute(OverrideRouteOptions)
   @delete
   @deletesResource(Resource)
   @armResourceDelete(Resource)
+  @Private.armUpdateProviderNamespace
   DeleteSync<
     Resource extends Foundations.SimpleResource,
     Parameters extends {} = {},
-    Response extends {} = ArmDeletedResponse | ArmDeletedNoContentResponse
-  >(...ParentParameters, ...ResourceTypeParameter, ...Parameters): Response | ErrorType;
+    Response extends {} = ArmDeletedResponse | ArmDeletedNoContentResponse,
+    OverrideErrorType extends {} = ErrorType,
+    OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
+  >(...ParentParameters, ...ResourceTypeParameter, ...Parameters): Response | OverrideErrorType;
 
   /**
    * @dev Get a resource
    * @template Resource The resource being read
    * @template Parameters Optional. Additional parameters after the path parameters
    * @template Response Optional. The success response for a get operation.
+   * @template OverrideErrorType Optional. The error response, if non-standard.
+   * @template OverrideRouteOptions Optional. The route options for the operation.
    */
-  @autoRoute
   @doc("Get a {name}", Resource)
+  @armOperationRoute(OverrideRouteOptions)
   @get
   @readsResource(Resource)
   @armResourceRead(Resource)
+  @Private.armUpdateProviderNamespace
   Read<
     Resource extends Foundations.SimpleResource,
     Parameters extends {} = {},
-    Response extends {} = ArmResponse<Resource>
-  >(...ParentParameters, ...ResourceTypeParameter, ...Parameters): Response | ErrorType;
+    Response extends {} = ArmResponse<Resource>,
+    OverrideErrorType extends {} = ErrorType,
+    OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
+  >(...ParentParameters, ...ResourceTypeParameter, ...Parameters): Response | OverrideErrorType;
+
+  /**
+   * Check a resource's existence via HEAD operation
+   * @template Resource The resource being checked
+   * @template Parameters Optional. Additional parameters after the path parameters
+   * @template Response Optional. The success response for a head operation (by default NoContent or NotFound response).
+   * @template OverrideErrorType Optional. The error response, if non-standard.
+   * @template OverrideRouteOptions Optional. The route options for the operation.
+   */
+  @armOperationRoute(OverrideRouteOptions)
+  @doc("Check for the existence of a {name}", Resource)
+  @Private.armUpdateProviderNamespace
+  @head
+  CheckExistence<
+    Resource extends Foundations.SimpleResource,
+    Parameters extends {} = {},
+    Response extends {} = ArmResourceExistsResponse | ArmResourceNotFoundResponse,
+    OverrideErrorType extends {} = ErrorType,
+    OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
+  > is Foundations.ArmReadOperation<
+    ParentParameters & ResourceTypeParameter & Parameters,
+    Response,
+    OverrideErrorType
+  >;
 
   /**
    * List a resource
    * @template Resource The resource being listed
    * @template Parameters Optional. Additional parameters after the path parameters
    * @template Response Optional. The response returned by the list
+   * @template OverrideErrorType Optional. The error response, if non-standard.
+   * @template OverrideRouteOptions Optional. The route options for the operation.
    */
-  @autoRoute
   @doc("List a {name}", Resource)
   @get
   @listsResource(Resource)
   @segmentOf(Resource)
+  @armOperationRoute(OverrideRouteOptions)
   @armResourceList(Resource)
+  @Private.armUpdateProviderNamespace
   List<
     Resource extends Foundations.SimpleResource,
     Parameters extends {} = {},
-    Response extends {} = ArmResponse<ResourceListResult<Resource>>
+    Response extends {} = ArmResponse<ResourceListResult<Resource>>,
+    OverrideErrorType extends {} = ErrorType,
+    OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
   >(...ParentParameters, ...Parameters): Response | ErrorType;
 
   /**
@@ -216,19 +295,24 @@ interface LegacyOperations<
    * @template Response The response model for the action
    * @template Parameters Optional. Additional parameters after the path parameters
    * @template OptionalRequestBody Optional. Indicates whether the request body is optional
+   * @template OverrideErrortype Optional. The error response, if non-standard.
+   * @template OverrideRouteOptions Optional. The route options for the operation.
    */
   @doc("")
-  @autoRoute
   @armResourceAction(Resource)
+  @armOperationRoute(OverrideRouteOptions)
   @Private.enforceConstraint(Resource, Foundations.Resource)
   @post
+  @Private.armUpdateProviderNamespace
   @returnsDoc("Azure operation completed successfully.")
   ActionSync<
     Resource extends Foundations.SimpleResource,
     Request extends TypeSpec.Reflection.Model | void,
     Response extends TypeSpec.Reflection.Model | void,
     Parameters extends {} = {},
-    OptionalRequestBody extends valueof boolean = false
+    OptionalRequestBody extends valueof boolean = false,
+    OverrideErrortype extends {} = ErrorType,
+    OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
   >(
     ...ParentParameters,
     ...ResourceTypeParameter,
@@ -237,22 +321,26 @@ interface LegacyOperations<
     @doc("The content of the action request")
     @armBodyRoot(OptionalRequestBody)
     body: Request,
-  ): Response | ErrorType;
+  ): Response | OverrideErrortype;
 
   /**
    * A long-running resource action.
    * @template Resource The resource being acted upon
    * @template Request The request model for the action
+   * @template Result The result model for the action when the operation is successful
    * @template LroHeaders Optional. Allows overriding the headers returned in the Accepted response
-   * @template Response The response model for the action
+   * @template Response The union of successful responses for the action
    * @template Parameters Optional. Additional parameters after the path parameters
    * @template OptionalRequestBody Optional. Indicates whether the request body is optional
+   * @template OverrideErrortype Optional. The error response, if non-standard.
+   * @template OverrideRouteOptions Optional. The route options for the operation.
    */
   #suppress "@azure-tools/typespec-azure-core/no-response-body" "ARM"
   @doc("")
-  @autoRoute
   @armResourceAction(Resource)
+  @armOperationRoute(OverrideRouteOptions)
   @Private.enforceConstraint(Resource, Foundations.Resource)
+  @Private.armUpdateProviderNamespace
   @post
   @returnsDoc("Azure operation completed successfully.")
   ActionAsync<
@@ -270,7 +358,9 @@ interface LegacyOperations<
       "Resource operation accepted.",
       LroHeaders
     > | Result,
-    OptionalRequestBody extends valueof boolean = false
+    OptionalRequestBody extends valueof boolean = false,
+    OverrideErrortype extends {} = ErrorType,
+    OverrideRouteOptions extends valueof ArmOperationOptions = ResourceRoute
   >(
     ...ParentParameters,
     ...ResourceTypeParameter,
@@ -279,16 +369,24 @@ interface LegacyOperations<
     @doc("The content of the action request")
     @armBodyRoot(OptionalRequestBody)
     body: Request,
-  ): Response | ErrorType;
+  ): Response | OverrideErrortype;
 }
 /**
- * @dev Get the provider namespace key-value pair
+ * @dev DEPRECATED: Use ProviderParameter instead. Get the provider namespace key-value pair
  * @template Resource Optional.  The resource to get the provider namespace for.
  */
 model Provider<Resource extends {} = TenantActionScope> {
   ...ProviderNamespace<Resource>;
 }
 
+/**
+ * @dev Get the provider namespace key-value pair
+ * @template Resource The resource to get the provider namespace for.
+ */
+model ProviderParameter<Resource extends {}> {
+  ...ProviderNamespace<Resource>;
+}
+
 /**
  * A long-running resource update using a custom PATCH payload (Asynchronous)
  * @template Resource the resource being patched

package/lib/arm.tsp

@@ -8,6 +8,7 @@ import "@azure-tools/typespec-azure-core";
 import "./foundations/arm.foundations.tsp";
 import "./Legacy/arm.legacy.tsp";
 import "./common-types/common-types.tsp";
+import "./extension/extension.tsp";
 import "./backcompat.tsp";
 import "./private.decorators.tsp";
 import "./models.tsp";

package/lib/common-types/internal.tsp

@@ -18,6 +18,15 @@ enum ResourceHome {
 
   @doc("The resource is bound to an extension")
   Extension,
+
+  @doc("The resource is a built in tenant resource")
+  BuiltIn,
+
+  @doc("The resource is a built in subscription resource")
+  BuiltInSubscription,
+
+  @doc("The resource is a built in resource group resource")
+  BuiltInResourceGroup,
 }
 
 /** Alias of keyEncryptionKeyIdentity for back compatibility. Please change to keyEncryptionKeyIdentity. */

package/lib/common-types/types-ref.tsp

@@ -376,7 +376,10 @@ namespace Azure.ResourceManager.CommonTypes;
     ResourceHome.Subscription,
     ResourceHome.Location,
     ResourceHome.Tenant,
-    ResourceHome.Extension
+    ResourceHome.Extension,
+    ResourceHome.BuiltIn,
+    ResourceHome.BuiltInSubscription,
+    ResourceHome.BuiltInResourceGroup
   ]
 );
 
@@ -398,7 +401,13 @@ namespace Azure.ResourceManager.CommonTypes;
   Azure.ResourceManager.CommonTypes.Versions.v6
 );
 @@resourceParameterBaseFor(SubscriptionIdParameter.subscriptionId,
-  [ResourceHome.ResourceGroup, ResourceHome.Subscription, ResourceHome.Location]
+  [
+    ResourceHome.ResourceGroup,
+    ResourceHome.Subscription,
+    ResourceHome.Location,
+    ResourceHome.BuiltInSubscription,
+    ResourceHome.BuiltInResourceGroup
+  ]
 );
 
 /** ResourceGroupNameParameter */
@@ -419,7 +428,7 @@ namespace Azure.ResourceManager.CommonTypes;
   Azure.ResourceManager.CommonTypes.Versions.v6
 );
 @@resourceParameterBaseFor(ResourceGroupNameParameter.resourceGroupName,
-  [ResourceHome.ResourceGroup]
+  [ResourceHome.ResourceGroup, ResourceHome.BuiltInResourceGroup]
 );
 
 /** ManagementGroupNameParameter */

package/lib/decorators.tsp

@@ -152,16 +152,48 @@ extern dec armResourceList(target: Operation, resourceType: Model);
 
 /**
  * This decorator is used to identify interfaces containing resource operations.
- * When applied, it marks the interface with the `@autoRoute` decorator so that
+ * By default, it marks the interface with the `@autoRoute` decorator so that
  * all of its contained operations will have their routes generated
  * automatically.
  *
- * It also adds a `@tag` decorator bearing the name of the interface so that all
+ * The decorator also adds a `@tag` decorator bearing the name of the interface so that all
  * of the operations will be grouped based on the interface name in generated
  * clients.
- * @param _ DEPRECATED
+ *
+ * The optional `resourceOperationOptions` parameter provides additional options.
+ * `allowStaticRoutes` turns off autoRout for the interface, so individual operations can
+ * choose static (`@route`) or automatic (`@autoRoute`) routing.
+ *
+ * `resourceType: Model` specifies the resource type for the operations in the interface
+ *
+ * `omitTags: true`: turns off the default tagging of operations in the interface, so that individual operations must be
+ * individually tagged
+ *
+ *
+ * @param resourceOperationOptions Options for routing the operations in the interface and associating them with a specific resource
  */
-extern dec armResourceOperations(target: Interface, _?: unknown);
+extern dec armResourceOperations(
+  target: Interface,
+  resourceOperationOptions?: (valueof ResourceOperationOptions) | unknown
+);
+
+/** Interface-level operation options */
+model ResourceOperationOptions {
+  /**
+   * The resource type for the operations in the interface
+   */
+  resourceType?: Model;
+
+  /**
+   * If true, turns off autoRoute for the interface, so individual operations can choose static (`@route`) or automatic (`@autoRoute`) routing.
+   */
+  allowStaticRoutes?: boolean;
+
+  /**
+   * If true, turns off the default tagging of operations in the interface, so that individual operations must be individually tagged
+   */
+  omitTags?: boolean;
+}
 
 /**
  * This decorator is used either on a namespace or a version enum value to indicate
@@ -180,7 +212,7 @@ extern dec armCommonTypesVersion(
  *
  * @param propertiesType: The type of the resource properties.
  */
-extern dec armVirtualResource(target: Model);
+extern dec armVirtualResource(target: Model, provider?: valueof string);
 
 /**
  * This decorator sets the base type of the given resource.
@@ -189,7 +221,7 @@ extern dec armVirtualResource(target: Model);
  */
 extern dec resourceBaseType(
   target: Model,
-  baseType: "Tenant" | "Subscription" | "ResourceGroup" | "Location" | "Extension"
+  baseTypeIt: "Tenant" | "Subscription" | "ResourceGroup" | "Location" | "Extension"
 );
 
 /**

package/lib/extension/extension.tsp

@@ -0,0 +1,6 @@
+import "@azure-tools/typespec-azure-core";
+import "./operations.tsp";
+import "./parameters.tsp";
+import "./private.decorators.tsp";
+
+namespace Azure.ResourceManager.Extension;