swagger: '2.0' info: title: Microsoft Azure Azure VMware Solution API description: Azure VMware Solution API version: 2020-07-17-preview host: management.azure.com schemes: - https consumes: - application/json produces: - application/json security: - azure_auth: - user_impersonation securityDefinitions: azure_auth: type: oauth2 authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize flow: implicit description: Azure Active Directory OAuth2 Flow scopes: user_impersonation: impersonate your user account tags: - name: Addons - name: Authorizations description: '' - name: Clusters description: '' - name: GlobalReachConnections description: '' - name: HcxEnterpriseSites description: '' - name: Locations description: '' - name: Operations description: '' - name: PrivateClouds description: '' - name: WorkloadNetworks description: '' parameters: privateCloudName: name: privateCloudName in: path required: true type: string description: Name of the private cloud x-ms-parameter-location: method clusterName: name: clusterName in: path required: true type: string description: Name of the cluster in the private cloud x-ms-parameter-location: method hcxEnterpriseSiteName: name: hcxEnterpriseSiteName in: path required: true type: string description: Name of the HCX Enterprise Site in the private cloud x-ms-parameter-location: method addonName: name: addonName in: path required: true type: string description: Name of the addon for the private cloud x-ms-parameter-location: method authorizationName: name: authorizationName in: path required: true type: string description: Name of the ExpressRoute Circuit Authorization in the private cloud x-ms-parameter-location: method globalReachConnectionName: name: globalReachConnectionName in: path required: true type: string description: Name of the global reach connection in the private cloud x-ms-parameter-location: method segmentId: name: segmentId in: path required: true type: string description: NSX Segment identifier. Generally the same as the Segment's display name x-ms-parameter-location: method dhcpId: name: dhcpId in: path required: true type: string description: NSX DHCP identifier. Generally the same as the DHCP display name x-ms-parameter-location: method portMirroringId: name: portMirroringId in: path required: true type: string description: >- NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name x-ms-parameter-location: method vmGroupId: name: vmGroupId in: path required: true type: string description: NSX VM Group identifier. Generally the same as the VM Group's display name x-ms-parameter-location: method virtualMachineId: name: virtualMachineId in: path required: true type: string description: NSX Virtual Machine identifier. x-ms-parameter-location: method gatewayId: name: gatewayId in: path required: true type: string description: NSX Gateway identifier. Generally the same as the Gateway's display name x-ms-parameter-location: method dnsServiceId: name: dnsServiceId in: path required: true type: string description: >- NSX DNS Service identifier. Generally the same as the DNS Service's display name x-ms-parameter-location: method dnsZoneId: name: dnsZoneId in: path required: true type: string description: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name x-ms-parameter-location: method paths: /providers/Microsoft.AVS/operations: get: tags: - Operations description: Lists all of the available operations operationId: microsoftAzureOperationsList x-ms-pageable: nextLinkName: nextLink parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: Request has succeeded schema: $ref: '#/definitions/OperationList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Operations_List: $ref: ./examples/Operations_List.json summary: Microsoft Azure Get Providers Microsoft Avs Operations /subscriptions/{subscriptionId}/providers/Microsoft.AVS/locations/{location}/checkTrialAvailability: post: tags: - Locations description: Return trial status for subscription by region operationId: microsoftAzureLocationsChecktrialavailability parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - name: location in: path required: true type: string description: Azure region - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: Request has succeeded schema: $ref: '#/definitions/Trial' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Locations_CheckTrialAvailability: $ref: ./examples/Locations_CheckTrialAvailability.json summary: >- Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Avs Locations Location Checktrialavailability /subscriptions/{subscriptionId}/providers/Microsoft.AVS/locations/{location}/checkQuotaAvailability: post: tags: - Locations description: Return quota for subscription by region operationId: microsoftAzureLocationsCheckquotaavailability parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - name: location in: path required: true type: string description: Azure region - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: Request has succeeded schema: $ref: '#/definitions/Quota' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Locations_CheckQuotaAvailability: $ref: ./examples/Locations_CheckQuotaAvailability.json summary: >- Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Avs Locations Location Checkquotaavailability /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds: get: operationId: microsoftAzurePrivatecloudsList x-ms-pageable: nextLinkName: nextLink tags: - PrivateClouds summary: Microsoft Azure List Private Clouds In A Resource Group parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/PrivateCloudList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: PrivateClouds_List: $ref: ./examples/PrivateClouds_List.json description: Needs a more full description created. /subscriptions/{subscriptionId}/providers/Microsoft.AVS/privateClouds: get: operationId: microsoftAzurePrivatecloudsListinsubscription x-ms-pageable: nextLinkName: nextLink tags: - PrivateClouds summary: Microsoft Azure List Private Clouds In A Subscription parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/PrivateCloudList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: PrivateClouds_ListInSubscription: $ref: ./examples/PrivateClouds_ListInSubscription.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName} : get: operationId: microsoftAzurePrivatecloudsGet tags: - PrivateClouds summary: Microsoft Azure Get A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/PrivateCloud' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: PrivateClouds_Get: $ref: ./examples/PrivateClouds_Get.json description: Needs a more full description created. put: operationId: microsoftAzurePrivatecloudsCreateorupdate x-ms-long-running-operation: true tags: - PrivateClouds summary: Microsoft Azure Create Or Update A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - name: privateCloud description: The private cloud in: body required: true schema: $ref: '#/definitions/PrivateCloud' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/PrivateCloud' '201': description: accepted operation schema: $ref: '#/definitions/PrivateCloud' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: PrivateClouds_CreateOrUpdate: $ref: ./examples/PrivateClouds_CreateOrUpdate.json description: Needs a more full description created. patch: operationId: microsoftAzurePrivatecloudsUpdate x-ms-long-running-operation: true tags: - PrivateClouds summary: Microsoft Azure Update A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - name: privateCloudUpdate description: The private cloud properties to be updated in: body required: true schema: $ref: '#/definitions/PrivateCloudUpdate' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/PrivateCloud' '201': description: accepted operation schema: $ref: '#/definitions/PrivateCloud' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: PrivateClouds_Update: $ref: ./examples/PrivateClouds_Update.json description: Needs a more full description created. delete: operationId: microsoftAzurePrivatecloudsDelete x-ms-long-running-operation: true tags: - PrivateClouds summary: Microsoft Azure Delete A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. The delete has succeeded '202': description: Accepted. The delete will complete asynchronously '204': description: No Content. No private cloud to delete default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: PrivateClouds_Delete: $ref: ./examples/PrivateClouds_Delete.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/rotateVcenterPassword : post: operationId: microsoftAzurePrivatecloudsRotatevcenterpassword tags: - PrivateClouds summary: Microsoft Azure Rotate The Vcenter Password parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter x-ms-long-running-operation: true responses: '202': description: The password rotation has started '204': description: The password rotation was successful default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: PrivateClouds_RotateVcenterPassword: $ref: ./examples/PrivateClouds_RotateVcenterPassword.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/rotateNsxtPassword : post: operationId: microsoftAzurePrivatecloudsRotatensxtpassword tags: - PrivateClouds summary: Microsoft Azure Rotate The Nsx T Manager Password parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter x-ms-long-running-operation: true responses: '202': description: The password rotation has started '204': description: The password rotation was successful default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: PrivateClouds_RotateNsxtPassword: $ref: ./examples/PrivateClouds_RotateNsxtPassword.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters : get: operationId: microsoftAzureClustersList x-ms-pageable: nextLinkName: nextLink tags: - Clusters summary: Microsoft Azure List Clusters In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/ClusterList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Clusters_List: $ref: ./examples/Clusters_List.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName} : get: operationId: microsoftAzureClustersGet tags: - Clusters summary: Microsoft Azure Get A Cluster By Name In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/clusterName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/Cluster' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Clusters_Get: $ref: ./examples/Clusters_Get.json description: Needs a more full description created. put: operationId: microsoftAzureClustersCreateorupdate x-ms-long-running-operation: true tags: - Clusters summary: Microsoft Azure Create Or Update A Cluster In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - name: privateCloudName in: path required: true type: string description: The name of the private cloud. - $ref: '#/parameters/clusterName' - name: cluster description: A cluster in the private cloud in: body required: true schema: $ref: '#/definitions/Cluster' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/Cluster' '201': description: accepted operation schema: $ref: '#/definitions/Cluster' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Clusters_CreateOrUpdate: $ref: ./examples/Clusters_CreateOrUpdate.json description: Needs a more full description created. patch: operationId: microsoftAzureClustersUpdate x-ms-long-running-operation: true tags: - Clusters summary: Microsoft Azure Update A Cluster In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/clusterName' - name: clusterUpdate description: The cluster properties to be updated in: body required: true schema: $ref: '#/definitions/ClusterUpdate' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/Cluster' '201': description: accepted operation schema: $ref: '#/definitions/Cluster' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Clusters_Update: $ref: ./examples/Clusters_Update.json description: Needs a more full description created. delete: operationId: microsoftAzureClustersDelete x-ms-long-running-operation: true tags: - Clusters summary: Microsoft Azure Delete A Cluster In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/clusterName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. The delete has succeeded '202': description: Accepted. The delete will complete asynchronously '204': description: No Content. No cluster to delete default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Clusters_Delete: $ref: ./examples/Clusters_Delete.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/listAdminCredentials : post: operationId: microsoftAzurePrivatecloudsListadmincredentials tags: - PrivateClouds summary: Microsoft Azure List The Admin Credentials For The Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/AdminCredentials' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: PrivateClouds_ListAdminCredentials: $ref: ./examples/PrivateClouds_ListAdminCredentials.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites : get: operationId: microsoftAzureHcxenterprisesitesList x-ms-pageable: nextLinkName: nextLink tags: - HcxEnterpriseSites summary: Microsoft Azure List Hcx Enterprise Sites In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/HcxEnterpriseSiteList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: HcxEnterpriseSites_List: $ref: ./examples/HcxEnterpriseSites_List.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName} : get: operationId: microsoftAzureHcxenterprisesitesGet tags: - HcxEnterpriseSites summary: Microsoft Azure Get An Hcx Enterprise Site By Name In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/hcxEnterpriseSiteName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/HcxEnterpriseSite' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: HcxEnterpriseSites_Get: $ref: ./examples/HcxEnterpriseSites_Get.json description: Needs a more full description created. put: operationId: microsoftAzureHcxenterprisesitesCreateorupdate tags: - HcxEnterpriseSites summary: Microsoft Azure Create Or Update An Hcx Enterprise Site In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - name: privateCloudName in: path required: true type: string description: The name of the private cloud. - $ref: '#/parameters/hcxEnterpriseSiteName' - name: hcxEnterpriseSite description: The HCX Enterprise Site in: body required: true schema: $ref: '#/definitions/HcxEnterpriseSite' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful update schema: $ref: '#/definitions/HcxEnterpriseSite' '201': description: successful create schema: $ref: '#/definitions/HcxEnterpriseSite' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: HcxEnterpriseSites_CreateOrUpdate: $ref: ./examples/HcxEnterpriseSites_CreateOrUpdate.json description: Needs a more full description created. delete: operationId: microsoftAzureHcxenterprisesitesDelete tags: - HcxEnterpriseSites summary: Microsoft Azure Delete An Hcx Enterprise Site In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/hcxEnterpriseSiteName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. The delete has succeeded '204': description: No Content. No HCX Enterprise Site to delete default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: HcxEnterpriseSites_Delete: $ref: ./examples/HcxEnterpriseSites_Delete.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations : get: operationId: microsoftAzureAuthorizationsList x-ms-pageable: nextLinkName: nextLink tags: - Authorizations summary: Microsoft Azure List Expressroute Circuit Authorizations In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/ExpressRouteAuthorizationList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Authorizations_List: $ref: ./examples/Authorizations_List.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName} : get: operationId: microsoftAzureAuthorizationsGet tags: - Authorizations summary: Microsoft Azure Get An Expressroute Circuit Authorization By Name In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/authorizationName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/ExpressRouteAuthorization' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Authorizations_Get: $ref: ./examples/Authorizations_Get.json description: Needs a more full description created. put: operationId: microsoftAzureAuthorizationsCreateorupdate x-ms-long-running-operation: true tags: - Authorizations summary: >- Microsoft Azure Create Or Update An Expressroute Circuit Authorization In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - name: privateCloudName in: path required: true type: string description: The name of the private cloud. - $ref: '#/parameters/authorizationName' - name: authorization description: An ExpressRoute Circuit Authorization in: body required: true schema: $ref: '#/definitions/ExpressRouteAuthorization' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/ExpressRouteAuthorization' '201': description: accepted operation schema: $ref: '#/definitions/ExpressRouteAuthorization' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Authorizations_CreateOrUpdate: $ref: ./examples/Authorizations_CreateOrUpdate.json description: Needs a more full description created. delete: operationId: microsoftAzureAuthorizationsDelete x-ms-long-running-operation: true tags: - Authorizations summary: Microsoft Azure Delete An Expressroute Circuit Authorization In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/authorizationName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. The delete has succeeded '202': description: Accepted. The delete will complete asynchronously '204': description: No Content. No ExpressRoute Circuit Authorization to delete default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Authorizations_Delete: $ref: ./examples/Authorizations_Delete.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections : get: operationId: microsoftAzureGlobalreachconnectionsList x-ms-pageable: nextLinkName: nextLink tags: - GlobalReachConnections summary: Microsoft Azure List Global Reach Connections In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/GlobalReachConnectionList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: GlobalReachConnections_List: $ref: ./examples/GlobalReachConnections_List.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName} : get: operationId: microsoftAzureGlobalreachconnectionsGet tags: - GlobalReachConnections summary: Microsoft Azure Get A Global Reach Connection By Name In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/globalReachConnectionName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/GlobalReachConnection' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: GlobalReachConnections_Get: $ref: ./examples/GlobalReachConnections_Get.json description: Needs a more full description created. put: operationId: microsoftAzureGlobalreachconnectionsCreateorupdate x-ms-long-running-operation: true tags: - GlobalReachConnections summary: Microsoft Azure Create Or Update A Global Reach Connection In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - name: privateCloudName in: path required: true type: string description: The name of the private cloud. - $ref: '#/parameters/globalReachConnectionName' - name: globalReachConnection description: A global reach connection in the private cloud in: body required: true schema: $ref: '#/definitions/GlobalReachConnection' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/GlobalReachConnection' '201': description: accepted operation schema: $ref: '#/definitions/GlobalReachConnection' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: GlobalReachConnections_CreateOrUpdate: $ref: ./examples/GlobalReachConnections_CreateOrUpdate.json description: Needs a more full description created. delete: operationId: microsoftAzureGlobalreachconnectionsDelete x-ms-long-running-operation: true tags: - GlobalReachConnections summary: Microsoft Azure Delete A Global Reach Connection In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/globalReachConnectionName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. The delete has succeeded '202': description: Accepted. The delete will complete asynchronously '204': description: No Content. No global reach connection to delete default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: GlobalReachConnections_Delete: $ref: ./examples/GlobalReachConnections_Delete.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments : get: operationId: microsoftAzureWorkloadnetworksListsegments x-ms-pageable: nextLinkName: nextLink tags: - WorkloadNetworks summary: 'Microsoft Azure List Of Segments In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkSegmentsList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_ListSegments: $ref: ./examples/WorkloadNetworks_ListSegments.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId} : get: operationId: microsoftAzureWorkloadnetworksGetsegment tags: - WorkloadNetworks summary: 'Microsoft Azure Get A Segment By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/segmentId' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkSegment' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_GetSegment: $ref: ./examples/WorkloadNetworks_GetSegments.json description: Needs a more full description created. put: operationId: microsoftAzureWorkloadnetworksCreatesegments x-ms-long-running-operation: true tags: - WorkloadNetworks summary: 'Microsoft Azure Create A Segment By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/segmentId' - name: workloadNetworkSegment description: NSX Segment in: body required: true schema: $ref: '#/definitions/WorkloadNetworkSegment' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkSegment' '201': description: accepted operation schema: $ref: '#/definitions/WorkloadNetworkSegment' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_CreateSegments: $ref: ./examples/WorkloadNetworks_CreateSegments.json description: Needs a more full description created. patch: operationId: microsoftAzureWorkloadnetworksUpdatesegments x-ms-long-running-operation: true tags: - WorkloadNetworks summary: 'Microsoft Azure Create Or Update A Segment By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/segmentId' - name: workloadNetworkSegment description: NSX Segment in: body required: true schema: $ref: '#/definitions/WorkloadNetworkSegment' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkSegment' '202': description: Accepted. The patch will complete asynchronously default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_UpdateSegments: $ref: ./examples/WorkloadNetworks_UpdateSegments.json description: Needs a more full description created. delete: operationId: microsoftAzureWorkloadnetworksDeletesegment x-ms-long-running-operation: true tags: - WorkloadNetworks summary: 'Microsoft Azure Delete A Segment By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/segmentId' responses: '200': description: OK. The delete has succeeded '202': description: Accepted. The delete will complete asynchronously '204': description: No Content. No segment to delete default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_DeleteSegment: $ref: ./examples/WorkloadNetworks_DeleteSegments.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations : get: operationId: microsoftAzureWorkloadnetworksListdhcp x-ms-pageable: nextLinkName: nextLink tags: - WorkloadNetworks summary: 'Microsoft Azure List Dhcp In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkDhcpList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_ListDhcp: $ref: ./examples/WorkloadNetworks_ListDhcpConfigurations.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId} : get: operationId: microsoftAzureWorkloadnetworksGetdhcp tags: - WorkloadNetworks summary: 'Microsoft Azure Get Dhcp By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/dhcpId' - $ref: '#/parameters/privateCloudName' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkDhcp' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_GetDhcp: $ref: ./examples/WorkloadNetworks_GetDhcpConfigurations.json description: Needs a more full description created. put: operationId: microsoftAzureWorkloadnetworksCreatedhcp x-ms-long-running-operation: true tags: - WorkloadNetworks summary: 'Microsoft Azure Create Dhcp By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/dhcpId' - name: workloadNetworkDhcp description: NSX DHCP in: body required: true schema: $ref: '#/definitions/WorkloadNetworkDhcp' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkDhcp' '201': description: accepted operation schema: $ref: '#/definitions/WorkloadNetworkDhcp' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_CreateDhcp: $ref: ./examples/WorkloadNetworks_CreateDhcpConfigurations.json description: Needs a more full description created. patch: operationId: microsoftAzureWorkloadnetworksUpdatedhcp x-ms-long-running-operation: true tags: - WorkloadNetworks summary: 'Microsoft Azure Create Or Update Dhcp By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/dhcpId' - name: workloadNetworkDhcp description: NSX DHCP in: body required: true schema: $ref: '#/definitions/WorkloadNetworkDhcp' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkDhcp' '202': description: Accepted. The patch will complete asynchronously default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_UpdateDhcp: $ref: ./examples/WorkloadNetworks_UpdateDhcpConfigurations.json description: Needs a more full description created. delete: operationId: microsoftAzureWorkloadnetworksDeletedhcp x-ms-long-running-operation: true tags: - WorkloadNetworks summary: 'Microsoft Azure Delete Dhcp By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/dhcpId' responses: '200': description: OK. The delete has succeeded '202': description: Accepted. The delete will complete asynchronously '204': description: No Content. No DHCP configuration to delete default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_DeleteDhcp: $ref: ./examples/WorkloadNetworks_DeleteDhcpConfigurations.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways : get: operationId: microsoftAzureWorkloadnetworksListgateways x-ms-pageable: nextLinkName: nextLink tags: - WorkloadNetworks summary: 'Microsoft Azure List Of Gateways In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkGatewayList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_ListGateways: $ref: ./examples/WorkloadNetworks_ListGateways.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways/{gatewayId} : get: operationId: microsoftAzureWorkloadnetworksGetgateway tags: - WorkloadNetworks summary: 'Microsoft Azure Get A Gateway By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/gatewayId' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkGateway' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_GetGateway: $ref: ./examples/WorkloadNetworks_GetGateway.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles : get: operationId: microsoftAzureWorkloadnetworksListportmirroring x-ms-pageable: nextLinkName: nextLink tags: - WorkloadNetworks summary: 'Microsoft Azure List Of Port Mirroring Profiles In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkPortMirroringList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_ListPortMirroring: $ref: ./examples/WorkloadNetworks_ListPortMirroringProfiles.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId} : get: operationId: microsoftAzureWorkloadnetworksGetportmirroring tags: - WorkloadNetworks summary: 'Microsoft Azure Get A Port Mirroring Profile By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/portMirroringId' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkPortMirroring' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_GetPortMirroring: $ref: ./examples/WorkloadNetworks_GetPortMirroringProfiles.json description: Needs a more full description created. put: operationId: microsoftAzureWorkloadnetworksCreateportmirroring x-ms-long-running-operation: true tags: - WorkloadNetworks summary: >- Microsoft Azure Create A Port Mirroring Profile By Id In A Private Cloud Workload Network parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/portMirroringId' - name: workloadNetworkPortMirroring description: NSX port mirroring in: body required: true schema: $ref: '#/definitions/WorkloadNetworkPortMirroring' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkPortMirroring' '201': description: accepted operation schema: $ref: '#/definitions/WorkloadNetworkPortMirroring' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_CreatePortMirroring: $ref: ./examples/WorkloadNetworks_CreatePortMirroringProfiles.json description: Needs a more full description created. patch: operationId: microsoftAzureWorkloadnetworksUpdateportmirroring x-ms-long-running-operation: true tags: - WorkloadNetworks summary: >- Microsoft Azure Create Or Update A Port Mirroring Profile By Id In A Private Cloud Workload Network parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/portMirroringId' - name: workloadNetworkPortMirroring description: NSX port mirroring in: body required: true schema: $ref: '#/definitions/WorkloadNetworkPortMirroring' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkPortMirroring' '202': description: Accepted. The patch will complete asynchronously default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_UpdatePortMirroring: $ref: ./examples/WorkloadNetworks_UpdatePortMirroringProfiles.json description: Needs a more full description created. delete: operationId: microsoftAzureWorkloadnetworksDeleteportmirroring x-ms-long-running-operation: true tags: - WorkloadNetworks summary: >- Microsoft Azure Delete A Port Mirroring Profile By Id In A Private Cloud Workload Network parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/portMirroringId' - $ref: '#/parameters/privateCloudName' responses: '200': description: OK. The delete has succeeded '202': description: Accepted. The delete will complete asynchronously '204': description: No Content. No port mirroring profile to delete default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_DeletePortMirroring: $ref: ./examples/WorkloadNetworks_DeletePortMirroringProfiles.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups : get: operationId: microsoftAzureWorkloadnetworksListvmgroups x-ms-pageable: nextLinkName: nextLink tags: - WorkloadNetworks summary: 'Microsoft Azure List Of Vm Groups In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkVMGroupsList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_ListVMGroups: $ref: ./examples/WorkloadNetworks_ListVMGroups.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId} : get: operationId: microsoftAzureWorkloadnetworksGetvmgroup tags: - WorkloadNetworks summary: 'Microsoft Azure Get A Vm Group By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/vmGroupId' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkVMGroup' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_GetVMGroup: $ref: ./examples/WorkloadNetworks_GetVMGroups.json description: Needs a more full description created. put: operationId: microsoftAzureWorkloadnetworksCreatevmgroup x-ms-long-running-operation: true tags: - WorkloadNetworks summary: 'Microsoft Azure Create A Vm Group By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/vmGroupId' - name: workloadNetworkVMGroup description: NSX VM Group in: body required: true schema: $ref: '#/definitions/WorkloadNetworkVMGroup' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkVMGroup' '201': description: accepted operation schema: $ref: '#/definitions/WorkloadNetworkVMGroup' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_CreateVMGroup: $ref: ./examples/WorkloadNetworks_CreateVMGroups.json description: Needs a more full description created. patch: operationId: microsoftAzureWorkloadnetworksUpdatevmgroup x-ms-long-running-operation: true tags: - WorkloadNetworks summary: 'Microsoft Azure Create Or Update A Vm Group By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/vmGroupId' - name: workloadNetworkVMGroup description: NSX VM Group in: body required: true schema: $ref: '#/definitions/WorkloadNetworkVMGroup' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkVMGroup' '202': description: Accepted. The patch will complete asynchronously default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_UpdateVMGroup: $ref: ./examples/WorkloadNetworks_UpdateVMGroups.json description: Needs a more full description created. delete: operationId: microsoftAzureWorkloadnetworksDeletevmgroup x-ms-long-running-operation: true tags: - WorkloadNetworks summary: 'Microsoft Azure Delete A Vm Group By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/vmGroupId' - $ref: '#/parameters/privateCloudName' responses: '200': description: OK. The delete has succeeded '202': description: Accepted. The delete will complete asynchronously '204': description: No Content. No VM group to delete default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_DeleteVMGroup: $ref: ./examples/WorkloadNetworks_DeleteVMGroups.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/virtualMachines : get: operationId: microsoftAzureWorkloadnetworksListvirtualmachines x-ms-pageable: nextLinkName: nextLink tags: - WorkloadNetworks summary: 'Microsoft Azure List Of Virtual Machines In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkVirtualMachinesList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_ListVirtualMachines: $ref: ./examples/WorkloadNetworks_ListVirtualMachines.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/virtualMachines/{virtualMachineId} : get: operationId: microsoftAzureWorkloadnetworksGetvirtualmachine tags: - WorkloadNetworks summary: 'Microsoft Azure Get A Virtual Machine By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/virtualMachineId' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkVirtualMachine' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_GetVirtualMachine: $ref: ./examples/WorkloadNetworks_GetVirtualMachine.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices : get: operationId: microsoftAzureWorkloadnetworksListdnsservices x-ms-pageable: nextLinkName: nextLink tags: - WorkloadNetworks summary: 'Microsoft Azure List Of Dns Services In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkDnsServicesList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_ListDnsServices: $ref: ./examples/WorkloadNetworks_ListDnsServices.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId} : get: operationId: microsoftAzureWorkloadnetworksGetdnsservice tags: - WorkloadNetworks summary: 'Microsoft Azure Get A Dns Service By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/dnsServiceId' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkDnsService' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_GetDnsService: $ref: ./examples/WorkloadNetworks_GetDnsServices.json description: Needs a more full description created. put: operationId: microsoftAzureWorkloadnetworksCreatednsservice x-ms-long-running-operation: true tags: - WorkloadNetworks summary: 'Microsoft Azure Create A Dns Service By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/dnsServiceId' - name: workloadNetworkDnsService description: NSX DNS Service in: body required: true schema: $ref: '#/definitions/WorkloadNetworkDnsService' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkDnsService' '201': description: accepted operation schema: $ref: '#/definitions/WorkloadNetworkDnsService' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_CreateDnsService: $ref: ./examples/WorkloadNetworks_CreateDnsServices.json description: Needs a more full description created. patch: operationId: microsoftAzureWorkloadnetworksUpdatednsservice x-ms-long-running-operation: true tags: - WorkloadNetworks summary: >- Microsoft Azure Create Or Update A Dns Service By Id In A Private Cloud Workload Network parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/dnsServiceId' - name: workloadNetworkDnsService description: NSX DNS Service in: body required: true schema: $ref: '#/definitions/WorkloadNetworkDnsService' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkDnsService' '202': description: Accepted. The patch will complete asynchronously default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_UpdateDnsService: $ref: ./examples/WorkloadNetworks_UpdateDnsServices.json description: Needs a more full description created. delete: operationId: microsoftAzureWorkloadnetworksDeletednsservice x-ms-long-running-operation: true tags: - WorkloadNetworks summary: 'Microsoft Azure Delete A Dns Service By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/dnsServiceId' - $ref: '#/parameters/privateCloudName' responses: '200': description: OK. The delete has succeeded '202': description: Accepted. The delete will complete asynchronously '204': description: No Content. No VM group to delete default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_DeleteDnsService: $ref: ./examples/WorkloadNetworks_DeleteDnsServices.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones : get: operationId: microsoftAzureWorkloadnetworksListdnszones x-ms-pageable: nextLinkName: nextLink tags: - WorkloadNetworks summary: 'Microsoft Azure List Of Dns Zones In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkDnsZonesList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_ListDnsZones: $ref: ./examples/WorkloadNetworks_ListDnsZones.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId} : get: operationId: microsoftAzureWorkloadnetworksGetdnszone tags: - WorkloadNetworks summary: 'Microsoft Azure Get A Dns Zone By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/dnsZoneId' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkDnsZone' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_GetDnsZone: $ref: ./examples/WorkloadNetworks_GetDnsZones.json description: Needs a more full description created. put: operationId: microsoftAzureWorkloadnetworksCreatednszone x-ms-long-running-operation: true tags: - WorkloadNetworks summary: 'Microsoft Azure Create A Dns Zone By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/dnsZoneId' - name: workloadNetworkDnsZone description: NSX DNS Zone in: body required: true schema: $ref: '#/definitions/WorkloadNetworkDnsZone' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkDnsZone' '201': description: accepted operation schema: $ref: '#/definitions/WorkloadNetworkDnsZone' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_CreateDnsZone: $ref: ./examples/WorkloadNetworks_CreateDnsZones.json description: Needs a more full description created. patch: operationId: microsoftAzureWorkloadnetworksUpdatednszone x-ms-long-running-operation: true tags: - WorkloadNetworks summary: 'Microsoft Azure Create Or Update A Dns Zone By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/dnsZoneId' - name: workloadNetworkDnsZone description: NSX DNS Zone in: body required: true schema: $ref: '#/definitions/WorkloadNetworkDnsZone' responses: '200': description: successful operation schema: $ref: '#/definitions/WorkloadNetworkDnsZone' '202': description: Accepted. The patch will complete asynchronously default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_UpdateDnsZone: $ref: ./examples/WorkloadNetworks_UpdateDnsZones.json description: Needs a more full description created. delete: operationId: microsoftAzureWorkloadnetworksDeletednszone x-ms-long-running-operation: true tags: - WorkloadNetworks summary: 'Microsoft Azure Delete A Dns Zone By Id In A Private Cloud Workload Network' parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/dnsZoneId' - $ref: '#/parameters/privateCloudName' responses: '200': description: OK. The delete has succeeded '202': description: Accepted. The delete will complete asynchronously '204': description: No Content. No VM group to delete default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: WorkloadNetworks_DeleteDnsZone: $ref: ./examples/WorkloadNetworks_DeleteDnsZones.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons : get: operationId: microsoftAzureAddonsList x-ms-pageable: nextLinkName: nextLink tags: - Addons summary: Microsoft Azure List Addons In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/AddonList' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Addons_List: $ref: ./examples/Addons_List.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName} : get: operationId: microsoftAzureAddonsGet tags: - Addons summary: Microsoft Azure Get An Addon By Name In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/addonName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/Addon' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Addons_Get: $ref: ./examples/Addons_Get.json description: Needs a more full description created. put: operationId: microsoftAzureAddonsCreateorupdate x-ms-long-running-operation: true tags: - Addons summary: Microsoft Azure Create Or Update A Addon In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - name: privateCloudName in: path required: true type: string description: The name of the private cloud. - $ref: '#/parameters/addonName' - name: addon description: A addon in the private cloud in: body required: true schema: $ref: '#/definitions/Addon' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: successful operation schema: $ref: '#/definitions/Addon' '201': description: accepted operation schema: $ref: '#/definitions/Addon' default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Addons_CreateOrUpdate: $ref: ./examples/Addons_CreateOrUpdate.json description: Needs a more full description created. delete: operationId: microsoftAzureAddonsDelete x-ms-long-running-operation: true tags: - Addons summary: Microsoft Azure Delete A Addon In A Private Cloud parameters: - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/privateCloudName' - $ref: '#/parameters/addonName' - $ref: >- ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. The delete has succeeded '202': description: Accepted. The delete will complete asynchronously '204': description: No Content. No addon to delete default: description: Error response describing why the operation failed schema: $ref: '#/definitions/CloudError' x-ms-examples: Addons_Delete: $ref: ./examples/Addons_Delete.json description: Needs a more full description created. definitions: Trial: description: Subscription trial availability properties: status: description: Trial status type: string enum: - TrialAvailable - TrialUsed - TrialDisabled readOnly: true x-ms-enum: name: TrialStatus modelAsString: true availableHosts: description: Number of trial hosts available type: integer format: int32 readOnly: true Quota: description: Subscription quotas properties: hostsRemaining: description: Remaining hosts quota by sku type type: object readOnly: true additionalProperties: type: integer format: int32 readOnly: true quotaEnabled: description: Host quota is active for current subscription type: string enum: - Enabled - Disabled readOnly: true x-ms-enum: name: QuotaEnabled modelAsString: true Resource: description: The core properties of ARM resources properties: id: description: Resource ID. readOnly: true type: string name: description: Resource name. readOnly: true type: string type: description: Resource type. readOnly: true type: string x-ms-azure-resource: true TrackedResource: description: The resource model definition for a ARM tracked top level resource allOf: - $ref: '#/definitions/Resource' properties: location: type: string description: Resource location tags: description: Resource tags $ref: '#/definitions/ResourceTags' ResourceTags: description: Resource tags type: object additionalProperties: type: string x-ms-mutability: - read - create - update ProxyResource: description: The resource model definition for a ARM proxy resource allOf: - $ref: '#/definitions/Resource' properties: {} CloudError: x-ms-external: true properties: error: description: An error returned by the API $ref: >- ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse description: API error response OperationList: description: Pageable list of operations properties: value: description: List of operations type: array readOnly: true items: $ref: '#/definitions/Operation' nextLink: description: URL to get the next page if any type: string readOnly: true Operation: description: A REST API operation type: object properties: name: description: Name of the operation being performed on this object type: string readOnly: true display: description: Contains the localized display information for this operation readOnly: true properties: provider: description: Localized friendly form of the resource provider name type: string readOnly: true resource: description: >- Localized friendly form of the resource type related to this operation type: string readOnly: true operation: description: Localized friendly name for the operation type: string readOnly: true description: description: Localized friendly description for the operation type: string readOnly: true isDataAction: description: >- Gets or sets a value indicating whether the operation is a data action or not type: boolean origin: description: Origin of the operation type: string properties: $ref: '#/definitions/OperationProperties' description: Properties of the operation OperationProperties: description: Extra Operation properties type: object properties: serviceSpecification: $ref: '#/definitions/ServiceSpecification' description: Service specifications of the operation ServiceSpecification: description: Service specification payload type: object properties: logSpecifications: description: Specifications of the Log for Azure Monitoring uniqueItems: false type: array items: $ref: '#/definitions/LogSpecification' metricSpecifications: description: Specifications of the Metrics for Azure Monitoring uniqueItems: false type: array items: $ref: '#/definitions/MetricSpecification' LogSpecification: description: Specifications of the Log for Azure Monitoring type: object properties: name: description: Name of the log type: string displayName: description: Localized friendly display name of the log type: string blobDuration: description: Blob duration of the log type: string MetricSpecification: description: Specifications of the Metrics for Azure Monitoring type: object properties: name: description: Name of the metric type: string displayName: description: Localized friendly display name of the metric type: string displayDescription: description: Localized friendly description of the metric type: string unit: description: Unit that makes sense for the metric type: string category: description: >- Name of the metric category that the metric belongs to. A metric can only belong to a single category. type: string aggregationType: description: >- Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count. type: string supportedAggregationTypes: description: Supported aggregation types uniqueItems: false type: array items: type: string supportedTimeGrainTypes: description: Supported time grain types uniqueItems: false type: array items: type: string fillGapWithZero: description: >- Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. type: boolean dimensions: description: Dimensions of the metric uniqueItems: false type: array items: $ref: '#/definitions/MetricDimension' enableRegionalMdmAccount: description: Whether or not the service is using regional MDM accounts. type: string sourceMdmAccount: description: The name of the MDM account. type: string sourceMdmNamespace: description: The name of the MDM namespace. type: string MetricDimension: description: Specifications of the Dimension of metrics type: object properties: name: description: Name of the dimension type: string displayName: description: Localized friendly display name of the dimension type: string internalName: description: Name of the dimension as it appears in MDM type: string toBeExportedForShoebox: description: >- A boolean flag indicating whether this dimension should be included for the shoebox export scenario type: boolean ExpressRouteAuthorization: description: ExpressRoute Circuit Authorization allOf: - $ref: '#/definitions/Resource' properties: properties: description: The properties of an ExpressRoute Circuit Authorization resource $ref: '#/definitions/ExpressRouteAuthorizationProperties' x-ms-client-flatten: true readOnly: true ExpressRouteAuthorizationProperties: description: The properties of an ExpressRoute Circuit Authorization resource properties: provisioningState: description: The state of the ExpressRoute Circuit Authorization provisioning type: string readOnly: true enum: - Succeeded - Failed - Updating x-ms-enum: name: ExpressRouteAuthorizationProvisioningState modelAsString: true expressRouteAuthorizationId: description: The ID of the ExpressRoute Circuit Authorization type: string readOnly: true expressRouteAuthorizationKey: description: The key of the ExpressRoute Circuit Authorization type: string readOnly: true ExpressRouteAuthorizationList: description: A paged list of ExpressRoute Circuit Authorizations properties: value: description: The items on a page type: array readOnly: true items: $ref: '#/definitions/ExpressRouteAuthorization' nextLink: description: URL to get the next page if any type: string readOnly: true Circuit: description: An ExpressRoute Circuit properties: primarySubnet: type: string readOnly: true description: CIDR of primary subnet secondarySubnet: type: string readOnly: true description: CIDR of secondary subnet expressRouteID: type: string readOnly: true description: Identifier of the ExpressRoute Circuit (Microsoft Colo only) expressRoutePrivatePeeringID: type: string readOnly: true description: ExpressRoute Circuit private peering identifier Endpoints: description: Endpoint addresses properties: nsxtManager: description: Endpoint for the NSX-T Data Center manager type: string readOnly: true vcsa: description: Endpoint for Virtual Center Server Appliance type: string readOnly: true hcxCloudManager: description: Endpoint for the HCX Cloud Manager type: string readOnly: true IdentitySource: description: vCenter Single Sign On Identity Source properties: name: description: The name of the identity source type: string alias: description: The domain's NetBIOS name type: string domain: description: The domain's dns name type: string baseUserDN: description: The base distinguished name for users type: string baseGroupDN: description: The base distinguished name for groups type: string primaryServer: description: Primary server URL type: string secondaryServer: description: Secondary server URL type: string ssl: description: Protect LDAP communication using SSL certificate (LDAPS) type: string enum: - Enabled - Disabled x-ms-enum: name: SslEnum modelAsString: true username: description: >- The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group type: string password: description: >- The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups. type: string x-ms-secret: true PrivateCloud: description: A private cloud resource required: - location - sku allOf: - $ref: '#/definitions/TrackedResource' properties: sku: description: The private cloud SKU $ref: '#/definitions/Sku' properties: description: The properties of a private cloud resource $ref: '#/definitions/PrivateCloudProperties' x-ms-client-flatten: true PrivateCloudUpdate: description: An update to a private cloud resource properties: tags: description: Resource tags $ref: '#/definitions/ResourceTags' properties: description: The updatable properties of a private cloud resource $ref: '#/definitions/PrivateCloudUpdateProperties' x-ms-client-flatten: true PrivateCloudUpdateProperties: description: The properties of a private cloud resource that may be updated properties: managementCluster: description: The default cluster used for management $ref: '#/definitions/ManagementCluster' internet: description: Connectivity to internet is enabled or disabled type: string enum: - Enabled - Disabled default: Disabled x-ms-enum: name: InternetEnum modelAsString: true identitySources: description: vCenter Single Sign On Identity Sources type: array items: $ref: '#/definitions/IdentitySource' PrivateCloudProperties: description: The properties of a private cloud resource required: - managementCluster - networkBlock allOf: - $ref: '#/definitions/PrivateCloudUpdateProperties' properties: provisioningState: description: The provisioning state type: string readOnly: true enum: - Succeeded - Failed - Cancelled - Pending - Building - Deleting - Updating x-ms-enum: name: PrivateCloudProvisioningState modelAsString: true circuit: description: An ExpressRoute Circuit $ref: '#/definitions/Circuit' endpoints: description: The endpoints readOnly: true $ref: '#/definitions/Endpoints' networkBlock: description: >- The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22 type: string managementNetwork: description: Network used to access vCenter Server and NSX-T Manager type: string readOnly: true provisioningNetwork: description: >- Used for virtual machine cold migration, cloning, and snapshot migration type: string readOnly: true vmotionNetwork: description: Used for live migration of virtual machines type: string readOnly: true vcenterPassword: description: >- Optionally, set the vCenter admin password when the private cloud is created type: string x-ms-secret: true nsxtPassword: description: >- Optionally, set the NSX-T Manager password when the private cloud is created type: string x-ms-secret: true vcenterCertificateThumbprint: description: Thumbprint of the vCenter Server SSL certificate type: string readOnly: true nsxtCertificateThumbprint: description: Thumbprint of the NSX-T Manager SSL certificate type: string readOnly: true Cluster: description: A cluster resource required: - sku allOf: - $ref: '#/definitions/Resource' properties: sku: description: The cluster SKU $ref: '#/definitions/Sku' properties: description: The properties of a cluster resource $ref: '#/definitions/ClusterProperties' x-ms-client-flatten: true ClusterUpdate: description: An update of a cluster resource properties: properties: description: The properties of a cluster resource that may be updated $ref: '#/definitions/ClusterUpdateProperties' x-ms-client-flatten: true ClusterUpdateProperties: description: The properties of a cluster that may be updated properties: clusterSize: description: The cluster size type: integer format: int32 CommonClusterProperties: description: The common properties of a cluster properties: provisioningState: description: The state of the cluster provisioning type: string readOnly: true enum: - Succeeded - Failed - Cancelled - Deleting - Updating x-ms-enum: name: ClusterProvisioningState modelAsString: true clusterSize: description: The cluster size type: integer format: int32 clusterId: description: The identity type: integer format: int32 readOnly: true hosts: description: The hosts type: array readOnly: true items: type: string ManagementCluster: description: The properties of a management cluster required: - clusterSize allOf: - $ref: '#/definitions/CommonClusterProperties' ClusterProperties: description: The properties of a cluster allOf: - $ref: '#/definitions/CommonClusterProperties' properties: {} PrivateCloudList: description: A paged list of private clouds properties: value: description: The items on the page type: array readOnly: true items: $ref: '#/definitions/PrivateCloud' nextLink: description: URL to get the next page if any type: string readOnly: true ClusterList: description: A paged list of clusters properties: value: description: The items on a page type: array readOnly: true items: $ref: '#/definitions/Cluster' nextLink: description: URL to get the next page if any type: string readOnly: true Addon: description: An addon resource allOf: - $ref: '#/definitions/Resource' properties: properties: description: The properties of an addon resource $ref: '#/definitions/AddonProperties' x-ms-client-flatten: true AddonUpdate: description: An update of an addon resource properties: properties: description: The properties of an addon resource that may be updated $ref: '#/definitions/AddonUpdateProperties' x-ms-client-flatten: true AddonUpdateProperties: description: The properties of an addon that may be updated properties: properties: description: reference specific properties definition for addon type being used $ref: '#/definitions/AddonProperties' x-ms-client-flatten: true AddonProperties: description: The properties of an addon that may be updated allOf: - $ref: '#/definitions/AddonSrmProperties' properties: addonType: description: The type of private cloud addon type: string enum: - SRM - VR x-ms-enum: name: AddonType modelAsString: true provisioningState: description: The state of the addon provisioning type: string readOnly: true enum: - Succeeded - Failed - Cancelled - Deleting - Updating x-ms-enum: name: AddonProvisioningState modelAsString: true AddonSrmProperties: description: The properties of an SRM addon that may be updated properties: licenseKey: description: The SRM license type: string AddonList: description: A paged list of addons properties: value: description: The items on a page type: array readOnly: true items: $ref: '#/definitions/Addon' nextLink: description: URL to get the next page if any type: string readOnly: true AdminCredentials: description: Administrative credentials for accessing vCenter and NSX-T properties: nsxtUsername: description: NSX-T Manager username type: string readOnly: true nsxtPassword: description: NSX-T Manager password type: string readOnly: true x-ms-secret: true vcenterUsername: description: vCenter admin username type: string readOnly: true vcenterPassword: description: vCenter admin password type: string readOnly: true x-ms-secret: true Sku: description: The resource model definition representing SKU properties: name: type: string description: The name of the SKU. required: - name HcxEnterpriseSiteList: description: A paged list of HCX Enterprise Sites properties: value: description: The items on a page type: array readOnly: true items: $ref: '#/definitions/HcxEnterpriseSite' nextLink: description: URL to get the next page if any type: string readOnly: true HcxEnterpriseSite: description: An HCX Enterprise Site resource allOf: - $ref: '#/definitions/Resource' properties: properties: description: The properties of an HCX Enterprise Site resource $ref: '#/definitions/HcxEnterpriseSiteProperties' x-ms-client-flatten: true readOnly: true HcxEnterpriseSiteProperties: description: The properties of an HCX Enterprise Site properties: activationKey: description: The activation key type: string readOnly: true status: description: The status of the HCX Enterprise Site type: string readOnly: true enum: - Available - Consumed - Deactivated - Deleted x-ms-enum: name: HcxEnterpriseSiteStatus modelAsString: true GlobalReachConnectionList: description: A paged list of global reach connections properties: value: description: The items on a page type: array readOnly: true items: $ref: '#/definitions/GlobalReachConnection' nextLink: description: URL to get the next page if any type: string readOnly: true GlobalReachConnection: description: A global reach connection resource allOf: - $ref: '#/definitions/Resource' properties: properties: description: The properties of a global reach connection resource $ref: '#/definitions/GlobalReachConnectionProperties' x-ms-client-flatten: true GlobalReachConnectionProperties: description: The properties of a global reach connection properties: provisioningState: description: The state of the ExpressRoute Circuit Authorization provisioning type: string readOnly: true enum: - Succeeded - Failed - Updating x-ms-enum: name: GlobalReachConnectionProvisioningState modelAsString: true addressPrefix: description: >- The network used for global reach carved out from the original network block provided for the private cloud type: string readOnly: true authorizationKey: description: >- Authorization key from the peer express route used for the global reach connection type: string circuitConnectionStatus: description: The connection status of the global reach connection type: string readOnly: true enum: - Connected - Connecting - Disconnected x-ms-enum: name: GlobalReachConnectionStatus modelAsString: true peerExpressRouteCircuit: type: string description: >- Identifier of the ExpressRoute Circuit to peer with in the global reach connection WorkloadNetworkSegmentSubnet: description: Subnet configuration for segment properties: dhcpRanges: description: DHCP Range assigned for subnet. type: array items: type: string gatewayAddress: description: Gateway address. type: string WorkloadNetworkSegmentPortVif: description: Ports and any VIF attached to segment. properties: portName: description: Name of port or VIF attached to segment. type: string WorkloadNetworkSegmentProperties: description: NSX Segment Properties properties: displayName: description: Display name of the segment. type: string connectedGateway: description: Gateway which to connect segment to. type: string subnet: description: Subnet which to connect segment to. $ref: '#/definitions/WorkloadNetworkSegmentSubnet' portVif: description: Port Vif which segment is associated with. type: array items: $ref: '#/definitions/WorkloadNetworkSegmentPortVif' readOnly: true status: description: Segment status. type: string enum: - SUCCESS, FAILURE x-ms-enum: name: SegmentStatusEnum modelAsString: true readOnly: true provisioningState: description: The provisioning state type: string readOnly: true enum: - Succeeded - Failed - Building - Deleting - Updating x-ms-enum: name: WorkloadNetworkSegmentProvisioningState modelAsString: true revision: description: NSX revision number. type: integer format: int64 WorkloadNetworkSegment: description: NSX Segment allOf: - $ref: '#/definitions/ProxyResource' properties: properties: description: The properties of a Workload Segment proxy resource. $ref: '#/definitions/WorkloadNetworkSegmentProperties' x-ms-client-flatten: true WorkloadNetworkSegmentsList: description: A list of NSX Segments properties: value: description: The items on the page type: array readOnly: true items: $ref: '#/definitions/WorkloadNetworkSegment' nextLink: description: URL to get the next page if any type: string readOnly: true WorkloadNetworkDhcpEntity: description: >- Base class for WorkloadNetworkDhcpServer and WorkloadNetworkDhcpRelay to inherit from discriminator: dhcpType properties: dhcpType: description: 'Type of DHCP: SERVER or RELAY.' type: string enum: - SERVER, RELAY x-ms-enum: name: DhcpTypeEnum modelAsString: true displayName: description: Display name of the DHCP entity. type: string segments: description: NSX Segments consuming DHCP. type: array items: type: string readOnly: true provisioningState: description: The provisioning state type: string readOnly: true enum: - Succeeded - Failed - Building - Deleting - Updating x-ms-enum: name: WorkloadNetworkDhcpProvisioningState modelAsString: true revision: description: NSX revision number. type: integer format: int64 required: - dhcpType WorkloadNetworkDhcpServer: description: NSX DHCP Server x-ms-discriminator-value: SERVER allOf: - $ref: '#/definitions/WorkloadNetworkDhcpEntity' properties: serverAddress: description: DHCP Server Address. type: string leaseTime: description: DHCP Server Lease Time. type: integer format: int64 WorkloadNetworkDhcpRelay: description: NSX DHCP Relay x-ms-discriminator-value: RELAY allOf: - $ref: '#/definitions/WorkloadNetworkDhcpEntity' properties: serverAddresses: description: DHCP Relay Addresses. Max 3. type: array items: type: string minItems: 1 maxItems: 3 WorkloadNetworkDhcp: description: NSX DHCP allOf: - $ref: '#/definitions/ProxyResource' properties: properties: description: DHCP properties. $ref: '#/definitions/WorkloadNetworkDhcpEntity' x-ms-client-flatten: true WorkloadNetworkDhcpList: description: A list of NSX dhcp entities properties: value: description: The items on the page type: array readOnly: true items: $ref: '#/definitions/WorkloadNetworkDhcp' nextLink: description: URL to get the next page if any type: string readOnly: true WorkloadNetworkPortMirroringProperties: description: NSX Port Mirroring Properties properties: displayName: description: Display name of the port mirroring profile. type: string direction: description: Direction of port mirroring profile. type: string enum: - INGRESS, EGRESS, BIDIRECTIONAL x-ms-enum: name: PortMirroringDirectionEnum modelAsString: true source: description: Source VM Group. type: string destination: description: Destination VM Group. type: string status: description: Port Mirroring Status. type: string enum: - SUCCESS, FAILURE x-ms-enum: name: PortMirroringStatusEnum modelAsString: true readOnly: true provisioningState: description: The provisioning state type: string readOnly: true enum: - Succeeded - Failed - Building - Deleting - Updating x-ms-enum: name: WorkloadNetworkPortMirroringProvisioningState modelAsString: true revision: description: NSX revision number. type: integer format: int64 WorkloadNetworkPortMirroring: description: NSX Port Mirroring allOf: - $ref: '#/definitions/ProxyResource' properties: properties: description: Port Mirroring Properties. $ref: '#/definitions/WorkloadNetworkPortMirroringProperties' x-ms-client-flatten: true WorkloadNetworkPortMirroringList: description: A list of NSX Port Mirroring properties: value: description: The items on the page type: array readOnly: true items: $ref: '#/definitions/WorkloadNetworkPortMirroring' nextLink: description: URL to get the next page if any type: string readOnly: true WorkloadNetworkVMGroupProperties: description: NSX VM Group Properties properties: displayName: description: Display name of the VM group. type: string members: description: Virtual machine members of this group. type: array items: type: string status: description: VM Group status. type: string enum: - SUCCESS, FAILURE x-ms-enum: name: VMGroupStatusEnum modelAsString: true readOnly: true provisioningState: description: The provisioning state type: string readOnly: true enum: - Succeeded - Failed - Building - Deleting - Updating x-ms-enum: name: WorkloadNetworkVMGroupProvisioningState modelAsString: true revision: description: NSX revision number. type: integer format: int64 WorkloadNetworkVMGroup: description: NSX VM Group allOf: - $ref: '#/definitions/ProxyResource' properties: properties: description: VM Group properties. $ref: '#/definitions/WorkloadNetworkVMGroupProperties' x-ms-client-flatten: true WorkloadNetworkVMGroupsList: description: A list of NSX VM Groups properties: value: description: The items on the page type: array readOnly: true items: $ref: '#/definitions/WorkloadNetworkVMGroup' nextLink: description: URL to get the next page if any type: string readOnly: true WorkloadNetworkVirtualMachineProperties: description: NSX Virtual Machine Properties properties: displayName: description: Display name of the VM. type: string vmType: description: Virtual machine type. type: string enum: - REGULAR, EDGE, SERVICE x-ms-enum: name: VMTypeEnum modelAsString: true readOnly: true WorkloadNetworkVirtualMachine: description: NSX Virtual Machine allOf: - $ref: '#/definitions/ProxyResource' properties: properties: description: Virtual machine properties. $ref: '#/definitions/WorkloadNetworkVirtualMachineProperties' x-ms-client-flatten: true WorkloadNetworkVirtualMachinesList: description: A list of NSX Virtual Machines properties: value: description: The items on the page type: array readOnly: true items: $ref: '#/definitions/WorkloadNetworkVirtualMachine' nextLink: description: URL to get the next page if any type: string readOnly: true WorkloadNetworkGatewayProperties: description: Properties of a NSX Gateway. properties: displayName: description: Display name of the DHCP entity. type: string path: description: NSX Gateway Path. type: string readOnly: true WorkloadNetworkGateway: description: NSX Gateway. allOf: - $ref: '#/definitions/ProxyResource' properties: properties: description: Gateway properties. $ref: '#/definitions/WorkloadNetworkGatewayProperties' x-ms-client-flatten: true WorkloadNetworkGatewayList: description: A list of NSX Gateways properties: value: description: The items on the page type: array readOnly: true items: $ref: '#/definitions/WorkloadNetworkGateway' nextLink: description: URL to get the next page if any type: string readOnly: true WorkloadNetworkDnsServiceProperties: description: NSX DNS Service Properties properties: displayName: description: Display name of the DNS Service. type: string dnsServiceIp: description: DNS service IP of the DNS Service. type: string defaultDnsZone: description: Default DNS zone of the DNS Service. type: string fqdnZones: description: FQDN zones of the DNS Service. type: array items: type: string logLevel: description: DNS Service log level. type: string enum: - DEBUG - INFO - WARNING - ERROR - FATAL x-ms-enum: name: DnsServiceLogLevelEnum modelAsString: true status: description: DNS Service status. type: string enum: - SUCCESS - FAILURE x-ms-enum: name: DnsServiceStatusEnum modelAsString: true readOnly: true provisioningState: description: The provisioning state type: string readOnly: true enum: - Succeeded - Failed - Building - Deleting - Updating x-ms-enum: name: WorkloadNetworkDnsServiceProvisioningState modelAsString: true revision: description: NSX revision number. type: integer format: int64 WorkloadNetworkDnsService: description: NSX DNS Service allOf: - $ref: '#/definitions/ProxyResource' properties: properties: description: DNS Service properties $ref: '#/definitions/WorkloadNetworkDnsServiceProperties' x-ms-client-flatten: true WorkloadNetworkDnsServicesList: description: A list of NSX DNS Services properties: value: description: The items on the page type: array readOnly: true items: $ref: '#/definitions/WorkloadNetworkDnsService' nextLink: description: URL to get the next page if any type: string readOnly: true WorkloadNetworkDnsZoneProperties: description: NSX DNS Zone Properties properties: displayName: description: Display name of the DNS Zone. type: string domain: description: Domain names of the DNS Zone. type: array items: type: string dnsServerIps: description: DNS Server IP array of the DNS Zone. type: array items: type: string sourceIp: description: Source IP of the DNS Zone. type: string dnsServices: description: Number of DNS Services using the DNS zone. type: integer format: int64 provisioningState: description: The provisioning state type: string readOnly: true enum: - Succeeded - Failed - Building - Deleting - Updating x-ms-enum: name: WorkloadNetworkDnsZoneProvisioningState modelAsString: true revision: description: NSX revision number. type: integer format: int64 WorkloadNetworkDnsZone: description: NSX DNS Zone allOf: - $ref: '#/definitions/ProxyResource' properties: properties: description: DNS Zone properties $ref: '#/definitions/WorkloadNetworkDnsZoneProperties' x-ms-client-flatten: true WorkloadNetworkDnsZonesList: description: A list of NSX DNS Zones properties: value: description: The items on the page type: array readOnly: true items: $ref: '#/definitions/WorkloadNetworkDnsZone' nextLink: description: URL to get the next page if any type: string readOnly: true