@azure-tools/typespec-azure-resource-manager 0.43.0-dev.1 → 0.43.0-dev.10

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

@@ -1,30 +1,13 @@
-import "@typespec/openapi";
-import "@typespec/http";
-import "@typespec/rest";
-import "@typespec/versioning";
-import "@azure-tools/typespec-autorest";
-import "@azure-tools/typespec-azure-core";
-
 using TypeSpec.Http;
-using TypeSpec.OpenAPI;
 using TypeSpec.Versioning;
-using Azure.ResourceManager.Private;
-
-namespace Azure.ResourceManager;
-
-/** The private endpoint resource */
-@armCommonDefinition(
-  "PrivateEndpoint",
-  #{ version: Azure.ResourceManager.CommonTypes.Versions.v4, isDefault: true },
-  "privatelinks.json"
-)
-@armCommonDefinition(
-  "PrivateEndpoint",
-  Azure.ResourceManager.CommonTypes.Versions.v5,
-  "privatelinks.json"
-)
+using OpenAPI;
+
+namespace Azure.ResourceManager.CommonTypes;
+
+/** The Private Endpoint resource. */
 model PrivateEndpoint {
   /** The resource identifier for private endpoint */
+  @visibility("read")
   id?: Azure.Core.armResourceIdentifier<[
     {
       type: "Microsoft.Network/privateEndpoints";
@@ -32,49 +15,65 @@ model PrivateEndpoint {
   ]>;
 }
 
+/** A private link resource. */
+model PrivateLinkResource extends Resource {
+  /** Resource properties. */
+  @extension("x-ms-client-flatten", true)
+  properties?: PrivateLinkResourceProperties;
+}
+
+/** Properties of a private link resource. */
+model PrivateLinkResourceProperties {
+  /** The private link resource group id. */
+  @visibility("read")
+  groupId?: string;
+
+  /** The private link resource required member names. */
+  @visibility("read")
+  requiredMembers?: string[];
+
+  /** The private link resource private link DNS zone name. */
+  requiredZoneNames?: string[];
+}
+
+/** A list of private link resources. */
+model PrivateLinkResourceListResult {
+  /** Array of private link resources */
+  value?: PrivateLinkResource[];
+}
+//#region
 /** The private endpoint connection resource */
-model PrivateEndpointConnection extends Azure.ResourceManager.Foundations.ProxyResource {
+model PrivateEndpointConnection extends Resource {
   /** The private endpoint connection properties */
+  @extension("x-ms-client-flatten", true)
   properties?: PrivateEndpointConnectionProperties;
 }
 
-/** Properties of he private endpoint connection resource */
-@armCommonDefinition(
-  "PrivateEndpointConnectionProperties",
-  #{ version: Azure.ResourceManager.CommonTypes.Versions.v4, isDefault: true },
-  "privatelinks.json"
-)
-@armCommonDefinition(
-  "PrivateEndpointConnectionProperties",
-  Azure.ResourceManager.CommonTypes.Versions.v5,
-  "privatelinks.json"
-)
+/** List of private endpoint connections associated with the specified resource. */
+model PrivateEndpointConnectionListResult {
+  /** Array of private endpoint connections. */
+  value?: PrivateEndpointConnection[];
+}
+
+/** Properties of the private endpoint connection. */
 model PrivateEndpointConnectionProperties {
-  /** The group identifiers for the private endpoint resource */
+  /** The group ids for the private endpoint resource. */
   @visibility("read")
+  @added(Versions.v4)
   groupIds?: string[];
 
-  /** The private endpoint resource */
+  /** The private endpoint resource. */
   privateEndpoint?: PrivateEndpoint;
 
   /** A collection of information about the state of the connection between service consumer and provider. */
   privateLinkServiceConnectionState: PrivateLinkServiceConnectionState;
 
   /** The provisioning state of the private endpoint connection resource. */
+  @visibility("read")
   provisioningState?: PrivateEndpointConnectionProvisioningState;
 }
 
 /** A collection of information about the state of the connection between service consumer and provider. */
-@armCommonDefinition(
-  "PrivateLinkServiceConnectionState",
-  #{ version: Azure.ResourceManager.CommonTypes.Versions.v4, isDefault: true },
-  "privatelinks.json"
-)
-@armCommonDefinition(
-  "PrivateLinkServiceConnectionState",
-  Azure.ResourceManager.CommonTypes.Versions.v5,
-  "privatelinks.json"
-)
 model PrivateLinkServiceConnectionState {
   /** Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */
   status?: PrivateEndpointServiceConnectionStatus;
@@ -86,18 +85,24 @@ model PrivateLinkServiceConnectionState {
   actionsRequired?: string;
 }
 
-/** The provisioning state of the connection */
+/** The current provisioning state. */
 union PrivateEndpointConnectionProvisioningState {
-  ResourceProvisioningState,
+  string,
+
+  /** Connection has been provisioned */
+  Succeeded: "Succeeded",
 
   /** Connection is being created */
   Creating: "Creating",
 
   /** Connection is being deleted */
   Deleting: "Deleting",
+
+  /** Connection provisioning has failed */
+  Failed: "Failed",
 }
 
-/** The private endpoint connection status */
+/** The private endpoint connection status. */
 union PrivateEndpointServiceConnectionStatus {
   /** Connectionaiting for approval or rejection */
   Pending: "Pending",
@@ -111,48 +116,6 @@ union PrivateEndpointServiceConnectionStatus {
   string,
 }
 
-model PrivateLinkResource extends Azure.ResourceManager.Foundations.ProxyResource {
-  /** Properties of the private link resource. */
-  properties?: PrivateLinkResourceProperties;
-}
-
-/** Properties of a private link resource. */
-#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Matches current common code"
-@armCommonDefinition(
-  "PrivateLinkResourceProperties",
-  #{ version: Azure.ResourceManager.CommonTypes.Versions.v4, isDefault: true },
-  "privatelinks.json"
-)
-@armCommonDefinition(
-  "PrivateLinkResourceProperties",
-  Azure.ResourceManager.CommonTypes.Versions.v5,
-  "privatelinks.json"
-)
-model PrivateLinkResourceProperties {
-  /** The private link resource group id. */
-  @visibility("read")
-  groupId?: string;
-
-  /** The private link resource required member names. */
-  @visibility("read")
-  requiredMembers?: string[];
-
-  /** The private link resource private link DNS zone name. */
-  requiredZoneNames?: string[];
-}
-
-/** List of private endpoint connections associated with the specified resource. */
-model PrivateEndpointConnectionResourceListResult {
-  /** Array of private endpoint connections */
-  value?: PrivateEndpointConnection[];
-}
-
-/** A list of private link resources. */
-model PrivateLinkResourceListResult {
-  /** Array of private link resources */
-  value?: PrivateLinkResource[];
-}
-
 /**
  * The name of the private endpoint connection associated with the Azure resource.
  * @template Segment The resource type name for private endpoint connections (default is privateEndpointConnections)
@@ -160,16 +123,6 @@ model PrivateLinkResourceListResult {
 model PrivateEndpointConnectionParameter<Segment extends valueof string = "privateEndpointConnections"> {
   /** The name of the private endpoint connection associated with the Azure resource. */
   @path
-  @armCommonParameter(
-    "PrivateEndpointConnectionName",
-    #{ version: Azure.ResourceManager.CommonTypes.Versions.v4, isDefault: true },
-    "privatelinks.json"
-  )
-  @armCommonParameter(
-    "PrivateEndpointConnectionName",
-    Azure.ResourceManager.CommonTypes.Versions.v5,
-    "privatelinks.json"
-  )
   @TypeSpec.Rest.segment(Segment)
   @key("privateEndpointConnectionName")
   name: string;

package/lib/common-types/types-ref.tsp

@@ -0,0 +1,414 @@
+import "../private.decorators.tsp";
+import "./common-types.tsp";
+import "./types.tsp";
+
+using Azure.ResourceManager.Private;
+using Azure.ResourceManager.CommonTypes.Private;
+
+namespace Azure.ResourceManager.CommonTypes;
+
+/** Common resource fields that are returned in the response for all Azure Resource Manager resources. */
+@@armCommonDefinition(Resource, "Resource", Azure.ResourceManager.CommonTypes.Versions.v3);
+@@armCommonDefinition(Resource, "Resource", Azure.ResourceManager.CommonTypes.Versions.v4);
+@@armCommonDefinition(Resource, "Resource", Azure.ResourceManager.CommonTypes.Versions.v5);
+
+/** The resource model definition for an Azure Resource Manager resource with an etag. */
+@@armCommonDefinition(AzureEntityResource,
+  "TrackedResource",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonDefinition(AzureEntityResource,
+  "TrackedResource",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonDefinition(AzureEntityResource,
+  "TrackedResource",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+/**
+ * The base tracked resource.
+ */
+@@armCommonDefinition(TrackedResource,
+  "TrackedResource",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonDefinition(TrackedResource,
+  "TrackedResource",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonDefinition(TrackedResource,
+  "TrackedResource",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+/**
+ * The base proxy resource.
+ */
+@@armCommonDefinition(ProxyResource,
+  "ProxyResource",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonDefinition(ProxyResource,
+  "ProxyResource",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonDefinition(ProxyResource,
+  "ProxyResource",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+/**
+ * The base extension resource.
+ */
+@@armCommonDefinition(ExtensionResource,
+  "ProxyResource",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonDefinition(ExtensionResource,
+  "ProxyResource",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonDefinition(ExtensionResource,
+  "ProxyResource",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+/**
+ * The SKU (Stock Keeping Unit) assigned to this resource.
+ */
+@@armCommonDefinition(Sku, "Sku", Azure.ResourceManager.CommonTypes.Versions.v3);
+@@armCommonDefinition(Sku, "Sku", Azure.ResourceManager.CommonTypes.Versions.v4);
+@@armCommonDefinition(Sku, "Sku", Azure.ResourceManager.CommonTypes.Versions.v5);
+
+/**
+ * A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
+ */
+@@armCommonDefinition(OperationListResult,
+  "OperationListResult",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonDefinition(OperationListResult,
+  "OperationListResult",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonDefinition(OperationListResult,
+  "OperationListResult",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+/**
+ * Details of a REST API operation, returned from the Resource Provider Operations API
+ */
+@@armCommonDefinition(Operation, "Operation", Azure.ResourceManager.CommonTypes.Versions.v3);
+@@armCommonDefinition(Operation, "Operation", Azure.ResourceManager.CommonTypes.Versions.v4);
+@@armCommonDefinition(Operation, "Operation", Azure.ResourceManager.CommonTypes.Versions.v5);
+
+/**
+ * Localized display information for and operation.
+ */
+@@armCommonDefinition(OperationDisplay,
+  "OperationDisplay",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonDefinition(OperationDisplay,
+  "OperationDisplay",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonDefinition(OperationDisplay,
+  "OperationDisplay",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+/**
+ * The current status of an async operation.
+ */
+@@armCommonDefinition(OperationStatusResult,
+  "OperationStatusResult",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonDefinition(OperationStatusResult,
+  "OperationStatusResult",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonDefinition(OperationStatusResult,
+  "OperationStatusResult",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+/**
+ * locationData
+ */
+@@armCommonDefinition(LocationData, "locationData", Azure.ResourceManager.CommonTypes.Versions.v3);
+@@armCommonDefinition(LocationData, "locationData", Azure.ResourceManager.CommonTypes.Versions.v4);
+@@armCommonDefinition(LocationData, "locationData", Azure.ResourceManager.CommonTypes.Versions.v5);
+
+/**
+ * The error detail.
+ */
+@@armCommonDefinition(ErrorDetail, "ErrorDetail", Azure.ResourceManager.CommonTypes.Versions.v3);
+@@armCommonDefinition(ErrorDetail, "ErrorDetail", Azure.ResourceManager.CommonTypes.Versions.v4);
+@@armCommonDefinition(ErrorDetail, "ErrorDetail", Azure.ResourceManager.CommonTypes.Versions.v5);
+
+/**
+ * The resource management error additional info.
+ */
+@@armCommonDefinition(ErrorAdditionalInfo,
+  "ErrorAdditionalInfo",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonDefinition(ErrorAdditionalInfo,
+  "ErrorAdditionalInfo",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonDefinition(ErrorAdditionalInfo,
+  "ErrorAdditionalInfo",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+/**
+ * Identity
+ */
+@@armCommonDefinition(Identity, "Identity", Azure.ResourceManager.CommonTypes.Versions.v3);
+@@armCommonDefinition(Identity, "Identity", Azure.ResourceManager.CommonTypes.Versions.v4);
+@@armCommonDefinition(Identity, "Identity", Azure.ResourceManager.CommonTypes.Versions.v5);
+
+/**
+ * Metadata pertaining to creation and last modification of the resource.
+ */
+@@armCommonDefinition(SystemData, "systemData", Azure.ResourceManager.CommonTypes.Versions.v3);
+@@armCommonDefinition(SystemData, "systemData", Azure.ResourceManager.CommonTypes.Versions.v4);
+@@armCommonDefinition(SystemData, "systemData", Azure.ResourceManager.CommonTypes.Versions.v5);
+
+/**
+ * Details of the resource plan.
+ */
+@@armCommonDefinition(Plan, "Plan", Azure.ResourceManager.CommonTypes.Versions.v3);
+@@armCommonDefinition(Plan, "Plan", Azure.ResourceManager.CommonTypes.Versions.v4);
+@@armCommonDefinition(Plan, "Plan", Azure.ResourceManager.CommonTypes.Versions.v5);
+
+/**
+ * encryptionProperties
+ */
+@@armCommonDefinition(EncryptionProperties,
+  "encryptionProperties",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonDefinition(EncryptionProperties,
+  "encryptionProperties",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonDefinition(EncryptionProperties,
+  "encryptionProperties",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+/**
+ * KeyVaultProperties
+ */
+@@armCommonDefinition(KeyVaultProperties,
+  "KeyVaultProperties",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonDefinition(KeyVaultProperties,
+  "KeyVaultProperties",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonDefinition(KeyVaultProperties,
+  "KeyVaultProperties",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+/**
+ * ResourceModelWithAllowedPropertySet
+ */
+@@armCommonDefinition(ResourceModelWithAllowedPropertySet,
+  "ResourceModelWithAllowedPropertySet",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonDefinition(ResourceModelWithAllowedPropertySet,
+  "ResourceModelWithAllowedPropertySet",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonDefinition(ResourceModelWithAllowedPropertySet,
+  "ResourceModelWithAllowedPropertySet",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+/**
+ * The check availability request body.
+ */
+@@armCommonDefinition(CheckNameAvailabilityRequest,
+  "CheckNameAvailabilityRequest",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonDefinition(CheckNameAvailabilityRequest,
+  "CheckNameAvailabilityRequest",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonDefinition(CheckNameAvailabilityRequest,
+  "CheckNameAvailabilityRequest",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+/**
+ * The check availability result.
+ */
+@@armCommonDefinition(CheckNameAvailabilityResponse,
+  "CheckNameAvailabilityResponse",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonDefinition(CheckNameAvailabilityResponse,
+  "CheckNameAvailabilityResponse",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonDefinition(CheckNameAvailabilityResponse,
+  "CheckNameAvailabilityResponse",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+@@armCommonDefinition(ErrorResponse,
+  "ErrorResponse",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonDefinition(ErrorResponse,
+  "ErrorResponse",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonDefinition(ErrorResponse,
+  "ErrorResponse",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+// -- Parameters
+/** ApiVersionParameter */
+@@armCommonParameter(ApiVersionParameter.apiVersion,
+  "ApiVersionParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonParameter(ApiVersionParameter.apiVersion,
+  "ApiVersionParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonParameter(ApiVersionParameter.apiVersion,
+  "ApiVersionParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+@@resourceParameterBaseFor(ApiVersionParameter.apiVersion,
+  [
+    ResourceHome.ResourceGroup,
+    ResourceHome.Subscription,
+    ResourceHome.Location,
+    ResourceHome.Tenant,
+    ResourceHome.Extension
+  ]
+);
+
+/** SubscriptionIdParameter */
+@@armCommonParameter(SubscriptionIdParameter.subscriptionId,
+  "SubscriptionIdParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonParameter(SubscriptionIdParameter.subscriptionId,
+  "SubscriptionIdParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonParameter(SubscriptionIdParameter.subscriptionId,
+  "SubscriptionIdParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+@@resourceParameterBaseFor(SubscriptionIdParameter.subscriptionId,
+  [ResourceHome.ResourceGroup, ResourceHome.Subscription, ResourceHome.Location]
+);
+
+/** ResourceGroupNameParameter */
+@@armCommonParameter(ResourceGroupNameParameter.resourceGroupName,
+  "ResourceGroupNameParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonParameter(ResourceGroupNameParameter.resourceGroupName,
+  "ResourceGroupNameParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonParameter(ResourceGroupNameParameter.resourceGroupName,
+  "ResourceGroupNameParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+@@resourceParameterBaseFor(ResourceGroupNameParameter.resourceGroupName,
+  [ResourceHome.ResourceGroup]
+);
+
+/** ManagementGroupNameParameter */
+@@armCommonParameter(ManagementGroupNameParameter.managementGroupName,
+  "ManagementGroupNameParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonParameter(ManagementGroupNameParameter.managementGroupName,
+  "ManagementGroupNameParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonParameter(ManagementGroupNameParameter.managementGroupName,
+  "ManagementGroupNameParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+/** ScopeParameter */
+@@armCommonParameter(ScopeParameter.scope,
+  "ScopeParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonParameter(ScopeParameter.scope,
+  "ScopeParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonParameter(ScopeParameter.scope,
+  "ScopeParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+/** LocationResourceParameter */
+@@armCommonParameter(LocationResourceParameter.location,
+  "LocationParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonParameter(LocationResourceParameter.location,
+  "LocationParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonParameter(LocationResourceParameter.location,
+  "LocationParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+/**
+ * The default operationId parameter type.
+ */
+@@armCommonParameter(OperationIdParameter.operationId,
+  "OperationIdParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonParameter(OperationIdParameter.operationId,
+  "OperationIdParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonParameter(OperationIdParameter.operationId,
+  "OperationIdParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);
+
+/**
+ * TenantIdParameter
+ */
+@@armCommonParameter(TenantIdParameter.tenantId,
+  "TenantIdParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v3
+);
+@@armCommonParameter(TenantIdParameter.tenantId,
+  "TenantIdParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v4
+);
+@@armCommonParameter(TenantIdParameter.tenantId,
+  "TenantIdParameter",
+  Azure.ResourceManager.CommonTypes.Versions.v5
+);