@azure-tools/typespec-azure-resource-manager 0.42.0-dev.8 → 0.42.0

package/lib/operations.tsp

@@ -21,8 +21,9 @@ namespace Azure.ResourceManager;
 @segmentOf(Resource)
 @armResourceList(Resource)
 @get
+@Private.enforceConstraint(Resource, Foundations.Resource)
 op ArmListBySubscription<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   Parameters extends {} = {},
   Response extends {} = ArmResponse<ResourceListResult<Resource>>,
   Error extends {} = ErrorResponse
@@ -44,8 +45,9 @@ op ArmListBySubscription<
 @segmentOf(Resource)
 @armRenameListByOperation(Resource, ParentName, ParentFriendlyName) // This must come before @armResourceList!
 @armResourceList(Resource)
+@Private.enforceConstraint(Resource, Foundations.Resource)
 op ArmResourceListByParent<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   BaseParameters = DefaultBaseParameters<Resource>,
   ParentName extends valueof string = "",
   ParentFriendlyName extends valueof string = "",
@@ -72,8 +74,9 @@ op ArmResourceListByParent<
 @segmentOf(Resource)
 @armRenameListByOperation(Resource) // This must come before @armResourceList!
 @armResourceList(Resource)
+@Private.enforceConstraint(Resource, Foundations.Resource)
 op ArmResourceListAtScope<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   BaseParameters = DefaultBaseParameters<Resource>,
   Parameters extends {} = {},
   Response extends {} = ArmResponse<ResourceListResult<Resource>>,
@@ -97,7 +100,7 @@ op ArmResourceListAtScope<
 @get
 @armResourceRead(Resource)
 op ArmResourceRead<
-  Resource extends ArmResourceBase,
+  Resource extends {},
   BaseParameters = DefaultBaseParameters<Resource>,
   Parameters extends {} = {},
   Response extends {} = ArmResponse<Resource>,
@@ -120,7 +123,7 @@ op ArmResourceRead<
 @doc("Check for the existence of a {name}", Resource)
 @head
 op ArmResourceCheckExistence<
-  Resource extends ArmResourceBase,
+  Resource extends {},
   BaseParameters = DefaultBaseParameters<Resource>,
   Parameters extends {} = {},
   Response extends {} = ArmResourceExistsResponse | ArmResourceNotFoundResponse,
@@ -150,9 +153,10 @@ op ArmResourceCheckExistence<
   }
 )
 @armResourceCreateOrUpdate(Resource)
+@Private.enforceConstraint(Resource, Foundations.Resource)
 @put
 op ArmResourceCreateOrUpdateAsync<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   BaseParameters = DefaultBaseParameters<Resource>,
   LroHeaders extends TypeSpec.Reflection.Model = Azure.Core.Foundations.RetryAfterHeader,
   Parameters extends {} = {},
@@ -180,9 +184,10 @@ op ArmResourceCreateOrUpdateAsync<
 @autoRoute
 @doc("Create a {name}", Resource)
 @armResourceCreateOrUpdate(Resource)
+@Private.enforceConstraint(Resource, Foundations.Resource)
 @put
 op ArmResourceCreateOrUpdateSync<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   BaseParameters = DefaultBaseParameters<Resource>,
   Parameters extends {} = {},
   Response extends {} = ArmResponse<Resource>,
@@ -205,9 +210,10 @@ op ArmResourceCreateOrUpdateSync<
 @autoRoute
 @doc("Create a {name}", Resource)
 @armResourceCreateOrUpdate(Resource)
+@Private.enforceConstraint(Resource, Foundations.Resource)
 @put
 op ArmResourceCreateOrReplaceSync<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   BaseParameters = DefaultBaseParameters<Resource>,
   Parameters extends {} = {},
   Response extends {} = ArmResourceUpdatedResponse<Resource> | ArmResourceCreatedSyncResponse<Resource>,
@@ -228,8 +234,9 @@ op ArmResourceCreateOrReplaceSync<
  * @template Response Optional. The success response for the createOrReplace operation
  * @template Error Optional. The error response, if non-standard.
  */
