Share via

PrivateCloud interface

  • Reference
Package:
@azure/arm-avs

A private cloud resource

Extends
TrackedResource

Properties

availability

Properties describing how the cloud is distributed across availability zones
circuit

An ExpressRoute Circuit
dnsZoneType

The type of DNS zone to use.
encryption

Customer managed key encryption, can be enabled or disabled
endpoints

The endpoints NOTE: This property will not be serialized. It can only be populated by the server.
extendedNetworkBlocks

Array of additional networks noncontiguous with networkBlock. Networks must be unique and non-overlapping across VNet in your subscription, on-premise, and this privateCloud networkBlock attribute. Make sure the CIDR format conforms to (A.B.C.D/X).
externalCloudLinks

Array of cloud link IDs from other clouds that connect to this one NOTE: This property will not be serialized. It can only be populated by the server.
identity

The managed service identities assigned to this resource.
identitySources

vCenter Single Sign On Identity Sources
internet

Connectivity to internet is enabled or disabled
managementCluster

The default cluster used for management
managementNetwork

Network used to access vCenter Server and NSX-T Manager NOTE: This property will not be serialized. It can only be populated by the server.
networkBlock

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
nsxPublicIpQuotaRaised

Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024 NOTE: This property will not be serialized. It can only be populated by the server.
nsxtCertificateThumbprint

Thumbprint of the NSX-T Manager SSL certificate NOTE: This property will not be serialized. It can only be populated by the server.
nsxtPassword

Optionally, set the NSX-T Manager password when the private cloud is created This value contains a credential. Consider obscuring before showing to users
provisioningNetwork

Used for virtual machine cold migration, cloning, and snapshot migration NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

The provisioning state NOTE: This property will not be serialized. It can only be populated by the server.
secondaryCircuit

A secondary expressRoute circuit from a separate AZ. Only present in a stretched private cloud
sku

The SKU (Stock Keeping Unit) assigned to this resource.
vcenterCertificateThumbprint

Thumbprint of the vCenter Server SSL certificate NOTE: This property will not be serialized. It can only be populated by the server.
vcenterPassword

Optionally, set the vCenter admin password when the private cloud is created This value contains a credential. Consider obscuring before showing to users
virtualNetworkId

Azure resource ID of the virtual network
vmotionNetwork

Used for live migration of virtual machines NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

availability

Properties describing how the cloud is distributed across availability zones

availability?: AvailabilityProperties

Property Value

AvailabilityProperties

circuit

An ExpressRoute Circuit

circuit?: Circuit

Property Value

Circuit

dnsZoneType

The type of DNS zone to use.

dnsZoneType?: string

Property Value

string

encryption

Customer managed key encryption, can be enabled or disabled

encryption?: Encryption

Property Value

Encryption

endpoints

The endpoints NOTE: This property will not be serialized. It can only be populated by the server.

endpoints?: Endpoints

Property Value

Endpoints

extendedNetworkBlocks

Array of additional networks noncontiguous with networkBlock. Networks must be unique and non-overlapping across VNet in your subscription, on-premise, and this privateCloud networkBlock attribute. Make sure the CIDR format conforms to (A.B.C.D/X).

extendedNetworkBlocks?: string[]

Property Value

string[]

Array of cloud link IDs from other clouds that connect to this one NOTE: This property will not be serialized. It can only be populated by the server.

externalCloudLinks?: string[]

Property Value

string[]

identity

The managed service identities assigned to this resource.

identity?: SystemAssignedServiceIdentity

Property Value

SystemAssignedServiceIdentity

identitySources

vCenter Single Sign On Identity Sources

identitySources?: IdentitySource[]

Property Value

IdentitySource[]

internet

Connectivity to internet is enabled or disabled

internet?: string

Property Value

string

managementCluster

The default cluster used for management

managementCluster?: ManagementCluster

Property Value

ManagementCluster

managementNetwork

Network used to access vCenter Server and NSX-T Manager NOTE: This property will not be serialized. It can only be populated by the server.

managementNetwork?: string

Property Value

string

networkBlock

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

networkBlock?: string

Property Value

string

nsxPublicIpQuotaRaised

Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024 NOTE: This property will not be serialized. It can only be populated by the server.

nsxPublicIpQuotaRaised?: string

Property Value

string

nsxtCertificateThumbprint

Thumbprint of the NSX-T Manager SSL certificate NOTE: This property will not be serialized. It can only be populated by the server.

nsxtCertificateThumbprint?: string

Property Value

string

nsxtPassword

Optionally, set the NSX-T Manager password when the private cloud is created This value contains a credential. Consider obscuring before showing to users

nsxtPassword?: string

Property Value

string

provisioningNetwork

Used for virtual machine cold migration, cloning, and snapshot migration NOTE: This property will not be serialized. It can only be populated by the server.

provisioningNetwork?: string

Property Value

string

provisioningState

The provisioning state NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

secondaryCircuit

A secondary expressRoute circuit from a separate AZ. Only present in a stretched private cloud

secondaryCircuit?: Circuit

Property Value

Circuit

sku

The SKU (Stock Keeping Unit) assigned to this resource.

sku: Sku

Property Value

Sku

vcenterCertificateThumbprint

Thumbprint of the vCenter Server SSL certificate NOTE: This property will not be serialized. It can only be populated by the server.

vcenterCertificateThumbprint?: string

Property Value

string

vcenterPassword

Optionally, set the vCenter admin password when the private cloud is created This value contains a credential. Consider obscuring before showing to users

vcenterPassword?: string

Property Value

string

virtualNetworkId

Azure resource ID of the virtual network

virtualNetworkId?: string

Property Value

string

vmotionNetwork

Used for live migration of virtual machines NOTE: This property will not be serialized. It can only be populated by the server.

vmotionNetwork?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type