Fully synced the armCommonDefinitions and Parameters

allenjzhang · Jun 7, 2024 · 656a3f9 · 656a3f9
1 parent 2f4df97
commit 656a3f9
Show file tree

Hide file tree

Showing 10 changed files with 305 additions and 140 deletions.
diff --git a/docs/libraries/azure-resource-manager/reference/data-types.md b/docs/libraries/azure-resource-manager/reference/data-types.md
@@ -512,20 +512,6 @@ model Azure.ResourceManager.LocationParameter
 | -------- | -------- | ------------------ |
 | location | `string` | The location name. |
 
-### `LocationResourceParameter` {#Azure.ResourceManager.LocationResourceParameter}
-
-The default location parameter type.
-
-```typespec
-model Azure.ResourceManager.LocationResourceParameter
-```
-
-#### Properties
-
-| Name     | Type     | Description        |
-| -------- | -------- | ------------------ |
-| location | `string` | The location name. |
-
 ### `ManagedByProperty` {#Azure.ResourceManager.ManagedByProperty}
 
 Model representing the standard `managedBy` envelope property for a resource.
@@ -674,20 +660,6 @@ model Azure.ResourceManager.ResourceGroupLocationResource
 | -------- | -------- | ------------------ |
 | location | `string` | The location name. |
 
-### `ResourceGroupParameter` {#Azure.ResourceManager.ResourceGroupParameter}
-
-The default resource group parameter type.
-
-```typespec
-model Azure.ResourceManager.ResourceGroupParameter
-```
-
-#### Properties
-
-| Name              | Type     | Description                                                   |
-| ----------------- | -------- | ------------------------------------------------------------- |
-| resourceGroupName | `string` | The name of the resource group. The name is case insensitive. |
-
 ### `ResourceInstanceParameters` {#Azure.ResourceManager.ResourceInstanceParameters}
 
 The dynamic parameters of a resource instance - pass in the proper base type to indicate
