swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector WorkloadNetworks API
schemes:
- https
tags:
- name: WorkloadNetworks
  description: ''
paths:
  ? /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.
definitions:
  ProxyResource:
    description: The resource model definition for a ARM proxy resource
    allOf:
    - $ref: '#/definitions/Resource'
    properties: {}
  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
  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
  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
  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
  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
  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
  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
  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
  WorkloadNetworkVirtualMachine:
    description: NSX Virtual Machine
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      properties:
        description: Virtual machine properties.
        $ref: '#/definitions/WorkloadNetworkVirtualMachineProperties'
        x-ms-client-flatten: 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
  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
  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
  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
  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
  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
  WorkloadNetworkPortMirroring:
    description: NSX Port Mirroring
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      properties:
        description: Port Mirroring Properties.
        $ref: '#/definitions/WorkloadNetworkPortMirroringProperties'
        x-ms-client-flatten: true
  WorkloadNetworkDhcp:
    description: NSX DHCP
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      properties:
        description: DHCP properties.
        $ref: '#/definitions/WorkloadNetworkDhcpEntity'
        x-ms-client-flatten: 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
  WorkloadNetworkDnsZone:
    description: NSX DNS Zone
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      properties:
        description: DNS Zone properties
        $ref: '#/definitions/WorkloadNetworkDnsZoneProperties'
        x-ms-client-flatten: true
  WorkloadNetworkDnsService:
    description: NSX DNS Service
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      properties:
        description: DNS Service properties
        $ref: '#/definitions/WorkloadNetworkDnsServiceProperties'
        x-ms-client-flatten: true
  WorkloadNetworkGateway:
    description: NSX Gateway.
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      properties:
        description: Gateway properties.
        $ref: '#/definitions/WorkloadNetworkGatewayProperties'
        x-ms-client-flatten: true
  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
  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
  WorkloadNetworkSegmentPortVif:
    description: Ports and any VIF attached to segment.
    properties:
      portName:
        description: Name of port or VIF attached to segment.
        type: string
  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
  WorkloadNetworkVMGroup:
    description: NSX VM Group
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      properties:
        description: VM Group properties.
        $ref: '#/definitions/WorkloadNetworkVMGroupProperties'
        x-ms-client-flatten: 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
parameters:
  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
  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
  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
  virtualMachineId:
    name: virtualMachineId
    in: path
    required: true
    type: string
    description: NSX Virtual Machine identifier.
    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
  privateCloudName:
    name: privateCloudName
    in: path
    required: true
    type: string
    description: Name of the private cloud
    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
  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
  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
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'