---
title: "Implements private cloud GET method"
method: GET
path: "/subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}"
tags: ["PrivateClouds"]
---

# Implements private cloud GET method

`GET /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}`

Returns private cloud by its name

## Path parameters

- `subscriptionId` string, required
- `pcName` string, required
- `regionId` string, required

## Query parameters

- `api-version` string, required

## Response `200`

successful operation

- PrivateCloud — Private cloud model
  - `id` string — Azure Id, e.g. "/subscriptions/4da99247-a172-4ed6-8ae9-ebed2d12f839/providers/Microsoft.VMwareCloudSimple/privateClouds/cloud123"
  - `location` string — Location where private cloud created, e.g "westus"
  - `name` string — Private cloud name
  - `properties` PrivateCloudProperties — Properties of private
    - `availabilityZoneId` string — Availability Zone id, e.g. "az1"
    - `availabilityZoneName` string — Availability Zone name, e.g. "Availability Zone 1"
    - `clustersNumber` integer — Number of clusters
    - `createdBy` string — User's emails who created cloud
    - `createdOn` string, date-time — When private cloud was created
    - `dnsServers` string[] — Array of DNS servers
    - `expires` string — Expiration date of PC
    - `nsxType` string — Nsx Type, e.g. "Advanced"
    - `placementGroupId` string — Placement Group id, e.g. "n1"
    - `placementGroupName` string — Placement Group name
    - `privateCloudId` string, uuid — Id of a private cloud
    - `resourcePools` ResourcePool[] — The list of Resource Pools
      - `id` string, required — resource pool id (privateCloudId:vsphereId)
      - `location` string — Azure region
      - `name` string — {ResourcePoolName}
      - `privateCloudId` string — The Private Cloud Id
      - `properties` ResourcePoolProperties — Properties of resource pool
        - `fullName` string — Hierarchical resource pool name
      - `type` string — {resourceProviderNamespace}/{resourceType}
    - `state` string — Private Cloud state, e.g. "operational"
    - `totalCpuCores` integer — Number of cores
    - `totalNodes` integer — Number of nodes
    - `totalRam` integer — Memory size
    - `totalStorage` number — Disk space in TB
    - `type` string — Virtualization type e.g. "vSphere"
    - `vSphereVersion` string — e.g. "6.5u2"
    - `vcenterFqdn` string — FQDN for vcenter access
    - `vcenterRefid` string — Vcenter ip address
    - `virtualMachineTemplates` VirtualMachineTemplate[] — The list of Virtual Machine Templates
      - `id` string — virtual machine template id (privateCloudId:vsphereId)
      - `location` string — Azure region
      - `name` string — {virtualMachineTemplateName}
      - `properties` VirtualMachineTemplateProperties — Properties of virtual machine template
        - `amountOfRam` integer — The amount of memory
        - `controllers` VirtualDiskController[] — The list of Virtual Disk Controllers
          - `id` string — Controller's id
          - `name` string — The display name of Controller
          - `subType` string — dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS)
          - `type` string — disk controller type (SCSI)
        - `description` string — The description of Virtual Machine Template
        - `disks` VirtualDisk[] — The list of Virtual Disks
          - `controllerId` string, required — Disk's Controller id
          - `independenceMode` 'persistent' | 'independent_persistent' | 'independent_nonpersistent', required — Disk's independence mode type
          - `totalSize` integer, required — Disk's total size
          - `virtualDiskId` string — Disk's id
          - `virtualDiskName` string — Disk's display name
        - `exposeToGuestVM` boolean — Expose Guest OS or not
        - `guestOS` string — The Guest OS
        - `guestOSType` string — The Guest OS types
        - `nics` VirtualNic[] — The list of Virtual NICs
          - `customization` GuestOSNICCustomization — Guest OS nic customization
            - `allocation` 'static' | 'dynamic' — IP address allocation method
            - `dnsServers` IPV4Address[] — List of dns servers to use
            - `gateway` IPV4Address[] — Gateway addresses assigned to nic
            - `ipAddress` string
            - `mask` string
            - `primaryWinsServer` string
            - `secondaryWinsServer` string
          - `ipAddresses` string[] — NIC ip address
          - `macAddress` string — NIC MAC address
          - `network` VirtualNetwork, required — Virtual network model
            - `assignable` boolean — can be used in vm creation/deletion
            - `id` string, required — virtual network id (privateCloudId:vsphereId)
            - `location` string — Azure region
            - `name` string — {VirtualNetworkName}
            - `properties` VirtualNetworkProperties — Properties of virtual network
              - …
            - `type` string — {resourceProviderNamespace}/{resourceType}
          - `nicType` 'E1000' | 'E1000E' | 'PCNET32' | 'VMXNET' | 'VMXNET2' | 'VMXNET3', required — NIC type
          - `powerOnBoot` boolean — Is NIC powered on/off on boot
          - `virtualNicId` string — NIC id
          - `virtualNicName` string — NIC name
        - `numberOfCores` integer — The number of CPU cores
        - `path` string — path to folder
        - `privateCloudId` string, required — The Private Cloud Id
        - `vSphereNetworks` string[] — The list of VSphere networks
        - `vSphereTags` string[] — The tags from VSphere
        - `vmwaretools` string — The VMware tools version
      - `type` string — {resourceProviderNamespace}/{resourceType}
    - `virtualNetworks` VirtualNetwork[] — The list of Virtual Networks
      - `assignable` boolean — can be used in vm creation/deletion
      - `id` string, required — virtual network id (privateCloudId:vsphereId)
      - `location` string — Azure region
      - `name` string — {VirtualNetworkName}
      - `properties` VirtualNetworkProperties — Properties of virtual network
        - `privateCloudId` string — The Private Cloud id
      - `type` string — {resourceProviderNamespace}/{resourceType}
    - `vrOpsEnabled` boolean — Is vRealize Operations Manager enabled/disabled
  - `type` 'Microsoft.VMwareCloudSimple/privateClouds' — Azure Resource type

## Other responses

- `default` — General Error

## Changes

- **2019-10-01** (2019-04-01) `7f9c99d00f07` — 3 info
  - api operation id `getPrivateCloud` removed and replaced with `PrivateClouds_Get`
  - api tag `PrivateClouds` added
  - api tag `privateCloud` removed
- **2019-06-20** (2019-04-01) `efec17f26250` — 3 info
  - api operation id `PrivateClouds_Get` removed and replaced with `getPrivateCloud`
  - api tag `privateCloud` added
  - api tag `PrivateClouds` removed

[Change history](https://skmtc.dev/azure/apis/vmwarecloudsimple/changes/subscriptions/:subscriptionId/providers/Microsoft.VMwareCloudSimple/locations/:regionId/privateClouds/:pcName/get.md)

---

[API](https://skmtc.dev/azure/apis/vmwarecloudsimple.md) · [All operations](https://skmtc.dev/azure/apis/vmwarecloudsimple/llms.txt) · [OpenAPI document](https://skmtc.dev/azure/apis/vmwarecloudsimple/revisions/e4f413d50659?raw)