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

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

@@ -2,6 +2,8 @@ using Azure.ResourceManager.Private;
 
 namespace Azure.ResourceManager.Foundations;
 
+#deprecated "Please change ManagedIdentityProperties to ManagedServiceIdentity."
+alias ManagedIdentityProperties = ManagedServiceIdentity;
 /**
  * The properties of the managed service identities assigned to this resource.
  */
@@ -18,8 +20,7 @@ namespace Azure.ResourceManager.Foundations;
   Azure.ResourceManager.CommonTypes.Versions.v5,
   "managedidentity.json"
 )
-@doc("The properties of the managed service identities assigned to this resource.")
-model ManagedIdentityProperties {
+model ManagedServiceIdentity {
   @doc("The Active Directory tenant id of the principal.")
   @visibility("read")
   tenantId?: string;
@@ -32,9 +33,14 @@ model ManagedIdentityProperties {
   type: ManagedServiceIdentityType;
 
   @doc("The identities assigned to this resource by the user.")
-  userAssignedIdentities?: Record<UserAssignedIdentity>;
+  userAssignedIdentities?: UserAssignedIdentities;
 }
 
+/** 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.", */
+model UserAssignedIdentities is Record<UserAssignedIdentity>;
+
+#deprecated "Please change ManagedSystemIdentityProperties to SystemAssignedServiceIdentity."
+alias ManagedSystemIdentityProperties = SystemAssignedServiceIdentity;
 /**
  * The properties of the service-assigned identity associated with this resource.
  */
@@ -51,8 +57,7 @@ model ManagedIdentityProperties {
   Azure.ResourceManager.CommonTypes.Versions.v5,
   "managedidentity.json"
 )
-@doc("The properties of the service-assigned identity associated with this resource.")
-model ManagedSystemIdentityProperties {
+model SystemAssignedServiceIdentity {
   @doc("The Active Directory tenant id of the principal.")
   @visibility("read")
   tenantId?: string;

package/lib/models.tsp

@@ -171,7 +171,9 @@ model DefaultProvisioningStateProperty {
   provisioningState?: ResourceProvisioningState;
 }
 
-/** The standard evenlop definition of ExtendedLocation.
+/**
+ * Model representing the standard `extendedLocation` envelope property for a resource.
+ * Spread this model into a Resource Model, if the resource supports extended locations
  *
  * @example
  * ```typespec
@@ -185,56 +187,88 @@ model ExtendedLocationProperty {
   extendedLocation: Foundations.ExtendedLocation;
 }
 
+#deprecated "Please change ManagedServiceIdentity to ManagedServiceIdentityProperty."
+alias ManagedServiceIdentity = ManagedServiceIdentityProperty;
+
 /**
- * Standard Azure Resource Manager definition of ManagedServiceIdentity
+ * Model representing the standard `ManagedServiceIdentity` envelope property for a resource.
+ * Spread this model into a resource model if the resource supports both system-assigned and user-assigned managed identities.
+ *
+ * @example
+ *
+ * ```typespec
+ * model Foo is TrackedResource<FooProperties> {
+ *   ...ResourceNameParameter<Foo>;
+ *   ...ManagedServiceIdentityProperty;
+ * }
+ * ```
  */
 @doc("The managed service identities envelope.")
-model ManagedServiceIdentity {
+model ManagedServiceIdentityProperty {
   @doc("The managed service identities assigned to this resource.")
-  identity?: ManagedIdentityProperties;
+  identity?: Foundations.ManagedServiceIdentity;
 }
 
+#deprecated "Please change ManagedSystemAssignedIdentity to ManagedSystemAssignedIdentityProperty."
+alias ManagedSystemAssignedIdentity = ManagedSystemAssignedIdentityProperty;
 /**
- * Standard Azure Resource Manager definition of ManagedServiceIdentity for services
- * that only support system-defined identities
+ * Model representing the standard `SystemAssignedServiceIdentity` envelope property for a resource.
+ * Spread this model into a resource model if the resource supports system-assigned managed identities
+ * but does not support user-assigned managed identities.
+ *
+ * @example
+ *
+ * ```typespec
+ * model Foo is TrackedResource<FooProperties> {
+ *   ...ResourceNameParameter<Foo>;
+ *   ...ManagedSystemAssignedIdentityProperty;
+ * }
+ * ```
  */
 @doc("Managed identity for services that are constrained to system-assigned managed identities.")
-model ManagedSystemAssignedIdentity {
+model ManagedSystemAssignedIdentityProperty {
   @doc("The managed service identities assigned to this resource.")
-  identity?: ManagedSystemIdentityProperties;
+  identity?: Foundations.SystemAssignedServiceIdentity;
 }
 
+#deprecated "`EntityTag` will be deprecated. Please use `EntityTagProperty` instead."
+alias EntityTag = EntityTagProperty;
 /**
  * Model used only to spread in the standard `eTag` envelope property for a resource
+ *
  * @example
  *
  * ```typespec
  * model Foo is TrackedResource<FooProperties> {
  *   // Only have standard Succeeded, Failed, Cancelled states
- *   ...EntityTag;
+ *   ...EntityTagProperty;
  * }
  * ```
  */
 @doc("The eTag property envelope.")
-model EntityTag {
+model EntityTagProperty {
   @doc("If eTag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
   @visibility("read")
   eTag?: string;
 }
 
+#deprecated "`ResourceKind` will be deprecated. Please use `ResourceKindProperty` instead."
+alias ResourceKind = ResourceKindProperty;
 /**
- * Model used only to spread in the standard `kind` envelope property for a resource
+ * Model representing the standard `kind` envelope property for a resource.
+ * Spread this model into a resource model if the resource support ARM `kind`.
+ *
  * @example
  *
  * ```typespec
  * model Foo is TrackedResource<FooProperties> {
  *   // Only have standard Succeeded, Failed, Cancelled states
- *   ...ResourceKind;
+ *   ...ResourceKindProperty;
  * }
  * ```
  */
 @doc("The resource kind property envelope.")
-model ResourceKind {
+model ResourceKindProperty {
   @doc("Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.")
   @pattern("^[-\\w\\._,\\(\\\\\\)]+$")
   @visibility("read", "create")
@@ -249,53 +283,65 @@ model ResourceKind {
 @friendlyName("{name}ListResult", Resource)
 model ResourceListResult<Resource extends ArmResource> is Azure.Core.Page<Resource>;
 
+#deprecated "`ResourcePlan` will be deprecated. Please use `ResourcePlanProperty` instead."
+alias ResourcePlan = ResourcePlanProperty;
 /**
- * Model used only to spread in the standard `plan` envelope property for a resource
+ * Model representing the standard `plan` envelope property for a resource.
+ * Spread this model into a resource Model if the resource supports ARM `plan`.
+ *
  * @example
  *
  * ```typespec
  * model Foo is TrackedResource<FooProperties> {
  *   // Only have standard Succeeded, Failed, Cancelled states
- *   ...ResourcePlan;
+ *   ...ResourcePlanProperty;
  * }
  * ```
  */
 @doc("The resource plan property envelope.")
-model ResourcePlan {
+model ResourcePlanProperty {
   @doc("Details of the resource plan.")
   plan?: ResourcePlanType;
 }
 
+#deprecated "`ResourceSku` will be deprecated. Please use `ResourceSkuProperty` instead."
+alias ResourceSku = ResourceSkuProperty;
 /**
- * Model used only to spread in the standard `sku` envelope property for a resource
+ * Model representing the standard `sku` envelope property for a resource.
+ * Spread this model into a resource model if the resource supports standard ARM `sku`.
+ *
  * @example
  *
  * ```typespec
  * model Foo is TrackedResource<FooProperties> {
  *   // Only have standard Succeeded, Failed, Cancelled states
- *   ...ResourceSku;
+ *   ...ResourceSkuProperty;
  * }
  * ```
  */
 @doc("The SKU (Stock Keeping Unit) assigned to this resource.")
-model ResourceSku {
+model ResourceSkuProperty {
   @doc("The SKU (Stock Keeping Unit) assigned to this resource.")
   sku?: ResourceSkuType;
 }
 
+#deprecated "`ManagedBy` will be deprecated. Please use `ManagedByProperty` instead."
+alias ManagedBy = ManagedByProperty;
 /**
- * Model used only to spread in the standard `managedBy` envelope property for a resource
+ * Model representing the standard `managedBy` envelope property for a resource.
+ * Spread this model into a resource model if the resource is managed by another entity.
+ *
  * @example
  *
  * ```typespec
  * model Foo is TrackedResource<FooProperties> {
  *   // Only have standard Succeeded, Failed, Cancelled states
- *   ...ManagedBy;
+ *   ...ManagedByProperty;
  * }
  * ```
  */
 @doc("The managedBy property envelope.")
-model ManagedBy {
+model ManagedByProperty {
   @doc("The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.")
   managedBy?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-azure-resource-manager",
-  "version": "0.42.0-dev.14",
+  "version": "0.42.0-dev.15",
   "author": "Microsoft Corporation",
   "description": "TypeSpec Azure Resource Manager library",
   "homepage": "https://azure.github.io/typespec-azure",