@azure-tools/typespec-azure-resource-manager 0.55.0 → 0.56.0-dev.1

package/lib/common-types/managed-identity.tsp

@@ -5,6 +5,7 @@ namespace Azure.ResourceManager.CommonTypes;
 
 /** The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */
 #deprecated "Do not use this model. Instead, use Record<UserAssignedIdentity | null> directly. Using this model will result in a different client SDK when generated from TypeSpec compared to the Swagger."
+@summary("User-Assigned Identities")
 @removed(Versions.v6)
 model UserAssignedIdentities is Record<UserAssignedIdentity | null>;
 
@@ -48,13 +49,13 @@ model SystemAssignedServiceIdentity {
  * User assigned identity properties
  */
 model UserAssignedIdentity {
-  /** The client ID of the assigned identity. */
-  @visibility(Lifecycle.Read)
-  clientId?: uuid;
-
   /** The principal ID of the assigned identity. */
   @visibility(Lifecycle.Read)
   principalId?: uuid;
+
+  /** The client ID of the assigned identity. */
+  @visibility(Lifecycle.Read)
+  clientId?: uuid;
 }
 
 /**

package/lib/common-types/private-links.tsp

@@ -6,9 +6,9 @@ using Azure.Core;
 
 namespace Azure.ResourceManager.CommonTypes;
 
-/** The Private Endpoint resource. */
+/** The private endpoint resource. */
 model PrivateEndpoint {
-  /** The resource identifier for private endpoint */
+  /** The resource identifier of the private endpoint */
   @visibility(Lifecycle.Read)
   @typeChangedFrom(CommonTypes.Versions.v4, string)
   id?: Azure.Core.armResourceIdentifier;
@@ -39,11 +39,12 @@ model PrivateLinkResourceProperties {
 @pagedResult
 model PrivateLinkResourceListResult {
   /** Array of private link resources */
+  @OpenAPI.extension("x-ms-identifiers", #["id"])
   value?: PrivateLinkResource[];
 
   /** URL to get the next set of operation list results (if there are any). */
   @visibility(Lifecycle.Read)
-  nextLink?: string;
+  nextLink?: url;
 }
 //#region
 /** The private endpoint connection resource */
@@ -57,11 +58,12 @@ model PrivateEndpointConnection extends Resource {
 @pagedResult
 model PrivateEndpointConnectionListResult {
   /** Array of private endpoint connections. */
+  @OpenAPI.extension("x-ms-identifiers", #["id"])
   value?: PrivateEndpointConnection[];
 
   /** URL to get the next set of operation list results (if there are any). */
   @visibility(Lifecycle.Read)
-  nextLink?: string;
+  nextLink?: url;
 }
 
 /** Properties of the private endpoint connection. */
@@ -113,7 +115,7 @@ union PrivateEndpointConnectionProvisioningState {
 
 /** The private endpoint connection status. */
 union PrivateEndpointServiceConnectionStatus {
-  /** Connectionaiting for approval or rejection */
+  /** Connection waiting for approval or rejection */
   Pending: "Pending",
 
   /** Connection approved */
@@ -179,6 +181,7 @@ model PrivateLinkResourceParameter<Segment extends valueof string = "privateLink
 @removed(Versions.v6)
 model PrivateLinkResourceListResultV5 {
   /** Array of private link resources */
+  @OpenAPI.extension("x-ms-identifiers", #["id"])
   value?: CommonTypes.PrivateLinkResource[];
 }
 
@@ -221,5 +224,6 @@ model PrivateLinkResourceListResultV5 {
 @removed(Versions.v6)
 model PrivateEndpointConnectionListResultV5 {
   /** Array of private endpoint connections. */
+  @OpenAPI.extension("x-ms-identifiers", #["id"])
   value?: CommonTypes.PrivateEndpointConnection[];
 }

package/lib/common-types/types.tsp

@@ -7,6 +7,7 @@ using Azure.Core;
 namespace Azure.ResourceManager.CommonTypes;
 
 /** Common fields that are returned in the response for all Azure Resource Manager resources */
+@summary("Resource")
 model Resource {
   /** Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */
   @typeChangedFrom(Versions.v4, string)
@@ -27,6 +28,7 @@ model Resource {
 }
 
 /** The resource model definition for an Azure Resource Manager resource with an etag. */
+@summary("Entity Resource")
 model AzureEntityResource extends Resource {
   /** Resource Etag. */
   @visibility(Lifecycle.Read)
@@ -36,6 +38,7 @@ model AzureEntityResource extends Resource {
 /**
  * The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
  */
+@summary("Tracked Resource")
 model TrackedResource extends Resource {
   /** Resource tags. */
   tags?: Record<string>;
@@ -48,6 +51,7 @@ model TrackedResource extends Resource {
 /**
  * The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
  */
+@summary("Proxy Resource")
 model ProxyResource extends Resource {}
 
 /**
@@ -129,6 +133,7 @@ model OperationListResult is Azure.Core.Page<Operation>;
 /**
  * Details of a REST API operation, returned from the Resource Provider Operations API
  */
+@summary("REST API Operation")
 model Operation {
   /** 
     The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action"
@@ -276,6 +281,7 @@ model ErrorDetail {
 /**
  * Common error response for all Azure Resource Manager APIs to return error details for failed operations.
  */
+@summary("Error response")
 @error
 model ErrorResponse {
   /** The error object. */
@@ -517,17 +523,8 @@ model SubscriptionIdParameter {
   @typeChangedFrom(Versions.v4, string)
   @path
   @segment("subscriptions")
-  subscriptionId: uuid;
-}
-
-/** The default location parameter type. */
-model LocationResourceParameter {
-  /** The name of the Azure region. */
-  @path
   @minLength(1)
-  @segment("locations")
-  @key
-  location: azureLocation;
+  subscriptionId: uuid;
 }
 
 /**

package/lib/parameters.tsp

@@ -23,11 +23,6 @@ alias SubscriptionIdParameter = CommonTypes.SubscriptionIdParameter;
  */
 alias ResourceGroupParameter = CommonTypes.ResourceGroupNameParameter;
 
-/**
- * The default LocationResource parameter type.
- */
-alias LocationResourceParameter = CommonTypes.LocationResourceParameter;
-
 /**
  * DEPRECATED - DO NOT USE
  * The default location parameter type.
@@ -45,6 +40,16 @@ model LocationParameter {
   location: string;
 }
 
+/** The default location parameter type. */
+model LocationResourceParameter {
+  /** The name of the Azure region. */
+  @path
+  @minLength(1)
+  @segment("locations")
+  @key
+  location: Azure.Core.azureLocation;
+}
+
 /**
  * The location resource for tenant-based locations.  This can be used as a parent
  * resource for resource types that are homed in a tenant-based location.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-azure-resource-manager",
-  "version": "0.55.0",
+  "version": "0.56.0-dev.1",
   "author": "Microsoft Corporation",
   "description": "TypeSpec Azure Resource Manager library",
   "homepage": "https://azure.github.io/typespec-azure",
@@ -44,30 +44,30 @@
     "pluralize": "^8.0.0"
   },
   "peerDependencies": {
-    "@azure-tools/typespec-azure-core": "^0.55.0",
+    "@azure-tools/typespec-azure-core": "^0.55.0 || >=0.56.0-dev <0.56.0",
     "@typespec/compiler": "^1.0.0-rc.1",
     "@typespec/http": "^1.0.0-rc.1",
     "@typespec/openapi": "^1.0.0-rc.1",
-    "@typespec/rest": "^0.69.0",
-    "@typespec/versioning": "^0.69.0"
+    "@typespec/rest": "^0.69.0 || >=0.70.0-dev <0.70.0",
+    "@typespec/versioning": "^0.69.0 || >=0.70.0-dev <0.70.0"
   },
   "devDependencies": {
+    "@azure-tools/typespec-azure-core": "^0.55.0 || >=0.56.0-dev <0.56.0",
     "@types/node": "~22.13.11",
     "@types/pluralize": "^0.0.33",
+    "@typespec/compiler": "^1.0.0-rc.1",
+    "@typespec/http": "^1.0.0-rc.1",
+    "@typespec/library-linter": "^0.69.0 || >=0.70.0-dev <0.70.0",
+    "@typespec/openapi": "^1.0.0-rc.1",
+    "@typespec/rest": "^0.69.0 || >=0.70.0-dev <0.70.0",
+    "@typespec/tspd": "^0.69.0 || >=0.70.0-dev <0.70.0",
+    "@typespec/versioning": "^0.69.0 || >=0.70.0-dev <0.70.0",
     "@vitest/coverage-v8": "^3.0.9",
     "@vitest/ui": "^3.0.9",
     "c8": "^10.1.3",
     "rimraf": "~6.0.1",
     "typescript": "~5.8.2",
-    "vitest": "^3.0.9",
-    "@azure-tools/typespec-azure-core": "^0.55.0",
-    "@typespec/http": "^1.0.0-rc.1",
-    "@typespec/compiler": "^1.0.0-rc.1",
-    "@typespec/library-linter": "^0.69.0",
-    "@typespec/openapi": "^1.0.0-rc.1",
-    "@typespec/rest": "^0.69.0",
-    "@typespec/tspd": "^0.69.0",
-    "@typespec/versioning": "^0.69.0"
+    "vitest": "^3.0.9"
   },
   "scripts": {
     "clean": "rimraf ./dist ./temp",