Microsoft Azure
Microsoft Azure PrivateClouds API

The PrivateClouds API from Microsoft Azure — 8 operation(s) for privateclouds.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector PrivateClouds API
schemes:
- https
tags:
- name: PrivateClouds
  description: ''
paths:
  /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}/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}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds:
    get:
      description: Returns list of private clouds in particular region
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - PrivateClouds
      summary: Microsoft Azure Implements Private Cloud List Get Method
      operationId: microsoftAzurePrivatecloudsList
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/regionId'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/PrivateCloudList_2'
        default:
          description: General Error
          schema:
            $ref: '#/definitions/CSRPError'
      x-ms-examples:
        ListPrivateCloudInLocation:
          $ref: ./examples/ListPrivateCloudInLocation.json
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}:
    get:
      description: Returns private cloud by its name
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - PrivateClouds
      summary: Microsoft Azure Implements Private Cloud Get Method
      operationId: microsoftAzurePrivatecloudsGet
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/pcName'
      - $ref: '#/parameters/regionId'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/PrivateCloud_2'
        default:
          description: General Error
          schema:
            $ref: '#/definitions/CSRPError'
      x-ms-examples:
        GetPrivateCloud:
          $ref: ./examples/GetPrivateCloud.json
definitions:
  PrivateCloudList_2:
    description: List of private clouds
    properties:
      nextLink:
        description: Link for next list of Private Clouds
        type: string
      value:
        description: the list of private clouds
        type: array
        items:
          $ref: '#/definitions/PrivateCloud_2'
  ResourcePool:
    description: Resource pool model
    required:
    - id
    properties:
      id:
        description: resource pool id (privateCloudId:vsphereId)
        type: string
      location:
        description: Azure region
        type: string
        readOnly: true
      name:
        description: '{ResourcePoolName}'
        type: string
        readOnly: true
      privateCloudId:
        description: The Private Cloud Id
        type: string
        readOnly: true
      properties:
        description: Resource pool properties
        x-ms-client-flatten: true
        $ref: '#/definitions/ResourcePoolProperties'
      type:
        description: '{resourceProviderNamespace}/{resourceType}'
        type: string
        readOnly: true
  PrivateCloud_2:
    description: Private cloud model
    properties:
      id:
        description: Azure Id, e.g. "/subscriptions/4da99247-a172-4ed6-8ae9-ebed2d12f839/providers/Microsoft.VMwareCloudSimple/privateClouds/cloud123"
        type: string
      location:
        description: Location where private cloud created, e.g "westus"
        type: string
      name:
        description: Private cloud name
        type: string
      properties:
        description: Private cloud properties
        x-ms-client-flatten: true
        $ref: '#/definitions/PrivateCloudProperties_2'
      type:
        description: Azure Resource type
        type: string
        enum:
        - Microsoft.VMwareCloudSimple/privateClouds
        x-ms-enum:
          modelAsString: false
          name: PrivateCloudResourceType
  VirtualMachineTemplate:
    description: Virtual machine template model
    properties:
      id:
        description: virtual machine template id (privateCloudId:vsphereId)
        type: string
        readOnly: true
      location:
        description: Azure region
        type: string
      name:
        description: '{virtualMachineTemplateName}'
        type: string
        readOnly: true
      properties:
        description: The Virtual Machine Template properties
        x-ms-client-flatten: true
        $ref: '#/definitions/VirtualMachineTemplateProperties'
      type:
        description: '{resourceProviderNamespace}/{resourceType}'
        type: string
        readOnly: true
  Sku:
    description: The resource model definition representing SKU
    properties:
      name:
        type: string
        description: The name of the SKU.
    required:
    - name
  VirtualNic:
    description: Virtual NIC model
    required:
    - nicType
    - network
    properties:
      customization:
        description: guest OS customization for nic
        $ref: '#/definitions/GuestOSNICCustomization'
      ipAddresses:
        description: NIC ip address
        type: array
        items:
          type: string
      macAddress:
        description: NIC MAC address
        type: string
      network:
        description: Virtual Network
        $ref: '#/definitions/VirtualNetwork'
      nicType:
        description: NIC type
        type: string
        enum:
        - E1000
        - E1000E
        - PCNET32
        - VMXNET
        - VMXNET2
        - VMXNET3
        x-ms-enum:
          modelAsString: false
          name: NICType
      powerOnBoot:
        description: Is NIC powered on/off on boot
        type: boolean
      virtualNicId:
        description: NIC id
        type: string
      virtualNicName:
        description: NIC name
        type: string
        readOnly: true
  GuestOSNICCustomization:
    description: Guest OS nic customization
    properties:
      allocation:
        description: IP address allocation method
        type: string
        enum:
        - static
        - dynamic
      dnsServers:
        description: List of dns servers to use
        type: array
        items:
          $ref: '#/definitions/IPV4Address'
      gateway:
        description: Gateway addresses assigned to nic
        type: array
        items:
          $ref: '#/definitions/IPV4Address'
      ipAddress:
        description: Static ip address for nic
        $ref: '#/definitions/IPV4Address'
      mask:
        description: Network mask for nic
        $ref: '#/definitions/IPV4Address'
      primaryWinsServer:
        description: primary WINS server for Windows
        $ref: '#/definitions/IPV4Address'
      secondaryWinsServer:
        description: secondary WINS server for Windows
        $ref: '#/definitions/IPV4Address'
  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
  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
  CSRPErrorBody:
    description: Error properties
    properties:
      code:
        description: Error's code
        type: string
        readOnly: true
      details:
        description: Error's details
        type: array
        items:
          $ref: '#/definitions/CSRPErrorBody'
        x-ms-identifiers: []
        readOnly: true
      message:
        description: Error's message
        type: string
        readOnly: true
      target:
        description: Error's target
        type: string
  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
  VirtualNetworkProperties:
    description: Properties of virtual network
    properties:
      privateCloudId:
        description: The Private Cloud id
        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
  VirtualMachineTemplateProperties:
    description: Properties of virtual machine template
    required:
    - privateCloudId
    properties:
      amountOfRam:
        description: The amount of memory
        type: integer
      controllers:
        description: The list of Virtual Disk Controllers
        type: array
        items:
          $ref: '#/definitions/VirtualDiskController'
      description:
        description: The description of Virtual Machine Template
        type: string
      disks:
        description: The list of Virtual Disks
        type: array
        items:
          $ref: '#/definitions/VirtualDisk'
        x-ms-identifiers:
        - virtualDiskId
      exposeToGuestVM:
        description: Expose Guest OS or not
        type: boolean
      guestOS:
        description: The Guest OS
        type: string
        readOnly: true
      guestOSType:
        description: The Guest OS types
        type: string
        readOnly: true
      nics:
        description: The list of Virtual NICs
        type: array
        items:
          $ref: '#/definitions/VirtualNic'
        x-ms-identifiers:
        - virtualNicId
      numberOfCores:
        description: The number of CPU cores
        type: integer
      path:
        description: path to folder
        type: string
        example: Datacenter/Workload VMs
      privateCloudId:
        description: The Private Cloud Id
        type: string
      vSphereNetworks:
        description: The list of VSphere networks
        type: array
        items:
          type: string
      vSphereTags:
        description: The tags from VSphere
        type: array
        items:
          type: string
      vmwaretools:
        description: The VMware tools version
        type: string
        readOnly: true
  ManagementCluster:
    description: The properties of a management cluster
    required:
    - clusterSize
    allOf:
    - $ref: '#/definitions/CommonClusterProperties'
  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'
  CSRPError:
    description: General error model
    properties:
      error:
        description: Error's body
        $ref: '#/definitions/CSRPErrorBody'
  VirtualDiskController:
    description: Virtual disk controller model
    properties:
      id:
        description: Controller's id
        type: string
        readOnly: true
      name:
        description: The display name of Controller
        type: string
        readOnly: true
      subType:
        description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS)
        type: string
        readOnly: true
      type:
        description: disk controller type (SCSI)
        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
  VirtualDisk:
    description: Virtual disk model
    required:
    - totalSize
    - independenceMode
    - controllerId
    properties:
      controllerId:
        description: Disk's Controller id
        type: string
      independenceMode:
        description: Disk's independence mode type
        type: string
        enum:
        - persistent
        - independent_persistent
        - independent_nonpersistent
        x-ms-enum:
          modelAsString: false
          name: DiskIndependenceMode
      totalSize:
        description: Disk's total size
        type: integer
      virtualDiskId:
        description: Disk's id
        type: string
      virtualDiskName:
        description: Disk's display name
        type: string
        readOnly: 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
  PrivateCloudProperties_2:
    description: Properties of private
    properties:
      availabilityZoneId:
        description: Availability Zone id, e.g. "az1"
        type: string
      availabilityZoneName:
        description: Availability Zone name, e.g. "Availability Zone 1"
        type: string
      clustersNumber:
        description: Number of clusters
        type: integer
      createdBy:
        description: User's emails who created cloud
        type: string
      createdOn:
        description: When private cloud was created
        type: string
        format: date-time
      dnsServers:
        description: Array of DNS servers
        type: array
        items:
          type: string
      expires:
        description: Expiration date of PC
        type: string
      nsxType:
        description: Nsx Type, e.g. "Advanced"
        type: string
      placementGroupId:
        description: Placement Group id, e.g. "n1"
        type: string
      placementGroupName:
        description: Placement Group name
        type: string
      privateCloudId:
        description: Id of a private cloud
        type: string
        format: uuid
      resourcePools:
        description: The list of Resource Pools
        type: array
        items:
          $ref: '#/definitions/ResourcePool'
      state:
        description: Private Cloud state, e.g. "operational"
        type: string
      totalCpuCores:
        description: Number of cores
        type: integer
      totalNodes:
        description: Number of nodes
        type: integer
      totalRam:
        description: Memory size
        type: integer
      totalStorage:
        description: Disk space in TB
        type: number
      type:
        description: Virtualization type e.g. "vSphere"
        type: string
      vSphereVersion:
        description: e.g. "6.5u2"
        type: string
      vcenterFqdn:
        description: FQDN for vcenter access
        type: string
      vcenterRefid:
        description: Vcenter ip address
        type: string
      virtualMachineTemplates:
        description: The list of Virtual Machine Templates
        type: array
        items:
          $ref: '#/definitions/VirtualMachineTemplate'
      virtualNetworks:
        description: The list of Virtual Networks
        type: array
        items:
          $ref: '#/definitions/VirtualNetwork'
      vrOpsEnabled:
        description: Is vRealize Operations Manager enabled/disabled
        type: boolean
  VirtualNetwork:
    description: Virtual network model
    required:
    - id
    properties:
      assignable:
        description: can be used in vm creation/deletion
        type: boolean
        readOnly: true
      id:
        description: virtual network id (privateCloudId:vsphereId)
        type: string
      location:
        description: Azure region
        type: string
        readOnly: true
      name:
        description: '{VirtualNetworkName}'
        type: string
        readOnly: true
      properties:
        description: Virtual Network properties
        x-ms-client-flatten: true
        $ref: '#/definitions/VirtualNetworkProperties'
      type:
        description: '{resourceProviderNamespace}/{resourceType}'
        type: string
        readOnly: true
  ResourceTags:
    description: Resource tags
    type: object
    additionalProperties:
      type: string
    x-ms-mutability:
    - read
    - create
    - update
  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
  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
  IPV4Address:
    type: string
    pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])[.]){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
  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
  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 

# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-privateclouds-api-openapi.yml
Microsoft Azure PrivateClouds API

Documentation

Specifications

Other Resources

OpenAPI Specification
