Microsoft.AVS (stable:2025-09-01)

2025/11/17 • 124 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AVS/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Locations_CheckQuotaAvailability (new)
Description :  Return quota for subscription by region
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AVS/locations/{location}/checkQuotaAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
hostsRemaining:
{
Description: Remaining hosts quota by sku type ,
Required: False ,
}
object ,
quotaEnabled:
{
Description: Host quota is active for current subscription ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Locations_CheckTrialAvailability (new)
Description :  Return trial status for subscription by region
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AVS/locations/{location}/checkTrialAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
sku:
{
Description: Optionally, check for a specific SKU ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
status:
{
Description: Trial status ,
Enum:
{
TrialAvailable: is available ,
TrialUsed: is used ,
TrialDisabled: is disabled ,
}
,
Required: False ,
}
enum ,
availableHosts:
{
Description: Number of trial hosts available ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ServiceComponents_CheckAvailability (new)
Description :  Return service component availability
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AVS/locations/{location}/serviceComponents/{serviceComponentName}/checkAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
serviceComponentName:
{
Description: A service component ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateClouds_ListInSubscription (new)
Description :  List PrivateCloud resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AVS/privateClouds
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateCloud items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
managementCluster:
{
Description: The default cluster used for management ,
Required: True ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The state of the cluster provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The identity ,
Format: int32 ,
Required: False ,
}
integer ,
hosts:
{
Description: The hosts ,
Required: False ,
}
[
string ,
]
,
vsanDatastoreName:
{
Description: Name of the vsan datastore associated with the cluster ,
Required: False ,
}
string ,
}
,
internet:
{
Description: Connectivity to internet is enabled or disabled ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
identitySources:
{
Description: vCenter Single Sign On Identity Sources ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity source ,
Required: False ,
}
string ,
alias:
{
Description: The domain's NetBIOS name ,
Required: False ,
}
string ,
domain:
{
Description: The domain's DNS name ,
Required: False ,
}
string ,
baseUserDN:
{
Description: The base distinguished name for users ,
Required: False ,
}
string ,
baseGroupDN:
{
Description: The base distinguished name for groups ,
Required: False ,
}
string ,
primaryServer:
{
Description: Primary server URL ,
Required: False ,
}
string ,
secondaryServer:
{
Description: Secondary server URL ,
Required: False ,
}
string ,
ssl:
{
Description: Protect LDAP communication using SSL certificate (LDAPS) ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
username:
{
Description: The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group ,
Required: False ,
}
string ,
password:
{
Description: The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
availability:
{
Description: Properties describing how the cloud is distributed across availability zones ,
Required: False ,
}
{
strategy:
{
Description: The availability strategy for the private cloud ,
Enum:
{
SingleZone: in single zone ,
DualZone: in two zones ,
}
,
Required: False ,
}
enum ,
zone:
{
Description: The primary availability zone for the private cloud ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryZone:
{
Description: The secondary availability zone for the private cloud ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
encryption:
{
Description: Customer managed key encryption, can be enabled or disabled ,
Required: False ,
}
{
status:
{
Description: Status of customer managed encryption key ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The key vault where the encryption key is stored ,
Required: False ,
}
{
keyName:
{
Description: The name of the key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key. ,
Required: False ,
}
string ,
autoDetectedKeyVersion:
{
Description: The auto-detected version of the key if versionType is auto-detected. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: The URL of the vault. ,
Required: False ,
}
string ,
keyState:
{
Description: The state of key provided ,
Enum:
{
Connected: is connected ,
AccessDenied: is access denied ,
}
,
Required: False ,
}
enum ,
versionType:
{
Description: Property of the key if user provided or auto detected ,
Enum:
{
Fixed: is fixed ,
AutoDetected: is auto-detected ,
}
,
Required: False ,
}
enum ,
}
,
}
,
extendedNetworkBlocks:
{
Description: 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). ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Pending: is pending ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
circuit:
{
Description: An ExpressRoute Circuit ,
Required: False ,
}
{
primarySubnet:
{
Description: CIDR of primary subnet ,
Required: False ,
}
string ,
secondarySubnet:
{
Description: CIDR of secondary subnet ,
Required: False ,
}
string ,
expressRouteID:
{
Description: Identifier of the ExpressRoute Circuit (Microsoft Colo only) ,
Required: False ,
}
string ,
expressRoutePrivatePeeringID:
{
Description: ExpressRoute Circuit private peering identifier ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: The endpoints ,
Required: False ,
}
{
nsxtManager:
{
Description: Endpoint FQDN for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint FQDN for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint FQDN for the HCX Cloud Manager ,
Required: False ,
}
string ,
nsxtManagerIp:
{
Description: Endpoint IP for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcenterIp:
{
Description: Endpoint IP for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManagerIp:
{
Description: Endpoint IP for the HCX Cloud Manager ,
Required: False ,
}
string ,
}
,
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 ,
Required: True ,
}
string ,
managementNetwork:
{
Description: Network used to access vCenter Server and NSX-T Manager ,
Required: False ,
}
string ,
provisioningNetwork:
{
Description: Used for virtual machine cold migration, cloning, and snapshot migration ,
Required: False ,
}
string ,
vmotionNetwork:
{
Description: Used for live migration of virtual machines ,
Required: False ,
}
string ,
vcenterPassword:
{
Description: Optionally, set the vCenter admin password when the private cloud is created ,
Format: password ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
Format: password ,
Required: False ,
}
string ,
vcenterCertificateThumbprint:
{
Description: Thumbprint of the vCenter Server SSL certificate ,
Required: False ,
}
string ,
nsxtCertificateThumbprint:
{
Description: Thumbprint of the NSX-T Manager SSL certificate ,
Required: False ,
}
string ,
externalCloudLinks:
{
Description: Array of cloud link IDs from other clouds that connect to this one ,
Required: False ,
}
[
string ,
]
,
secondaryCircuit:
{
Description: A secondary expressRoute circuit from a separate AZ. Only present in a stretched private cloud ,
Required: False ,
}
{
primarySubnet:
{
Description: CIDR of primary subnet ,
Required: False ,
}
string ,
secondarySubnet:
{
Description: CIDR of secondary subnet ,
Required: False ,
}
string ,
expressRouteID:
{
Description: Identifier of the ExpressRoute Circuit (Microsoft Colo only) ,
Required: False ,
}
string ,
expressRoutePrivatePeeringID:
{
Description: ExpressRoute Circuit private peering identifier ,
Required: False ,
}
string ,
}
,
nsxPublicIpQuotaRaised:
{
Description: Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024 ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
virtualNetworkId:
{
Description: Azure resource ID of the virtual network ,
Format: arm-id ,
Required: False ,
}
string ,
dnsZoneType:
{
Description: The type of DNS zone to use. ,
Enum:
{
Public: Primary DNS zone. ,
Private: Private DNS zone. ,
}
,
Required: False ,
}
enum ,
vcfLicense:
{
Description: The private cloud license ,
Required: False ,
}
{
kind:
{
Description: License kind ,
Enum:
{
vcf5: A VMware Cloud Foundation (VCF) 5.0 license ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the license provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_List (new)
Description :  A list of SKUs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AVS/skus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ResourceSku items on this page ,
Required: True ,
}
[
{
resourceType:
{
Description: The type of resource the SKU applies to. ,
Enum:
{
privateClouds: The SKU is for a private cloud. ,
privateClouds/clusters: The SKU is for a private cloud cluster. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
tier:
{
Description: The tier of virtual machines in a scale set ,
Required: False ,
}
string ,
size:
{
Description: The size of the SKU. ,
Required: False ,
}
string ,
family:
{
Description: The family of the SKU. ,
Required: False ,
}
string ,
locations:
{
Description: The set of locations that the SKU is available. ,
Required: True ,
}
[
string ,
]
,
locationInfo:
{
Description: A list of locations and availability zones in those locations where the SKU is available ,
Required: True ,
}
[
{
location:
{
Description: Location of the SKU ,
Required: True ,
}
string ,
zones:
{
Description: List of availability zones where the SKU is supported. ,
Required: True ,
}
[
string ,
]
,
zoneDetails:
{
Description: Gets details of capabilities available to a SKU in specific zones. ,
Required: True ,
}
[
{
name:
{
Description: Gets the set of zones that the SKU is available in with the specified capabilities. ,
Required: True ,
}
[
string ,
]
,
capabilities:
{
Description: A list of capabilities that are available for the SKU in the specified list of zones. ,
Required: True ,
}
[
{
name:
{
Description: The name of the SKU capability. ,
Required: True ,
}
string ,
value:
{
Description: The value of the SKU capability. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
capabilities:
{
Description: Name value pairs to describe the capability. ,
Required: False ,
}
[
{
name:
{
Description: The name of the SKU capability. ,
Required: True ,
}
string ,
value:
{
Description: The value of the SKU capability. ,
Required: True ,
}
string ,
}
,
]
,
restrictions:
{
Description: The restrictions of the SKU. ,
Required: True ,
}
[
{
type:
{
Description: the type of restrictions. ,
Enum:
{
Location: SKU restricted by location. ,
Zone: SKU restricted by availability zone. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted. ,
Required: True ,
}
[
string ,
]
,
restrictionInfo:
{
Description: The information about the restriction where the SKU cannot be used. ,
Required: True ,
}
{
locations:
{
Description: Locations where the SKU is restricted ,
Required: False ,
}
[
string ,
]
,
zones:
{
Description: List of availability zones where the SKU is restricted. ,
Required: False ,
}
[
string ,
]
,
}
,
reasonCode:
{
Description: the reason for restriction. ,
Enum:
{
QuotaId: The restriction is due to exceeding a quota limitation. ,
NotAvailableForSubscription: The restriction is not available for this subscription. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateClouds_List (new)
Description :  List PrivateCloud resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PrivateCloud items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
managementCluster:
{
Description: The default cluster used for management ,
Required: True ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The state of the cluster provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The identity ,
Format: int32 ,
Required: False ,
}
integer ,
hosts:
{
Description: The hosts ,
Required: False ,
}
[
string ,
]
,
vsanDatastoreName:
{
Description: Name of the vsan datastore associated with the cluster ,
Required: False ,
}
string ,
}
,
internet:
{
Description: Connectivity to internet is enabled or disabled ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
identitySources:
{
Description: vCenter Single Sign On Identity Sources ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity source ,
Required: False ,
}
string ,
alias:
{
Description: The domain's NetBIOS name ,
Required: False ,
}
string ,
domain:
{
Description: The domain's DNS name ,
Required: False ,
}
string ,
baseUserDN:
{
Description: The base distinguished name for users ,
Required: False ,
}
string ,
baseGroupDN:
{
Description: The base distinguished name for groups ,
Required: False ,
}
string ,
primaryServer:
{
Description: Primary server URL ,
Required: False ,
}
string ,
secondaryServer:
{
Description: Secondary server URL ,
Required: False ,
}
string ,
ssl:
{
Description: Protect LDAP communication using SSL certificate (LDAPS) ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
username:
{
Description: The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group ,
Required: False ,
}
string ,
password:
{
Description: The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
availability:
{
Description: Properties describing how the cloud is distributed across availability zones ,
Required: False ,
}
{
strategy:
{
Description: The availability strategy for the private cloud ,
Enum:
{
SingleZone: in single zone ,
DualZone: in two zones ,
}
,
Required: False ,
}
enum ,
zone:
{
Description: The primary availability zone for the private cloud ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryZone:
{
Description: The secondary availability zone for the private cloud ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
encryption:
{
Description: Customer managed key encryption, can be enabled or disabled ,
Required: False ,
}
{
status:
{
Description: Status of customer managed encryption key ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The key vault where the encryption key is stored ,
Required: False ,
}
{
keyName:
{
Description: The name of the key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key. ,
Required: False ,
}
string ,
autoDetectedKeyVersion:
{
Description: The auto-detected version of the key if versionType is auto-detected. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: The URL of the vault. ,
Required: False ,
}
string ,
keyState:
{
Description: The state of key provided ,
Enum:
{
Connected: is connected ,
AccessDenied: is access denied ,
}
,
Required: False ,
}
enum ,
versionType:
{
Description: Property of the key if user provided or auto detected ,
Enum:
{
Fixed: is fixed ,
AutoDetected: is auto-detected ,
}
,
Required: False ,
}
enum ,
}
,
}
,
extendedNetworkBlocks:
{
Description: 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). ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Pending: is pending ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
circuit:
{
Description: An ExpressRoute Circuit ,
Required: False ,
}
{
primarySubnet:
{
Description: CIDR of primary subnet ,
Required: False ,
}
string ,
secondarySubnet:
{
Description: CIDR of secondary subnet ,
Required: False ,
}
string ,
expressRouteID:
{
Description: Identifier of the ExpressRoute Circuit (Microsoft Colo only) ,
Required: False ,
}
string ,
expressRoutePrivatePeeringID:
{
Description: ExpressRoute Circuit private peering identifier ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: The endpoints ,
Required: False ,
}
{
nsxtManager:
{
Description: Endpoint FQDN for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint FQDN for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint FQDN for the HCX Cloud Manager ,
Required: False ,
}
string ,
nsxtManagerIp:
{
Description: Endpoint IP for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcenterIp:
{
Description: Endpoint IP for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManagerIp:
{
Description: Endpoint IP for the HCX Cloud Manager ,
Required: False ,
}
string ,
}
,
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 ,
Required: True ,
}
string ,
managementNetwork:
{
Description: Network used to access vCenter Server and NSX-T Manager ,
Required: False ,
}
string ,
provisioningNetwork:
{
Description: Used for virtual machine cold migration, cloning, and snapshot migration ,
Required: False ,
}
string ,
vmotionNetwork:
{
Description: Used for live migration of virtual machines ,
Required: False ,
}
string ,
vcenterPassword:
{
Description: Optionally, set the vCenter admin password when the private cloud is created ,
Format: password ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
Format: password ,
Required: False ,
}
string ,
vcenterCertificateThumbprint:
{
Description: Thumbprint of the vCenter Server SSL certificate ,
Required: False ,
}
string ,
nsxtCertificateThumbprint:
{
Description: Thumbprint of the NSX-T Manager SSL certificate ,
Required: False ,
}
string ,
externalCloudLinks:
{
Description: Array of cloud link IDs from other clouds that connect to this one ,
Required: False ,
}
[
string ,
]
,
secondaryCircuit:
{
Description: A secondary expressRoute circuit from a separate AZ. Only present in a stretched private cloud ,
Required: False ,
}
{
primarySubnet:
{
Description: CIDR of primary subnet ,
Required: False ,
}
string ,
secondarySubnet:
{
Description: CIDR of secondary subnet ,
Required: False ,
}
string ,
expressRouteID:
{
Description: Identifier of the ExpressRoute Circuit (Microsoft Colo only) ,
Required: False ,
}
string ,
expressRoutePrivatePeeringID:
{
Description: ExpressRoute Circuit private peering identifier ,
Required: False ,
}
string ,
}
,
nsxPublicIpQuotaRaised:
{
Description: Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024 ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
virtualNetworkId:
{
Description: Azure resource ID of the virtual network ,
Format: arm-id ,
Required: False ,
}
string ,
dnsZoneType:
{
Description: The type of DNS zone to use. ,
Enum:
{
Public: Primary DNS zone. ,
Private: Private DNS zone. ,
}
,
Required: False ,
}
enum ,
vcfLicense:
{
Description: The private cloud license ,
Required: False ,
}
{
kind:
{
Description: License kind ,
Enum:
{
vcf5: A VMware Cloud Foundation (VCF) 5.0 license ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the license provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateClouds_Get (new)
Description :  Get a PrivateCloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
managementCluster:
{
Description: The default cluster used for management ,
Required: True ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The state of the cluster provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The identity ,
Format: int32 ,
Required: False ,
}
integer ,
hosts:
{
Description: The hosts ,
Required: False ,
}
[
string ,
]
,
vsanDatastoreName:
{
Description: Name of the vsan datastore associated with the cluster ,
Required: False ,
}
string ,
}
,
internet:
{
Description: Connectivity to internet is enabled or disabled ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
identitySources:
{
Description: vCenter Single Sign On Identity Sources ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity source ,
Required: False ,
}
string ,
alias:
{
Description: The domain's NetBIOS name ,
Required: False ,
}
string ,
domain:
{
Description: The domain's DNS name ,
Required: False ,
}
string ,
baseUserDN:
{
Description: The base distinguished name for users ,
Required: False ,
}
string ,
baseGroupDN:
{
Description: The base distinguished name for groups ,
Required: False ,
}
string ,
primaryServer:
{
Description: Primary server URL ,
Required: False ,
}
string ,
secondaryServer:
{
Description: Secondary server URL ,
Required: False ,
}
string ,
ssl:
{
Description: Protect LDAP communication using SSL certificate (LDAPS) ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
username:
{
Description: The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group ,
Required: False ,
}
string ,
password:
{
Description: The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
availability:
{
Description: Properties describing how the cloud is distributed across availability zones ,
Required: False ,
}
{
strategy:
{
Description: The availability strategy for the private cloud ,
Enum:
{
SingleZone: in single zone ,
DualZone: in two zones ,
}
,
Required: False ,
}
enum ,
zone:
{
Description: The primary availability zone for the private cloud ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryZone:
{
Description: The secondary availability zone for the private cloud ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
encryption:
{
Description: Customer managed key encryption, can be enabled or disabled ,
Required: False ,
}
{
status:
{
Description: Status of customer managed encryption key ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The key vault where the encryption key is stored ,
Required: False ,
}
{
keyName:
{
Description: The name of the key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key. ,
Required: False ,
}
string ,
autoDetectedKeyVersion:
{
Description: The auto-detected version of the key if versionType is auto-detected. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: The URL of the vault. ,
Required: False ,
}
string ,
keyState:
{
Description: The state of key provided ,
Enum:
{
Connected: is connected ,
AccessDenied: is access denied ,
}
,
Required: False ,
}
enum ,
versionType:
{
Description: Property of the key if user provided or auto detected ,
Enum:
{
Fixed: is fixed ,
AutoDetected: is auto-detected ,
}
,
Required: False ,
}
enum ,
}
,
}
,
extendedNetworkBlocks:
{
Description: 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). ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Pending: is pending ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
circuit:
{
Description: An ExpressRoute Circuit ,
Required: False ,
}
{
primarySubnet:
{
Description: CIDR of primary subnet ,
Required: False ,
}
string ,
secondarySubnet:
{
Description: CIDR of secondary subnet ,
Required: False ,
}
string ,
expressRouteID:
{
Description: Identifier of the ExpressRoute Circuit (Microsoft Colo only) ,
Required: False ,
}
string ,
expressRoutePrivatePeeringID:
{
Description: ExpressRoute Circuit private peering identifier ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: The endpoints ,
Required: False ,
}
{
nsxtManager:
{
Description: Endpoint FQDN for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint FQDN for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint FQDN for the HCX Cloud Manager ,
Required: False ,
}
string ,
nsxtManagerIp:
{
Description: Endpoint IP for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcenterIp:
{
Description: Endpoint IP for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManagerIp:
{
Description: Endpoint IP for the HCX Cloud Manager ,
Required: False ,
}
string ,
}
,
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 ,
Required: True ,
}
string ,
managementNetwork:
{
Description: Network used to access vCenter Server and NSX-T Manager ,
Required: False ,
}
string ,
provisioningNetwork:
{
Description: Used for virtual machine cold migration, cloning, and snapshot migration ,
Required: False ,
}
string ,
vmotionNetwork:
{
Description: Used for live migration of virtual machines ,
Required: False ,
}
string ,
vcenterPassword:
{
Description: Optionally, set the vCenter admin password when the private cloud is created ,
Format: password ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
Format: password ,
Required: False ,
}
string ,
vcenterCertificateThumbprint:
{
Description: Thumbprint of the vCenter Server SSL certificate ,
Required: False ,
}
string ,
nsxtCertificateThumbprint:
{
Description: Thumbprint of the NSX-T Manager SSL certificate ,
Required: False ,
}
string ,
externalCloudLinks:
{
Description: Array of cloud link IDs from other clouds that connect to this one ,
Required: False ,
}
[
string ,
]
,
secondaryCircuit:
{
Description: A secondary expressRoute circuit from a separate AZ. Only present in a stretched private cloud ,
Required: False ,
}
{
primarySubnet:
{
Description: CIDR of primary subnet ,
Required: False ,
}
string ,
secondarySubnet:
{
Description: CIDR of secondary subnet ,
Required: False ,
}
string ,
expressRouteID:
{
Description: Identifier of the ExpressRoute Circuit (Microsoft Colo only) ,
Required: False ,
}
string ,
expressRoutePrivatePeeringID:
{
Description: ExpressRoute Circuit private peering identifier ,
Required: False ,
}
string ,
}
,
nsxPublicIpQuotaRaised:
{
Description: Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024 ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
virtualNetworkId:
{
Description: Azure resource ID of the virtual network ,
Format: arm-id ,
Required: False ,
}
string ,
dnsZoneType:
{
Description: The type of DNS zone to use. ,
Enum:
{
Public: Primary DNS zone. ,
Private: Private DNS zone. ,
}
,
Required: False ,
}
enum ,
vcfLicense:
{
Description: The private cloud license ,
Required: False ,
}
{
kind:
{
Description: License kind ,
Enum:
{
vcf5: A VMware Cloud Foundation (VCF) 5.0 license ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the license provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateClouds_CreateOrUpdate (new)
Description :  Create a PrivateCloud
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
privateCloud:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
managementCluster:
{
Description: The default cluster used for management ,
Required: True ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The state of the cluster provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The identity ,
Format: int32 ,
Required: False ,
}
integer ,
hosts:
{
Description: The hosts ,
Required: False ,
}
[
string ,
]
,
vsanDatastoreName:
{
Description: Name of the vsan datastore associated with the cluster ,
Required: False ,
}
string ,
}
,
internet:
{
Description: Connectivity to internet is enabled or disabled ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
identitySources:
{
Description: vCenter Single Sign On Identity Sources ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity source ,
Required: False ,
}
string ,
alias:
{
Description: The domain's NetBIOS name ,
Required: False ,
}
string ,
domain:
{
Description: The domain's DNS name ,
Required: False ,
}
string ,
baseUserDN:
{
Description: The base distinguished name for users ,
Required: False ,
}
string ,
baseGroupDN:
{
Description: The base distinguished name for groups ,
Required: False ,
}
string ,
primaryServer:
{
Description: Primary server URL ,
Required: False ,
}
string ,
secondaryServer:
{
Description: Secondary server URL ,
Required: False ,
}
string ,
ssl:
{
Description: Protect LDAP communication using SSL certificate (LDAPS) ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
username:
{
Description: The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group ,
Required: False ,
}
string ,
password:
{
Description: The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
availability:
{
Description: Properties describing how the cloud is distributed across availability zones ,
Required: False ,
}
{
strategy:
{
Description: The availability strategy for the private cloud ,
Enum:
{
SingleZone: in single zone ,
DualZone: in two zones ,
}
,
Required: False ,
}
enum ,
zone:
{
Description: The primary availability zone for the private cloud ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryZone:
{
Description: The secondary availability zone for the private cloud ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
encryption:
{
Description: Customer managed key encryption, can be enabled or disabled ,
Required: False ,
}
{
status:
{
Description: Status of customer managed encryption key ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The key vault where the encryption key is stored ,
Required: False ,
}
{
keyName:
{
Description: The name of the key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key. ,
Required: False ,
}
string ,
autoDetectedKeyVersion:
{
Description: The auto-detected version of the key if versionType is auto-detected. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: The URL of the vault. ,
Required: False ,
}
string ,
keyState:
{
Description: The state of key provided ,
Enum:
{
Connected: is connected ,
AccessDenied: is access denied ,
}
,
Required: False ,
}
enum ,
versionType:
{
Description: Property of the key if user provided or auto detected ,
Enum:
{
Fixed: is fixed ,
AutoDetected: is auto-detected ,
}
,
Required: False ,
}
enum ,
}
,
}
,
extendedNetworkBlocks:
{
Description: 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). ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Pending: is pending ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
circuit:
{
Description: An ExpressRoute Circuit ,
Required: False ,
}
{
primarySubnet:
{
Description: CIDR of primary subnet ,
Required: False ,
}
string ,
secondarySubnet:
{
Description: CIDR of secondary subnet ,
Required: False ,
}
string ,
expressRouteID:
{
Description: Identifier of the ExpressRoute Circuit (Microsoft Colo only) ,
Required: False ,
}
string ,
expressRoutePrivatePeeringID:
{
Description: ExpressRoute Circuit private peering identifier ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: The endpoints ,
Required: False ,
}
{
nsxtManager:
{
Description: Endpoint FQDN for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint FQDN for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint FQDN for the HCX Cloud Manager ,
Required: False ,
}
string ,
nsxtManagerIp:
{
Description: Endpoint IP for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcenterIp:
{
Description: Endpoint IP for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManagerIp:
{
Description: Endpoint IP for the HCX Cloud Manager ,
Required: False ,
}
string ,
}
,
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 ,
Required: True ,
}
string ,
managementNetwork:
{
Description: Network used to access vCenter Server and NSX-T Manager ,
Required: False ,
}
string ,
provisioningNetwork:
{
Description: Used for virtual machine cold migration, cloning, and snapshot migration ,
Required: False ,
}
string ,
vmotionNetwork:
{
Description: Used for live migration of virtual machines ,
Required: False ,
}
string ,
vcenterPassword:
{
Description: Optionally, set the vCenter admin password when the private cloud is created ,
Format: password ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
Format: password ,
Required: False ,
}
string ,
vcenterCertificateThumbprint:
{
Description: Thumbprint of the vCenter Server SSL certificate ,
Required: False ,
}
string ,
nsxtCertificateThumbprint:
{
Description: Thumbprint of the NSX-T Manager SSL certificate ,
Required: False ,
}
string ,
externalCloudLinks:
{
Description: Array of cloud link IDs from other clouds that connect to this one ,
Required: False ,
}
[
string ,
]
,
secondaryCircuit:
{
Description: A secondary expressRoute circuit from a separate AZ. Only present in a stretched private cloud ,
Required: False ,
}
{
primarySubnet:
{
Description: CIDR of primary subnet ,
Required: False ,
}
string ,
secondarySubnet:
{
Description: CIDR of secondary subnet ,
Required: False ,
}
string ,
expressRouteID:
{
Description: Identifier of the ExpressRoute Circuit (Microsoft Colo only) ,
Required: False ,
}
string ,
expressRoutePrivatePeeringID:
{
Description: ExpressRoute Circuit private peering identifier ,
Required: False ,
}
string ,
}
,
nsxPublicIpQuotaRaised:
{
Description: Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024 ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
virtualNetworkId:
{
Description: Azure resource ID of the virtual network ,
Format: arm-id ,
Required: False ,
}
string ,
dnsZoneType:
{
Description: The type of DNS zone to use. ,
Enum:
{
Public: Primary DNS zone. ,
Private: Private DNS zone. ,
}
,
Required: False ,
}
enum ,
vcfLicense:
{
Description: The private cloud license ,
Required: False ,
}
{
kind:
{
Description: License kind ,
Enum:
{
vcf5: A VMware Cloud Foundation (VCF) 5.0 license ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the license provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
managementCluster:
{
Description: The default cluster used for management ,
Required: True ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The state of the cluster provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The identity ,
Format: int32 ,
Required: False ,
}
integer ,
hosts:
{
Description: The hosts ,
Required: False ,
}
[
string ,
]
,
vsanDatastoreName:
{
Description: Name of the vsan datastore associated with the cluster ,
Required: False ,
}
string ,
}
,
internet:
{
Description: Connectivity to internet is enabled or disabled ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
identitySources:
{
Description: vCenter Single Sign On Identity Sources ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity source ,
Required: False ,
}
string ,
alias:
{
Description: The domain's NetBIOS name ,
Required: False ,
}
string ,
domain:
{
Description: The domain's DNS name ,
Required: False ,
}
string ,
baseUserDN:
{
Description: The base distinguished name for users ,
Required: False ,
}
string ,
baseGroupDN:
{
Description: The base distinguished name for groups ,
Required: False ,
}
string ,
primaryServer:
{
Description: Primary server URL ,
Required: False ,
}
string ,
secondaryServer:
{
Description: Secondary server URL ,
Required: False ,
}
string ,
ssl:
{
Description: Protect LDAP communication using SSL certificate (LDAPS) ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
username:
{
Description: The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group ,
Required: False ,
}
string ,
password:
{
Description: The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
availability:
{
Description: Properties describing how the cloud is distributed across availability zones ,
Required: False ,
}
{
strategy:
{
Description: The availability strategy for the private cloud ,
Enum:
{
SingleZone: in single zone ,
DualZone: in two zones ,
}
,
Required: False ,
}
enum ,
zone:
{
Description: The primary availability zone for the private cloud ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryZone:
{
Description: The secondary availability zone for the private cloud ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
encryption:
{
Description: Customer managed key encryption, can be enabled or disabled ,
Required: False ,
}
{
status:
{
Description: Status of customer managed encryption key ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The key vault where the encryption key is stored ,
Required: False ,
}
{
keyName:
{
Description: The name of the key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key. ,
Required: False ,
}
string ,
autoDetectedKeyVersion:
{
Description: The auto-detected version of the key if versionType is auto-detected. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: The URL of the vault. ,
Required: False ,
}
string ,
keyState:
{
Description: The state of key provided ,
Enum:
{
Connected: is connected ,
AccessDenied: is access denied ,
}
,
Required: False ,
}
enum ,
versionType:
{
Description: Property of the key if user provided or auto detected ,
Enum:
{
Fixed: is fixed ,
AutoDetected: is auto-detected ,
}
,
Required: False ,
}
enum ,
}
,
}
,
extendedNetworkBlocks:
{
Description: 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). ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Pending: is pending ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
circuit:
{
Description: An ExpressRoute Circuit ,
Required: False ,
}
{
primarySubnet:
{
Description: CIDR of primary subnet ,
Required: False ,
}
string ,
secondarySubnet:
{
Description: CIDR of secondary subnet ,
Required: False ,
}
string ,
expressRouteID:
{
Description: Identifier of the ExpressRoute Circuit (Microsoft Colo only) ,
Required: False ,
}
string ,
expressRoutePrivatePeeringID:
{
Description: ExpressRoute Circuit private peering identifier ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: The endpoints ,
Required: False ,
}
{
nsxtManager:
{
Description: Endpoint FQDN for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint FQDN for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint FQDN for the HCX Cloud Manager ,
Required: False ,
}
string ,
nsxtManagerIp:
{
Description: Endpoint IP for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcenterIp:
{
Description: Endpoint IP for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManagerIp:
{
Description: Endpoint IP for the HCX Cloud Manager ,
Required: False ,
}
string ,
}
,
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 ,
Required: True ,
}
string ,
managementNetwork:
{
Description: Network used to access vCenter Server and NSX-T Manager ,
Required: False ,
}
string ,
provisioningNetwork:
{
Description: Used for virtual machine cold migration, cloning, and snapshot migration ,
Required: False ,
}
string ,
vmotionNetwork:
{
Description: Used for live migration of virtual machines ,
Required: False ,
}
string ,
vcenterPassword:
{
Description: Optionally, set the vCenter admin password when the private cloud is created ,
Format: password ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
Format: password ,
Required: False ,
}
string ,
vcenterCertificateThumbprint:
{
Description: Thumbprint of the vCenter Server SSL certificate ,
Required: False ,
}
string ,
nsxtCertificateThumbprint:
{
Description: Thumbprint of the NSX-T Manager SSL certificate ,
Required: False ,
}
string ,
externalCloudLinks:
{
Description: Array of cloud link IDs from other clouds that connect to this one ,
Required: False ,
}
[
string ,
]
,
secondaryCircuit:
{
Description: A secondary expressRoute circuit from a separate AZ. Only present in a stretched private cloud ,
Required: False ,
}
{
primarySubnet:
{
Description: CIDR of primary subnet ,
Required: False ,
}
string ,
secondarySubnet:
{
Description: CIDR of secondary subnet ,
Required: False ,
}
string ,
expressRouteID:
{
Description: Identifier of the ExpressRoute Circuit (Microsoft Colo only) ,
Required: False ,
}
string ,
expressRoutePrivatePeeringID:
{
Description: ExpressRoute Circuit private peering identifier ,
Required: False ,
}
string ,
}
,
nsxPublicIpQuotaRaised:
{
Description: Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024 ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
virtualNetworkId:
{
Description: Azure resource ID of the virtual network ,
Format: arm-id ,
Required: False ,
}
string ,
dnsZoneType:
{
Description: The type of DNS zone to use. ,
Enum:
{
Public: Primary DNS zone. ,
Private: Private DNS zone. ,
}
,
Required: False ,
}
enum ,
vcfLicense:
{
Description: The private cloud license ,
Required: False ,
}
{
kind:
{
Description: License kind ,
Enum:
{
vcf5: A VMware Cloud Foundation (VCF) 5.0 license ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the license provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A private cloud resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
managementCluster:
{
Description: The default cluster used for management ,
Required: True ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The state of the cluster provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The identity ,
Format: int32 ,
Required: False ,
}
integer ,
hosts:
{
Description: The hosts ,
Required: False ,
}
[
string ,
]
,
vsanDatastoreName:
{
Description: Name of the vsan datastore associated with the cluster ,
Required: False ,
}
string ,
}
,
internet:
{
Description: Connectivity to internet is enabled or disabled ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
identitySources:
{
Description: vCenter Single Sign On Identity Sources ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity source ,
Required: False ,
}
string ,
alias:
{
Description: The domain's NetBIOS name ,
Required: False ,
}
string ,
domain:
{
Description: The domain's DNS name ,
Required: False ,
}
string ,
baseUserDN:
{
Description: The base distinguished name for users ,
Required: False ,
}
string ,
baseGroupDN:
{
Description: The base distinguished name for groups ,
Required: False ,
}
string ,
primaryServer:
{
Description: Primary server URL ,
Required: False ,
}
string ,
secondaryServer:
{
Description: Secondary server URL ,
Required: False ,
}
string ,
ssl:
{
Description: Protect LDAP communication using SSL certificate (LDAPS) ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
username:
{
Description: The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group ,
Required: False ,
}
string ,
password:
{
Description: The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
availability:
{
Description: Properties describing how the cloud is distributed across availability zones ,
Required: False ,
}
{
strategy:
{
Description: The availability strategy for the private cloud ,
Enum:
{
SingleZone: in single zone ,
DualZone: in two zones ,
}
,
Required: False ,
}
enum ,
zone:
{
Description: The primary availability zone for the private cloud ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryZone:
{
Description: The secondary availability zone for the private cloud ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
encryption:
{
Description: Customer managed key encryption, can be enabled or disabled ,
Required: False ,
}
{
status:
{
Description: Status of customer managed encryption key ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The key vault where the encryption key is stored ,
Required: False ,
}
{
keyName:
{
Description: The name of the key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key. ,
Required: False ,
}
string ,
autoDetectedKeyVersion:
{
Description: The auto-detected version of the key if versionType is auto-detected. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: The URL of the vault. ,
Required: False ,
}
string ,
keyState:
{
Description: The state of key provided ,
Enum:
{
Connected: is connected ,
AccessDenied: is access denied ,
}
,
Required: False ,
}
enum ,
versionType:
{
Description: Property of the key if user provided or auto detected ,
Enum:
{
Fixed: is fixed ,
AutoDetected: is auto-detected ,
}
,
Required: False ,
}
enum ,
}
,
}
,
extendedNetworkBlocks:
{
Description: 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). ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Pending: is pending ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
circuit:
{
Description: An ExpressRoute Circuit ,
Required: False ,
}
{
primarySubnet:
{
Description: CIDR of primary subnet ,
Required: False ,
}
string ,
secondarySubnet:
{
Description: CIDR of secondary subnet ,
Required: False ,
}
string ,
expressRouteID:
{
Description: Identifier of the ExpressRoute Circuit (Microsoft Colo only) ,
Required: False ,
}
string ,
expressRoutePrivatePeeringID:
{
Description: ExpressRoute Circuit private peering identifier ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: The endpoints ,
Required: False ,
}
{
nsxtManager:
{
Description: Endpoint FQDN for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint FQDN for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint FQDN for the HCX Cloud Manager ,
Required: False ,
}
string ,
nsxtManagerIp:
{
Description: Endpoint IP for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcenterIp:
{
Description: Endpoint IP for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManagerIp:
{
Description: Endpoint IP for the HCX Cloud Manager ,
Required: False ,
}
string ,
}
,
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 ,
Required: True ,
}
string ,
managementNetwork:
{
Description: Network used to access vCenter Server and NSX-T Manager ,
Required: False ,
}
string ,
provisioningNetwork:
{
Description: Used for virtual machine cold migration, cloning, and snapshot migration ,
Required: False ,
}
string ,
vmotionNetwork:
{
Description: Used for live migration of virtual machines ,
Required: False ,
}
string ,
vcenterPassword:
{
Description: Optionally, set the vCenter admin password when the private cloud is created ,
Format: password ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
Format: password ,
Required: False ,
}
string ,
vcenterCertificateThumbprint:
{
Description: Thumbprint of the vCenter Server SSL certificate ,
Required: False ,
}
string ,
nsxtCertificateThumbprint:
{
Description: Thumbprint of the NSX-T Manager SSL certificate ,
Required: False ,
}
string ,
externalCloudLinks:
{
Description: Array of cloud link IDs from other clouds that connect to this one ,
Required: False ,
}
[
string ,
]
,
secondaryCircuit:
{
Description: A secondary expressRoute circuit from a separate AZ. Only present in a stretched private cloud ,
Required: False ,
}
{
primarySubnet:
{
Description: CIDR of primary subnet ,
Required: False ,
}
string ,
secondarySubnet:
{
Description: CIDR of secondary subnet ,
Required: False ,
}
string ,
expressRouteID:
{
Description: Identifier of the ExpressRoute Circuit (Microsoft Colo only) ,
Required: False ,
}
string ,
expressRoutePrivatePeeringID:
{
Description: ExpressRoute Circuit private peering identifier ,
Required: False ,
}
string ,
}
,
nsxPublicIpQuotaRaised:
{
Description: Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024 ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
virtualNetworkId:
{
Description: Azure resource ID of the virtual network ,
Format: arm-id ,
Required: False ,
}
string ,
dnsZoneType:
{
Description: The type of DNS zone to use. ,
Enum:
{
Public: Primary DNS zone. ,
Private: Private DNS zone. ,
}
,
Required: False ,
}
enum ,
vcfLicense:
{
Description: The private cloud license ,
Required: False ,
}
{
kind:
{
Description: License kind ,
Enum:
{
vcf5: A VMware Cloud Foundation (VCF) 5.0 license ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the license provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateClouds_Update (new)
Description :  Update a PrivateCloud
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
privateCloudUpdate:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
properties:
{
Description: The updatable properties of a private cloud resource ,
Required: False ,
}
{
managementCluster:
{
Description: The default cluster used for management ,
Required: False ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The state of the cluster provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The identity ,
Format: int32 ,
Required: False ,
}
integer ,
hosts:
{
Description: The hosts ,
Required: False ,
}
[
string ,
]
,
vsanDatastoreName:
{
Description: Name of the vsan datastore associated with the cluster ,
Required: False ,
}
string ,
}
,
internet:
{
Description: Connectivity to internet is enabled or disabled ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
identitySources:
{
Description: vCenter Single Sign On Identity Sources ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity source ,
Required: False ,
}
string ,
alias:
{
Description: The domain's NetBIOS name ,
Required: False ,
}
string ,
domain:
{
Description: The domain's DNS name ,
Required: False ,
}
string ,
baseUserDN:
{
Description: The base distinguished name for users ,
Required: False ,
}
string ,
baseGroupDN:
{
Description: The base distinguished name for groups ,
Required: False ,
}
string ,
primaryServer:
{
Description: Primary server URL ,
Required: False ,
}
string ,
secondaryServer:
{
Description: Secondary server URL ,
Required: False ,
}
string ,
ssl:
{
Description: Protect LDAP communication using SSL certificate (LDAPS) ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
username:
{
Description: The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group ,
Required: False ,
}
string ,
password:
{
Description: The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
availability:
{
Description: Properties describing how the cloud is distributed across availability zones ,
Required: False ,
}
{
strategy:
{
Description: The availability strategy for the private cloud ,
Enum:
{
SingleZone: in single zone ,
DualZone: in two zones ,
}
,
Required: False ,
}
enum ,
zone:
{
Description: The primary availability zone for the private cloud ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryZone:
{
Description: The secondary availability zone for the private cloud ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
encryption:
{
Description: Customer managed key encryption, can be enabled or disabled ,
Required: False ,
}
{
status:
{
Description: Status of customer managed encryption key ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The key vault where the encryption key is stored ,
Required: False ,
}
{
keyName:
{
Description: The name of the key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key. ,
Required: False ,
}
string ,
autoDetectedKeyVersion:
{
Description: The auto-detected version of the key if versionType is auto-detected. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: The URL of the vault. ,
Required: False ,
}
string ,
keyState:
{
Description: The state of key provided ,
Enum:
{
Connected: is connected ,
AccessDenied: is access denied ,
}
,
Required: False ,
}
enum ,
versionType:
{
Description: Property of the key if user provided or auto detected ,
Enum:
{
Fixed: is fixed ,
AutoDetected: is auto-detected ,
}
,
Required: False ,
}
enum ,
}
,
}
,
extendedNetworkBlocks:
{
Description: 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). ,
Required: False ,
}
[
string ,
]
,
dnsZoneType:
{
Description: The type of DNS zone to use. ,
Enum:
{
Public: Primary DNS zone. ,
Private: Private DNS zone. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
managementCluster:
{
Description: The default cluster used for management ,
Required: True ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The state of the cluster provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The identity ,
Format: int32 ,
Required: False ,
}
integer ,
hosts:
{
Description: The hosts ,
Required: False ,
}
[
string ,
]
,
vsanDatastoreName:
{
Description: Name of the vsan datastore associated with the cluster ,
Required: False ,
}
string ,
}
,
internet:
{
Description: Connectivity to internet is enabled or disabled ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
identitySources:
{
Description: vCenter Single Sign On Identity Sources ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity source ,
Required: False ,
}
string ,
alias:
{
Description: The domain's NetBIOS name ,
Required: False ,
}
string ,
domain:
{
Description: The domain's DNS name ,
Required: False ,
}
string ,
baseUserDN:
{
Description: The base distinguished name for users ,
Required: False ,
}
string ,
baseGroupDN:
{
Description: The base distinguished name for groups ,
Required: False ,
}
string ,
primaryServer:
{
Description: Primary server URL ,
Required: False ,
}
string ,
secondaryServer:
{
Description: Secondary server URL ,
Required: False ,
}
string ,
ssl:
{
Description: Protect LDAP communication using SSL certificate (LDAPS) ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
username:
{
Description: The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group ,
Required: False ,
}
string ,
password:
{
Description: The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
availability:
{
Description: Properties describing how the cloud is distributed across availability zones ,
Required: False ,
}
{
strategy:
{
Description: The availability strategy for the private cloud ,
Enum:
{
SingleZone: in single zone ,
DualZone: in two zones ,
}
,
Required: False ,
}
enum ,
zone:
{
Description: The primary availability zone for the private cloud ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryZone:
{
Description: The secondary availability zone for the private cloud ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
encryption:
{
Description: Customer managed key encryption, can be enabled or disabled ,
Required: False ,
}
{
status:
{
Description: Status of customer managed encryption key ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The key vault where the encryption key is stored ,
Required: False ,
}
{
keyName:
{
Description: The name of the key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key. ,
Required: False ,
}
string ,
autoDetectedKeyVersion:
{
Description: The auto-detected version of the key if versionType is auto-detected. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: The URL of the vault. ,
Required: False ,
}
string ,
keyState:
{
Description: The state of key provided ,
Enum:
{
Connected: is connected ,
AccessDenied: is access denied ,
}
,
Required: False ,
}
enum ,
versionType:
{
Description: Property of the key if user provided or auto detected ,
Enum:
{
Fixed: is fixed ,
AutoDetected: is auto-detected ,
}
,
Required: False ,
}
enum ,
}
,
}
,
extendedNetworkBlocks:
{
Description: 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). ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Pending: is pending ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
circuit:
{
Description: An ExpressRoute Circuit ,
Required: False ,
}
{
primarySubnet:
{
Description: CIDR of primary subnet ,
Required: False ,
}
string ,
secondarySubnet:
{
Description: CIDR of secondary subnet ,
Required: False ,
}
string ,
expressRouteID:
{
Description: Identifier of the ExpressRoute Circuit (Microsoft Colo only) ,
Required: False ,
}
string ,
expressRoutePrivatePeeringID:
{
Description: ExpressRoute Circuit private peering identifier ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: The endpoints ,
Required: False ,
}
{
nsxtManager:
{
Description: Endpoint FQDN for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint FQDN for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint FQDN for the HCX Cloud Manager ,
Required: False ,
}
string ,
nsxtManagerIp:
{
Description: Endpoint IP for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcenterIp:
{
Description: Endpoint IP for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManagerIp:
{
Description: Endpoint IP for the HCX Cloud Manager ,
Required: False ,
}
string ,
}
,
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 ,
Required: True ,
}
string ,
managementNetwork:
{
Description: Network used to access vCenter Server and NSX-T Manager ,
Required: False ,
}
string ,
provisioningNetwork:
{
Description: Used for virtual machine cold migration, cloning, and snapshot migration ,
Required: False ,
}
string ,
vmotionNetwork:
{
Description: Used for live migration of virtual machines ,
Required: False ,
}
string ,
vcenterPassword:
{
Description: Optionally, set the vCenter admin password when the private cloud is created ,
Format: password ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
Format: password ,
Required: False ,
}
string ,
vcenterCertificateThumbprint:
{
Description: Thumbprint of the vCenter Server SSL certificate ,
Required: False ,
}
string ,
nsxtCertificateThumbprint:
{
Description: Thumbprint of the NSX-T Manager SSL certificate ,
Required: False ,
}
string ,
externalCloudLinks:
{
Description: Array of cloud link IDs from other clouds that connect to this one ,
Required: False ,
}
[
string ,
]
,
secondaryCircuit:
{
Description: A secondary expressRoute circuit from a separate AZ. Only present in a stretched private cloud ,
Required: False ,
}
{
primarySubnet:
{
Description: CIDR of primary subnet ,
Required: False ,
}
string ,
secondarySubnet:
{
Description: CIDR of secondary subnet ,
Required: False ,
}
string ,
expressRouteID:
{
Description: Identifier of the ExpressRoute Circuit (Microsoft Colo only) ,
Required: False ,
}
string ,
expressRoutePrivatePeeringID:
{
Description: ExpressRoute Circuit private peering identifier ,
Required: False ,
}
string ,
}
,
nsxPublicIpQuotaRaised:
{
Description: Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024 ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
virtualNetworkId:
{
Description: Azure resource ID of the virtual network ,
Format: arm-id ,
Required: False ,
}
string ,
dnsZoneType:
{
Description: The type of DNS zone to use. ,
Enum:
{
Public: Primary DNS zone. ,
Private: Private DNS zone. ,
}
,
Required: False ,
}
enum ,
vcfLicense:
{
Description: The private cloud license ,
Required: False ,
}
{
kind:
{
Description: License kind ,
Enum:
{
vcf5: A VMware Cloud Foundation (VCF) 5.0 license ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the license provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A private cloud resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
managementCluster:
{
Description: The default cluster used for management ,
Required: True ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The state of the cluster provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The identity ,
Format: int32 ,
Required: False ,
}
integer ,
hosts:
{
Description: The hosts ,
Required: False ,
}
[
string ,
]
,
vsanDatastoreName:
{
Description: Name of the vsan datastore associated with the cluster ,
Required: False ,
}
string ,
}
,
internet:
{
Description: Connectivity to internet is enabled or disabled ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
identitySources:
{
Description: vCenter Single Sign On Identity Sources ,
Required: False ,
}
[
{
name:
{
Description: The name of the identity source ,
Required: False ,
}
string ,
alias:
{
Description: The domain's NetBIOS name ,
Required: False ,
}
string ,
domain:
{
Description: The domain's DNS name ,
Required: False ,
}
string ,
baseUserDN:
{
Description: The base distinguished name for users ,
Required: False ,
}
string ,
baseGroupDN:
{
Description: The base distinguished name for groups ,
Required: False ,
}
string ,
primaryServer:
{
Description: Primary server URL ,
Required: False ,
}
string ,
secondaryServer:
{
Description: Secondary server URL ,
Required: False ,
}
string ,
ssl:
{
Description: Protect LDAP communication using SSL certificate (LDAPS) ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
username:
{
Description: The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group ,
Required: False ,
}
string ,
password:
{
Description: The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups. ,
Format: password ,
Required: False ,
}
string ,
}
,
]
,
availability:
{
Description: Properties describing how the cloud is distributed across availability zones ,
Required: False ,
}
{
strategy:
{
Description: The availability strategy for the private cloud ,
Enum:
{
SingleZone: in single zone ,
DualZone: in two zones ,
}
,
Required: False ,
}
enum ,
zone:
{
Description: The primary availability zone for the private cloud ,
Format: int32 ,
Required: False ,
}
integer ,
secondaryZone:
{
Description: The secondary availability zone for the private cloud ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
encryption:
{
Description: Customer managed key encryption, can be enabled or disabled ,
Required: False ,
}
{
status:
{
Description: Status of customer managed encryption key ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: The key vault where the encryption key is stored ,
Required: False ,
}
{
keyName:
{
Description: The name of the key. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The version of the key. ,
Required: False ,
}
string ,
autoDetectedKeyVersion:
{
Description: The auto-detected version of the key if versionType is auto-detected. ,
Required: False ,
}
string ,
keyVaultUrl:
{
Description: The URL of the vault. ,
Required: False ,
}
string ,
keyState:
{
Description: The state of key provided ,
Enum:
{
Connected: is connected ,
AccessDenied: is access denied ,
}
,
Required: False ,
}
enum ,
versionType:
{
Description: Property of the key if user provided or auto detected ,
Enum:
{
Fixed: is fixed ,
AutoDetected: is auto-detected ,
}
,
Required: False ,
}
enum ,
}
,
}
,
extendedNetworkBlocks:
{
Description: 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). ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Pending: is pending ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
circuit:
{
Description: An ExpressRoute Circuit ,
Required: False ,
}
{
primarySubnet:
{
Description: CIDR of primary subnet ,
Required: False ,
}
string ,
secondarySubnet:
{
Description: CIDR of secondary subnet ,
Required: False ,
}
string ,
expressRouteID:
{
Description: Identifier of the ExpressRoute Circuit (Microsoft Colo only) ,
Required: False ,
}
string ,
expressRoutePrivatePeeringID:
{
Description: ExpressRoute Circuit private peering identifier ,
Required: False ,
}
string ,
}
,
endpoints:
{
Description: The endpoints ,
Required: False ,
}
{
nsxtManager:
{
Description: Endpoint FQDN for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint FQDN for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint FQDN for the HCX Cloud Manager ,
Required: False ,
}
string ,
nsxtManagerIp:
{
Description: Endpoint IP for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcenterIp:
{
Description: Endpoint IP for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManagerIp:
{
Description: Endpoint IP for the HCX Cloud Manager ,
Required: False ,
}
string ,
}
,
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 ,
Required: True ,
}
string ,
managementNetwork:
{
Description: Network used to access vCenter Server and NSX-T Manager ,
Required: False ,
}
string ,
provisioningNetwork:
{
Description: Used for virtual machine cold migration, cloning, and snapshot migration ,
Required: False ,
}
string ,
vmotionNetwork:
{
Description: Used for live migration of virtual machines ,
Required: False ,
}
string ,
vcenterPassword:
{
Description: Optionally, set the vCenter admin password when the private cloud is created ,
Format: password ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
Format: password ,
Required: False ,
}
string ,
vcenterCertificateThumbprint:
{
Description: Thumbprint of the vCenter Server SSL certificate ,
Required: False ,
}
string ,
nsxtCertificateThumbprint:
{
Description: Thumbprint of the NSX-T Manager SSL certificate ,
Required: False ,
}
string ,
externalCloudLinks:
{
Description: Array of cloud link IDs from other clouds that connect to this one ,
Required: False ,
}
[
string ,
]
,
secondaryCircuit:
{
Description: A secondary expressRoute circuit from a separate AZ. Only present in a stretched private cloud ,
Required: False ,
}
{
primarySubnet:
{
Description: CIDR of primary subnet ,
Required: False ,
}
string ,
secondarySubnet:
{
Description: CIDR of secondary subnet ,
Required: False ,
}
string ,
expressRouteID:
{
Description: Identifier of the ExpressRoute Circuit (Microsoft Colo only) ,
Required: False ,
}
string ,
expressRoutePrivatePeeringID:
{
Description: ExpressRoute Circuit private peering identifier ,
Required: False ,
}
string ,
}
,
nsxPublicIpQuotaRaised:
{
Description: Flag to indicate whether the private cloud has the quota for provisioned NSX Public IP count raised from 64 to 1024 ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
virtualNetworkId:
{
Description: Azure resource ID of the virtual network ,
Format: arm-id ,
Required: False ,
}
string ,
dnsZoneType:
{
Description: The type of DNS zone to use. ,
Enum:
{
Public: Primary DNS zone. ,
Private: Private DNS zone. ,
}
,
Required: False ,
}
enum ,
vcfLicense:
{
Description: The private cloud license ,
Required: False ,
}
{
kind:
{
Description: License kind ,
Enum:
{
vcf5: A VMware Cloud Foundation (VCF) 5.0 license ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the license provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateClouds_Delete (new)
Description :  Delete a PrivateCloud
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Addons_List (new)
Description :  List Addon resources by PrivateCloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Addon items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
addonType:
{
Description: Addon type ,
Enum:
{
SRM: No description available. ,
VR: No description available. ,
HCX: No description available. ,
Arc: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the addon provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Addons_Get (new)
Description :  Get a Addon
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
addonName:
{
Description: Name of the addon. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
addonType:
{
Description: Addon type ,
Enum:
{
SRM: No description available. ,
VR: No description available. ,
HCX: No description available. ,
Arc: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the addon provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Addons_CreateOrUpdate (new)
Description :  Create a Addon
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
addonName:
{
Description: Name of the addon. ,
Required: True ,
}
string ,
addon:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
addonType:
{
Description: Addon type ,
Enum:
{
SRM: No description available. ,
VR: No description available. ,
HCX: No description available. ,
Arc: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the addon provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
addonType:
{
Description: Addon type ,
Enum:
{
SRM: No description available. ,
VR: No description available. ,
HCX: No description available. ,
Arc: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the addon provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An addon resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
addonType:
{
Description: Addon type ,
Enum:
{
SRM: No description available. ,
VR: No description available. ,
HCX: No description available. ,
Arc: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the addon provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Addons_Delete (new)
Description :  Delete a Addon
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
addonName:
{
Description: Name of the addon. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Authorizations_List (new)
Description :  List ExpressRouteAuthorization resources by PrivateCloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ExpressRouteAuthorization items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
expressRouteAuthorizationId:
{
Description: The ID of the ExpressRoute Circuit Authorization ,
Required: False ,
}
string ,
expressRouteAuthorizationKey:
{
Description: The key of the ExpressRoute Circuit Authorization ,
Required: False ,
}
string ,
expressRouteId:
{
Description: The ID of the ExpressRoute Circuit ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Authorizations_Get (new)
Description :  Get a ExpressRouteAuthorization
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
authorizationName:
{
Description: Name of the ExpressRoute Circuit Authorization ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
expressRouteAuthorizationId:
{
Description: The ID of the ExpressRoute Circuit Authorization ,
Required: False ,
}
string ,
expressRouteAuthorizationKey:
{
Description: The key of the ExpressRoute Circuit Authorization ,
Required: False ,
}
string ,
expressRouteId:
{
Description: The ID of the ExpressRoute Circuit ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Authorizations_CreateOrUpdate (new)
Description :  Create a ExpressRouteAuthorization
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
authorizationName:
{
Description: Name of the ExpressRoute Circuit Authorization ,
Required: True ,
}
string ,
authorization:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
expressRouteAuthorizationId:
{
Description: The ID of the ExpressRoute Circuit Authorization ,
Required: False ,
}
string ,
expressRouteAuthorizationKey:
{
Description: The key of the ExpressRoute Circuit Authorization ,
Required: False ,
}
string ,
expressRouteId:
{
Description: The ID of the ExpressRoute Circuit ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
expressRouteAuthorizationId:
{
Description: The ID of the ExpressRoute Circuit Authorization ,
Required: False ,
}
string ,
expressRouteAuthorizationKey:
{
Description: The key of the ExpressRoute Circuit Authorization ,
Required: False ,
}
string ,
expressRouteId:
{
Description: The ID of the ExpressRoute Circuit ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: ExpressRoute Circuit Authorization ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
expressRouteAuthorizationId:
{
Description: The ID of the ExpressRoute Circuit Authorization ,
Required: False ,
}
string ,
expressRouteAuthorizationKey:
{
Description: The key of the ExpressRoute Circuit Authorization ,
Required: False ,
}
string ,
expressRouteId:
{
Description: The ID of the ExpressRoute Circuit ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Authorizations_Delete (new)
Description :  Delete a ExpressRouteAuthorization
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
authorizationName:
{
Description: Name of the ExpressRoute Circuit Authorization ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_List (new)
Description :  List Cluster resources by PrivateCloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Cluster items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The state of the cluster provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The identity ,
Format: int32 ,
Required: False ,
}
integer ,
hosts:
{
Description: The hosts ,
Required: False ,
}
[
string ,
]
,
vsanDatastoreName:
{
Description: Name of the vsan datastore associated with the cluster ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Get (new)
Description :  Get a Cluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The state of the cluster provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The identity ,
Format: int32 ,
Required: False ,
}
integer ,
hosts:
{
Description: The hosts ,
Required: False ,
}
[
string ,
]
,
vsanDatastoreName:
{
Description: Name of the vsan datastore associated with the cluster ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_CreateOrUpdate (new)
Description :  Create a Cluster
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
cluster:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The state of the cluster provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The identity ,
Format: int32 ,
Required: False ,
}
integer ,
hosts:
{
Description: The hosts ,
Required: False ,
}
[
string ,
]
,
vsanDatastoreName:
{
Description: Name of the vsan datastore associated with the cluster ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The state of the cluster provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The identity ,
Format: int32 ,
Required: False ,
}
integer ,
hosts:
{
Description: The hosts ,
Required: False ,
}
[
string ,
]
,
vsanDatastoreName:
{
Description: Name of the vsan datastore associated with the cluster ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A cluster resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The state of the cluster provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The identity ,
Format: int32 ,
Required: False ,
}
integer ,
hosts:
{
Description: The hosts ,
Required: False ,
}
[
string ,
]
,
vsanDatastoreName:
{
Description: Name of the vsan datastore associated with the cluster ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Update (new)
Description :  Update a Cluster
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
clusterUpdate:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
properties:
{
Description: The properties of a cluster resource that may be updated ,
Required: False ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
hosts:
{
Description: The hosts ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The state of the cluster provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The identity ,
Format: int32 ,
Required: False ,
}
integer ,
hosts:
{
Description: The hosts ,
Required: False ,
}
[
string ,
]
,
vsanDatastoreName:
{
Description: Name of the vsan datastore associated with the cluster ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A cluster resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The state of the cluster provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
clusterId:
{
Description: The identity ,
Format: int32 ,
Required: False ,
}
integer ,
hosts:
{
Description: The hosts ,
Required: False ,
}
[
string ,
]
,
vsanDatastoreName:
{
Description: Name of the vsan datastore associated with the cluster ,
Required: False ,
}
string ,
}
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Delete (new)
Description :  Delete a Cluster
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Datastores_List (new)
Description :  List Datastore resources by Cluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Datastore items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the datastore provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Pending: is pending ,
Creating: is creating ,
Updating: is updating ,
Deleting: is deleting ,
}
,
Required: False ,
}
enum ,
netAppVolume:
{
Description: An Azure NetApp Files volume ,
Required: False ,
}
{
id:
{
Description: Azure resource ID of the NetApp volume ,
Required: True ,
}
string ,
}
,
diskPoolVolume:
{
Description: An iSCSI volume ,
Required: False ,
}
{
targetId:
{
Description: Azure resource ID of the iSCSI target ,
Required: True ,
}
string ,
lunName:
{
Description: Name of the LUN to be used for datastore ,
Required: True ,
}
string ,
mountOption:
{
Description: Mode that describes whether the LUN has to be mounted as a datastore or attached as a LUN ,
Enum:
{
MOUNT: is mount ,
ATTACH: is attach ,
}
,
Required: False ,
}
enum ,
path:
{
Description: Device path ,
Required: False ,
}
string ,
}
,
elasticSanVolume:
{
Description: An Elastic SAN volume ,
Required: False ,
}
{
targetId:
{
Description: Azure resource ID of the Elastic SAN Volume ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
pureStorageVolume:
{
Description: A Pure Storage volume ,
Required: False ,
}
{
storagePoolId:
{
Description: Azure resource ID of the Pure Storage Pool ,
Format: arm-id ,
Required: True ,
}
string ,
sizeGb:
{
Description: Volume size to be used to create a Virtual Volumes (vVols) datastore ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
status:
{
Description: The operational status of the datastore ,
Enum:
{
Unknown: is unknown ,
Accessible: is accessible ,
Inaccessible: is inaccessible ,
Attached: is attached ,
Detached: is detached ,
LostCommunication: is lost communication ,
DeadOrError: is dead or error ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Datastores_Get (new)
Description :  Get a Datastore
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores/{datastoreName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
datastoreName:
{
Description: Name of the datastore ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the datastore provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Pending: is pending ,
Creating: is creating ,
Updating: is updating ,
Deleting: is deleting ,
}
,
Required: False ,
}
enum ,
netAppVolume:
{
Description: An Azure NetApp Files volume ,
Required: False ,
}
{
id:
{
Description: Azure resource ID of the NetApp volume ,
Required: True ,
}
string ,
}
,
diskPoolVolume:
{
Description: An iSCSI volume ,
Required: False ,
}
{
targetId:
{
Description: Azure resource ID of the iSCSI target ,
Required: True ,
}
string ,
lunName:
{
Description: Name of the LUN to be used for datastore ,
Required: True ,
}
string ,
mountOption:
{
Description: Mode that describes whether the LUN has to be mounted as a datastore or attached as a LUN ,
Enum:
{
MOUNT: is mount ,
ATTACH: is attach ,
}
,
Required: False ,
}
enum ,
path:
{
Description: Device path ,
Required: False ,
}
string ,
}
,
elasticSanVolume:
{
Description: An Elastic SAN volume ,
Required: False ,
}
{
targetId:
{
Description: Azure resource ID of the Elastic SAN Volume ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
pureStorageVolume:
{
Description: A Pure Storage volume ,
Required: False ,
}
{
storagePoolId:
{
Description: Azure resource ID of the Pure Storage Pool ,
Format: arm-id ,
Required: True ,
}
string ,
sizeGb:
{
Description: Volume size to be used to create a Virtual Volumes (vVols) datastore ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
status:
{
Description: The operational status of the datastore ,
Enum:
{
Unknown: is unknown ,
Accessible: is accessible ,
Inaccessible: is inaccessible ,
Attached: is attached ,
Detached: is detached ,
LostCommunication: is lost communication ,
DeadOrError: is dead or error ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Datastores_CreateOrUpdate (new)
Description :  Create a Datastore
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores/{datastoreName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
datastoreName:
{
Description: Name of the datastore ,
Required: True ,
}
string ,
datastore:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the datastore provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Pending: is pending ,
Creating: is creating ,
Updating: is updating ,
Deleting: is deleting ,
}
,
Required: False ,
}
enum ,
netAppVolume:
{
Description: An Azure NetApp Files volume ,
Required: False ,
}
{
id:
{
Description: Azure resource ID of the NetApp volume ,
Required: True ,
}
string ,
}
,
diskPoolVolume:
{
Description: An iSCSI volume ,
Required: False ,
}
{
targetId:
{
Description: Azure resource ID of the iSCSI target ,
Required: True ,
}
string ,
lunName:
{
Description: Name of the LUN to be used for datastore ,
Required: True ,
}
string ,
mountOption:
{
Description: Mode that describes whether the LUN has to be mounted as a datastore or attached as a LUN ,
Enum:
{
MOUNT: is mount ,
ATTACH: is attach ,
}
,
Required: False ,
}
enum ,
path:
{
Description: Device path ,
Required: False ,
}
string ,
}
,
elasticSanVolume:
{
Description: An Elastic SAN volume ,
Required: False ,
}
{
targetId:
{
Description: Azure resource ID of the Elastic SAN Volume ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
pureStorageVolume:
{
Description: A Pure Storage volume ,
Required: False ,
}
{
storagePoolId:
{
Description: Azure resource ID of the Pure Storage Pool ,
Format: arm-id ,
Required: True ,
}
string ,
sizeGb:
{
Description: Volume size to be used to create a Virtual Volumes (vVols) datastore ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
status:
{
Description: The operational status of the datastore ,
Enum:
{
Unknown: is unknown ,
Accessible: is accessible ,
Inaccessible: is inaccessible ,
Attached: is attached ,
Detached: is detached ,
LostCommunication: is lost communication ,
DeadOrError: is dead or error ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the datastore provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Pending: is pending ,
Creating: is creating ,
Updating: is updating ,
Deleting: is deleting ,
}
,
Required: False ,
}
enum ,
netAppVolume:
{
Description: An Azure NetApp Files volume ,
Required: False ,
}
{
id:
{
Description: Azure resource ID of the NetApp volume ,
Required: True ,
}
string ,
}
,
diskPoolVolume:
{
Description: An iSCSI volume ,
Required: False ,
}
{
targetId:
{
Description: Azure resource ID of the iSCSI target ,
Required: True ,
}
string ,
lunName:
{
Description: Name of the LUN to be used for datastore ,
Required: True ,
}
string ,
mountOption:
{
Description: Mode that describes whether the LUN has to be mounted as a datastore or attached as a LUN ,
Enum:
{
MOUNT: is mount ,
ATTACH: is attach ,
}
,
Required: False ,
}
enum ,
path:
{
Description: Device path ,
Required: False ,
}
string ,
}
,
elasticSanVolume:
{
Description: An Elastic SAN volume ,
Required: False ,
}
{
targetId:
{
Description: Azure resource ID of the Elastic SAN Volume ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
pureStorageVolume:
{
Description: A Pure Storage volume ,
Required: False ,
}
{
storagePoolId:
{
Description: Azure resource ID of the Pure Storage Pool ,
Format: arm-id ,
Required: True ,
}
string ,
sizeGb:
{
Description: Volume size to be used to create a Virtual Volumes (vVols) datastore ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
status:
{
Description: The operational status of the datastore ,
Enum:
{
Unknown: is unknown ,
Accessible: is accessible ,
Inaccessible: is inaccessible ,
Attached: is attached ,
Detached: is detached ,
LostCommunication: is lost communication ,
DeadOrError: is dead or error ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A datastore resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the datastore provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Cancelled: is cancelled ,
Pending: is pending ,
Creating: is creating ,
Updating: is updating ,
Deleting: is deleting ,
}
,
Required: False ,
}
enum ,
netAppVolume:
{
Description: An Azure NetApp Files volume ,
Required: False ,
}
{
id:
{
Description: Azure resource ID of the NetApp volume ,
Required: True ,
}
string ,
}
,
diskPoolVolume:
{
Description: An iSCSI volume ,
Required: False ,
}
{
targetId:
{
Description: Azure resource ID of the iSCSI target ,
Required: True ,
}
string ,
lunName:
{
Description: Name of the LUN to be used for datastore ,
Required: True ,
}
string ,
mountOption:
{
Description: Mode that describes whether the LUN has to be mounted as a datastore or attached as a LUN ,
Enum:
{
MOUNT: is mount ,
ATTACH: is attach ,
}
,
Required: False ,
}
enum ,
path:
{
Description: Device path ,
Required: False ,
}
string ,
}
,
elasticSanVolume:
{
Description: An Elastic SAN volume ,
Required: False ,
}
{
targetId:
{
Description: Azure resource ID of the Elastic SAN Volume ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
pureStorageVolume:
{
Description: A Pure Storage volume ,
Required: False ,
}
{
storagePoolId:
{
Description: Azure resource ID of the Pure Storage Pool ,
Format: arm-id ,
Required: True ,
}
string ,
sizeGb:
{
Description: Volume size to be used to create a Virtual Volumes (vVols) datastore ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
status:
{
Description: The operational status of the datastore ,
Enum:
{
Unknown: is unknown ,
Accessible: is accessible ,
Inaccessible: is inaccessible ,
Attached: is attached ,
Detached: is detached ,
LostCommunication: is lost communication ,
DeadOrError: is dead or error ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Datastores_Delete (new)
Description :  Delete a Datastore
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores/{datastoreName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
datastoreName:
{
Description: Name of the datastore ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Hosts_List (new)
Description :  List Host resources by Cluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/hosts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Host items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
kind:
{
Description: The kind of host ,
Enum:
{
General: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the host provisioning. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the host in VMware vCenter. ,
Required: False ,
}
string ,
moRefId:
{
Description: vCenter managed object reference ID of the host. ,
Required: False ,
}
string ,
fqdn:
{
Description: Fully qualified domain name of the host. ,
Required: False ,
}
string ,
maintenance:
{
Description: If provided, the host is in maintenance. The value is the reason for maintenance. ,
Enum:
{
Replacement: The host is a replacement host. ,
Upgrade: The host is for an upgrade, such as an upgrade to ESXi, NSX-T, or other component. ,
}
,
Required: False ,
}
enum ,
faultDomain:
{
Required: False ,
}
string ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Hosts_Get (new)
Description :  Get a Host
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/hosts/{hostId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
hostId:
{
Description: The host identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
kind:
{
Description: The kind of host ,
Enum:
{
General: No description available. ,
Specialized: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the host provisioning. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the host in VMware vCenter. ,
Required: False ,
}
string ,
moRefId:
{
Description: vCenter managed object reference ID of the host. ,
Required: False ,
}
string ,
fqdn:
{
Description: Fully qualified domain name of the host. ,
Required: False ,
}
string ,
maintenance:
{
Description: If provided, the host is in maintenance. The value is the reason for maintenance. ,
Enum:
{
Replacement: The host is a replacement host. ,
Upgrade: The host is for an upgrade, such as an upgrade to ESXi, NSX-T, or other component. ,
}
,
Required: False ,
}
enum ,
faultDomain:
{
Required: False ,
}
string ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
sku:
{
Description: The SKU (Stock Keeping Unit) assigned to this resource. ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. E.g. P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListZones (new)
Description :  List hosts by zone in a cluster
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/listZones
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
zones:
{
Description: Zone and associated hosts info ,
Required: False ,
}
[
{
hosts:
{
Description: List of hosts belonging to the availability zone in a cluster ,
Required: False ,
}
[
string ,
]
,
zone:
{
Description: Availability zone identifier ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PlacementPolicies_List (new)
Description :  List PlacementPolicy resources by Cluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PlacementPolicy items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
type:
{
Description: Placement Policy type ,
Enum:
{
VmVm: No description available. ,
VmHost: No description available. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: Whether the placement policy is enabled or disabled ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the placement policy ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PlacementPolicies_Get (new)
Description :  Get a PlacementPolicy
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies/{placementPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
placementPolicyName:
{
Description: Name of the placement policy. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
type:
{
Description: Placement Policy type ,
Enum:
{
VmVm: No description available. ,
VmHost: No description available. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: Whether the placement policy is enabled or disabled ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the placement policy ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PlacementPolicies_CreateOrUpdate (new)
Description :  Create a PlacementPolicy
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies/{placementPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
placementPolicyName:
{
Description: Name of the placement policy. ,
Required: True ,
}
string ,
placementPolicy:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
type:
{
Description: Placement Policy type ,
Enum:
{
VmVm: No description available. ,
VmHost: No description available. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: Whether the placement policy is enabled or disabled ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the placement policy ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
type:
{
Description: Placement Policy type ,
Enum:
{
VmVm: No description available. ,
VmHost: No description available. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: Whether the placement policy is enabled or disabled ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the placement policy ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A vSphere Distributed Resource Scheduler (DRS) placement policy ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
type:
{
Description: Placement Policy type ,
Enum:
{
VmVm: No description available. ,
VmHost: No description available. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: Whether the placement policy is enabled or disabled ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the placement policy ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PlacementPolicies_Update (new)
Description :  Update a PlacementPolicy
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies/{placementPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
placementPolicyName:
{
Description: Name of the placement policy. ,
Required: True ,
}
string ,
placementPolicyUpdate:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The properties of a placement policy resource that may be updated ,
Required: False ,
}
{
state:
{
Description: Whether the placement policy is enabled or disabled ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
vmMembers:
{
Description: Virtual machine members list ,
Required: False ,
}
[
string ,
]
,
hostMembers:
{
Description: Host members list ,
Required: False ,
}
[
string ,
]
,
affinityStrength:
{
Description: vm-host placement policy affinity strength (should/must) ,
Enum:
{
Should: is should ,
Must: is must ,
}
,
Required: False ,
}
enum ,
azureHybridBenefitType:
{
Description: placement policy azure hybrid benefit opt-in type ,
Enum:
{
SqlHost: is SqlHost ,
None: is None ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
type:
{
Description: Placement Policy type ,
Enum:
{
VmVm: No description available. ,
VmHost: No description available. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: Whether the placement policy is enabled or disabled ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the placement policy ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A vSphere Distributed Resource Scheduler (DRS) placement policy ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
type:
{
Description: Placement Policy type ,
Enum:
{
VmVm: No description available. ,
VmHost: No description available. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: Whether the placement policy is enabled or disabled ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the placement policy ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PlacementPolicies_Delete (new)
Description :  Delete a PlacementPolicy
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/placementPolicies/{placementPolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
placementPolicyName:
{
Description: Name of the placement policy. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_List (new)
Description :  List VirtualMachine resources by Cluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/virtualMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The VirtualMachine items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the VM. ,
Required: False ,
}
string ,
moRefId:
{
Description: vCenter managed object reference ID of the virtual machine ,
Required: False ,
}
string ,
folderPath:
{
Description: Path to virtual machine's folder starting from datacenter virtual machine folder ,
Required: False ,
}
string ,
restrictMovement:
{
Description: Whether VM DRS-driven movement is restricted (enabled) or not (disabled) ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_Get (new)
Description :  Get a VirtualMachine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/virtualMachines/{virtualMachineId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
virtualMachineId:
{
Description: ID of the virtual machine. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the VM. ,
Required: False ,
}
string ,
moRefId:
{
Description: vCenter managed object reference ID of the virtual machine ,
Required: False ,
}
string ,
folderPath:
{
Description: Path to virtual machine's folder starting from datacenter virtual machine folder ,
Required: False ,
}
string ,
restrictMovement:
{
Description: Whether VM DRS-driven movement is restricted (enabled) or not (disabled) ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachines_RestrictMovement (new)
Description :  Enable or disable DRS-driven VM movement restriction
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/virtualMachines/{virtualMachineId}/restrictMovement
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster ,
Required: True ,
}
string ,
virtualMachineId:
{
Description: ID of the virtual machine. ,
Required: True ,
}
string ,
restrictMovement:
{
Description: The content of the action request ,
Required: True ,
}
{
restrictMovement:
{
Description: Whether VM DRS-driven movement is restricted (enabled) or not (disabled) ,
Enum:
{
Enabled: is enabled ,
Disabled: is disabled ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateClouds_GetVcfLicense (new)
Description :  Get the license for the private cloud
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/getVcfLicense
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: License kind ,
Enum:
{
vcf5: A VMware Cloud Foundation (VCF) 5.0 license ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the license provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalReachConnections_List (new)
Description :  List GlobalReachConnection resources by PrivateCloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The GlobalReachConnection items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
addressPrefix:
{
Description: The network used for global reach carved out from the original network block provided for the private cloud ,
Required: False ,
}
string ,
authorizationKey:
{
Description: Authorization key from the peer express route used for the global reach connection ,
Required: False ,
}
string ,
circuitConnectionStatus:
{
Description: The connection status of the global reach connection ,
Enum:
{
Connected: is connected ,
Connecting: is connecting ,
Disconnected: is disconnected ,
}
,
Required: False ,
}
enum ,
peerExpressRouteCircuit:
{
Description: Identifier of the ExpressRoute Circuit to peer with in the global reach connection ,
Required: False ,
}
string ,
expressRouteId:
{
Description: The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalReachConnections_Get (new)
Description :  Get a GlobalReachConnection
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
globalReachConnectionName:
{
Description: Name of the global reach connection ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
addressPrefix:
{
Description: The network used for global reach carved out from the original network block provided for the private cloud ,
Required: False ,
}
string ,
authorizationKey:
{
Description: Authorization key from the peer express route used for the global reach connection ,
Required: False ,
}
string ,
circuitConnectionStatus:
{
Description: The connection status of the global reach connection ,
Enum:
{
Connected: is connected ,
Connecting: is connecting ,
Disconnected: is disconnected ,
}
,
Required: False ,
}
enum ,
peerExpressRouteCircuit:
{
Description: Identifier of the ExpressRoute Circuit to peer with in the global reach connection ,
Required: False ,
}
string ,
expressRouteId:
{
Description: The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalReachConnections_CreateOrUpdate (new)
Description :  Create a GlobalReachConnection
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
globalReachConnectionName:
{
Description: Name of the global reach connection ,
Required: True ,
}
string ,
globalReachConnection:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
addressPrefix:
{
Description: The network used for global reach carved out from the original network block provided for the private cloud ,
Required: False ,
}
string ,
authorizationKey:
{
Description: Authorization key from the peer express route used for the global reach connection ,
Required: False ,
}
string ,
circuitConnectionStatus:
{
Description: The connection status of the global reach connection ,
Enum:
{
Connected: is connected ,
Connecting: is connecting ,
Disconnected: is disconnected ,
}
,
Required: False ,
}
enum ,
peerExpressRouteCircuit:
{
Description: Identifier of the ExpressRoute Circuit to peer with in the global reach connection ,
Required: False ,
}
string ,
expressRouteId:
{
Description: The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
addressPrefix:
{
Description: The network used for global reach carved out from the original network block provided for the private cloud ,
Required: False ,
}
string ,
authorizationKey:
{
Description: Authorization key from the peer express route used for the global reach connection ,
Required: False ,
}
string ,
circuitConnectionStatus:
{
Description: The connection status of the global reach connection ,
Enum:
{
Connected: is connected ,
Connecting: is connecting ,
Disconnected: is disconnected ,
}
,
Required: False ,
}
enum ,
peerExpressRouteCircuit:
{
Description: Identifier of the ExpressRoute Circuit to peer with in the global reach connection ,
Required: False ,
}
string ,
expressRouteId:
{
Description: The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A global reach connection resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
addressPrefix:
{
Description: The network used for global reach carved out from the original network block provided for the private cloud ,
Required: False ,
}
string ,
authorizationKey:
{
Description: Authorization key from the peer express route used for the global reach connection ,
Required: False ,
}
string ,
circuitConnectionStatus:
{
Description: The connection status of the global reach connection ,
Enum:
{
Connected: is connected ,
Connecting: is connecting ,
Disconnected: is disconnected ,
}
,
Required: False ,
}
enum ,
peerExpressRouteCircuit:
{
Description: Identifier of the ExpressRoute Circuit to peer with in the global reach connection ,
Required: False ,
}
string ,
expressRouteId:
{
Description: The ID of the Private Cloud's ExpressRoute Circuit that is participating in the global reach connection ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GlobalReachConnections_Delete (new)
Description :  Delete a GlobalReachConnection
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
globalReachConnectionName:
{
Description: Name of the global reach connection ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HcxEnterpriseSites_List (new)
Description :  List HcxEnterpriseSite resources by PrivateCloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The HcxEnterpriseSite items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
activationKey:
{
Description: The activation key ,
Required: False ,
}
string ,
status:
{
Description: The status of the HCX Enterprise Site ,
Enum:
{
Available: is available ,
Consumed: is consumed ,
Deactivated: is deactivated ,
Deleted: is deleted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HcxEnterpriseSites_Get (new)
Description :  Get a HcxEnterpriseSite
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
hcxEnterpriseSiteName:
{
Description: Name of the HCX Enterprise Site ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
activationKey:
{
Description: The activation key ,
Required: False ,
}
string ,
status:
{
Description: The status of the HCX Enterprise Site ,
Enum:
{
Available: is available ,
Consumed: is consumed ,
Deactivated: is deactivated ,
Deleted: is deleted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HcxEnterpriseSites_CreateOrUpdate (new)
Description :  Create a HcxEnterpriseSite
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
hcxEnterpriseSiteName:
{
Description: Name of the HCX Enterprise Site ,
Required: True ,
}
string ,
hcxEnterpriseSite:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
activationKey:
{
Description: The activation key ,
Required: False ,
}
string ,
status:
{
Description: The status of the HCX Enterprise Site ,
Enum:
{
Available: is available ,
Consumed: is consumed ,
Deactivated: is deactivated ,
Deleted: is deleted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
activationKey:
{
Description: The activation key ,
Required: False ,
}
string ,
status:
{
Description: The status of the HCX Enterprise Site ,
Enum:
{
Available: is available ,
Consumed: is consumed ,
Deactivated: is deactivated ,
Deleted: is deleted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
activationKey:
{
Description: The activation key ,
Required: False ,
}
string ,
status:
{
Description: The status of the HCX Enterprise Site ,
Enum:
{
Available: is available ,
Consumed: is consumed ,
Deactivated: is deactivated ,
Deleted: is deleted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
HcxEnterpriseSites_Delete (new)
Description :  Delete a HcxEnterpriseSite
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
hcxEnterpriseSiteName:
{
Description: Name of the HCX Enterprise Site ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IscsiPaths_ListByPrivateCloud (new)
Description :  List IscsiPath resources by PrivateCloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/iscsiPaths
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The IscsiPath items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the iSCSI path provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Pending: is pending ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
networkBlock:
{
Description: CIDR Block for iSCSI path. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IscsiPaths_Get (new)
Description :  Get a IscsiPath
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/iscsiPaths/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the iSCSI path provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Pending: is pending ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
networkBlock:
{
Description: CIDR Block for iSCSI path. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IscsiPaths_CreateOrUpdate (new)
Description :  Create a IscsiPath
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/iscsiPaths/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the iSCSI path provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Pending: is pending ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
networkBlock:
{
Description: CIDR Block for iSCSI path. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the iSCSI path provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Pending: is pending ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
networkBlock:
{
Description: CIDR Block for iSCSI path. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An iSCSI path resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the iSCSI path provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Pending: is pending ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
networkBlock:
{
Description: CIDR Block for iSCSI path. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IscsiPaths_Delete (new)
Description :  Delete a IscsiPath
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/iscsiPaths/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Licenses_List (new)
Description :  List License resources by PrivateCloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/licenses
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The License items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
kind:
{
Description: License kind ,
Enum:
{
VmwareFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the license provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Licenses_Get (new)
Description :  Get a License
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/licenses/{licenseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
licenseName:
{
Description: Name of the license. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
kind:
{
Description: License kind ,
Enum:
{
VmwareFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the license provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Licenses_CreateOrUpdate (new)
Description :  Create a License
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/licenses/{licenseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
licenseName:
{
Description: Name of the license. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
kind:
{
Description: License kind ,
Enum:
{
VmwareFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the license provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
kind:
{
Description: License kind ,
Enum:
{
VmwareFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the license provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A license resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
kind:
{
Description: License kind ,
Enum:
{
VmwareFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the license provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Licenses_Delete (new)
Description :  Delete a License
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/licenses/{licenseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
licenseName:
{
Description: Name of the license. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Licenses_GetProperties (new)
Description :  Just like ArmResourceActionSync, but with no request body.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/licenses/{licenseName}/getProperties
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
licenseName:
{
Description: Name of the license. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: License kind ,
Enum:
{
VmwareFirewall: No description available. ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: The state of the license provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateClouds_ListAdminCredentials (new)
Description :  List the admin credentials for the private cloud
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/listAdminCredentials
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nsxtUsername:
{
Description: NSX-T Manager username ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: NSX-T Manager password ,
Format: password ,
Required: False ,
}
string ,
vcenterUsername:
{
Description: vCenter admin username ,
Required: False ,
}
string ,
vcenterPassword:
{
Description: vCenter admin password ,
Format: password ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Maintenances_List (new)
Description :  List Maintenance resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/maintenances
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
stateName:
{
Description: Filter maintenances based on state ,
Required: False ,
}
string ,
status:
{
Description: Filter active or inactive maintenances ,
Required: False ,
}
string ,
from:
{
Description: date from which result should be returned. ie. scheduledStartTime >= from ,
Format: date-time ,
Required: False ,
}
string ,
to:
{
Description: date till which result should be returned. i.e. scheduledStartTime <= to ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Maintenance items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
component:
{
Description: type of maintenance ,
Enum:
{
VCSA: maintenance for vCenter Server Appliance ,
ESXI: maintenance for ESXi ,
NSXT: maintenance for NSX-T ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name for maintenance ,
Required: False ,
}
string ,
clusterId:
{
Description: Cluster ID for on which maintenance will be applied. Empty if maintenance is at private cloud level ,
Format: int32 ,
Required: False ,
}
integer ,
infoLink:
{
Description: Link to maintenance info ,
Required: False ,
}
string ,
impact:
{
Description: Impact on the resource during maintenance period ,
Required: False ,
}
string ,
scheduledByMicrosoft:
{
Description: If maintenance is scheduled by Microsoft ,
Required: False ,
}
boolean ,
state:
{
Description: The state of the maintenance ,
Required: False ,
}
{
name:
{
Description: Customer presentable maintenance state ,
Enum:
{
NotScheduled: Maintenance Not Scheduled ,
Scheduled: Maintenance Scheduled ,
InProgress: Maintenance In Progress ,
Success: Maintenance Succeeded ,
Failed: Maintenance Failed ,
Canceled: Maintenance Cancelled ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Failure/Success info ,
Required: False ,
}
string ,
startedAt:
{
Description: Time when current state started ,
Format: date-time ,
Required: False ,
}
string ,
endedAt:
{
Description: Time when current state ended ,
Format: date-time ,
Required: False ,
}
string ,
}
,
scheduledStartTime:
{
Description: Scheduled maintenance start time ,
Format: date-time ,
Required: False ,
}
string ,
estimatedDurationInMinutes:
{
Description: Estimated time maintenance will take in minutes ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
operations:
{
Description: Operations on maintenance ,
Required: False ,
}
[
{
kind:
{
Description: The kind of operation ,
Enum:
{
Schedule: Represents a scheduling operation ,
Reschedule: Represents a rescheduling operation ,
MaintenanceReadinessRefresh: Represents a maintenance readiness refresh operation ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maintenanceReadiness:
{
Description: Indicates whether the maintenance is ready to proceed ,
Required: False ,
}
{
type:
{
Description: The type of maintenance readiness check ,
Enum:
{
Precheck: Pre-check maintenance readiness ,
Preflight: Pre-flight maintenance readiness ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The current readiness status of maintenance ,
Enum:
{
Ready: The system is ready for maintenance ,
NotReady: The system is not ready for maintenance ,
DataNotAvailable: Data is not available to determine readiness ,
NotApplicable: Readiness check is not applicable ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A summary message of the readiness check result ,
Required: False ,
}
string ,
failedChecks:
{
Description: A list of failed checks, if any ,
Required: False ,
}
[
{
name:
{
Description: The name of the failed check ,
Required: False ,
}
string ,
impactedResources:
{
Description: A list of resources impacted by the failed check ,
Required: False ,
}
[
{
id:
{
Description: The ID of the impacted resource ,
Required: False ,
}
string ,
errors:
{
Description: A list of errors associated with the impacted resource ,
Required: False ,
}
[
{
errorCode:
{
Description: The error code ,
Required: False ,
}
string ,
name:
{
Description: The name of the error ,
Required: False ,
}
string ,
details:
{
Description: Additional details about the error ,
Required: False ,
}
string ,
resolutionSteps:
{
Description: Steps to resolve the error ,
Required: False ,
}
[
string ,
]
,
actionRequired:
{
Description: Indicates whether action is required by the customer ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
]
,
lastUpdated:
{
Description: The timestamp of the last readiness update ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Maintenances_Get (new)
Description :  Get a Maintenance
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/maintenances/{maintenanceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
maintenanceName:
{
Description: Name of the maintenance ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
component:
{
Description: type of maintenance ,
Enum:
{
VCSA: maintenance for vCenter Server Appliance ,
ESXI: maintenance for ESXi ,
NSXT: maintenance for NSX-T ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name for maintenance ,
Required: False ,
}
string ,
clusterId:
{
Description: Cluster ID for on which maintenance will be applied. Empty if maintenance is at private cloud level ,
Format: int32 ,
Required: False ,
}
integer ,
infoLink:
{
Description: Link to maintenance info ,
Required: False ,
}
string ,
impact:
{
Description: Impact on the resource during maintenance period ,
Required: False ,
}
string ,
scheduledByMicrosoft:
{
Description: If maintenance is scheduled by Microsoft ,
Required: False ,
}
boolean ,
state:
{
Description: The state of the maintenance ,
Required: False ,
}
{
name:
{
Description: Customer presentable maintenance state ,
Enum:
{
NotScheduled: Maintenance Not Scheduled ,
Scheduled: Maintenance Scheduled ,
InProgress: Maintenance In Progress ,
Success: Maintenance Succeeded ,
Failed: Maintenance Failed ,
Canceled: Maintenance Cancelled ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Failure/Success info ,
Required: False ,
}
string ,
startedAt:
{
Description: Time when current state started ,
Format: date-time ,
Required: False ,
}
string ,
endedAt:
{
Description: Time when current state ended ,
Format: date-time ,
Required: False ,
}
string ,
}
,
scheduledStartTime:
{
Description: Scheduled maintenance start time ,
Format: date-time ,
Required: False ,
}
string ,
estimatedDurationInMinutes:
{
Description: Estimated time maintenance will take in minutes ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
operations:
{
Description: Operations on maintenance ,
Required: False ,
}
[
{
kind:
{
Description: The kind of operation ,
Enum:
{
Schedule: Represents a scheduling operation ,
Reschedule: Represents a rescheduling operation ,
MaintenanceReadinessRefresh: Represents a maintenance readiness refresh operation ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maintenanceReadiness:
{
Description: Indicates whether the maintenance is ready to proceed ,
Required: False ,
}
{
type:
{
Description: The type of maintenance readiness check ,
Enum:
{
Precheck: Pre-check maintenance readiness ,
Preflight: Pre-flight maintenance readiness ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The current readiness status of maintenance ,
Enum:
{
Ready: The system is ready for maintenance ,
NotReady: The system is not ready for maintenance ,
DataNotAvailable: Data is not available to determine readiness ,
NotApplicable: Readiness check is not applicable ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A summary message of the readiness check result ,
Required: False ,
}
string ,
failedChecks:
{
Description: A list of failed checks, if any ,
Required: False ,
}
[
{
name:
{
Description: The name of the failed check ,
Required: False ,
}
string ,
impactedResources:
{
Description: A list of resources impacted by the failed check ,
Required: False ,
}
[
{
id:
{
Description: The ID of the impacted resource ,
Required: False ,
}
string ,
errors:
{
Description: A list of errors associated with the impacted resource ,
Required: False ,
}
[
{
errorCode:
{
Description: The error code ,
Required: False ,
}
string ,
name:
{
Description: The name of the error ,
Required: False ,
}
string ,
details:
{
Description: Additional details about the error ,
Required: False ,
}
string ,
resolutionSteps:
{
Description: Steps to resolve the error ,
Required: False ,
}
[
string ,
]
,
actionRequired:
{
Description: Indicates whether action is required by the customer ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
]
,
lastUpdated:
{
Description: The timestamp of the last readiness update ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Maintenances_InitiateChecks (new)
Description :  Initiate maintenance readiness checks
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/maintenances/{maintenanceName}/initiateChecks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
maintenanceName:
{
Description: Name of the maintenance ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
component:
{
Description: type of maintenance ,
Enum:
{
VCSA: maintenance for vCenter Server Appliance ,
ESXI: maintenance for ESXi ,
NSXT: maintenance for NSX-T ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name for maintenance ,
Required: False ,
}
string ,
clusterId:
{
Description: Cluster ID for on which maintenance will be applied. Empty if maintenance is at private cloud level ,
Format: int32 ,
Required: False ,
}
integer ,
infoLink:
{
Description: Link to maintenance info ,
Required: False ,
}
string ,
impact:
{
Description: Impact on the resource during maintenance period ,
Required: False ,
}
string ,
scheduledByMicrosoft:
{
Description: If maintenance is scheduled by Microsoft ,
Required: False ,
}
boolean ,
state:
{
Description: The state of the maintenance ,
Required: False ,
}
{
name:
{
Description: Customer presentable maintenance state ,
Enum:
{
NotScheduled: Maintenance Not Scheduled ,
Scheduled: Maintenance Scheduled ,
InProgress: Maintenance In Progress ,
Success: Maintenance Succeeded ,
Failed: Maintenance Failed ,
Canceled: Maintenance Cancelled ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Failure/Success info ,
Required: False ,
}
string ,
startedAt:
{
Description: Time when current state started ,
Format: date-time ,
Required: False ,
}
string ,
endedAt:
{
Description: Time when current state ended ,
Format: date-time ,
Required: False ,
}
string ,
}
,
scheduledStartTime:
{
Description: Scheduled maintenance start time ,
Format: date-time ,
Required: False ,
}
string ,
estimatedDurationInMinutes:
{
Description: Estimated time maintenance will take in minutes ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
operations:
{
Description: Operations on maintenance ,
Required: False ,
}
[
{
kind:
{
Description: The kind of operation ,
Enum:
{
Schedule: Represents a scheduling operation ,
Reschedule: Represents a rescheduling operation ,
MaintenanceReadinessRefresh: Represents a maintenance readiness refresh operation ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maintenanceReadiness:
{
Description: Indicates whether the maintenance is ready to proceed ,
Required: False ,
}
{
type:
{
Description: The type of maintenance readiness check ,
Enum:
{
Precheck: Pre-check maintenance readiness ,
Preflight: Pre-flight maintenance readiness ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The current readiness status of maintenance ,
Enum:
{
Ready: The system is ready for maintenance ,
NotReady: The system is not ready for maintenance ,
DataNotAvailable: Data is not available to determine readiness ,
NotApplicable: Readiness check is not applicable ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A summary message of the readiness check result ,
Required: False ,
}
string ,
failedChecks:
{
Description: A list of failed checks, if any ,
Required: False ,
}
[
{
name:
{
Description: The name of the failed check ,
Required: False ,
}
string ,
impactedResources:
{
Description: A list of resources impacted by the failed check ,
Required: False ,
}
[
{
id:
{
Description: The ID of the impacted resource ,
Required: False ,
}
string ,
errors:
{
Description: A list of errors associated with the impacted resource ,
Required: False ,
}
[
{
errorCode:
{
Description: The error code ,
Required: False ,
}
string ,
name:
{
Description: The name of the error ,
Required: False ,
}
string ,
details:
{
Description: Additional details about the error ,
Required: False ,
}
string ,
resolutionSteps:
{
Description: Steps to resolve the error ,
Required: False ,
}
[
string ,
]
,
actionRequired:
{
Description: Indicates whether action is required by the customer ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
]
,
lastUpdated:
{
Description: The timestamp of the last readiness update ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Maintenances_Reschedule (new)
Description :  Reschedule a maintenance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/maintenances/{maintenanceName}/reschedule
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
maintenanceName:
{
Description: Name of the maintenance ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
rescheduleTime:
{
Description: reschedule time ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: rescheduling reason ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
component:
{
Description: type of maintenance ,
Enum:
{
VCSA: maintenance for vCenter Server Appliance ,
ESXI: maintenance for ESXi ,
NSXT: maintenance for NSX-T ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name for maintenance ,
Required: False ,
}
string ,
clusterId:
{
Description: Cluster ID for on which maintenance will be applied. Empty if maintenance is at private cloud level ,
Format: int32 ,
Required: False ,
}
integer ,
infoLink:
{
Description: Link to maintenance info ,
Required: False ,
}
string ,
impact:
{
Description: Impact on the resource during maintenance period ,
Required: False ,
}
string ,
scheduledByMicrosoft:
{
Description: If maintenance is scheduled by Microsoft ,
Required: False ,
}
boolean ,
state:
{
Description: The state of the maintenance ,
Required: False ,
}
{
name:
{
Description: Customer presentable maintenance state ,
Enum:
{
NotScheduled: Maintenance Not Scheduled ,
Scheduled: Maintenance Scheduled ,
InProgress: Maintenance In Progress ,
Success: Maintenance Succeeded ,
Failed: Maintenance Failed ,
Canceled: Maintenance Cancelled ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Failure/Success info ,
Required: False ,
}
string ,
startedAt:
{
Description: Time when current state started ,
Format: date-time ,
Required: False ,
}
string ,
endedAt:
{
Description: Time when current state ended ,
Format: date-time ,
Required: False ,
}
string ,
}
,
scheduledStartTime:
{
Description: Scheduled maintenance start time ,
Format: date-time ,
Required: False ,
}
string ,
estimatedDurationInMinutes:
{
Description: Estimated time maintenance will take in minutes ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
operations:
{
Description: Operations on maintenance ,
Required: False ,
}
[
{
kind:
{
Description: The kind of operation ,
Enum:
{
Schedule: Represents a scheduling operation ,
Reschedule: Represents a rescheduling operation ,
MaintenanceReadinessRefresh: Represents a maintenance readiness refresh operation ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maintenanceReadiness:
{
Description: Indicates whether the maintenance is ready to proceed ,
Required: False ,
}
{
type:
{
Description: The type of maintenance readiness check ,
Enum:
{
Precheck: Pre-check maintenance readiness ,
Preflight: Pre-flight maintenance readiness ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The current readiness status of maintenance ,
Enum:
{
Ready: The system is ready for maintenance ,
NotReady: The system is not ready for maintenance ,
DataNotAvailable: Data is not available to determine readiness ,
NotApplicable: Readiness check is not applicable ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A summary message of the readiness check result ,
Required: False ,
}
string ,
failedChecks:
{
Description: A list of failed checks, if any ,
Required: False ,
}
[
{
name:
{
Description: The name of the failed check ,
Required: False ,
}
string ,
impactedResources:
{
Description: A list of resources impacted by the failed check ,
Required: False ,
}
[
{
id:
{
Description: The ID of the impacted resource ,
Required: False ,
}
string ,
errors:
{
Description: A list of errors associated with the impacted resource ,
Required: False ,
}
[
{
errorCode:
{
Description: The error code ,
Required: False ,
}
string ,
name:
{
Description: The name of the error ,
Required: False ,
}
string ,
details:
{
Description: Additional details about the error ,
Required: False ,
}
string ,
resolutionSteps:
{
Description: Steps to resolve the error ,
Required: False ,
}
[
string ,
]
,
actionRequired:
{
Description: Indicates whether action is required by the customer ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
]
,
lastUpdated:
{
Description: The timestamp of the last readiness update ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Maintenances_Schedule (new)
Description :  Schedule a maintenance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/maintenances/{maintenanceName}/schedule
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
maintenanceName:
{
Description: Name of the maintenance ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
scheduleTime:
{
Description: schedule time ,
Format: date-time ,
Required: False ,
}
string ,
message:
{
Description: scheduling message ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
component:
{
Description: type of maintenance ,
Enum:
{
VCSA: maintenance for vCenter Server Appliance ,
ESXI: maintenance for ESXi ,
NSXT: maintenance for NSX-T ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name for maintenance ,
Required: False ,
}
string ,
clusterId:
{
Description: Cluster ID for on which maintenance will be applied. Empty if maintenance is at private cloud level ,
Format: int32 ,
Required: False ,
}
integer ,
infoLink:
{
Description: Link to maintenance info ,
Required: False ,
}
string ,
impact:
{
Description: Impact on the resource during maintenance period ,
Required: False ,
}
string ,
scheduledByMicrosoft:
{
Description: If maintenance is scheduled by Microsoft ,
Required: False ,
}
boolean ,
state:
{
Description: The state of the maintenance ,
Required: False ,
}
{
name:
{
Description: Customer presentable maintenance state ,
Enum:
{
NotScheduled: Maintenance Not Scheduled ,
Scheduled: Maintenance Scheduled ,
InProgress: Maintenance In Progress ,
Success: Maintenance Succeeded ,
Failed: Maintenance Failed ,
Canceled: Maintenance Cancelled ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Failure/Success info ,
Required: False ,
}
string ,
startedAt:
{
Description: Time when current state started ,
Format: date-time ,
Required: False ,
}
string ,
endedAt:
{
Description: Time when current state ended ,
Format: date-time ,
Required: False ,
}
string ,
}
,
scheduledStartTime:
{
Description: Scheduled maintenance start time ,
Format: date-time ,
Required: False ,
}
string ,
estimatedDurationInMinutes:
{
Description: Estimated time maintenance will take in minutes ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
operations:
{
Description: Operations on maintenance ,
Required: False ,
}
[
{
kind:
{
Description: The kind of operation ,
Enum:
{
Schedule: Represents a scheduling operation ,
Reschedule: Represents a rescheduling operation ,
MaintenanceReadinessRefresh: Represents a maintenance readiness refresh operation ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maintenanceReadiness:
{
Description: Indicates whether the maintenance is ready to proceed ,
Required: False ,
}
{
type:
{
Description: The type of maintenance readiness check ,
Enum:
{
Precheck: Pre-check maintenance readiness ,
Preflight: Pre-flight maintenance readiness ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The current readiness status of maintenance ,
Enum:
{
Ready: The system is ready for maintenance ,
NotReady: The system is not ready for maintenance ,
DataNotAvailable: Data is not available to determine readiness ,
NotApplicable: Readiness check is not applicable ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A summary message of the readiness check result ,
Required: False ,
}
string ,
failedChecks:
{
Description: A list of failed checks, if any ,
Required: False ,
}
[
{
name:
{
Description: The name of the failed check ,
Required: False ,
}
string ,
impactedResources:
{
Description: A list of resources impacted by the failed check ,
Required: False ,
}
[
{
id:
{
Description: The ID of the impacted resource ,
Required: False ,
}
string ,
errors:
{
Description: A list of errors associated with the impacted resource ,
Required: False ,
}
[
{
errorCode:
{
Description: The error code ,
Required: False ,
}
string ,
name:
{
Description: The name of the error ,
Required: False ,
}
string ,
details:
{
Description: Additional details about the error ,
Required: False ,
}
string ,
resolutionSteps:
{
Description: Steps to resolve the error ,
Required: False ,
}
[
string ,
]
,
actionRequired:
{
Description: Indicates whether action is required by the customer ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
]
,
lastUpdated:
{
Description: The timestamp of the last readiness update ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProvisionedNetworks_List (new)
Description :  List ProvisionedNetwork resources by PrivateCloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/provisionedNetworks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ProvisionedNetwork items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
addressPrefix:
{
Description: The address prefixes of the provisioned network in CIDR notation. ,
Required: False ,
}
string ,
networkType:
{
Description: The type of network provisioned. ,
Enum:
{
esxManagement: network for ESX management ,
esxReplication: network for ESX replication ,
hcxManagement: network for HCX management ,
hcxUplink: network for HCX uplink ,
vcenterManagement: network for vCenter management ,
vmotion: network for vmotion ,
vsan: network for vsan ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProvisionedNetworks_Get (new)
Description :  Get a ProvisionedNetwork
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/provisionedNetworks/{provisionedNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
provisionedNetworkName:
{
Description: Name of the cloud link. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
addressPrefix:
{
Description: The address prefixes of the provisioned network in CIDR notation. ,
Required: False ,
}
string ,
networkType:
{
Description: The type of network provisioned. ,
Enum:
{
esxManagement: network for ESX management ,
esxReplication: network for ESX replication ,
hcxManagement: network for HCX management ,
hcxUplink: network for HCX uplink ,
vcenterManagement: network for vCenter management ,
vmotion: network for vmotion ,
vsan: network for vsan ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PureStoragePolicies_List (new)
Description :  List PureStoragePolicy resources by PrivateCloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/pureStoragePolicies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The PureStoragePolicy items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePolicyDefinition:
{
Description: Definition of a Pure Storage Policy Based Management policy ,
Required: True ,
}
string ,
storagePoolId:
{
Description: Azure resource ID of the Pure Storage Pool associated with the storage policy ,
Required: True ,
}
string ,
provisioningState:
{
Description: The state of the Pure Storage Policy Based Management policy provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PureStoragePolicies_Get (new)
Description :  Get a PureStoragePolicy
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/pureStoragePolicies/{storagePolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
storagePolicyName:
{
Description: Name of the storage policy. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePolicyDefinition:
{
Description: Definition of a Pure Storage Policy Based Management policy ,
Required: True ,
}
string ,
storagePoolId:
{
Description: Azure resource ID of the Pure Storage Pool associated with the storage policy ,
Required: True ,
}
string ,
provisioningState:
{
Description: The state of the Pure Storage Policy Based Management policy provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PureStoragePolicies_CreateOrUpdate (new)
Description :  Create a PureStoragePolicy
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/pureStoragePolicies/{storagePolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
storagePolicyName:
{
Description: Name of the storage policy. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePolicyDefinition:
{
Description: Definition of a Pure Storage Policy Based Management policy ,
Required: True ,
}
string ,
storagePoolId:
{
Description: Azure resource ID of the Pure Storage Pool associated with the storage policy ,
Required: True ,
}
string ,
provisioningState:
{
Description: The state of the Pure Storage Policy Based Management policy provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePolicyDefinition:
{
Description: Definition of a Pure Storage Policy Based Management policy ,
Required: True ,
}
string ,
storagePoolId:
{
Description: Azure resource ID of the Pure Storage Pool associated with the storage policy ,
Required: True ,
}
string ,
provisioningState:
{
Description: The state of the Pure Storage Policy Based Management policy provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An instance describing a Pure Storage Policy Based Management policy ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storagePolicyDefinition:
{
Description: Definition of a Pure Storage Policy Based Management policy ,
Required: True ,
}
string ,
storagePoolId:
{
Description: Azure resource ID of the Pure Storage Pool associated with the storage policy ,
Required: True ,
}
string ,
provisioningState:
{
Description: The state of the Pure Storage Policy Based Management policy provisioning ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PureStoragePolicies_Delete (new)
Description :  Delete a PureStoragePolicy
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/pureStoragePolicies/{storagePolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
storagePolicyName:
{
Description: Name of the storage policy. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateClouds_RotateNsxtPassword (new)
Description :  Rotate the NSX-T Manager password
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/rotateNsxtPassword
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateClouds_RotateVcenterPassword (new)
Description :  Rotate the vCenter password
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/rotateVcenterPassword
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScriptExecutions_List (new)
Description :  List ScriptExecution resources by PrivateCloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ScriptExecution items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
scriptCmdletId:
{
Description: A reference to the script cmdlet resource if user is running a AVS script ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters the script will accept ,
Required: False ,
}
[
{
type:
{
Description: script execution parameter type ,
Enum:
{
Value: No description available. ,
SecureValue: No description available. ,
Credential: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The parameter name ,
Required: True ,
}
string ,
}
,
]
,
hiddenParameters:
{
Description: Parameters that will be hidden/not visible to ARM, such as passwords and credentials ,
Required: False ,
}
[
{
type:
{
Description: script execution parameter type ,
Enum:
{
Value: No description available. ,
SecureValue: No description available. ,
Credential: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The parameter name ,
Required: True ,
}
string ,
}
,
]
,
failureReason:
{
Description: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception ,
Required: False ,
}
string ,
timeout:
{
Description: Time limit for execution ,
Required: True ,
}
string ,
retention:
{
Description: Time to live for the resource. If not provided, will be available for 60 days ,
Required: False ,
}
string ,
submittedAt:
{
Description: Time the script execution was submitted ,
Format: date-time ,
Required: False ,
}
string ,
startedAt:
{
Description: Time the script execution was started ,
Format: date-time ,
Required: False ,
}
string ,
finishedAt:
{
Description: Time the script execution was finished ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the script execution resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Pending: is pending ,
Running: is running ,
Cancelling: is cancelling ,
Cancelled: is cancelled ,
Deleting: is deleting ,
}
,
Required: False ,
}
enum ,
output:
{
Description: Standard output stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
namedOutputs:
{
Description: User-defined dictionary. ,
Required: False ,
}
object ,
information:
{
Description: Standard information out stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
warnings:
{
Description: Standard warning out stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Standard error output stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScriptExecutions_Get (new)
Description :  Get a ScriptExecution
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
scriptExecutionName:
{
Description: Name of the script cmdlet. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
scriptCmdletId:
{
Description: A reference to the script cmdlet resource if user is running a AVS script ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters the script will accept ,
Required: False ,
}
[
{
type:
{
Description: script execution parameter type ,
Enum:
{
Value: No description available. ,
SecureValue: No description available. ,
Credential: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The parameter name ,
Required: True ,
}
string ,
}
,
]
,
hiddenParameters:
{
Description: Parameters that will be hidden/not visible to ARM, such as passwords and credentials ,
Required: False ,
}
[
{
type:
{
Description: script execution parameter type ,
Enum:
{
Value: No description available. ,
SecureValue: No description available. ,
Credential: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The parameter name ,
Required: True ,
}
string ,
}
,
]
,
failureReason:
{
Description: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception ,
Required: False ,
}
string ,
timeout:
{
Description: Time limit for execution ,
Required: True ,
}
string ,
retention:
{
Description: Time to live for the resource. If not provided, will be available for 60 days ,
Required: False ,
}
string ,
submittedAt:
{
Description: Time the script execution was submitted ,
Format: date-time ,
Required: False ,
}
string ,
startedAt:
{
Description: Time the script execution was started ,
Format: date-time ,
Required: False ,
}
string ,
finishedAt:
{
Description: Time the script execution was finished ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the script execution resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Pending: is pending ,
Running: is running ,
Cancelling: is cancelling ,
Cancelled: is cancelled ,
Deleting: is deleting ,
}
,
Required: False ,
}
enum ,
output:
{
Description: Standard output stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
namedOutputs:
{
Description: User-defined dictionary. ,
Required: False ,
}
object ,
information:
{
Description: Standard information out stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
warnings:
{
Description: Standard warning out stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Standard error output stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScriptExecutions_CreateOrUpdate (new)
Description :  Create a ScriptExecution
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
scriptExecutionName:
{
Description: Name of the script cmdlet. ,
Required: True ,
}
string ,
scriptExecution:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
scriptCmdletId:
{
Description: A reference to the script cmdlet resource if user is running a AVS script ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters the script will accept ,
Required: False ,
}
[
{
type:
{
Description: script execution parameter type ,
Enum:
{
Value: No description available. ,
SecureValue: No description available. ,
Credential: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The parameter name ,
Required: True ,
}
string ,
}
,
]
,
hiddenParameters:
{
Description: Parameters that will be hidden/not visible to ARM, such as passwords and credentials ,
Required: False ,
}
[
{
type:
{
Description: script execution parameter type ,
Enum:
{
Value: No description available. ,
SecureValue: No description available. ,
Credential: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The parameter name ,
Required: True ,
}
string ,
}
,
]
,
failureReason:
{
Description: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception ,
Required: False ,
}
string ,
timeout:
{
Description: Time limit for execution ,
Required: True ,
}
string ,
retention:
{
Description: Time to live for the resource. If not provided, will be available for 60 days ,
Required: False ,
}
string ,
submittedAt:
{
Description: Time the script execution was submitted ,
Format: date-time ,
Required: False ,
}
string ,
startedAt:
{
Description: Time the script execution was started ,
Format: date-time ,
Required: False ,
}
string ,
finishedAt:
{
Description: Time the script execution was finished ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the script execution resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Pending: is pending ,
Running: is running ,
Cancelling: is cancelling ,
Cancelled: is cancelled ,
Deleting: is deleting ,
}
,
Required: False ,
}
enum ,
output:
{
Description: Standard output stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
namedOutputs:
{
Description: User-defined dictionary. ,
Required: False ,
}
object ,
information:
{
Description: Standard information out stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
warnings:
{
Description: Standard warning out stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Standard error output stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
scriptCmdletId:
{
Description: A reference to the script cmdlet resource if user is running a AVS script ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters the script will accept ,
Required: False ,
}
[
{
type:
{
Description: script execution parameter type ,
Enum:
{
Value: No description available. ,
SecureValue: No description available. ,
Credential: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The parameter name ,
Required: True ,
}
string ,
}
,
]
,
hiddenParameters:
{
Description: Parameters that will be hidden/not visible to ARM, such as passwords and credentials ,
Required: False ,
}
[
{
type:
{
Description: script execution parameter type ,
Enum:
{
Value: No description available. ,
SecureValue: No description available. ,
Credential: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The parameter name ,
Required: True ,
}
string ,
}
,
]
,
failureReason:
{
Description: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception ,
Required: False ,
}
string ,
timeout:
{
Description: Time limit for execution ,
Required: True ,
}
string ,
retention:
{
Description: Time to live for the resource. If not provided, will be available for 60 days ,
Required: False ,
}
string ,
submittedAt:
{
Description: Time the script execution was submitted ,
Format: date-time ,
Required: False ,
}
string ,
startedAt:
{
Description: Time the script execution was started ,
Format: date-time ,
Required: False ,
}
string ,
finishedAt:
{
Description: Time the script execution was finished ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the script execution resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Pending: is pending ,
Running: is running ,
Cancelling: is cancelling ,
Cancelled: is cancelled ,
Deleting: is deleting ,
}
,
Required: False ,
}
enum ,
output:
{
Description: Standard output stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
namedOutputs:
{
Description: User-defined dictionary. ,
Required: False ,
}
object ,
information:
{
Description: Standard information out stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
warnings:
{
Description: Standard warning out stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Standard error output stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: An instance of a script executed by a user - custom or AVS ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
scriptCmdletId:
{
Description: A reference to the script cmdlet resource if user is running a AVS script ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters the script will accept ,
Required: False ,
}
[
{
type:
{
Description: script execution parameter type ,
Enum:
{
Value: No description available. ,
SecureValue: No description available. ,
Credential: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The parameter name ,
Required: True ,
}
string ,
}
,
]
,
hiddenParameters:
{
Description: Parameters that will be hidden/not visible to ARM, such as passwords and credentials ,
Required: False ,
}
[
{
type:
{
Description: script execution parameter type ,
Enum:
{
Value: No description available. ,
SecureValue: No description available. ,
Credential: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The parameter name ,
Required: True ,
}
string ,
}
,
]
,
failureReason:
{
Description: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception ,
Required: False ,
}
string ,
timeout:
{
Description: Time limit for execution ,
Required: True ,
}
string ,
retention:
{
Description: Time to live for the resource. If not provided, will be available for 60 days ,
Required: False ,
}
string ,
submittedAt:
{
Description: Time the script execution was submitted ,
Format: date-time ,
Required: False ,
}
string ,
startedAt:
{
Description: Time the script execution was started ,
Format: date-time ,
Required: False ,
}
string ,
finishedAt:
{
Description: Time the script execution was finished ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the script execution resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Pending: is pending ,
Running: is running ,
Cancelling: is cancelling ,
Cancelled: is cancelled ,
Deleting: is deleting ,
}
,
Required: False ,
}
enum ,
output:
{
Description: Standard output stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
namedOutputs:
{
Description: User-defined dictionary. ,
Required: False ,
}
object ,
information:
{
Description: Standard information out stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
warnings:
{
Description: Standard warning out stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Standard error output stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScriptExecutions_Delete (new)
Description :  Delete a ScriptExecution
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
scriptExecutionName:
{
Description: Name of the script cmdlet. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScriptExecutions_GetExecutionLogs (new)
Description :  Return the logs for a script execution resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptExecutions/{scriptExecutionName}/getExecutionLogs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
scriptExecutionName:
{
Description: Name of the script cmdlet. ,
Required: True ,
}
string ,
scriptOutputStreamType:
{
Description: Name of the desired output stream to return. If not provided, will return all. An empty array will return nothing. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
scriptCmdletId:
{
Description: A reference to the script cmdlet resource if user is running a AVS script ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters the script will accept ,
Required: False ,
}
[
{
type:
{
Description: script execution parameter type ,
Enum:
{
Value: No description available. ,
SecureValue: No description available. ,
Credential: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The parameter name ,
Required: True ,
}
string ,
}
,
]
,
hiddenParameters:
{
Description: Parameters that will be hidden/not visible to ARM, such as passwords and credentials ,
Required: False ,
}
[
{
type:
{
Description: script execution parameter type ,
Enum:
{
Value: No description available. ,
SecureValue: No description available. ,
Credential: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The parameter name ,
Required: True ,
}
string ,
}
,
]
,
failureReason:
{
Description: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception ,
Required: False ,
}
string ,
timeout:
{
Description: Time limit for execution ,
Required: True ,
}
string ,
retention:
{
Description: Time to live for the resource. If not provided, will be available for 60 days ,
Required: False ,
}
string ,
submittedAt:
{
Description: Time the script execution was submitted ,
Format: date-time ,
Required: False ,
}
string ,
startedAt:
{
Description: Time the script execution was started ,
Format: date-time ,
Required: False ,
}
string ,
finishedAt:
{
Description: Time the script execution was finished ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The state of the script execution resource ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Pending: is pending ,
Running: is running ,
Cancelling: is cancelling ,
Cancelled: is cancelled ,
Deleting: is deleting ,
}
,
Required: False ,
}
enum ,
output:
{
Description: Standard output stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
namedOutputs:
{
Description: User-defined dictionary. ,
Required: False ,
}
object ,
information:
{
Description: Standard information out stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
warnings:
{
Description: Standard warning out stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: Standard error output stream from the powershell execution ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScriptPackages_List (new)
Description :  List ScriptPackage resources by PrivateCloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ScriptPackage items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: User friendly description of the package ,
Required: False ,
}
string ,
version:
{
Description: Module version ,
Required: False ,
}
string ,
company:
{
Description: Company that created and supports the package ,
Required: False ,
}
string ,
uri:
{
Description: Link to support by the package vendor ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScriptPackages_Get (new)
Description :  Get a ScriptPackage
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages/{scriptPackageName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
scriptPackageName:
{
Description: Name of the script package. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: User friendly description of the package ,
Required: False ,
}
string ,
version:
{
Description: Module version ,
Required: False ,
}
string ,
company:
{
Description: Company that created and supports the package ,
Required: False ,
}
string ,
uri:
{
Description: Link to support by the package vendor ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScriptCmdlets_List (new)
Description :  List ScriptCmdlet resources by ScriptPackage
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages/{scriptPackageName}/scriptCmdlets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
scriptPackageName:
{
Description: Name of the script package. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ScriptCmdlet items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the scripts functionality ,
Required: False ,
}
string ,
timeout:
{
Description: Recommended time limit for execution ,
Required: False ,
}
string ,
audience:
{
Description: Specifies whether a script cmdlet is intended to be invoked only through automation or visible to customers ,
Enum:
{
Automation: is automation ,
Any: is any ,
}
,
Required: False ,
}
enum ,
parameters:
{
Description: Parameters the script will accept ,
Required: False ,
}
[
{
type:
{
Description: The type of parameter the script is expecting. psCredential is a PSCredentialObject ,
Enum:
{
String: is string ,
SecureString: is secure string ,
Credential: is credential ,
Int: is int ,
Bool: is bool ,
Float: is float ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The parameter name that the script will expect a parameter value for ,
Required: False ,
}
string ,
description:
{
Description: User friendly description of the parameter ,
Required: False ,
}
string ,
visibility:
{
Description: Should this parameter be visible to arm and passed in the parameters argument when executing ,
Enum:
{
Visible: is visible ,
Hidden: is hidden ,
}
,
Required: False ,
}
enum ,
optional:
{
Description: Is this parameter required or optional ,
Enum:
{
Optional: is optional ,
Required: is required ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ScriptCmdlets_Get (new)
Description :  Get a ScriptCmdlet
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/scriptPackages/{scriptPackageName}/scriptCmdlets/{scriptCmdletName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
scriptPackageName:
{
Description: Name of the script package. ,
Required: True ,
}
string ,
scriptCmdletName:
{
Description: Name of the script cmdlet. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the scripts functionality ,
Required: False ,
}
string ,
timeout:
{
Description: Recommended time limit for execution ,
Required: False ,
}
string ,
audience:
{
Description: Specifies whether a script cmdlet is intended to be invoked only through automation or visible to customers ,
Enum:
{
Automation: is automation ,
Any: is any ,
}
,
Required: False ,
}
enum ,
parameters:
{
Description: Parameters the script will accept ,
Required: False ,
}
[
{
type:
{
Description: The type of parameter the script is expecting. psCredential is a PSCredentialObject ,
Enum:
{
String: is string ,
SecureString: is secure string ,
Credential: is credential ,
Int: is int ,
Bool: is bool ,
Float: is float ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The parameter name that the script will expect a parameter value for ,
Required: False ,
}
string ,
description:
{
Description: User friendly description of the parameter ,
Required: False ,
}
string ,
visibility:
{
Description: Should this parameter be visible to arm and passed in the parameters argument when executing ,
Enum:
{
Visible: is visible ,
Hidden: is hidden ,
}
,
Required: False ,
}
enum ,
optional:
{
Description: Is this parameter required or optional ,
Enum:
{
Optional: is optional ,
Required: is required ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_List (new)
Description :  List WorkloadNetwork resources by PrivateCloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WorkloadNetwork items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_Get (new)
Description :  Get a WorkloadNetwork
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_ListDhcp (new)
Description :  List WorkloadNetworkDhcp resources by WorkloadNetwork
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WorkloadNetworkDhcp items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER: No description available. ,
RELAY: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the DHCP entity. ,
Required: False ,
}
string ,
segments:
{
Description: NSX Segments consuming DHCP. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_GetDhcp (new)
Description :  Get a WorkloadNetworkDhcp
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dhcpId:
{
Description: The ID of the DHCP configuration ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER: No description available. ,
RELAY: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the DHCP entity. ,
Required: False ,
}
string ,
segments:
{
Description: NSX Segments consuming DHCP. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_CreateDhcp (new)
Description :  Create a WorkloadNetworkDhcp
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dhcpId:
{
Description: The ID of the DHCP configuration ,
Required: True ,
}
string ,
workloadNetworkDhcp:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER: No description available. ,
RELAY: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the DHCP entity. ,
Required: False ,
}
string ,
segments:
{
Description: NSX Segments consuming DHCP. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER: No description available. ,
RELAY: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the DHCP entity. ,
Required: False ,
}
string ,
segments:
{
Description: NSX Segments consuming DHCP. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: NSX DHCP ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER: No description available. ,
RELAY: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the DHCP entity. ,
Required: False ,
}
string ,
segments:
{
Description: NSX Segments consuming DHCP. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_UpdateDhcp (new)
Description :  Update a WorkloadNetworkDhcp
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dhcpId:
{
Description: The ID of the DHCP configuration ,
Required: True ,
}
string ,
workloadNetworkDhcp:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER: No description available. ,
RELAY: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the DHCP entity. ,
Required: False ,
}
string ,
segments:
{
Description: NSX Segments consuming DHCP. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER: No description available. ,
RELAY: No description available. ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Display name of the DHCP entity. ,
Required: False ,
}
string ,
segments:
{
Description: NSX Segments consuming DHCP. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_DeleteDhcp (new)
Description :  Delete a WorkloadNetworkDhcp
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dhcpId:
{
Description: The ID of the DHCP configuration ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_ListDnsServices (new)
Description :  List WorkloadNetworkDnsService resources by WorkloadNetwork
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WorkloadNetworkDnsService items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the DNS Service. ,
Required: False ,
}
string ,
dnsServiceIp:
{
Description: DNS service IP of the DNS Service. ,
Required: False ,
}
string ,
defaultDnsZone:
{
Description: Default DNS zone of the DNS Service. ,
Required: False ,
}
string ,
fqdnZones:
{
Description: FQDN zones of the DNS Service. ,
Required: False ,
}
[
string ,
]
,
logLevel:
{
Description: DNS Service log level. ,
Enum:
{
DEBUG: is debug ,
INFO: is info ,
WARNING: is warning ,
ERROR: is error ,
FATAL: is fatal ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_GetDnsService (new)
Description :  Get a WorkloadNetworkDnsService
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dnsServiceId:
{
Description: ID of the DNS service. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the DNS Service. ,
Required: False ,
}
string ,
dnsServiceIp:
{
Description: DNS service IP of the DNS Service. ,
Required: False ,
}
string ,
defaultDnsZone:
{
Description: Default DNS zone of the DNS Service. ,
Required: False ,
}
string ,
fqdnZones:
{
Description: FQDN zones of the DNS Service. ,
Required: False ,
}
[
string ,
]
,
logLevel:
{
Description: DNS Service log level. ,
Enum:
{
DEBUG: is debug ,
INFO: is info ,
WARNING: is warning ,
ERROR: is error ,
FATAL: is fatal ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_CreateDnsService (new)
Description :  Create a WorkloadNetworkDnsService
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dnsServiceId:
{
Description: ID of the DNS service. ,
Required: True ,
}
string ,
workloadNetworkDnsService:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the DNS Service. ,
Required: False ,
}
string ,
dnsServiceIp:
{
Description: DNS service IP of the DNS Service. ,
Required: False ,
}
string ,
defaultDnsZone:
{
Description: Default DNS zone of the DNS Service. ,
Required: False ,
}
string ,
fqdnZones:
{
Description: FQDN zones of the DNS Service. ,
Required: False ,
}
[
string ,
]
,
logLevel:
{
Description: DNS Service log level. ,
Enum:
{
DEBUG: is debug ,
INFO: is info ,
WARNING: is warning ,
ERROR: is error ,
FATAL: is fatal ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the DNS Service. ,
Required: False ,
}
string ,
dnsServiceIp:
{
Description: DNS service IP of the DNS Service. ,
Required: False ,
}
string ,
defaultDnsZone:
{
Description: Default DNS zone of the DNS Service. ,
Required: False ,
}
string ,
fqdnZones:
{
Description: FQDN zones of the DNS Service. ,
Required: False ,
}
[
string ,
]
,
logLevel:
{
Description: DNS Service log level. ,
Enum:
{
DEBUG: is debug ,
INFO: is info ,
WARNING: is warning ,
ERROR: is error ,
FATAL: is fatal ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: NSX DNS Service ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the DNS Service. ,
Required: False ,
}
string ,
dnsServiceIp:
{
Description: DNS service IP of the DNS Service. ,
Required: False ,
}
string ,
defaultDnsZone:
{
Description: Default DNS zone of the DNS Service. ,
Required: False ,
}
string ,
fqdnZones:
{
Description: FQDN zones of the DNS Service. ,
Required: False ,
}
[
string ,
]
,
logLevel:
{
Description: DNS Service log level. ,
Enum:
{
DEBUG: is debug ,
INFO: is info ,
WARNING: is warning ,
ERROR: is error ,
FATAL: is fatal ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_UpdateDnsService (new)
Description :  Update a WorkloadNetworkDnsService
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dnsServiceId:
{
Description: ID of the DNS service. ,
Required: True ,
}
string ,
workloadNetworkDnsService:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the DNS Service. ,
Required: False ,
}
string ,
dnsServiceIp:
{
Description: DNS service IP of the DNS Service. ,
Required: False ,
}
string ,
defaultDnsZone:
{
Description: Default DNS zone of the DNS Service. ,
Required: False ,
}
string ,
fqdnZones:
{
Description: FQDN zones of the DNS Service. ,
Required: False ,
}
[
string ,
]
,
logLevel:
{
Description: DNS Service log level. ,
Enum:
{
DEBUG: is debug ,
INFO: is info ,
WARNING: is warning ,
ERROR: is error ,
FATAL: is fatal ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the DNS Service. ,
Required: False ,
}
string ,
dnsServiceIp:
{
Description: DNS service IP of the DNS Service. ,
Required: False ,
}
string ,
defaultDnsZone:
{
Description: Default DNS zone of the DNS Service. ,
Required: False ,
}
string ,
fqdnZones:
{
Description: FQDN zones of the DNS Service. ,
Required: False ,
}
[
string ,
]
,
logLevel:
{
Description: DNS Service log level. ,
Enum:
{
DEBUG: is debug ,
INFO: is info ,
WARNING: is warning ,
ERROR: is error ,
FATAL: is fatal ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_DeleteDnsService (new)
Description :  Delete a WorkloadNetworkDnsService
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsServiceId:
{
Description: ID of the DNS service. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_ListDnsZones (new)
Description :  List WorkloadNetworkDnsZone resources by WorkloadNetwork
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WorkloadNetworkDnsZone items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the DNS Zone. ,
Required: False ,
}
string ,
domain:
{
Description: Domain names of the DNS Zone. ,
Required: False ,
}
[
string ,
]
,
dnsServerIps:
{
Description: DNS Server IP array of the DNS Zone. ,
Required: False ,
}
[
string ,
]
,
sourceIp:
{
Description: Source IP of the DNS Zone. ,
Required: False ,
}
string ,
dnsServices:
{
Description: Number of DNS Services using the DNS zone. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_GetDnsZone (new)
Description :  Get a WorkloadNetworkDnsZone
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dnsZoneId:
{
Description: ID of the DNS zone. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the DNS Zone. ,
Required: False ,
}
string ,
domain:
{
Description: Domain names of the DNS Zone. ,
Required: False ,
}
[
string ,
]
,
dnsServerIps:
{
Description: DNS Server IP array of the DNS Zone. ,
Required: False ,
}
[
string ,
]
,
sourceIp:
{
Description: Source IP of the DNS Zone. ,
Required: False ,
}
string ,
dnsServices:
{
Description: Number of DNS Services using the DNS zone. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_CreateDnsZone (new)
Description :  Create a WorkloadNetworkDnsZone
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dnsZoneId:
{
Description: ID of the DNS zone. ,
Required: True ,
}
string ,
workloadNetworkDnsZone:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the DNS Zone. ,
Required: False ,
}
string ,
domain:
{
Description: Domain names of the DNS Zone. ,
Required: False ,
}
[
string ,
]
,
dnsServerIps:
{
Description: DNS Server IP array of the DNS Zone. ,
Required: False ,
}
[
string ,
]
,
sourceIp:
{
Description: Source IP of the DNS Zone. ,
Required: False ,
}
string ,
dnsServices:
{
Description: Number of DNS Services using the DNS zone. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the DNS Zone. ,
Required: False ,
}
string ,
domain:
{
Description: Domain names of the DNS Zone. ,
Required: False ,
}
[
string ,
]
,
dnsServerIps:
{
Description: DNS Server IP array of the DNS Zone. ,
Required: False ,
}
[
string ,
]
,
sourceIp:
{
Description: Source IP of the DNS Zone. ,
Required: False ,
}
string ,
dnsServices:
{
Description: Number of DNS Services using the DNS zone. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: NSX DNS Zone ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the DNS Zone. ,
Required: False ,
}
string ,
domain:
{
Description: Domain names of the DNS Zone. ,
Required: False ,
}
[
string ,
]
,
dnsServerIps:
{
Description: DNS Server IP array of the DNS Zone. ,
Required: False ,
}
[
string ,
]
,
sourceIp:
{
Description: Source IP of the DNS Zone. ,
Required: False ,
}
string ,
dnsServices:
{
Description: Number of DNS Services using the DNS zone. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_UpdateDnsZone (new)
Description :  Update a WorkloadNetworkDnsZone
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dnsZoneId:
{
Description: ID of the DNS zone. ,
Required: True ,
}
string ,
workloadNetworkDnsZone:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the DNS Zone. ,
Required: False ,
}
string ,
domain:
{
Description: Domain names of the DNS Zone. ,
Required: False ,
}
[
string ,
]
,
dnsServerIps:
{
Description: DNS Server IP array of the DNS Zone. ,
Required: False ,
}
[
string ,
]
,
sourceIp:
{
Description: Source IP of the DNS Zone. ,
Required: False ,
}
string ,
dnsServices:
{
Description: Number of DNS Services using the DNS zone. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the DNS Zone. ,
Required: False ,
}
string ,
domain:
{
Description: Domain names of the DNS Zone. ,
Required: False ,
}
[
string ,
]
,
dnsServerIps:
{
Description: DNS Server IP array of the DNS Zone. ,
Required: False ,
}
[
string ,
]
,
sourceIp:
{
Description: Source IP of the DNS Zone. ,
Required: False ,
}
string ,
dnsServices:
{
Description: Number of DNS Services using the DNS zone. ,
Format: int64 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_DeleteDnsZone (new)
Description :  Delete a WorkloadNetworkDnsZone
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
dnsZoneId:
{
Description: ID of the DNS zone. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_ListGateways (new)
Description :  List WorkloadNetworkGateway resources by WorkloadNetwork
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WorkloadNetworkGateway items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the DHCP entity. ,
Required: False ,
}
string ,
path:
{
Description: NSX Gateway Path. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_GetGateway (new)
Description :  Get a WorkloadNetworkGateway
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways/{gatewayId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
gatewayId:
{
Description: The ID of the NSX Gateway ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the DHCP entity. ,
Required: False ,
}
string ,
path:
{
Description: NSX Gateway Path. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_ListPortMirroring (new)
Description :  List WorkloadNetworkPortMirroring resources by WorkloadNetwork
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WorkloadNetworkPortMirroring items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS: is ingress ,
EGRESS: is egress ,
BIDIRECTIONAL: is bidirectional ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source VM Group. ,
Required: False ,
}
string ,
destination:
{
Description: Destination VM Group. ,
Required: False ,
}
string ,
status:
{
Description: Port Mirroring Status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_GetPortMirroring (new)
Description :  Get a WorkloadNetworkPortMirroring
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
portMirroringId:
{
Description: ID of the NSX port mirroring profile. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS: is ingress ,
EGRESS: is egress ,
BIDIRECTIONAL: is bidirectional ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source VM Group. ,
Required: False ,
}
string ,
destination:
{
Description: Destination VM Group. ,
Required: False ,
}
string ,
status:
{
Description: Port Mirroring Status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_CreatePortMirroring (new)
Description :  Create a WorkloadNetworkPortMirroring
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
portMirroringId:
{
Description: ID of the NSX port mirroring profile. ,
Required: True ,
}
string ,
workloadNetworkPortMirroring:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS: is ingress ,
EGRESS: is egress ,
BIDIRECTIONAL: is bidirectional ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source VM Group. ,
Required: False ,
}
string ,
destination:
{
Description: Destination VM Group. ,
Required: False ,
}
string ,
status:
{
Description: Port Mirroring Status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS: is ingress ,
EGRESS: is egress ,
BIDIRECTIONAL: is bidirectional ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source VM Group. ,
Required: False ,
}
string ,
destination:
{
Description: Destination VM Group. ,
Required: False ,
}
string ,
status:
{
Description: Port Mirroring Status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: NSX Port Mirroring ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS: is ingress ,
EGRESS: is egress ,
BIDIRECTIONAL: is bidirectional ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source VM Group. ,
Required: False ,
}
string ,
destination:
{
Description: Destination VM Group. ,
Required: False ,
}
string ,
status:
{
Description: Port Mirroring Status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_UpdatePortMirroring (new)
Description :  Update a WorkloadNetworkPortMirroring
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
portMirroringId:
{
Description: ID of the NSX port mirroring profile. ,
Required: True ,
}
string ,
workloadNetworkPortMirroring:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS: is ingress ,
EGRESS: is egress ,
BIDIRECTIONAL: is bidirectional ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source VM Group. ,
Required: False ,
}
string ,
destination:
{
Description: Destination VM Group. ,
Required: False ,
}
string ,
status:
{
Description: Port Mirroring Status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS: is ingress ,
EGRESS: is egress ,
BIDIRECTIONAL: is bidirectional ,
}
,
Required: False ,
}
enum ,
source:
{
Description: Source VM Group. ,
Required: False ,
}
string ,
destination:
{
Description: Destination VM Group. ,
Required: False ,
}
string ,
status:
{
Description: Port Mirroring Status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_DeletePortMirroring (new)
Description :  Delete a WorkloadNetworkPortMirroring
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
portMirroringId:
{
Description: ID of the NSX port mirroring profile. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_ListPublicIPs (new)
Description :  List WorkloadNetworkPublicIP resources by WorkloadNetwork
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WorkloadNetworkPublicIP items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the Public IP Block. ,
Required: False ,
}
string ,
numberOfPublicIPs:
{
Description: Number of Public IPs requested. ,
Format: int64 ,
Required: False ,
}
integer ,
publicIPBlock:
{
Description: CIDR Block of the Public IP Block. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_GetPublicIP (new)
Description :  Get a WorkloadNetworkPublicIP
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs/{publicIPId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
publicIPId:
{
Description: ID of the DNS zone. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the Public IP Block. ,
Required: False ,
}
string ,
numberOfPublicIPs:
{
Description: Number of Public IPs requested. ,
Format: int64 ,
Required: False ,
}
integer ,
publicIPBlock:
{
Description: CIDR Block of the Public IP Block. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_CreatePublicIP (new)
Description :  Create a WorkloadNetworkPublicIP
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs/{publicIPId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
publicIPId:
{
Description: ID of the DNS zone. ,
Required: True ,
}
string ,
workloadNetworkPublicIP:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the Public IP Block. ,
Required: False ,
}
string ,
numberOfPublicIPs:
{
Description: Number of Public IPs requested. ,
Format: int64 ,
Required: False ,
}
integer ,
publicIPBlock:
{
Description: CIDR Block of the Public IP Block. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the Public IP Block. ,
Required: False ,
}
string ,
numberOfPublicIPs:
{
Description: Number of Public IPs requested. ,
Format: int64 ,
Required: False ,
}
integer ,
publicIPBlock:
{
Description: CIDR Block of the Public IP Block. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: NSX Public IP Block ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the Public IP Block. ,
Required: False ,
}
string ,
numberOfPublicIPs:
{
Description: Number of Public IPs requested. ,
Format: int64 ,
Required: False ,
}
integer ,
publicIPBlock:
{
Description: CIDR Block of the Public IP Block. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_DeletePublicIP (new)
Description :  Delete a WorkloadNetworkPublicIP
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/publicIPs/{publicIPId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
publicIPId:
{
Description: ID of the DNS zone. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_ListSegments (new)
Description :  List WorkloadNetworkSegment resources by WorkloadNetwork
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WorkloadNetworkSegment items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the segment. ,
Required: False ,
}
string ,
connectedGateway:
{
Description: Gateway which to connect segment to. ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet which to connect segment to. ,
Required: False ,
}
{
dhcpRanges:
{
Description: DHCP Range assigned for subnet. ,
Required: False ,
}
[
string ,
]
,
gatewayAddress:
{
Description: Gateway address. ,
Required: False ,
}
string ,
}
,
portVif:
{
Description: Port Vif which segment is associated with. ,
Required: False ,
}
[
{
portName:
{
Description: Name of port or VIF attached to segment. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Segment status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_GetSegment (new)
Description :  Get a WorkloadNetworkSegment
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
segmentId:
{
Description: The ID of the NSX Segment ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the segment. ,
Required: False ,
}
string ,
connectedGateway:
{
Description: Gateway which to connect segment to. ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet which to connect segment to. ,
Required: False ,
}
{
dhcpRanges:
{
Description: DHCP Range assigned for subnet. ,
Required: False ,
}
[
string ,
]
,
gatewayAddress:
{
Description: Gateway address. ,
Required: False ,
}
string ,
}
,
portVif:
{
Description: Port Vif which segment is associated with. ,
Required: False ,
}
[
{
portName:
{
Description: Name of port or VIF attached to segment. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Segment status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_CreateSegments (new)
Description :  Create a WorkloadNetworkSegment
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
segmentId:
{
Description: The ID of the NSX Segment ,
Required: True ,
}
string ,
workloadNetworkSegment:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the segment. ,
Required: False ,
}
string ,
connectedGateway:
{
Description: Gateway which to connect segment to. ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet which to connect segment to. ,
Required: False ,
}
{
dhcpRanges:
{
Description: DHCP Range assigned for subnet. ,
Required: False ,
}
[
string ,
]
,
gatewayAddress:
{
Description: Gateway address. ,
Required: False ,
}
string ,
}
,
portVif:
{
Description: Port Vif which segment is associated with. ,
Required: False ,
}
[
{
portName:
{
Description: Name of port or VIF attached to segment. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Segment status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the segment. ,
Required: False ,
}
string ,
connectedGateway:
{
Description: Gateway which to connect segment to. ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet which to connect segment to. ,
Required: False ,
}
{
dhcpRanges:
{
Description: DHCP Range assigned for subnet. ,
Required: False ,
}
[
string ,
]
,
gatewayAddress:
{
Description: Gateway address. ,
Required: False ,
}
string ,
}
,
portVif:
{
Description: Port Vif which segment is associated with. ,
Required: False ,
}
[
{
portName:
{
Description: Name of port or VIF attached to segment. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Segment status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: NSX Segment ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the segment. ,
Required: False ,
}
string ,
connectedGateway:
{
Description: Gateway which to connect segment to. ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet which to connect segment to. ,
Required: False ,
}
{
dhcpRanges:
{
Description: DHCP Range assigned for subnet. ,
Required: False ,
}
[
string ,
]
,
gatewayAddress:
{
Description: Gateway address. ,
Required: False ,
}
string ,
}
,
portVif:
{
Description: Port Vif which segment is associated with. ,
Required: False ,
}
[
{
portName:
{
Description: Name of port or VIF attached to segment. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Segment status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_UpdateSegments (new)
Description :  Update a WorkloadNetworkSegment
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
segmentId:
{
Description: The ID of the NSX Segment ,
Required: True ,
}
string ,
workloadNetworkSegment:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the segment. ,
Required: False ,
}
string ,
connectedGateway:
{
Description: Gateway which to connect segment to. ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet which to connect segment to. ,
Required: False ,
}
{
dhcpRanges:
{
Description: DHCP Range assigned for subnet. ,
Required: False ,
}
[
string ,
]
,
gatewayAddress:
{
Description: Gateway address. ,
Required: False ,
}
string ,
}
,
portVif:
{
Description: Port Vif which segment is associated with. ,
Required: False ,
}
[
{
portName:
{
Description: Name of port or VIF attached to segment. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Segment status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the segment. ,
Required: False ,
}
string ,
connectedGateway:
{
Description: Gateway which to connect segment to. ,
Required: False ,
}
string ,
subnet:
{
Description: Subnet which to connect segment to. ,
Required: False ,
}
{
dhcpRanges:
{
Description: DHCP Range assigned for subnet. ,
Required: False ,
}
[
string ,
]
,
gatewayAddress:
{
Description: Gateway address. ,
Required: False ,
}
string ,
}
,
portVif:
{
Description: Port Vif which segment is associated with. ,
Required: False ,
}
[
{
portName:
{
Description: Name of port or VIF attached to segment. ,
Required: False ,
}
string ,
}
,
]
,
status:
{
Description: Segment status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_DeleteSegment (new)
Description :  Delete a WorkloadNetworkSegment
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
segmentId:
{
Description: The ID of the NSX Segment ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_ListVirtualMachines (new)
Description :  List WorkloadNetworkVirtualMachine resources by WorkloadNetwork
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/virtualMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WorkloadNetworkVirtualMachine items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the VM. ,
Required: False ,
}
string ,
vmType:
{
Description: Virtual machine type. ,
Enum:
{
REGULAR: is regular ,
EDGE: is edge ,
SERVICE: is service ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_GetVirtualMachine (new)
Description :  Get a WorkloadNetworkVirtualMachine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/virtualMachines/{virtualMachineId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
virtualMachineId:
{
Description: ID of the virtual machine. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: Display name of the VM. ,
Required: False ,
}
string ,
vmType:
{
Description: Virtual machine type. ,
Enum:
{
REGULAR: is regular ,
EDGE: is edge ,
SERVICE: is service ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_ListVMGroups (new)
Description :  List WorkloadNetworkVMGroup resources by WorkloadNetwork
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The WorkloadNetworkVMGroup items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the VM group. ,
Required: False ,
}
string ,
members:
{
Description: Virtual machine members of this group. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: VM Group status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_GetVMGroup (new)
Description :  Get a WorkloadNetworkVMGroup
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
vmGroupId:
{
Description: ID of the VM group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the VM group. ,
Required: False ,
}
string ,
members:
{
Description: Virtual machine members of this group. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: VM Group status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_CreateVMGroup (new)
Description :  Create a WorkloadNetworkVMGroup
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
vmGroupId:
{
Description: ID of the VM group. ,
Required: True ,
}
string ,
workloadNetworkVMGroup:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the VM group. ,
Required: False ,
}
string ,
members:
{
Description: Virtual machine members of this group. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: VM Group status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the VM group. ,
Required: False ,
}
string ,
members:
{
Description: Virtual machine members of this group. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: VM Group status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: NSX VM Group ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the VM group. ,
Required: False ,
}
string ,
members:
{
Description: Virtual machine members of this group. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: VM Group status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_UpdateVMGroup (new)
Description :  Update a WorkloadNetworkVMGroup
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
vmGroupId:
{
Description: ID of the VM group. ,
Required: True ,
}
string ,
workloadNetworkVMGroup:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the VM group. ,
Required: False ,
}
string ,
members:
{
Description: Virtual machine members of this group. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: VM Group status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the VM group. ,
Required: False ,
}
string ,
members:
{
Description: Virtual machine members of this group. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: VM Group status. ,
Enum:
{
SUCCESS: is success ,
FAILURE: is failure ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Building: is building ,
Deleting: is deleting ,
Updating: is updating ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
WorkloadNetworks_DeleteVMGroup (new)
Description :  Delete a WorkloadNetworkVMGroup
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vmGroupId:
{
Description: ID of the VM group. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}