@azure-tools/typespec-azure-resource-manager 0.43.0-dev.9 → 0.44.0-dev.0

package/lib/decorators.tsp

@@ -180,7 +180,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 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.
+ * @param version The Azure.ResourceManager.CommonTypes.Versions for the desired common-types version or an equivalent string value like "v5".
  */
 extern dec armCommonTypesVersion(
   target: Namespace | EnumMember,

package/lib/{arm.foundations.tsp → foundations/arm.foundations.tsp}

@@ -1,30 +1,21 @@
+import "@typespec/openapi";
+import "@typespec/http";
+import "@typespec/rest";
+
+import "./backcompat.tsp";
+import "./deprecation.tsp";
+import "../common-types/common-types.tsp";
+import "../decorators.tsp";
+import "../responses.tsp";
+import "../private.decorators.tsp";
+import "../parameters.tsp";
+
 using TypeSpec.Http;
 using TypeSpec.OpenAPI;
-using TypeSpec.Versioning;
 using Azure.ResourceManager.Private;
 
 namespace Azure.ResourceManager.Foundations;
 
-/**
- * An internal enum to indicate the resource support for various path types
- */
-enum ResourceHome {
-  @doc("The resource is bound to a tenant")
-  Tenant,
-
-  @doc("The resource is bound to a subscription")
-  Subscription,
-
-  @doc("The resource is bound to a location")
-  Location,
-
-  @doc("The resource is bound to a resource group")
-  ResourceGroup,
-
-  @doc("The resource is bound to an extension")
-  Extension,
-}
-
 /**
  * Base parameters for a resource.
  *
@@ -53,6 +44,17 @@ model DefaultBaseParameters<Resource extends {}> {
   ...ResourceUriParameter;
 }
 
+/**
+ * Standard type definition for Azure Resource Manager Tags property.
+ *
+ * It is included in the TrackedResource template definition.
+ */
+/** The Azure Resource Manager Resource tags. */
+model ArmTagsProperty {
+  /** Resource tags. */
+  tags?: Record<string>;
+}
+
 /**
  * The static parameters for a tenant-based resource
  */
@@ -113,7 +115,11 @@ model ResourceUpdateModelProperties<
 model ResourceUpdateModel<
   Resource extends Foundations.Resource,
   Properties extends TypeSpec.Reflection.Model
-> is OptionalProperties<UpdateableProperties<OmitProperties<Resource, "Name" | "name">>> {
+>
+  is OptionalProperties<UpdateableProperties<OmitProperties<
+    Resource,
+    "Name" | "name" | "properties"
+  >>> {
   @extension("x-ms-client-flatten", true)
   properties?: ResourceUpdateModelProperties<Resource, Properties>;
 }

package/lib/foundations/backcompat.tsp

@@ -0,0 +1,39 @@
+namespace Azure.ResourceManager.Foundations {
+  // extended-location
+  alias ExtendedLocation = CommonTypes.ExtendedLocation;
+  alias ExtendedLocationType = CommonTypes.ExtendedLocationType;
+
+  // managed-identities
+  alias ManagedServiceIdentity = CommonTypes.ManagedServiceIdentity;
+  #suppress "deprecated" "Need for back compatibility in common-types"
+  alias UserAssignedIdentities = CommonTypes.UserAssignedIdentities;
+  alias SystemAssignedServiceIdentity = CommonTypes.SystemAssignedServiceIdentity;
+  alias UserAssignedIdentity = CommonTypes.UserAssignedIdentity;
+  alias ManagedServiceIdentityType = CommonTypes.ManagedServiceIdentityType;
+  alias SystemAssignedServiceIdentityType = CommonTypes.SystemAssignedServiceIdentityType;
+  alias ManagedSystemIdentityType = SystemAssignedServiceIdentityType;
+
+  // types
+  alias Resource = CommonTypes.Resource;
+  alias AzureEntityResource = CommonTypes.AzureEntityResource;
+  alias TrackedResource = CommonTypes.TrackedResource;
+  alias ProxyResource = CommonTypes.ProxyResource;
+  alias ExtensionResource = CommonTypes.ExtensionResource;
+  alias Sku = CommonTypes.Sku;
+  alias SkuTier = CommonTypes.SkuTier;
+  alias OperationListResult = CommonTypes.OperationListResult;
+  alias Operation = CommonTypes.Operation;
+  alias OperationDisplay = CommonTypes.OperationDisplay;
+  alias OperationStatusResult = CommonTypes.OperationStatusResult;
+  alias OperationIdParameter = CommonTypes.OperationIdParameter;
+  alias ActionType = CommonTypes.ActionType;
+  alias Origin = CommonTypes.Origin;
+  alias ErrorDetail = CommonTypes.ErrorDetail;
+  alias ErrorAdditionalInfo = CommonTypes.ErrorAdditionalInfo;
+  alias SystemData = CommonTypes.SystemData;
+  alias createdByType = CommonTypes.createdByType;
+  alias Plan = CommonTypes.Plan;
+  alias CheckNameAvailabilityRequest = CommonTypes.CheckNameAvailabilityRequest;
+  alias CheckNameAvailabilityResponse = CommonTypes.CheckNameAvailabilityResponse;
+  alias CheckNameAvailabilityReason = CommonTypes.CheckNameAvailabilityReason;
+}

package/lib/{common-types/backcompat.tsp → foundations/deprecation.tsp}

@@ -17,3 +17,14 @@ alias ResourceSkuType = Sku;
 
 #deprecated "Please use Foundations.Plan instead of Foundations.ResourcePlanType"
 alias ResourcePlanType = Plan;
+
+// managed-identity
+#deprecated "Please change ManagedIdentityProperties to ManagedServiceIdentity."
+alias ManagedIdentityProperties = ManagedServiceIdentity;
+
+#deprecated "Please change ManagedSystemIdentityProperties to SystemAssignedServiceIdentity."
+alias ManagedSystemIdentityProperties = SystemAssignedServiceIdentity;
+
+/** Alias of ManagedServiceIdentityType for back compatability. Please change to ManagedServiceIdentityType. */
+#deprecated "Please change to ManagedServiceIdentityType."
+alias ManagedIdentityType = ManagedServiceIdentityType;

package/lib/models.tsp

@@ -46,7 +46,6 @@ model ResourceNameParameter<
 @includeInapplicableMetadataInPayload(false)
 model TrackedResource<Properties extends {}> extends Foundations.TrackedResource {
   @doc("The resource-specific properties for this resource.")
-  @visibility("read", "create")
   @extension("x-ms-client-flatten", true)
   properties?: Properties;
 }
@@ -62,7 +61,6 @@ model TrackedResource<Properties extends {}> extends Foundations.TrackedResource
 @includeInapplicableMetadataInPayload(false)
 model ProxyResource<Properties extends {}> extends Foundations.ProxyResource {
   @doc("The resource-specific properties for this resource.")
-  @visibility("read", "create")
   @extension("x-ms-client-flatten", true)
   properties?: Properties;
 }
@@ -79,7 +77,6 @@ model ProxyResource<Properties extends {}> extends Foundations.ProxyResource {
 @includeInapplicableMetadataInPayload(false)
 model ExtensionResource<Properties extends {}> extends Foundations.ExtensionResource {
   @doc("The resource-specific properties for this resource.")
-  @visibility("read", "create")
   @extension("x-ms-client-flatten", true)
   properties?: Properties;
 }
@@ -352,4 +349,22 @@ model ManagedByProperty {
   managedBy?: string;
 }
 
+/** Please use the spread model EncryptionProperty */
+alias Encryption = EncryptionProperty;
+/**
+ * Model used only to spread in the `encryption` envelope property for a resource.
+ * @example
+ *
+ * ```typespec
+ * model Foo is TrackedResource<FooProperties> {
+ *   ...Encryption;
+ * }
+ * ```
+ */
+/** All encryption configuration for a resource. */
+model EncryptionProperty {
+  /** All encryption configuration for a resource. */
+  encryption: EncryptionConfiguration;
+}
+
 //#endregion

package/lib/parameters.tsp

@@ -3,80 +3,45 @@ using TypeSpec.Rest;
 using TypeSpec.OpenAPI;
 using Azure.ResourceManager.Foundations;
 using Azure.ResourceManager.Private;
+using Azure.ResourceManager.CommonTypes;
+using Azure.ResourceManager.CommonTypes.Private;
 
 namespace Azure.ResourceManager;
 
 /**
  * The default api-version parameter type.
  */
-@doc("The default api-version parameter type.")
-model ApiVersionParameter {
-  @query("api-version")
-  @minLength(1)
-  @doc("The API version to use for this operation.")
-  @armCommonParameter("ApiVersionParameter", Azure.ResourceManager.CommonTypes.Versions.v3)
-  @armCommonParameter("ApiVersionParameter", Azure.ResourceManager.CommonTypes.Versions.v4)
-  @armCommonParameter("ApiVersionParameter", Azure.ResourceManager.CommonTypes.Versions.v5)
-  @resourceParameterBaseFor(
-    [
-      ResourceHome.ResourceGroup,
-      ResourceHome.Subscription,
-      ResourceHome.Location,
-      ResourceHome.Tenant,
-      ResourceHome.Extension
-    ]
-  )
-  apiVersion: string;
-}
+alias ApiVersionParameter = CommonTypes.ApiVersionParameter;
 
 /**
  * The default subscriptionId parameter type.
  */
-@doc("The default subscriptionId parameter type.")
-model SubscriptionIdParameter {
-  @path
-  @minLength(1)
-  @segment("subscriptions")
-  @doc("The ID of the target subscription.")
-  @armCommonParameter("SubscriptionIdParameter", Azure.ResourceManager.CommonTypes.Versions.v3)
-  @armCommonParameter("SubscriptionIdParameter", Azure.ResourceManager.CommonTypes.Versions.v4)
-  @armCommonParameter("SubscriptionIdParameter", Azure.ResourceManager.CommonTypes.Versions.v5)
-  @resourceParameterBaseFor(
-    [ResourceHome.ResourceGroup, ResourceHome.Subscription, ResourceHome.Location]
-  )
-  subscriptionId: string;
-}
+alias SubscriptionIdParameter = CommonTypes.SubscriptionIdParameter;
 
 /**
- * DEPRECATED - DO NOT USE
- * The default location parameter type.
+ * The default ResourceGroup parameter type.
  */
-@doc("The default location parameter type.")
-model LocationParameter {
-  @path
-  @minLength(1)
-  @segment("locations")
-  @doc("The location name.")
-  @armCommonParameter("LocationParameter", Azure.ResourceManager.CommonTypes.Versions.v3)
-  @armCommonParameter("LocationParameter", Azure.ResourceManager.CommonTypes.Versions.v4)
-  @armCommonParameter("LocationParameter", Azure.ResourceManager.CommonTypes.Versions.v5)
-  @resourceParameterBaseFor([ResourceHome.Location])
-  location: string;
-}
+alias ResourceGroupParameter = CommonTypes.ResourceGroupNameParameter;
+
+/**
+ * The default LocationResource parameter type.
+ */
+alias LocationResourceParameter = CommonTypes.LocationResourceParameter;
 
 /**
+ * DEPRECATED - DO NOT USE
  * The default location parameter type.
  */
 @doc("The default location parameter type.")
-model LocationResourceParameter {
+model LocationParameter {
   @path
   @minLength(1)
   @segment("locations")
   @doc("The location name.")
-  @key
   @armCommonParameter("LocationParameter", Azure.ResourceManager.CommonTypes.Versions.v3)
   @armCommonParameter("LocationParameter", Azure.ResourceManager.CommonTypes.Versions.v4)
   @armCommonParameter("LocationParameter", Azure.ResourceManager.CommonTypes.Versions.v5)
+  @resourceParameterBaseFor([ResourceHome.Location])
   location: string;
 }
 
@@ -113,24 +78,6 @@ model ArmLocationResource<BaseType extends
   ...LocationResourceParameter;
 }
 
-/**
- * The default resource group parameter type.
- */
-@doc("The default resource group parameter type.")
-model ResourceGroupParameter {
-  @path
-  @minLength(1)
-  @maxLength(90)
-  @segment("resourceGroups")
-  @pattern("^[-\\w\\._\\(\\)]+$")
-  @doc("The name of the resource group. The name is case insensitive.")
-  @armCommonParameter("ResourceGroupNameParameter", Azure.ResourceManager.CommonTypes.Versions.v3)
-  @armCommonParameter("ResourceGroupNameParameter", Azure.ResourceManager.CommonTypes.Versions.v4)
-  @armCommonParameter("ResourceGroupNameParameter", Azure.ResourceManager.CommonTypes.Versions.v5)
-  @resourceParameterBaseFor([ResourceHome.ResourceGroup])
-  resourceGroupName: string;
-}
-
 /**
  * The default resourceUri parameter type.
  */

package/lib/private.decorators.tsp

@@ -14,39 +14,6 @@ extern dec armUpdateProviderNamespace(target: Reflection.Operation);
  */
 extern dec assignProviderNameValue(target: ModelProperty, resource: Model);
 
-/**
- * Describes the shape of model literals accepted by the `version` parameter of
- * the `armCommonDefinition` and `armCommonParameter` decorators.
- */
-alias ArmCommonTypeVersionSpec = {
-  version: string | EnumMember;
-  isDefault: boolean;
-};
-
-/**
- * @param definitionName Definition name
- * @param version Azure Resource Manager Version
- * @param referenceFile Reference file
- */
-extern dec armCommonDefinition(
-  target: Model,
-  definitionName?: valueof string,
-  version?: valueof EnumMember | ArmCommonTypeVersionSpec | string,
-  referenceFile?: valueof string
-);
-
-/**
- * @param definitionName Definition name
- * @param version Azure Resource Manager Version
- * @param referenceFile Reference file
- */
-extern dec armCommonParameter(
-  target: ModelProperty,
-  definitionName?: valueof string,
-  version?: valueof EnumMember | ArmCommonTypeVersionSpec | string,
-  referenceFile?: valueof string
-);
-
 /**
  * This decorator is used to identify Azure Resource Manager resource types and extract their
  * metadata.  It is *not* meant to be used directly by a spec author, it instead
@@ -78,11 +45,6 @@ extern dec resourceBaseParametersOf(target: Model, propertyName: Model);
  */
 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

package/lib/responses.tsp

@@ -3,6 +3,7 @@ using TypeSpec.Rest;
 using TypeSpec.OpenAPI;
 using Azure.ResourceManager.Foundations;
 using Azure.ResourceManager.Private;
+using Azure.ResourceManager.CommonTypes.Private;
 
 namespace Azure.ResourceManager;
 
@@ -242,19 +243,6 @@ model ArmResourceCreatedSyncResponse<Resource extends Azure.ResourceManager.Foun
   body: Resource;
 }
 
-/**
- * The standard Azure Resource Manager error response
- */
-@error
-@armCommonDefinition("ErrorResponse", Azure.ResourceManager.CommonTypes.Versions.v3)
-@armCommonDefinition("ErrorResponse", Azure.ResourceManager.CommonTypes.Versions.v4)
-@armCommonDefinition("ErrorResponse", Azure.ResourceManager.CommonTypes.Versions.v5)
-@doc("Common error response for all Azure Resource Manager APIs to return error details for failed operations.")
-model ErrorResponse {
-  @doc("The error object.")
-  error?: ErrorDetail;
-}
-
 /**
  * @dev Resource exists response
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-azure-resource-manager",
-  "version": "0.43.0-dev.9",
+  "version": "0.44.0-dev.0",
   "author": "Microsoft Corporation",
   "description": "TypeSpec Azure Resource Manager library",
   "homepage": "https://azure.github.io/typespec-azure",
@@ -43,23 +43,23 @@
     "pluralize": "^8.0.0"
   },
   "peerDependencies": {
-    "@azure-tools/typespec-azure-core": "~0.42.0 || >=0.43.0-dev <0.43.0",
-    "@typespec/compiler": "~0.56.0 || >=0.57.0-dev <0.57.0",
-    "@typespec/http": "~0.56.0 || >=0.57.0-dev <0.57.0",
-    "@typespec/openapi": "~0.56.0 || >=0.57.0-dev <0.57.0",
-    "@typespec/rest": "~0.56.0 || >=0.57.0-dev <0.57.0",
-    "@typespec/versioning": "~0.56.0 || >=0.57.0-dev <0.57.0"
+    "@azure-tools/typespec-azure-core": "~0.43.0 || >=0.44.0-dev <0.44.0",
+    "@typespec/compiler": "~0.57.0 || >=0.58.0-dev <0.58.0",
+    "@typespec/http": "~0.57.0 || >=0.58.0-dev <0.58.0",
+    "@typespec/openapi": "~0.57.0 || >=0.58.0-dev <0.58.0",
+    "@typespec/rest": "~0.57.0 || >=0.58.0-dev <0.58.0",
+    "@typespec/versioning": "~0.57.0 || >=0.58.0-dev <0.58.0"
   },
   "devDependencies": {
-    "@azure-tools/typespec-azure-core": "~0.42.0 || >=0.43.0-dev <0.43.0",
+    "@azure-tools/typespec-azure-core": "~0.43.0 || >=0.44.0-dev <0.44.0",
     "@types/node": "~18.11.19",
     "@types/pluralize": "^0.0.33",
-    "@typespec/compiler": "~0.56.0 || >=0.57.0-dev <0.57.0",
-    "@typespec/http": "~0.56.0 || >=0.57.0-dev <0.57.0",
-    "@typespec/library-linter": "~0.56.0 || >=0.57.0-dev <0.57.0",
-    "@typespec/openapi": "~0.56.0 || >=0.57.0-dev <0.57.0",
-    "@typespec/rest": "~0.56.0 || >=0.57.0-dev <0.57.0",
-    "@typespec/versioning": "~0.56.0 || >=0.57.0-dev <0.57.0",
+    "@typespec/compiler": "~0.57.0 || >=0.58.0-dev <0.58.0",
+    "@typespec/http": "~0.57.0 || >=0.58.0-dev <0.58.0",
+    "@typespec/library-linter": "~0.57.0 || >=0.58.0-dev <0.58.0",
+    "@typespec/openapi": "~0.57.0 || >=0.58.0-dev <0.58.0",
+    "@typespec/rest": "~0.57.0 || >=0.58.0-dev <0.58.0",
+    "@typespec/versioning": "~0.57.0 || >=0.58.0-dev <0.58.0",
     "@vitest/coverage-v8": "^1.6.0",
     "@vitest/ui": "^1.6.0",
     "c8": "^9.1.0",