@@ -1036,12 +1008,12 @@ model Azure.ResourceManager.CommonTypes.Encryption
 | infrastructureEncryption?     | [`InfrastructureEncryption`](./data-types.md#Azure.ResourceManager.CommonTypes.InfrastructureEncryption)         | Values are enabled and disabled.                                 |
 | customerManagedKeyEncryption? | [`CustomerManagedKeyEncryption`](./data-types.md#Azure.ResourceManager.CommonTypes.CustomerManagedKeyEncryption) | All Customer-managed key encryption properties for the resource. |
 
-### `encryptionProperties` {#Azure.ResourceManager.CommonTypes.encryptionProperties}
+### `EncryptionProperties` {#Azure.ResourceManager.CommonTypes.EncryptionProperties}
 
 Configuration of key for data encryption
 
 ```typespec
-model Azure.ResourceManager.CommonTypes.encryptionProperties
+model Azure.ResourceManager.CommonTypes.EncryptionProperties
 ```
 
 #### Properties
@@ -1113,18 +1085,6 @@ model Azure.ResourceManager.CommonTypes.ExtendedLocation
 | name | `string`                                                                                         | The name of the extended location. |
 | type | [`ExtendedLocationType`](./data-types.md#Azure.ResourceManager.CommonTypes.ExtendedLocationType) | The type of the extended location. |
 
-### `ExtensionResource` {#Azure.ResourceManager.CommonTypes.ExtensionResource}
-
-The base extension resource.
-
-```typespec
-model Azure.ResourceManager.CommonTypes.ExtensionResource
-```
-
-#### Properties
-
-None
-
 ### `Identity` {#Azure.ResourceManager.CommonTypes.Identity}
 
 Identity for the resource.
@@ -1199,12 +1159,12 @@ model Azure.ResourceManager.CommonTypes.KeyVaultProperties
 | keyIdentifier? | `string` | Key vault uri to access the encryption key.                           |
 | identity?      | `string` | The client ID of the identity which will be used to access key vault. |
 
-### `locationData` {#Azure.ResourceManager.CommonTypes.locationData}
+### `LocationData` {#Azure.ResourceManager.CommonTypes.LocationData}
 
 Metadata pertaining to the geographic location of the resource.
 
 ```typespec
-model Azure.ResourceManager.CommonTypes.locationData
+model Azure.ResourceManager.CommonTypes.LocationData
 ```
 
 #### Properties
@@ -1230,6 +1190,20 @@ model Azure.ResourceManager.CommonTypes.LocationParameter
 | -------- | -------- | ------------------------- |
 | location | `string` | The name of Azure region. |
 
+### `LocationResourceParameter` {#Azure.ResourceManager.CommonTypes.LocationResourceParameter}
+
+The default location parameter type.
+
+```typespec
+model Azure.ResourceManager.CommonTypes.LocationResourceParameter
+```
+
+#### Properties
+
+| Name     | Type     | Description        |
+| -------- | -------- | ------------------ |
+| location | `string` | The location name. |
+
 ### `ManagedServiceIdentity` {#Azure.ResourceManager.CommonTypes.ManagedServiceIdentity}
 
 Managed service identity (system assigned and/or user assigned identities)

diff --git a/docs/libraries/azure-resource-manager/reference/decorators.md b/docs/libraries/azure-resource-manager/reference/decorators.md
@@ -23,9 +23,9 @@ the version of the Azure Resource Manager common-types to use for refs in emitte
 
 #### Parameters
 
-| Name    | Type                           | Description                                                                          |
-| ------- | ------------------------------ | ------------------------------------------------------------------------------------ |
-| version | `valueof string \| EnumMember` | The Azure.ResourceManager.CommonTypes.Versions for the desired common-types version. |
+| Name    | Type                           | Description                                                                                                                  |
+| ------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
+| version | `valueof string \| EnumMember` | The Azure.ResourceManager.CommonTypes.Versions for the desired common-types version or an equivalent string value like "v5". |
 
 ### `@armLibraryNamespace` {#@Azure.ResourceManager.armLibraryNamespace}
 

diff --git a/docs/libraries/azure-resource-manager/reference/index.mdx b/docs/libraries/azure-resource-manager/reference/index.mdx
@@ -141,15 +141,13 @@ npm install --save-peer @azure-tools/typespec-azure-resource-manager
 - [`ExtensionResource`](./data-types.md#Azure.ResourceManager.ExtensionResource)
 - [`KeysOf`](./data-types.md#Azure.ResourceManager.KeysOf)
 - [`LocationParameter`](./data-types.md#Azure.ResourceManager.LocationParameter)
-- [`LocationResourceParameter`](./data-types.md#Azure.ResourceManager.LocationResourceParameter)
 - [`ManagedByProperty`](./data-types.md#Azure.ResourceManager.ManagedByProperty)
 - [`ManagedServiceIdentityProperty`](./data-types.md#Azure.ResourceManager.ManagedServiceIdentityProperty)
 - [`ManagedSystemAssignedIdentityProperty`](./data-types.md#Azure.ResourceManager.ManagedSystemAssignedIdentityProperty)
 - [`ParentKeysOf`](./data-types.md#Azure.ResourceManager.ParentKeysOf)
 - [`ProviderNamespace`](./data-types.md#Azure.ResourceManager.ProviderNamespace)
 - [`ProxyResource`](./data-types.md#Azure.ResourceManager.ProxyResource)
 - [`ResourceGroupLocationResource`](./data-types.md#Azure.ResourceManager.ResourceGroupLocationResource)
-- [`ResourceGroupParameter`](./data-types.md#Azure.ResourceManager.ResourceGroupParameter)
 - [`ResourceInstanceParameters`](./data-types.md#Azure.ResourceManager.ResourceInstanceParameters)
 - [`ResourceKindProperty`](./data-types.md#Azure.ResourceManager.ResourceKindProperty)
 - [`ResourceListResult`](./data-types.md#Azure.ResourceManager.ResourceListResult)
@@ -172,19 +170,19 @@ npm install --save-peer @azure-tools/typespec-azure-resource-manager
 - [`CheckNameAvailabilityResponse`](./data-types.md#Azure.ResourceManager.CommonTypes.CheckNameAvailabilityResponse)
 - [`CustomerManagedKeyEncryption`](./data-types.md#Azure.ResourceManager.CommonTypes.CustomerManagedKeyEncryption)
 - [`Encryption`](./data-types.md#Azure.ResourceManager.CommonTypes.Encryption)
-- [`encryptionProperties`](./data-types.md#Azure.ResourceManager.CommonTypes.encryptionProperties)
+- [`EncryptionProperties`](./data-types.md#Azure.ResourceManager.CommonTypes.EncryptionProperties)
 - [`ErrorAdditionalInfo`](./data-types.md#Azure.ResourceManager.CommonTypes.ErrorAdditionalInfo)
 - [`ErrorDetail`](./data-types.md#Azure.ResourceManager.CommonTypes.ErrorDetail)
 - [`ErrorResponse`](./data-types.md#Azure.ResourceManager.CommonTypes.ErrorResponse)
 - [`ExtendedLocation`](./data-types.md#Azure.ResourceManager.CommonTypes.ExtendedLocation)
-- [`ExtensionResource`](./data-types.md#Azure.ResourceManager.CommonTypes.ExtensionResource)
 - [`Identity`](./data-types.md#Azure.ResourceManager.CommonTypes.Identity)
 - [`IfMatchHeader`](./data-types.md#Azure.ResourceManager.CommonTypes.IfMatchHeader)
 - [`IfNoneMatchHeader`](./data-types.md#Azure.ResourceManager.CommonTypes.IfNoneMatchHeader)
 - [`KeyEncryptionKeyIdentity`](./data-types.md#Azure.ResourceManager.CommonTypes.KeyEncryptionKeyIdentity)
 - [`KeyVaultProperties`](./data-types.md#Azure.ResourceManager.CommonTypes.KeyVaultProperties)
-- [`locationData`](./data-types.md#Azure.ResourceManager.CommonTypes.locationData)
+- [`LocationData`](./data-types.md#Azure.ResourceManager.CommonTypes.LocationData)
 - [`LocationParameter`](./data-types.md#Azure.ResourceManager.CommonTypes.LocationParameter)
+- [`LocationResourceParameter`](./data-types.md#Azure.ResourceManager.CommonTypes.LocationResourceParameter)
 - [`ManagedServiceIdentity`](./data-types.md#Azure.ResourceManager.CommonTypes.ManagedServiceIdentity)
 - [`ManagementGroupNameParameter`](./data-types.md#Azure.ResourceManager.CommonTypes.ManagementGroupNameParameter)
 - [`Operation`](./data-types.md#Azure.ResourceManager.CommonTypes.Operation)

diff --git a/packages/typespec-azure-resource-manager/README.md b/packages/typespec-azure-resource-manager/README.md
@@ -103,9 +103,9 @@ the version of the Azure Resource Manager common-types to use for refs in emitte
 
 ##### Parameters
 
-| Name    | Type                           | Description                                                                          |
-| ------- | ------------------------------ | ------------------------------------------------------------------------------------ |
-| version | `valueof string \| EnumMember` | The Azure.ResourceManager.CommonTypes.Versions for the desired common-types version. |
+| Name    | Type                           | Description                                                                                                                  |
+| ------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
+| version | `valueof string \| EnumMember` | The Azure.ResourceManager.CommonTypes.Versions for the desired common-types version or an equivalent string value like "v5". |
 
 #### `@armLibraryNamespace`
 

diff --git a/packages/typespec-azure-resource-manager/lib/common-types/customer-managed-keys-ref.tsp b/packages/typespec-azure-resource-manager/lib/common-types/customer-managed-keys-ref.tsp
@@ -6,11 +6,22 @@ namespace Azure.ResourceManager.CommonTypes;
 
 @@armCommonDefinition(Encryption,
   "encryption",
-  Azure.ResourceManager.CommonTypes.Versions.v4,
+  #{ version: Azure.ResourceManager.CommonTypes.Versions.v4, isDefault: true },
   "customermanagedkeys.json"
 );
 @@armCommonDefinition(Encryption,
   "encryption",
   Azure.ResourceManager.CommonTypes.Versions.v5,
   "customermanagedkeys.json"
 );
+
+@@armCommonDefinition(CustomerManagedKeyEncryption,
+  "customerManagedKeyEncryption",
+  #{ version: Azure.ResourceManager.CommonTypes.Versions.v4, isDefault: true },
+  "customermanagedkeys.json"
+);
+@@armCommonDefinition(CustomerManagedKeyEncryption,
+  "customerManagedKeyEncryption",
+  Azure.ResourceManager.CommonTypes.Versions.v5,
+  "customermanagedkeys.json"
+);
diff --git a/packages/typespec-azure-resource-manager/lib/common-types/private-links-ref.tsp b/packages/typespec-azure-resource-manager/lib/common-types/private-links-ref.tsp
@@ -4,22 +4,66 @@ using Azure.ResourceManager.CommonTypes.Private;
 
 namespace Azure.ResourceManager.CommonTypes;
 
-/** The private endpoint resource */
+/** The private endpoint */
 @@armCommonDefinition(PrivateEndpoint,
   "PrivateEndpoint",
-  #{ version: Azure.ResourceManager.CommonTypes.Versions.v4, isDefault: true },
+  #{ version: Azure.ResourceManager.CommonTypes.Versions.v3, isDefault: true },
   "privatelinks.json"
 );
 @@armCommonDefinition(PrivateEndpoint,
   "PrivateEndpoint",
+  Azure.ResourceManager.CommonTypes.Versions.v4,
+  "privatelinks.json"
+);
+@@armCommonDefinition(PrivateEndpoint,
+  "PrivateEndpoint",
+  Azure.ResourceManager.CommonTypes.Versions.v5,
+  "privatelinks.json"
+);
+
+/** The private endpoint resource */
+@@armCommonDefinition(PrivateLinkResource,
+  "PrivateLinkResource",
+  #{ version: Azure.ResourceManager.CommonTypes.Versions.v3, isDefault: true },
+  "privatelinks.json"
+);
+@@armCommonDefinition(PrivateLinkResource,
+  "PrivateLinkResource",
+  Azure.ResourceManager.CommonTypes.Versions.v4,
+  "privatelinks.json"
+);
+@@armCommonDefinition(PrivateLinkResource,
+  "PrivateLinkResource",
+  Azure.ResourceManager.CommonTypes.Versions.v5,
+  "privatelinks.json"
+);
+
+/** PrivateEndpointConnection */
+@@armCommonDefinition(PrivateEndpointConnection,
+  "PrivateEndpointConnection",
+  #{ version: Azure.ResourceManager.CommonTypes.Versions.v3, isDefault: true },
+  "privatelinks.json"
+);
+@@armCommonDefinition(PrivateEndpointConnection,
+  "PrivateEndpointConnection",
+  Azure.ResourceManager.CommonTypes.Versions.v4,
+  "privatelinks.json"
+);
+@@armCommonDefinition(PrivateEndpointConnection,
+  "PrivateEndpointConnection",
   Azure.ResourceManager.CommonTypes.Versions.v5,
   "privatelinks.json"
 );
 
 /** Properties of he private endpoint connection resource */
 @@armCommonDefinition(PrivateEndpointConnectionProperties,
   "PrivateEndpointConnectionProperties",
-  #{ version: Azure.ResourceManager.CommonTypes.Versions.v4, isDefault: true },
+  #{ version: Azure.ResourceManager.CommonTypes.Versions.v3, isDefault: true },
+  "privatelinks.json"
+);
+@@armCommonDefinition(PrivateEndpointConnectionProperties,
+  "PrivateEndpointConnectionProperties",
+  Azure.ResourceManager.CommonTypes.Versions.v4,
   "privatelinks.json"
 );
 @@armCommonDefinition(PrivateEndpointConnectionProperties,
@@ -31,7 +75,12 @@ namespace Azure.ResourceManager.CommonTypes;
 /** A collection of information about the state of the connection between service consumer and provider. */
 @@armCommonDefinition(PrivateLinkServiceConnectionState,
   "PrivateLinkServiceConnectionState",
-  #{ version: Azure.ResourceManager.CommonTypes.Versions.v4, isDefault: true },
+  #{ version: Azure.ResourceManager.CommonTypes.Versions.v3, isDefault: true },
+  "privatelinks.json"
+);
+@@armCommonDefinition(PrivateLinkServiceConnectionState,
+  "PrivateLinkServiceConnectionState",
+  Azure.ResourceManager.CommonTypes.Versions.v4,
   "privatelinks.json"
 );
 @@armCommonDefinition(PrivateLinkServiceConnectionState,
@@ -44,7 +93,12 @@ namespace Azure.ResourceManager.CommonTypes;
 #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Matches current common code"
 @@armCommonDefinition(PrivateLinkResourceProperties,
   "PrivateLinkResourceProperties",
-  #{ version: Azure.ResourceManager.CommonTypes.Versions.v4, isDefault: true },
+  #{ version: Azure.ResourceManager.CommonTypes.Versions.v3, isDefault: true },
+  "privatelinks.json"
+);
+@@armCommonDefinition(PrivateLinkResourceProperties,
+  "PrivateLinkResourceProperties",
+  Azure.ResourceManager.CommonTypes.Versions.v4,
   "privatelinks.json"
 );
 @@armCommonDefinition(PrivateLinkResourceProperties,
@@ -53,9 +107,49 @@ namespace Azure.ResourceManager.CommonTypes;
   "privatelinks.json"
 );
 
+/** PrivateEndpointConnectionListResult */
+@@armCommonDefinition(PrivateEndpointConnectionListResult,
+  "PrivateEndpointConnectionListResult",
+  #{ version: Azure.ResourceManager.CommonTypes.Versions.v3, isDefault: true },
+  "privatelinks.json"
+);
+@@armCommonDefinition(PrivateEndpointConnectionListResult,
+  "PrivateEndpointConnectionListResult",
+  Azure.ResourceManager.CommonTypes.Versions.v4,
+  "privatelinks.json"
+);
+@@armCommonDefinition(PrivateEndpointConnectionListResult,
+  "PrivateEndpointConnectionListResult",
+  Azure.ResourceManager.CommonTypes.Versions.v5,
+  "privatelinks.json"
+);
+
+/** PrivateLinkResourceListResult */
+@@armCommonDefinition(PrivateLinkResourceListResult,
+  "PrivateLinkResourceListResult",
+  #{ version: Azure.ResourceManager.CommonTypes.Versions.v3, isDefault: true },
+  "privatelinks.json"
+);
+@@armCommonDefinition(PrivateLinkResourceListResult,
+  "PrivateLinkResourceListResult",
+  Azure.ResourceManager.CommonTypes.Versions.v4,
+  "privatelinks.json"
+);
+@@armCommonDefinition(PrivateLinkResourceListResult,
+  "PrivateLinkResourceListResult",
+  Azure.ResourceManager.CommonTypes.Versions.v5,
+  "privatelinks.json"
+);
+
+/** PrivateEndpointConnectionParameter */
+@@CommonTypes.Private.armCommonParameter(PrivateEndpointConnectionParameter.name,
+  "PrivateEndpointConnectionName",
+  #{ version: Azure.ResourceManager.CommonTypes.Versions.v3, isDefault: true },
+  "privatelinks.json"
+);
 @@CommonTypes.Private.armCommonParameter(PrivateEndpointConnectionParameter.name,
   "PrivateEndpointConnectionName",
-  #{ version: Azure.ResourceManager.CommonTypes.Versions.v4, isDefault: true },
+  Azure.ResourceManager.CommonTypes.Versions.v4,
   "privatelinks.json"
 );
 @@CommonTypes.Private.armCommonParameter(PrivateEndpointConnectionParameter.name,