+@Private.enforceConstraint(Resource, Foundations.Resource)
 op ArmResourceCreateOrReplaceAsync<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   BaseParameters = DefaultBaseParameters<Resource>,
   LroHeaders extends TypeSpec.Reflection.Model = Azure.Core.Foundations.RetryAfterHeader,
   Parameters extends {} = {},
@@ -254,8 +261,9 @@ op ArmResourceCreateOrReplaceAsync<
  * @template LroHeaders Optional.  Allows overriding the lro headers that appear in the Accepted response
  * @template Parameters Optional. Additional parameters after the path parameters
  */
+@Private.enforceConstraint(Resource, Foundations.Resource)
 op ArmTagsPatchAsync<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   Properties extends {} = TagsUpdateModel<Resource>,
   BaseParameters = DefaultBaseParameters<Resource>,
   LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader<
@@ -281,8 +289,9 @@ op ArmTagsPatchAsync<
  * @template LroHeaders Optional.  Allows overriding the lro headers returned in the Accepted response
  * @template Parameters Optional. Additional parameters after the path parameters
  */
+@Private.enforceConstraint(Resource, Foundations.Resource)
 op ArmResourcePatchAsync<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   Properties extends TypeSpec.Reflection.Model,
   BaseParameters = DefaultBaseParameters<Resource>,
   LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader<
@@ -320,9 +329,10 @@ op ArmResourcePatchAsync<
   }
 )
 @armResourceUpdate(Resource)
+@Private.enforceConstraint(Resource, Foundations.Resource)
 @patch
 op ArmCustomPatchAsync<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   PatchModel extends TypeSpec.Reflection.Model = TagsUpdateModel<Resource>,
   BaseParameters = DefaultBaseParameters<Resource>,
   LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader<
@@ -350,8 +360,9 @@ op ArmCustomPatchAsync<
  * @template BaseParameters Optional. Allows overriding the operation parameters
  * @template Parameters Optional. Additional parameters after the path parameters
  */
+@Private.enforceConstraint(Resource, Foundations.Resource)
 op ArmTagsPatchSync<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   BaseParameters = DefaultBaseParameters<Resource>,
   Parameters extends {} = {}
 > is ArmCustomPatchSync<Resource, TagsUpdateModel<Resource>, BaseParameters, Parameters>;
@@ -363,8 +374,9 @@ op ArmTagsPatchSync<
  * @template BaseParameters Optional. Allows overriding the operation parameters
  * @template Parameters Optional. Additional parameters after the path parameters
  */
+@Private.enforceConstraint(Resource, Foundations.Resource)
 op ArmResourcePatchSync<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   Properties extends TypeSpec.Reflection.Model,
   BaseParameters = DefaultBaseParameters<Resource>,
   Parameters extends {} = {}
@@ -387,9 +399,10 @@ op ArmResourcePatchSync<
 @autoRoute
 @doc("Update a {name}", Resource)
 @armResourceUpdate(Resource)
+@Private.enforceConstraint(Resource, Foundations.Resource)
 @patch
 op ArmCustomPatchSync<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   PatchModel extends TypeSpec.Reflection.Model = TagsUpdateModel<Resource>,
   BaseParameters = DefaultBaseParameters<Resource>,
   Parameters extends {} = {},
@@ -420,9 +433,10 @@ op ArmCustomPatchSync<
   }
 )
 @armResourceDelete(Resource)
+@Private.enforceConstraint(Resource, Foundations.Resource)
 @delete
 op ArmResourceDeleteAsyncBase<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   Response,
   BaseParameters = DefaultBaseParameters<Resource>,
   Parameters extends {} = {},
@@ -439,8 +453,9 @@ op ArmResourceDeleteAsyncBase<
  * @template Error Optional. The error response, if non-standard.
  */
 #deprecated "Use 'ArmResourceDeleteWithoutOkAsync' instead"
+@Private.enforceConstraint(Resource, Foundations.Resource)
 op ArmResourceDeleteAsync<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   BaseParameters = DefaultBaseParameters<Resource>,
   LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader &
     Azure.Core.Foundations.RetryAfterHeader,
@@ -458,8 +473,9 @@ op ArmResourceDeleteAsync<
  * @template Response Optional. The success response(s) for the delete operation
  * @template Error Optional. The error response, if non-standard.
  */
