Microsoft.AVS (preview:2021-01-01)

2025/08/29 • 71 new, 71 deleted methods

Operations_List (new)
Description :  Lists all of the available operations
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 ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation being performed on this object ,
Required: False ,
}
string ,
display:
{
Description: Contains the localized display information for this operation ,
Required: False ,
}
{
provider:
{
Description: Localized friendly form of the resource provider name ,
Required: False ,
}
string ,
resource:
{
Description: Localized friendly form of the resource type related to this operation ,
Required: False ,
}
string ,
operation:
{
Description: Localized friendly name for the operation ,
Required: False ,
}
string ,
description:
{
Description: Localized friendly description for the operation ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: Gets or sets a value indicating whether the operation is a data action or not ,
Required: False ,
}
boolean ,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the operation ,
Required: False ,
}
{
serviceSpecification:
{
Description: Service specifications of the operation ,
Required: False ,
}
{
logSpecifications:
{
Description: Specifications of the Log for Azure Monitoring ,
Required: False ,
}
[
{
name:
{
Description: Name of the log ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the log ,
Required: False ,
}
string ,
blobDuration:
{
Description: Blob duration of the log ,
Required: False ,
}
string ,
}
,
]
,
metricSpecifications:
{
Description: Specifications of the Metrics for Azure Monitoring ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the metric ,
Required: False ,
}
string ,
displayDescription:
{
Description: Localized friendly description of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Unit that makes sense for the metric ,
Required: False ,
}
string ,
category:
{
Description: Name of the metric category that the metric belongs to. A metric can only belong to a single category. ,
Required: False ,
}
string ,
aggregationType:
{
Description: Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count. ,
Required: False ,
}
string ,
supportedAggregationTypes:
{
Description: Supported aggregation types ,
Required: False ,
}
[
string ,
]
,
supportedTimeGrainTypes:
{
Description: Supported time grain types ,
Required: False ,
}
[
string ,
]
,
fillGapWithZero:
{
Description: Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. ,
Required: False ,
}
boolean ,
dimensions:
{
Description: Dimensions of the metric ,
Required: False ,
}
[
{
name:
{
Description: Name of the dimension ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the dimension ,
Required: False ,
}
string ,
internalName:
{
Description: Name of the dimension as it appears in MDM ,
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Description: A boolean flag indicating whether this dimension should be included for the shoebox export scenario ,
Required: False ,
}
boolean ,
}
,
]
,
enableRegionalMdmAccount:
{
Description: Whether or not the service is using regional MDM accounts. ,
Required: False ,
}
string ,
sourceMdmAccount:
{
Description: The name of the MDM account. ,
Required: False ,
}
string ,
sourceMdmNamespace:
{
Description: The name of the MDM namespace. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Trial status ,
Enum:
{
TrialAvailable: No description available. ,
TrialUsed: No description available. ,
TrialDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
availableHosts:
{
Description: Number of trial hosts available ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 private clouds in a resource group
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
sku:
{
Description: The private cloud SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a private cloud resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
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 for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint 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 ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 private clouds in a subscription
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
sku:
{
Description: The private cloud SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a private cloud resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
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 for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint 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 ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The private cloud SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a private cloud resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
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 for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint 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 ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 or update a private cloud
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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: The private cloud ,
Required: True ,
}
{
sku:
{
Description: The private cloud SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a private cloud resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
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 for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint 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 ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
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 ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The private cloud SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a private cloud resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
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 for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint 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 ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
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 ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The private cloud SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a private cloud resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
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 for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint 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 ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 private cloud
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 private cloud properties to be updated ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: The updatable properties of a private cloud resource ,
Required: False ,
}
{
managementCluster:
{
Description: The default cluster used for management ,
Required: False ,
}
string ,
internet:
{
Description: Connectivity to internet is enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
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. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The private cloud SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a private cloud resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
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 for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint 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 ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
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 ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The private cloud SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a private cloud resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
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 for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint 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 ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 private cloud
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 clusters in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The items on a page ,
Required: False ,
}
[
{
sku:
{
Description: The cluster SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a cluster resource ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 by name in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The cluster SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a cluster resource ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 or update a cluster in a private cloud
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: The name of the private cloud. ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster in the private cloud ,
Required: True ,
}
string ,
cluster:
{
Description: A cluster in the private cloud ,
Required: True ,
}
{
sku:
{
Description: The cluster SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a cluster resource ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The cluster SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a cluster resource ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
sku:
{
Description: The cluster SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a cluster resource ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 in a private cloud
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
clusterUpdate:
{
Description: The cluster properties to be updated ,
Required: True ,
}
{
properties:
{
Description: The properties of a cluster resource that may be updated ,
Required: False ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The cluster SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a cluster resource ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
sku:
{
Description: The cluster SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a cluster resource ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 in a private cloud
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 cloud datastores in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The items on a page ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a datastore resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the datastore provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
netAppVolume:
{
Description: An Azure NetApp Files volume ,
Required: False ,
}
{
nfsProviderIp:
{
Description: IP address of the NFS provider ,
Required: False ,
}
string ,
nfsFilePath:
{
Description: File path through which the NFS volume is exposed by the provider ,
Required: False ,
}
string ,
}
,
diskPoolVolume:
{
Description: An iSCSI volume ,
Required: False ,
}
{
endpoints:
{
Description: iSCSI provider target IP address list ,
Required: False ,
}
[
string ,
]
,
lunName:
{
Description: Name of the LUN to be used ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 in a private cloud cluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores/{datastoreName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
datastoreName:
{
Description: Name of the datastore in the private cloud cluster ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a datastore resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the datastore provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
netAppVolume:
{
Description: An Azure NetApp Files volume ,
Required: False ,
}
{
nfsProviderIp:
{
Description: IP address of the NFS provider ,
Required: False ,
}
string ,
nfsFilePath:
{
Description: File path through which the NFS volume is exposed by the provider ,
Required: False ,
}
string ,
}
,
diskPoolVolume:
{
Description: An iSCSI volume ,
Required: False ,
}
{
endpoints:
{
Description: iSCSI provider target IP address list ,
Required: False ,
}
[
string ,
]
,
lunName:
{
Description: Name of the LUN to be used ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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_Create (new)
Description :  Create a datastore in a private cloud cluster
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores/{datastoreName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
datastoreName:
{
Description: Name of the datastore in the private cloud cluster ,
Required: True ,
}
string ,
datastore:
{
Description: A datastore in a private cloud cluster ,
Required: True ,
}
{
properties:
{
Description: The properties of a datastore resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the datastore provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
netAppVolume:
{
Description: An Azure NetApp Files volume ,
Required: False ,
}
{
nfsProviderIp:
{
Description: IP address of the NFS provider ,
Required: False ,
}
string ,
nfsFilePath:
{
Description: File path through which the NFS volume is exposed by the provider ,
Required: False ,
}
string ,
}
,
diskPoolVolume:
{
Description: An iSCSI volume ,
Required: False ,
}
{
endpoints:
{
Description: iSCSI provider target IP address list ,
Required: False ,
}
[
string ,
]
,
lunName:
{
Description: Name of the LUN to be used ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a datastore resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the datastore provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
netAppVolume:
{
Description: An Azure NetApp Files volume ,
Required: False ,
}
{
nfsProviderIp:
{
Description: IP address of the NFS provider ,
Required: False ,
}
string ,
nfsFilePath:
{
Description: File path through which the NFS volume is exposed by the provider ,
Required: False ,
}
string ,
}
,
diskPoolVolume:
{
Description: An iSCSI volume ,
Required: False ,
}
{
endpoints:
{
Description: iSCSI provider target IP address list ,
Required: False ,
}
[
string ,
]
,
lunName:
{
Description: Name of the LUN to be used ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a datastore resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the datastore provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
netAppVolume:
{
Description: An Azure NetApp Files volume ,
Required: False ,
}
{
nfsProviderIp:
{
Description: IP address of the NFS provider ,
Required: False ,
}
string ,
nfsFilePath:
{
Description: File path through which the NFS volume is exposed by the provider ,
Required: False ,
}
string ,
}
,
diskPoolVolume:
{
Description: An iSCSI volume ,
Required: False ,
}
{
endpoints:
{
Description: iSCSI provider target IP address list ,
Required: False ,
}
[
string ,
]
,
lunName:
{
Description: Name of the LUN to be used ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 in a private cloud cluster
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores/{datastoreName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
datastoreName:
{
Description: Name of the datastore in the private cloud cluster ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 HCX Enterprise Sites in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The items on a page ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an HCX Enterprise Site resource ,
Required: False ,
}
{
activationKey:
{
Description: The activation key ,
Required: False ,
}
string ,
status:
{
Description: The status of the HCX Enterprise Site ,
Enum:
{
Available: No description available. ,
Consumed: No description available. ,
Deactivated: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 an HCX Enterprise Site by name in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an HCX Enterprise Site resource ,
Required: False ,
}
{
activationKey:
{
Description: The activation key ,
Required: False ,
}
string ,
status:
{
Description: The status of the HCX Enterprise Site ,
Enum:
{
Available: No description available. ,
Consumed: No description available. ,
Deactivated: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 or update an HCX Enterprise Site in a private cloud
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: The name of the private cloud. ,
Required: True ,
}
string ,
hcxEnterpriseSiteName:
{
Description: Name of the HCX Enterprise Site in the private cloud ,
Required: True ,
}
string ,
hcxEnterpriseSite:
{
Description: The HCX Enterprise Site ,
Required: True ,
}
{
properties:
{
Description: The properties of an HCX Enterprise Site resource ,
Required: False ,
}
{
activationKey:
{
Description: The activation key ,
Required: False ,
}
string ,
status:
{
Description: The status of the HCX Enterprise Site ,
Enum:
{
Available: No description available. ,
Consumed: No description available. ,
Deactivated: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an HCX Enterprise Site resource ,
Required: False ,
}
{
activationKey:
{
Description: The activation key ,
Required: False ,
}
string ,
status:
{
Description: The status of the HCX Enterprise Site ,
Enum:
{
Available: No description available. ,
Consumed: No description available. ,
Deactivated: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of an HCX Enterprise Site resource ,
Required: False ,
}
{
activationKey:
{
Description: The activation key ,
Required: False ,
}
string ,
status:
{
Description: The status of the HCX Enterprise Site ,
Enum:
{
Available: No description available. ,
Consumed: No description available. ,
Deactivated: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 an HCX Enterprise Site in a private cloud
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ExpressRoute Circuit Authorizations in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The items on a page ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an ExpressRoute Circuit Authorization resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 an ExpressRoute Circuit Authorization by name in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an ExpressRoute Circuit Authorization resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 or update an ExpressRoute Circuit Authorization in a private cloud
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: The name of the private cloud. ,
Required: True ,
}
string ,
authorizationName:
{
Description: Name of the ExpressRoute Circuit Authorization in the private cloud ,
Required: True ,
}
string ,
authorization:
{
Description: An ExpressRoute Circuit Authorization ,
Required: True ,
}
{
properties:
{
Description: The properties of an ExpressRoute Circuit Authorization resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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 ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an ExpressRoute Circuit Authorization resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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 ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of an ExpressRoute Circuit Authorization resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 an ExpressRoute Circuit Authorization in a private cloud
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 global reach connections in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The items on a page ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a global reach connection resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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: No description available. ,
Connecting: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
peerExpressRouteCircuit:
{
Description: Identifier of the ExpressRoute Circuit to peer with in the global reach connection ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 global reach connection by name in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a global reach connection resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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: No description available. ,
Connecting: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
peerExpressRouteCircuit:
{
Description: Identifier of the ExpressRoute Circuit to peer with in the global reach connection ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 or update a global reach connection in a private cloud
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: The name of the private cloud. ,
Required: True ,
}
string ,
globalReachConnectionName:
{
Description: Name of the global reach connection in the private cloud ,
Required: True ,
}
string ,
globalReachConnection:
{
Description: A global reach connection in the private cloud ,
Required: True ,
}
{
properties:
{
Description: The properties of a global reach connection resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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: No description available. ,
Connecting: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
peerExpressRouteCircuit:
{
Description: Identifier of the ExpressRoute Circuit to peer with in the global reach connection ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a global reach connection resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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: No description available. ,
Connecting: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
peerExpressRouteCircuit:
{
Description: Identifier of the ExpressRoute Circuit to peer with in the global reach connection ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a global reach connection resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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: No description available. ,
Connecting: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
peerExpressRouteCircuit:
{
Description: Identifier of the ExpressRoute Circuit to peer with in the global reach connection ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 global reach connection in a private cloud
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 of segments in a private cloud workload network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a Workload Segment proxy 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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 segment by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
segmentId:
{
Description: NSX Segment identifier. Generally the same as the Segment's display name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a Workload Segment proxy 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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 segment by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
segmentId:
{
Description: NSX Segment identifier. Generally the same as the Segment's display name ,
Required: True ,
}
string ,
workloadNetworkSegment:
{
Description: NSX Segment ,
Required: True ,
}
{
properties:
{
Description: The properties of a Workload Segment proxy 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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a Workload Segment proxy 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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a Workload Segment proxy 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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 :  Create or update a segment by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
segmentId:
{
Description: NSX Segment identifier. Generally the same as the Segment's display name ,
Required: True ,
}
string ,
workloadNetworkSegment:
{
Description: NSX Segment ,
Required: True ,
}
{
properties:
{
Description: The properties of a Workload Segment proxy 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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a Workload Segment proxy 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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 segment by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
segmentId:
{
Description: NSX Segment identifier. Generally the same as the Segment's display name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 dhcp in a private cloud workload network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
properties:
{
Description: DHCP properties. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER, 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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 dhcp by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
dhcpId:
{
Description: NSX DHCP identifier. Generally the same as the DHCP display name ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DHCP properties. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER, 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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 dhcp by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dhcpId:
{
Description: NSX DHCP identifier. Generally the same as the DHCP display name ,
Required: True ,
}
string ,
workloadNetworkDhcp:
{
Description: NSX DHCP ,
Required: True ,
}
{
properties:
{
Description: DHCP properties. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER, 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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DHCP properties. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER, 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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: DHCP properties. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER, 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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 :  Create or update dhcp by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dhcpId:
{
Description: NSX DHCP identifier. Generally the same as the DHCP display name ,
Required: True ,
}
string ,
workloadNetworkDhcp:
{
Description: NSX DHCP ,
Required: True ,
}
{
properties:
{
Description: DHCP properties. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER, 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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DHCP properties. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER, 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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 dhcp by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dhcpId:
{
Description: NSX DHCP identifier. Generally the same as the DHCP display name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 of gateways in a private cloud workload network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
properties:
{
Description: Gateway properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the DHCP entity. ,
Required: False ,
}
string ,
path:
{
Description: NSX Gateway Path. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 gateway by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways/{gatewayId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
gatewayId:
{
Description: NSX Gateway identifier. Generally the same as the Gateway's display name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gateway properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the DHCP entity. ,
Required: False ,
}
string ,
path:
{
Description: NSX Gateway Path. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 of port mirroring profiles in a private cloud workload network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
properties:
{
Description: Port Mirroring Properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS, EGRESS, BIDIRECTIONAL: No description available. ,
}
,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 port mirroring profile by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
portMirroringId:
{
Description: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Port Mirroring Properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS, EGRESS, BIDIRECTIONAL: No description available. ,
}
,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 port mirroring profile by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
portMirroringId:
{
Description: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name ,
Required: True ,
}
string ,
workloadNetworkPortMirroring:
{
Description: NSX port mirroring ,
Required: True ,
}
{
properties:
{
Description: Port Mirroring Properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS, EGRESS, BIDIRECTIONAL: No description available. ,
}
,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Port Mirroring Properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS, EGRESS, BIDIRECTIONAL: No description available. ,
}
,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Port Mirroring Properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS, EGRESS, BIDIRECTIONAL: No description available. ,
}
,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 :  Create or update a port mirroring profile by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
portMirroringId:
{
Description: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name ,
Required: True ,
}
string ,
workloadNetworkPortMirroring:
{
Description: NSX port mirroring ,
Required: True ,
}
{
properties:
{
Description: Port Mirroring Properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS, EGRESS, BIDIRECTIONAL: No description available. ,
}
,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Port Mirroring Properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS, EGRESS, BIDIRECTIONAL: No description available. ,
}
,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 port mirroring profile by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
portMirroringId:
{
Description: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 of vm groups in a private cloud workload network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
properties:
{
Description: VM Group properties. ,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 vm group by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
vmGroupId:
{
Description: NSX VM Group identifier. Generally the same as the VM Group's display name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VM Group properties. ,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 vm group by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
vmGroupId:
{
Description: NSX VM Group identifier. Generally the same as the VM Group's display name ,
Required: True ,
}
string ,
workloadNetworkVMGroup:
{
Description: NSX VM Group ,
Required: True ,
}
{
properties:
{
Description: VM Group properties. ,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: VM Group properties. ,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: VM Group properties. ,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 :  Create or update a vm group by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
vmGroupId:
{
Description: NSX VM Group identifier. Generally the same as the VM Group's display name ,
Required: True ,
}
string ,
workloadNetworkVMGroup:
{
Description: NSX VM Group ,
Required: True ,
}
{
properties:
{
Description: VM Group properties. ,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: VM Group properties. ,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 vm group by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vmGroupId:
{
Description: NSX VM Group identifier. Generally the same as the VM Group's display name ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 of virtual machines in a private cloud workload network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
properties:
{
Description: Virtual machine properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the VM. ,
Required: False ,
}
string ,
vmType:
{
Description: Virtual machine type. ,
Enum:
{
REGULAR, EDGE, SERVICE: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 virtual machine by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/virtualMachines/{virtualMachineId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
virtualMachineId:
{
Description: NSX Virtual Machine identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Virtual machine properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the VM. ,
Required: False ,
}
string ,
vmType:
{
Description: Virtual machine type. ,
Enum:
{
REGULAR, EDGE, SERVICE: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 of DNS services in a private cloud workload network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
properties:
{
Description: DNS Service properties ,
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: No description available. ,
INFO: No description available. ,
WARNING: No description available. ,
ERROR: No description available. ,
FATAL: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: No description available. ,
FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 DNS service by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dnsServiceId:
{
Description: NSX DNS Service identifier. Generally the same as the DNS Service's display name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DNS Service properties ,
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: No description available. ,
INFO: No description available. ,
WARNING: No description available. ,
ERROR: No description available. ,
FATAL: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: No description available. ,
FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 DNS service by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dnsServiceId:
{
Description: NSX DNS Service identifier. Generally the same as the DNS Service's display name ,
Required: True ,
}
string ,
workloadNetworkDnsService:
{
Description: NSX DNS Service ,
Required: True ,
}
{
properties:
{
Description: DNS Service properties ,
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: No description available. ,
INFO: No description available. ,
WARNING: No description available. ,
ERROR: No description available. ,
FATAL: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: No description available. ,
FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DNS Service properties ,
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: No description available. ,
INFO: No description available. ,
WARNING: No description available. ,
ERROR: No description available. ,
FATAL: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: No description available. ,
FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: DNS Service properties ,
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: No description available. ,
INFO: No description available. ,
WARNING: No description available. ,
ERROR: No description available. ,
FATAL: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: No description available. ,
FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 :  Create or update a DNS service by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dnsServiceId:
{
Description: NSX DNS Service identifier. Generally the same as the DNS Service's display name ,
Required: True ,
}
string ,
workloadNetworkDnsService:
{
Description: NSX DNS Service ,
Required: True ,
}
{
properties:
{
Description: DNS Service properties ,
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: No description available. ,
INFO: No description available. ,
WARNING: No description available. ,
ERROR: No description available. ,
FATAL: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: No description available. ,
FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DNS Service properties ,
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: No description available. ,
INFO: No description available. ,
WARNING: No description available. ,
ERROR: No description available. ,
FATAL: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: No description available. ,
FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 DNS service by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
dnsServiceId:
{
Description: NSX DNS Service identifier. Generally the same as the DNS Service's display name ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 of DNS zones in a private cloud workload network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
properties:
{
Description: DNS Zone properties ,
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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 DNS zone by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dnsZoneId:
{
Description: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DNS Zone properties ,
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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 DNS zone by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dnsZoneId:
{
Description: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name ,
Required: True ,
}
string ,
workloadNetworkDnsZone:
{
Description: NSX DNS Zone ,
Required: True ,
}
{
properties:
{
Description: DNS Zone properties ,
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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DNS Zone properties ,
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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: DNS Zone properties ,
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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 :  Create or update a DNS zone by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dnsZoneId:
{
Description: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name ,
Required: True ,
}
string ,
workloadNetworkDnsZone:
{
Description: NSX DNS Zone ,
Required: True ,
}
{
properties:
{
Description: DNS Zone properties ,
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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DNS Zone properties ,
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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 DNS zone by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
dnsZoneId:
{
Description: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 addons in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The items on a page ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an addon resource ,
Required: False ,
}
{
addonType:
{
Description: The type of private cloud addon ,
Enum:
{
SRM: No description available. ,
VR: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the addon provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 an addon by name in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 for the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an addon resource ,
Required: False ,
}
{
addonType:
{
Description: The type of private cloud addon ,
Enum:
{
SRM: No description available. ,
VR: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the addon provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 or update a addon in a private cloud
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: The name of the private cloud. ,
Required: True ,
}
string ,
addonName:
{
Description: Name of the addon for the private cloud ,
Required: True ,
}
string ,
addon:
{
Description: A addon in the private cloud ,
Required: True ,
}
{
properties:
{
Description: The properties of an addon resource ,
Required: False ,
}
{
addonType:
{
Description: The type of private cloud addon ,
Enum:
{
SRM: No description available. ,
VR: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the addon provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an addon resource ,
Required: False ,
}
{
addonType:
{
Description: The type of private cloud addon ,
Enum:
{
SRM: No description available. ,
VR: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the addon provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of an addon resource ,
Required: False ,
}
{
addonType:
{
Description: The type of private cloud addon ,
Enum:
{
SRM: No description available. ,
VR: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the addon provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 in a private cloud
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 for the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Lists all of the available operations
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 ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation being performed on this object ,
Required: False ,
}
string ,
display:
{
Description: Contains the localized display information for this operation ,
Required: False ,
}
{
provider:
{
Description: Localized friendly form of the resource provider name ,
Required: False ,
}
string ,
resource:
{
Description: Localized friendly form of the resource type related to this operation ,
Required: False ,
}
string ,
operation:
{
Description: Localized friendly name for the operation ,
Required: False ,
}
string ,
description:
{
Description: Localized friendly description for the operation ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: Gets or sets a value indicating whether the operation is a data action or not ,
Required: False ,
}
boolean ,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the operation ,
Required: False ,
}
{
serviceSpecification:
{
Description: Service specifications of the operation ,
Required: False ,
}
{
logSpecifications:
{
Description: Specifications of the Log for Azure Monitoring ,
Required: False ,
}
[
{
name:
{
Description: Name of the log ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the log ,
Required: False ,
}
string ,
blobDuration:
{
Description: Blob duration of the log ,
Required: False ,
}
string ,
}
,
]
,
metricSpecifications:
{
Description: Specifications of the Metrics for Azure Monitoring ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the metric ,
Required: False ,
}
string ,
displayDescription:
{
Description: Localized friendly description of the metric ,
Required: False ,
}
string ,
unit:
{
Description: Unit that makes sense for the metric ,
Required: False ,
}
string ,
category:
{
Description: Name of the metric category that the metric belongs to. A metric can only belong to a single category. ,
Required: False ,
}
string ,
aggregationType:
{
Description: Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count. ,
Required: False ,
}
string ,
supportedAggregationTypes:
{
Description: Supported aggregation types ,
Required: False ,
}
[
string ,
]
,
supportedTimeGrainTypes:
{
Description: Supported time grain types ,
Required: False ,
}
[
string ,
]
,
fillGapWithZero:
{
Description: Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. ,
Required: False ,
}
boolean ,
dimensions:
{
Description: Dimensions of the metric ,
Required: False ,
}
[
{
name:
{
Description: Name of the dimension ,
Required: False ,
}
string ,
displayName:
{
Description: Localized friendly display name of the dimension ,
Required: False ,
}
string ,
internalName:
{
Description: Name of the dimension as it appears in MDM ,
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Description: A boolean flag indicating whether this dimension should be included for the shoebox export scenario ,
Required: False ,
}
boolean ,
}
,
]
,
enableRegionalMdmAccount:
{
Description: Whether or not the service is using regional MDM accounts. ,
Required: False ,
}
string ,
sourceMdmAccount:
{
Description: The name of the MDM account. ,
Required: False ,
}
string ,
sourceMdmNamespace:
{
Description: The name of the MDM namespace. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Return trial status for subscription by region
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AVS/locations/{location}/checkTrialAvailability
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Trial status ,
Enum:
{
TrialAvailable: No description available. ,
TrialUsed: No description available. ,
TrialDisabled: No description available. ,
}
,
Required: False ,
}
enum ,
availableHosts:
{
Description: Number of trial hosts available ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Return quota for subscription by region
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AVS/locations/{location}/checkQuotaAvailability
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
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: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  List private clouds in a resource group
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
sku:
{
Description: The private cloud SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a private cloud resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
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 for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint 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 ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  List private clouds in a subscription
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
sku:
{
Description: The private cloud SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a private cloud resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
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 for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint 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 ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Get a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The private cloud SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a private cloud resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
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 for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint 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 ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create or update a private cloud
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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: The private cloud ,
Required: True ,
}
{
sku:
{
Description: The private cloud SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a private cloud resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
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 for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint 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 ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
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 ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The private cloud SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a private cloud resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
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 for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint 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 ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
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 ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The private cloud SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a private cloud resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
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 for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint 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 ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Update a private cloud
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 private cloud properties to be updated ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: The updatable properties of a private cloud resource ,
Required: False ,
}
{
managementCluster:
{
Description: The default cluster used for management ,
Required: False ,
}
string ,
internet:
{
Description: Connectivity to internet is enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
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: No description available. ,
Disabled: No description available. ,
}
,
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. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The private cloud SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a private cloud resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
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 for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint 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 ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
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 ,
}
,
}

⚐ Response (201)

{
sku:
{
Description: The private cloud SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a private cloud resource ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Pending: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
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 for the NSX-T Data Center manager ,
Required: False ,
}
string ,
vcsa:
{
Description: Endpoint for Virtual Center Server Appliance ,
Required: False ,
}
string ,
hcxCloudManager:
{
Description: Endpoint 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 ,
Required: False ,
}
string ,
nsxtPassword:
{
Description: Optionally, set the NSX-T Manager password when the private cloud is created ,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Delete a private cloud
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Rotate the vCenter password
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/rotateVcenterPassword
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Rotate the NSX-T Manager password
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/rotateNsxtPassword
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  List clusters in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The items on a page ,
Required: False ,
}
[
{
sku:
{
Description: The cluster SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a cluster resource ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Get a cluster by name in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The cluster SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a cluster resource ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create or update a cluster in a private cloud
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: The name of the private cloud. ,
Required: True ,
}
string ,
clusterName:
{
Description: Name of the cluster in the private cloud ,
Required: True ,
}
string ,
cluster:
{
Description: A cluster in the private cloud ,
Required: True ,
}
{
sku:
{
Description: The cluster SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a cluster resource ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The cluster SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a cluster resource ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
sku:
{
Description: The cluster SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a cluster resource ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Update a cluster in a private cloud
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
clusterUpdate:
{
Description: The cluster properties to be updated ,
Required: True ,
}
{
properties:
{
Description: The properties of a cluster resource that may be updated ,
Required: False ,
}
{
clusterSize:
{
Description: The cluster size ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sku:
{
Description: The cluster SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a cluster resource ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
sku:
{
Description: The cluster SKU ,
Required: True ,
}
{
name:
{
Description: The name of the SKU. ,
Required: True ,
}
string ,
}
,
properties:
{
Description: The properties of a cluster resource ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Delete a cluster in a private cloud
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  List cloud datastores in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The items on a page ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a datastore resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the datastore provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
netAppVolume:
{
Description: An Azure NetApp Files volume ,
Required: False ,
}
{
nfsProviderIp:
{
Description: IP address of the NFS provider ,
Required: False ,
}
string ,
nfsFilePath:
{
Description: File path through which the NFS volume is exposed by the provider ,
Required: False ,
}
string ,
}
,
diskPoolVolume:
{
Description: An iSCSI volume ,
Required: False ,
}
{
endpoints:
{
Description: iSCSI provider target IP address list ,
Required: False ,
}
[
string ,
]
,
lunName:
{
Description: Name of the LUN to be used ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Get a datastore in a private cloud cluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores/{datastoreName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
datastoreName:
{
Description: Name of the datastore in the private cloud cluster ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a datastore resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the datastore provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
netAppVolume:
{
Description: An Azure NetApp Files volume ,
Required: False ,
}
{
nfsProviderIp:
{
Description: IP address of the NFS provider ,
Required: False ,
}
string ,
nfsFilePath:
{
Description: File path through which the NFS volume is exposed by the provider ,
Required: False ,
}
string ,
}
,
diskPoolVolume:
{
Description: An iSCSI volume ,
Required: False ,
}
{
endpoints:
{
Description: iSCSI provider target IP address list ,
Required: False ,
}
[
string ,
]
,
lunName:
{
Description: Name of the LUN to be used ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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_Create (removed)
Description :  Create a datastore in a private cloud cluster
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores/{datastoreName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
datastoreName:
{
Description: Name of the datastore in the private cloud cluster ,
Required: True ,
}
string ,
datastore:
{
Description: A datastore in a private cloud cluster ,
Required: True ,
}
{
properties:
{
Description: The properties of a datastore resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the datastore provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
netAppVolume:
{
Description: An Azure NetApp Files volume ,
Required: False ,
}
{
nfsProviderIp:
{
Description: IP address of the NFS provider ,
Required: False ,
}
string ,
nfsFilePath:
{
Description: File path through which the NFS volume is exposed by the provider ,
Required: False ,
}
string ,
}
,
diskPoolVolume:
{
Description: An iSCSI volume ,
Required: False ,
}
{
endpoints:
{
Description: iSCSI provider target IP address list ,
Required: False ,
}
[
string ,
]
,
lunName:
{
Description: Name of the LUN to be used ,
Required: False ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a datastore resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the datastore provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
netAppVolume:
{
Description: An Azure NetApp Files volume ,
Required: False ,
}
{
nfsProviderIp:
{
Description: IP address of the NFS provider ,
Required: False ,
}
string ,
nfsFilePath:
{
Description: File path through which the NFS volume is exposed by the provider ,
Required: False ,
}
string ,
}
,
diskPoolVolume:
{
Description: An iSCSI volume ,
Required: False ,
}
{
endpoints:
{
Description: iSCSI provider target IP address list ,
Required: False ,
}
[
string ,
]
,
lunName:
{
Description: Name of the LUN to be used ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a datastore resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the datastore provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
netAppVolume:
{
Description: An Azure NetApp Files volume ,
Required: False ,
}
{
nfsProviderIp:
{
Description: IP address of the NFS provider ,
Required: False ,
}
string ,
nfsFilePath:
{
Description: File path through which the NFS volume is exposed by the provider ,
Required: False ,
}
string ,
}
,
diskPoolVolume:
{
Description: An iSCSI volume ,
Required: False ,
}
{
endpoints:
{
Description: iSCSI provider target IP address list ,
Required: False ,
}
[
string ,
]
,
lunName:
{
Description: Name of the LUN to be used ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Delete a datastore in a private cloud cluster
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}/datastores/{datastoreName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
datastoreName:
{
Description: Name of the datastore in the private cloud cluster ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  List the admin credentials for the private cloud
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/listAdminCredentials
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  List HCX Enterprise Sites in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The items on a page ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an HCX Enterprise Site resource ,
Required: False ,
}
{
activationKey:
{
Description: The activation key ,
Required: False ,
}
string ,
status:
{
Description: The status of the HCX Enterprise Site ,
Enum:
{
Available: No description available. ,
Consumed: No description available. ,
Deactivated: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Get an HCX Enterprise Site by name in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an HCX Enterprise Site resource ,
Required: False ,
}
{
activationKey:
{
Description: The activation key ,
Required: False ,
}
string ,
status:
{
Description: The status of the HCX Enterprise Site ,
Enum:
{
Available: No description available. ,
Consumed: No description available. ,
Deactivated: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create or update an HCX Enterprise Site in a private cloud
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: The name of the private cloud. ,
Required: True ,
}
string ,
hcxEnterpriseSiteName:
{
Description: Name of the HCX Enterprise Site in the private cloud ,
Required: True ,
}
string ,
hcxEnterpriseSite:
{
Description: The HCX Enterprise Site ,
Required: True ,
}
{
properties:
{
Description: The properties of an HCX Enterprise Site resource ,
Required: False ,
}
{
activationKey:
{
Description: The activation key ,
Required: False ,
}
string ,
status:
{
Description: The status of the HCX Enterprise Site ,
Enum:
{
Available: No description available. ,
Consumed: No description available. ,
Deactivated: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an HCX Enterprise Site resource ,
Required: False ,
}
{
activationKey:
{
Description: The activation key ,
Required: False ,
}
string ,
status:
{
Description: The status of the HCX Enterprise Site ,
Enum:
{
Available: No description available. ,
Consumed: No description available. ,
Deactivated: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of an HCX Enterprise Site resource ,
Required: False ,
}
{
activationKey:
{
Description: The activation key ,
Required: False ,
}
string ,
status:
{
Description: The status of the HCX Enterprise Site ,
Enum:
{
Available: No description available. ,
Consumed: No description available. ,
Deactivated: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Delete an HCX Enterprise Site in a private cloud
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  List ExpressRoute Circuit Authorizations in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The items on a page ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an ExpressRoute Circuit Authorization resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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 ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Get an ExpressRoute Circuit Authorization by name in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an ExpressRoute Circuit Authorization resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create or update an ExpressRoute Circuit Authorization in a private cloud
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: The name of the private cloud. ,
Required: True ,
}
string ,
authorizationName:
{
Description: Name of the ExpressRoute Circuit Authorization in the private cloud ,
Required: True ,
}
string ,
authorization:
{
Description: An ExpressRoute Circuit Authorization ,
Required: True ,
}
{
properties:
{
Description: The properties of an ExpressRoute Circuit Authorization resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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 ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an ExpressRoute Circuit Authorization resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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 ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of an ExpressRoute Circuit Authorization resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Delete an ExpressRoute Circuit Authorization in a private cloud
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  List global reach connections in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The items on a page ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a global reach connection resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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: No description available. ,
Connecting: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
peerExpressRouteCircuit:
{
Description: Identifier of the ExpressRoute Circuit to peer with in the global reach connection ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Get a global reach connection by name in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a global reach connection resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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: No description available. ,
Connecting: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
peerExpressRouteCircuit:
{
Description: Identifier of the ExpressRoute Circuit to peer with in the global reach connection ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create or update a global reach connection in a private cloud
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: The name of the private cloud. ,
Required: True ,
}
string ,
globalReachConnectionName:
{
Description: Name of the global reach connection in the private cloud ,
Required: True ,
}
string ,
globalReachConnection:
{
Description: A global reach connection in the private cloud ,
Required: True ,
}
{
properties:
{
Description: The properties of a global reach connection resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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: No description available. ,
Connecting: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
peerExpressRouteCircuit:
{
Description: Identifier of the ExpressRoute Circuit to peer with in the global reach connection ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a global reach connection resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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: No description available. ,
Connecting: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
peerExpressRouteCircuit:
{
Description: Identifier of the ExpressRoute Circuit to peer with in the global reach connection ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a global reach connection resource ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the ExpressRoute Circuit Authorization provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Updating: No description available. ,
}
,
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: No description available. ,
Connecting: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
peerExpressRouteCircuit:
{
Description: Identifier of the ExpressRoute Circuit to peer with in the global reach connection ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Delete a global reach connection in a private cloud
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/globalReachConnections/{globalReachConnectionName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 in the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  List of segments in a private cloud workload network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a Workload Segment proxy 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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Get a segment by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
segmentId:
{
Description: NSX Segment identifier. Generally the same as the Segment's display name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a Workload Segment proxy 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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create a segment by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
segmentId:
{
Description: NSX Segment identifier. Generally the same as the Segment's display name ,
Required: True ,
}
string ,
workloadNetworkSegment:
{
Description: NSX Segment ,
Required: True ,
}
{
properties:
{
Description: The properties of a Workload Segment proxy 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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a Workload Segment proxy 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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a Workload Segment proxy 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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create or update a segment by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
segmentId:
{
Description: NSX Segment identifier. Generally the same as the Segment's display name ,
Required: True ,
}
string ,
workloadNetworkSegment:
{
Description: NSX Segment ,
Required: True ,
}
{
properties:
{
Description: The properties of a Workload Segment proxy 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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a Workload Segment proxy 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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Delete a segment by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/segments/{segmentId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
segmentId:
{
Description: NSX Segment identifier. Generally the same as the Segment's display name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  List dhcp in a private cloud workload network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
properties:
{
Description: DHCP properties. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER, 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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Get dhcp by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
dhcpId:
{
Description: NSX DHCP identifier. Generally the same as the DHCP display name ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DHCP properties. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER, 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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create dhcp by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dhcpId:
{
Description: NSX DHCP identifier. Generally the same as the DHCP display name ,
Required: True ,
}
string ,
workloadNetworkDhcp:
{
Description: NSX DHCP ,
Required: True ,
}
{
properties:
{
Description: DHCP properties. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER, 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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DHCP properties. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER, 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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: DHCP properties. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER, 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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create or update dhcp by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dhcpId:
{
Description: NSX DHCP identifier. Generally the same as the DHCP display name ,
Required: True ,
}
string ,
workloadNetworkDhcp:
{
Description: NSX DHCP ,
Required: True ,
}
{
properties:
{
Description: DHCP properties. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER, 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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DHCP properties. ,
Required: False ,
}
{
dhcpType:
{
Description: Type of DHCP: SERVER or RELAY. ,
Enum:
{
SERVER, 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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Delete dhcp by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dhcpId:
{
Description: NSX DHCP identifier. Generally the same as the DHCP display name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  List of gateways in a private cloud workload network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
properties:
{
Description: Gateway properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the DHCP entity. ,
Required: False ,
}
string ,
path:
{
Description: NSX Gateway Path. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Get a gateway by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/gateways/{gatewayId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
gatewayId:
{
Description: NSX Gateway identifier. Generally the same as the Gateway's display name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gateway properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the DHCP entity. ,
Required: False ,
}
string ,
path:
{
Description: NSX Gateway Path. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  List of port mirroring profiles in a private cloud workload network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
properties:
{
Description: Port Mirroring Properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS, EGRESS, BIDIRECTIONAL: No description available. ,
}
,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Get a port mirroring profile by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
portMirroringId:
{
Description: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Port Mirroring Properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS, EGRESS, BIDIRECTIONAL: No description available. ,
}
,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create a port mirroring profile by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
portMirroringId:
{
Description: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name ,
Required: True ,
}
string ,
workloadNetworkPortMirroring:
{
Description: NSX port mirroring ,
Required: True ,
}
{
properties:
{
Description: Port Mirroring Properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS, EGRESS, BIDIRECTIONAL: No description available. ,
}
,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Port Mirroring Properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS, EGRESS, BIDIRECTIONAL: No description available. ,
}
,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Port Mirroring Properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS, EGRESS, BIDIRECTIONAL: No description available. ,
}
,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create or update a port mirroring profile by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
portMirroringId:
{
Description: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name ,
Required: True ,
}
string ,
workloadNetworkPortMirroring:
{
Description: NSX port mirroring ,
Required: True ,
}
{
properties:
{
Description: Port Mirroring Properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS, EGRESS, BIDIRECTIONAL: No description available. ,
}
,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Port Mirroring Properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the port mirroring profile. ,
Required: False ,
}
string ,
direction:
{
Description: Direction of port mirroring profile. ,
Enum:
{
INGRESS, EGRESS, BIDIRECTIONAL: No description available. ,
}
,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Delete a port mirroring profile by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/portMirroringProfiles/{portMirroringId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
portMirroringId:
{
Description: NSX Port Mirroring identifier. Generally the same as the Port Mirroring display name ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  List of vm groups in a private cloud workload network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
properties:
{
Description: VM Group properties. ,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Get a vm group by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
vmGroupId:
{
Description: NSX VM Group identifier. Generally the same as the VM Group's display name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: VM Group properties. ,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create a vm group by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
vmGroupId:
{
Description: NSX VM Group identifier. Generally the same as the VM Group's display name ,
Required: True ,
}
string ,
workloadNetworkVMGroup:
{
Description: NSX VM Group ,
Required: True ,
}
{
properties:
{
Description: VM Group properties. ,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: VM Group properties. ,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: VM Group properties. ,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create or update a vm group by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
vmGroupId:
{
Description: NSX VM Group identifier. Generally the same as the VM Group's display name ,
Required: True ,
}
string ,
workloadNetworkVMGroup:
{
Description: NSX VM Group ,
Required: True ,
}
{
properties:
{
Description: VM Group properties. ,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: VM Group properties. ,
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, FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Delete a vm group by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/vmGroups/{vmGroupId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vmGroupId:
{
Description: NSX VM Group identifier. Generally the same as the VM Group's display name ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  List of virtual machines in a private cloud workload network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
properties:
{
Description: Virtual machine properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the VM. ,
Required: False ,
}
string ,
vmType:
{
Description: Virtual machine type. ,
Enum:
{
REGULAR, EDGE, SERVICE: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Get a virtual machine by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/virtualMachines/{virtualMachineId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
virtualMachineId:
{
Description: NSX Virtual Machine identifier. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Virtual machine properties. ,
Required: False ,
}
{
displayName:
{
Description: Display name of the VM. ,
Required: False ,
}
string ,
vmType:
{
Description: Virtual machine type. ,
Enum:
{
REGULAR, EDGE, SERVICE: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  List of DNS services in a private cloud workload network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
properties:
{
Description: DNS Service properties ,
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: No description available. ,
INFO: No description available. ,
WARNING: No description available. ,
ERROR: No description available. ,
FATAL: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: No description available. ,
FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Get a DNS service by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dnsServiceId:
{
Description: NSX DNS Service identifier. Generally the same as the DNS Service's display name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DNS Service properties ,
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: No description available. ,
INFO: No description available. ,
WARNING: No description available. ,
ERROR: No description available. ,
FATAL: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: No description available. ,
FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create a DNS service by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dnsServiceId:
{
Description: NSX DNS Service identifier. Generally the same as the DNS Service's display name ,
Required: True ,
}
string ,
workloadNetworkDnsService:
{
Description: NSX DNS Service ,
Required: True ,
}
{
properties:
{
Description: DNS Service properties ,
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: No description available. ,
INFO: No description available. ,
WARNING: No description available. ,
ERROR: No description available. ,
FATAL: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: No description available. ,
FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DNS Service properties ,
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: No description available. ,
INFO: No description available. ,
WARNING: No description available. ,
ERROR: No description available. ,
FATAL: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: No description available. ,
FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: DNS Service properties ,
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: No description available. ,
INFO: No description available. ,
WARNING: No description available. ,
ERROR: No description available. ,
FATAL: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: No description available. ,
FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create or update a DNS service by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dnsServiceId:
{
Description: NSX DNS Service identifier. Generally the same as the DNS Service's display name ,
Required: True ,
}
string ,
workloadNetworkDnsService:
{
Description: NSX DNS Service ,
Required: True ,
}
{
properties:
{
Description: DNS Service properties ,
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: No description available. ,
INFO: No description available. ,
WARNING: No description available. ,
ERROR: No description available. ,
FATAL: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: No description available. ,
FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DNS Service properties ,
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: No description available. ,
INFO: No description available. ,
WARNING: No description available. ,
ERROR: No description available. ,
FATAL: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: DNS Service status. ,
Enum:
{
SUCCESS: No description available. ,
FAILURE: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Delete a DNS service by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsServices/{dnsServiceId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
dnsServiceId:
{
Description: NSX DNS Service identifier. Generally the same as the DNS Service's display name ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  List of DNS zones in a private cloud workload network.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The items on the page ,
Required: False ,
}
[
{
properties:
{
Description: DNS Zone properties ,
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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Get a DNS zone by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dnsZoneId:
{
Description: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: DNS Zone properties ,
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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create a DNS zone by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dnsZoneId:
{
Description: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name ,
Required: True ,
}
string ,
workloadNetworkDnsZone:
{
Description: NSX DNS Zone ,
Required: True ,
}
{
properties:
{
Description: DNS Zone properties ,
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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DNS Zone properties ,
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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: DNS Zone properties ,
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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create or update a DNS zone by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
dnsZoneId:
{
Description: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name ,
Required: True ,
}
string ,
workloadNetworkDnsZone:
{
Description: NSX DNS Zone ,
Required: True ,
}
{
properties:
{
Description: DNS Zone properties ,
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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: DNS Zone properties ,
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: No description available. ,
Failed: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
revision:
{
Description: NSX revision number. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Delete a DNS zone by id in a private cloud workload network.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dnsZones/{dnsZoneId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
dnsZoneId:
{
Description: NSX DNS Zone identifier. Generally the same as the DNS Zone's display name ,
Required: True ,
}
string ,
privateCloudName:
{
Description: Name of the private cloud ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  List addons in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The items on a page ,
Required: False ,
}
[
{
properties:
{
Description: The properties of an addon resource ,
Required: False ,
}
{
addonType:
{
Description: The type of private cloud addon ,
Enum:
{
SRM: No description available. ,
VR: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the addon provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next page if any ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Get an addon by name in a private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 for the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an addon resource ,
Required: False ,
}
{
addonType:
{
Description: The type of private cloud addon ,
Enum:
{
SRM: No description available. ,
VR: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the addon provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Create or update a addon in a private cloud
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
privateCloudName:
{
Description: The name of the private cloud. ,
Required: True ,
}
string ,
addonName:
{
Description: Name of the addon for the private cloud ,
Required: True ,
}
string ,
addon:
{
Description: A addon in the private cloud ,
Required: True ,
}
{
properties:
{
Description: The properties of an addon resource ,
Required: False ,
}
{
addonType:
{
Description: The type of private cloud addon ,
Enum:
{
SRM: No description available. ,
VR: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the addon provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of an addon resource ,
Required: False ,
}
{
addonType:
{
Description: The type of private cloud addon ,
Enum:
{
SRM: No description available. ,
VR: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the addon provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of an addon resource ,
Required: False ,
}
{
addonType:
{
Description: The type of private cloud addon ,
Enum:
{
SRM: No description available. ,
VR: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the addon provisioning ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Building: No description available. ,
Deleting: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 (removed)
Description :  Delete a addon in a private cloud
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/addons/{addonName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
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 for the private cloud ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An error returned by the API ,
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 ,
}
[
{
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
]
,
}
,
}