+@Private.enforceConstraint(Resource, Foundations.Resource)
 op ArmResourceDeleteWithoutOkAsync<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   BaseParameters = DefaultBaseParameters<Resource>,
   LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader &
     Azure.Core.Foundations.RetryAfterHeader,
@@ -479,9 +495,10 @@ op ArmResourceDeleteWithoutOkAsync<
 @autoRoute
 @doc("Delete a {name}", Resource)
 @armResourceDelete(Resource)
+@Private.enforceConstraint(Resource, Foundations.Resource)
 @delete
 op ArmResourceDeleteSync<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   BaseParameters = DefaultBaseParameters<Resource>,
   Parameters extends {} = {},
   Response extends {} = ArmDeletedResponse | ArmDeletedNoContentResponse,
@@ -506,9 +523,10 @@ op ArmResourceDeleteSync<
   }
 )
 @armResourceAction(Resource)
+@Private.enforceConstraint(Resource, Foundations.Resource)
 @post
 op ArmResourceActionAsyncBase<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   Request extends TypeSpec.Reflection.Model | void,
   Response extends TypeSpec.Reflection.Model | void,
   BaseParameters extends TypeSpec.Reflection.Model,
@@ -519,7 +537,7 @@ op ArmResourceActionAsyncBase<
   ...Parameters,
 
   @doc("The content of the action request")
-  @body
+  @bodyRoot
   body: Request,
 ): Response | Error;
 
@@ -534,8 +552,9 @@ op ArmResourceActionAsyncBase<
  * @template Error Optional. The error response, if non-standard.
  */
 @returnsDoc("Azure operation completed successfully.")
+@Private.enforceConstraint(Resource, Foundations.Resource)
 op ArmResourceActionAsync<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   Request extends TypeSpec.Reflection.Model | void,
   Response extends TypeSpec.Reflection.Model | void,
   BaseParameters extends TypeSpec.Reflection.Model = DefaultBaseParameters<Resource>,
@@ -567,10 +586,11 @@ op ArmResourceActionAsync<
  */
 @autoRoute
 @armResourceAction(Resource)
+@Private.enforceConstraint(Resource, Foundations.Resource)
 @post
 @returnsDoc("Azure operation completed successfully.")
 op ArmResourceActionSync<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   Request extends TypeSpec.Reflection.Model | void,
   Response extends TypeSpec.Reflection.Model | void,
   BaseParameters = DefaultBaseParameters<Resource>,
@@ -581,7 +601,7 @@ op ArmResourceActionSync<
   ...Parameters,
 
   @doc("The content of the action request")
-  @body
+  @bodyRoot
   body: Request,
 ): Response | Error;
 
@@ -594,8 +614,9 @@ op ArmResourceActionSync<
  * @template Parameters Optional. Additional parameters after the path parameters
  * @template Error Optional. The error response, if non-standard.
  */
+@Private.enforceConstraint(Resource, Foundations.Resource)
 op ArmResourceActionNoContentAsync<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   Request extends TypeSpec.Reflection.Model | void,
   BaseParameters extends TypeSpec.Reflection.Model = DefaultBaseParameters<Resource>,
   LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader &
@@ -623,8 +644,9 @@ op ArmResourceActionNoContentAsync<
  * @template Parameters Optional. Additional parameters after the path parameters
  * @template Error Optional. The error response, if non-standard.
  */
+@Private.enforceConstraint(Resource, Foundations.Resource)
 op ArmResourceActionNoResponseContentAsync<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   Request extends TypeSpec.Reflection.Model | void,
   BaseParameters extends TypeSpec.Reflection.Model = DefaultBaseParameters<Resource>,
   LroHeaders extends TypeSpec.Reflection.Model = ArmLroLocationHeader<
@@ -654,9 +676,10 @@ op ArmResourceActionNoResponseContentAsync<
  */
 @autoRoute
 @armResourceAction(Resource)
+@Private.enforceConstraint(Resource, Foundations.Resource)
 @post
 op ArmResourceActionNoContentSync<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   Request extends TypeSpec.Reflection.Model | void,
   BaseParameters = DefaultBaseParameters<Resource>,
   Parameters extends {} = {},
@@ -666,7 +689,7 @@ op ArmResourceActionNoContentSync<
   ...Parameters,
 
   @doc("The content of the action request")
-  @body
+  @bodyRoot
   body: Request,
 ): ArmNoContentResponse<"Action completed successfully."> | Error;
 

package/lib/parameters.tsp

@@ -150,7 +150,7 @@ model ResourceUriParameter {
  * @template BaseParameters The parameters representing the base Uri of the resource
  */
 model ResourceInstanceParameters<
-  Resource extends ArmResourceBase,
+  Resource extends {},
   BaseParameters = DefaultBaseParameters<Resource>
 > {
   ...BaseParameters;
@@ -165,7 +165,7 @@ model ResourceInstanceParameters<
  * @template BaseParameters The parameters representing the base Uri of the resource
  */
 model ResourceParentParameters<
-  Resource extends ArmResource,
+  Resource extends Foundations.Resource,
   BaseParameters = DefaultBaseParameters<Resource>
 > {
   ...BaseParameters;
@@ -177,7 +177,7 @@ model ResourceParentParameters<
  * The dynamic parameters of a list call for an extension resource instance.
  * @template Resource The extension resource
  */
-alias ExtensionResourceInstanceParameters<Resource extends ArmResource> = ResourceInstanceParameters<
+alias ExtensionResourceInstanceParameters<Resource extends Foundations.Resource> = ResourceInstanceParameters<
   Resource,
   ExtensionBaseParameters
 >;
@@ -186,7 +186,7 @@ alias ExtensionResourceInstanceParameters<Resource extends ArmResource> = Resour
  * The dynamic parameters of a list call for a tenant resource instance.
  * @template Resource the tenant resource
  */
-alias TenantInstanceParameters<Resource extends ArmResource> = ResourceInstanceParameters<
+alias TenantInstanceParameters<Resource extends Foundations.Resource> = ResourceInstanceParameters<
   Resource,
   TenantBaseParameters
 >;

package/lib/private.decorators.tsp

@@ -82,3 +82,25 @@ extern dec resourceParameterBaseFor(target: ModelProperty, values: unknown[]);
  * Marks an enum as representing the valid `common-types` versions.
  */
 extern dec armCommonTypesVersions(target: Enum);
+
+/**
+ * Provides default name decoration on resource name property with
+ * camelcased and pluralized key and segment name
+ */
+extern dec defaultResourceKeySegmentName(
+  target: ModelProperty,
+  armResource: Model,
+  keyName: valueof string,
+  segment: valueof string
+);
+
+/**
+ * Provides strict contraint type check.
+ *
+ * Due to TypeSpec language and all optional properties of `Foundations.Resource`,
+ * the `Resource extends Foundations.Resource` on many of the standard ARM templates is
+ * essentially equal to `Resource extends {}` and does not enforce the containt.
+ *
+ * Note, this is intended for internal use only for now.
+ */
+extern dec enforceConstraint(target: Operation | Model, sourceType: Model, constraintType: Model);

package/lib/responses.tsp

@@ -92,7 +92,7 @@ model ArmAcceptedLroResponse<
 model ArmOperationStatus<
   Properties extends {} = never,
   StatusValues extends TypeSpec.Reflection.Union = ResourceProvisioningState
-> is ArmResourceBase {
+> {
   /** RP-specific properties for the operationStatus resource, only appears when operation ended with Succeeded status */
   @visibility("read")
   properties?: Properties;
@@ -204,7 +204,7 @@ model ArmNoContentResponse<Message extends valueof string = "Operation completed
  * @template Resource The resource being updated
  */
 @doc("Resource '{name}' update operation succeeded", Resource)
-model ArmResourceUpdatedResponse<Resource extends Azure.ResourceManager.Foundations.ArmResource>
+model ArmResourceUpdatedResponse<Resource extends Azure.ResourceManager.Foundations.Resource>
   is ArmResponse<Resource>;
 
 /**
@@ -214,7 +214,7 @@ model ArmResourceUpdatedResponse<Resource extends Azure.ResourceManager.Foundati
  */
 @doc("Resource '{name}' create operation succeeded", Resource)
 model ArmResourceCreatedResponse<
-  Resource extends Azure.ResourceManager.Foundations.ArmResource,
+  Resource extends Azure.ResourceManager.Foundations.Resource,
   LroHeaders extends TypeSpec.Reflection.Model = Azure.Core.Foundations.RetryAfterHeader
 > {
   ...CreatedResponse;
@@ -231,7 +231,7 @@ model ArmResourceCreatedResponse<
  * @template Resource The resource being updated
  */
 @doc("Resource '{name}' create operation succeeded", Resource)
-model ArmResourceCreatedSyncResponse<Resource extends Azure.ResourceManager.Foundations.ArmResource> {
+model ArmResourceCreatedSyncResponse<Resource extends Azure.ResourceManager.Foundations.Resource> {
   ...CreatedResponse;
 
   @doc("The body type of the operation request or response.")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-azure-resource-manager",
-  "version": "0.42.0-dev.8",
+  "version": "0.42.0",
   "author": "Microsoft Corporation",
   "description": "TypeSpec Azure Resource Manager library",
   "homepage": "https://azure.github.io/typespec-azure",
@@ -34,38 +34,42 @@
     "node": ">=18.0.0"
   },
   "files": [
-    "lib/*.tsp",
+    "lib/**/*.tsp",
     "dist/**",
     "!dist/test/**"
   ],
+  "dependencies": {
+    "change-case": "~5.4.4",
+    "pluralize": "^8.0.0"
+  },
   "peerDependencies": {
-    "@azure-tools/typespec-autorest": "~0.41.1 || >=0.42.0-dev <0.42.0",
-    "@azure-tools/typespec-azure-core": "~0.41.0 || >=0.42.0-dev <0.42.0",
-    "@typespec/compiler": "~0.55.0 || >=0.56.0-dev <0.56.0",
-    "@typespec/http": "~0.55.0 || >=0.56.0-dev <0.56.0",
-    "@typespec/openapi": "~0.55.0 || >=0.56.0-dev <0.56.0",
-    "@typespec/rest": "~0.55.0 || >=0.56.0-dev <0.56.0",
-    "@typespec/versioning": "~0.55.0 || >=0.56.0-dev <0.56.0"
+    "@azure-tools/typespec-autorest": "~0.42.0",
+    "@typespec/compiler": "~0.56.0",
+    "@azure-tools/typespec-azure-core": "~0.42.0",
+    "@typespec/http": "~0.56.0",
+    "@typespec/openapi": "~0.56.0",
+    "@typespec/rest": "~0.56.0",
+    "@typespec/versioning": "~0.56.0"
   },
   "devDependencies": {
-    "@azure-tools/typespec-autorest": "~0.41.1 || >=0.42.0-dev <0.42.0",
-    "@azure-tools/typespec-azure-core": "~0.41.0 || >=0.42.0-dev <0.42.0",
     "@types/node": "~18.11.19",
-    "@typespec/compiler": "~0.55.0 || >=0.56.0-dev <0.56.0",
-    "@typespec/http": "~0.55.0 || >=0.56.0-dev <0.56.0",
-    "@typespec/library-linter": "~0.55.0 || >=0.56.0-dev <0.56.0",
-    "@typespec/openapi": "~0.55.0 || >=0.56.0-dev <0.56.0",
-    "@typespec/rest": "~0.55.0 || >=0.56.0-dev <0.56.0",
-    "@typespec/versioning": "~0.55.0 || >=0.56.0-dev <0.56.0",
+    "@types/pluralize": "^0.0.33",
     "@vitest/coverage-v8": "^1.5.0",
     "@vitest/ui": "^1.5.0",
     "c8": "^9.1.0",
     "rimraf": "~5.0.5",
     "typescript": "~5.4.5",
     "vitest": "^1.5.0",
+    "@azure-tools/typespec-autorest": "~0.42.0",
+    "@azure-tools/typespec-azure-core": "~0.42.0",
+    "@typespec/compiler": "~0.56.0",
+    "@typespec/http": "~0.56.0",
+    "@typespec/library-linter": "~0.56.0",
+    "@typespec/openapi": "~0.56.0",
+    "@typespec/rest": "~0.56.0",
+    "@typespec/versioning": "~0.56.0",
     "@typespec/tspd": "~0.46.0"
   },
-  "dependencies": {},
   "scripts": {
     "clean": "rimraf ./dist ./temp",
     "build": "tsc -p . && npm run lint-typespec-library",