Microsoft.VMwareCloudSimple (stable:2019-04-01)

2025/09/19 • 34 new, 34 deleted methods

Operations_List (new)
Description :  Return list of operations
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.VMwareCloudSimple/operations
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of available operations ,
Required: False ,
}
string ,
value:
{
Description: Returns a list of available operations ,
Required: False ,
}
[
{
display:
{
Description: The list of operations ,
Required: False ,
}
{
description:
{
Description: Description of the operation for display purposes ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation for display purposes ,
Required: False ,
}
string ,
provider:
{
Description: Name of the provider for display purposes ,
Required: False ,
}
string ,
resource:
{
Description: Name of the resource type for display purposes ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: Indicating whether the operation is a data action or not ,
Required: False ,
}
boolean ,
name:
{
Description: {resourceProviderNamespace}/{resourceType}/{read|write|delete|action} ,
Required: False ,
}
string ,
origin:
{
Description: The origin of operation ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The list of operation properties ,
Required: False ,
}
{
serviceSpecification:
{
Description: The list of specification's service metrics ,
Required: False ,
}
{
metricSpecifications:
{
Description: Metric specifications of operation ,
Required: False ,
}
[
{
aggregationType:
{
Description: Metric's aggregation type for e.g. (Average, Total) ,
Enum:
{
Average: No description available. ,
Total: No description available. ,
}
,
Required: True ,
}
enum ,
displayDescription:
{
Description: Metric's description ,
Required: True ,
}
string ,
displayName:
{
Description: Human readable metric's name ,
Required: True ,
}
string ,
name:
{
Description: Metric's name/id ,
Required: True ,
}
string ,
unit:
{
Description: Metric's unit ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudNodes_ListBySubscription (new)
Description :  Returns list of dedicate cloud nodes within subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudNodes
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of record sets to return ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: to be used by nextLink implementation ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of DedicatedCloudNode ,
Required: False ,
}
string ,
value:
{
Description: Results of the DedicatedCloudNode list ,
Required: False ,
}
[
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudNodeName} ,
Required: False ,
}
string ,
properties:
{
Description: Dedicated Cloud Nodes properties ,
Required: False ,
}
{
availabilityZoneId:
{
Description: Availability Zone id, e.g. "az1" ,
Required: True ,
}
string ,
availabilityZoneName:
{
Description: Availability Zone name, e.g. "Availability Zone 1" ,
Required: False ,
}
string ,
cloudRackName:
{
Description: VMWare Cloud Rack Name ,
Required: False ,
}
string ,
created:
{
Description: date time the resource was created ,
Format: date-time ,
Required: False ,
}
string ,
nodesCount:
{
Description: count of nodes to create ,
Required: True ,
}
integer ,
placementGroupId:
{
Description: Placement Group id, e.g. "n1" ,
Required: True ,
}
string ,
placementGroupName:
{
Description: Placement Name, e.g. "Placement Group 1" ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: False ,
}
string ,
privateCloudName:
{
Description: Resource Pool Name ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
purchaseId:
{
Description: purchase id ,
Format: uuid ,
Required: True ,
}
string ,
skuDescription:
{
Description: Dedicated Cloud Nodes SKU's description ,
Required: False ,
}
{
id:
{
Description: SKU's id ,
Required: True ,
}
string ,
name:
{
Description: SKU's name ,
Required: True ,
}
string ,
}
,
status:
{
Description: Node status, indicates is private cloud set up on this node or not ,
Enum:
{
unused: No description available. ,
used: No description available. ,
}
,
Required: False ,
}
enum ,
vmwareClusterName:
{
Description: VMWare Cluster Name ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Dedicated Cloud Nodes SKU ,
Required: False ,
}
{
capacity:
{
Description: The capacity of the SKU ,
Required: False ,
}
string ,
description:
{
Description: dedicatedCloudNode example: 8 x Ten-Core Intel® Xeon® Processor E5-2640 v4 2.40GHz 25MB Cache (90W); 12 x 64GB PC4-19200 2400MHz DDR4 ECC Registered DIMM, ... ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU for VMWare CloudSimple Node ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the SKU ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Dedicated Cloud Nodes tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudServices_ListBySubscription (new)
Description :  Returns list of dedicated cloud services within a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudServices
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of record sets to return ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: to be used by nextLink implementation ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of DedicatedCloudNode ,
Required: False ,
}
string ,
value:
{
Description: Results of the DedicatedCloudService list ,
Required: False ,
}
[
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudServices/{dedicatedCloudServiceName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudServiceName} ,
Required: False ,
}
string ,
properties:
{
Description: The properties of Dedicated Node Service ,
Required: False ,
}
{
gatewaySubnet:
{
Description: gateway Subnet for the account. It will collect the subnet address and always treat it as /28 ,
Required: True ,
}
string ,
isAccountOnboarded:
{
Description: indicates whether account onboarded or not in a given region ,
Enum:
{
notOnBoarded: No description available. ,
onBoarded: No description available. ,
onBoardingFailed: No description available. ,
onBoarding: No description available. ,
}
,
Required: False ,
}
enum ,
nodes:
{
Description: total nodes purchased ,
Required: False ,
}
integer ,
serviceURL:
{
Description: link to a service management web portal ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
SkusAvailability_List (new)
Description :  Returns list of available resources in region
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/availabilities
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
skuId:
{
Description: sku id, if no sku is passed availability for all skus will be returned ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of DedicatedCloudNode ,
Required: False ,
}
string ,
value:
{
Description: Results of the DedicatedPlacementGroupSkuAvailability list ,
Required: False ,
}
[
{
dedicatedAvailabilityZoneId:
{
Description: CloudSimple Availability Zone id ,
Required: False ,
}
string ,
dedicatedAvailabilityZoneName:
{
Description: CloudSimple Availability Zone Name ,
Required: False ,
}
string ,
dedicatedPlacementGroupId:
{
Description: CloudSimple Placement Group Id ,
Required: False ,
}
string ,
dedicatedPlacementGroupName:
{
Description: CloudSimple Placement Group name ,
Required: False ,
}
string ,
limit:
{
Description: indicates how many resources of a given SKU is available in a AZ->PG ,
Required: True ,
}
integer ,
resourceType:
{
Description: resource type e.g. DedicatedCloudNodes ,
Required: False ,
}
string ,
skuId:
{
Description: sku id ,
Required: False ,
}
string ,
skuName:
{
Description: sku name ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
Operations_Get (new)
Description :  Return an async operation
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/operationResults/{operationId}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
Referer:
{
Description: referer url ,
Required: True ,
}
string ,
operationId:
{
Description: operation id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endTime:
{
Description: End time of the operation ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error Message if operation failed ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
}
,
id:
{
Description: Operation Id ,
Required: False ,
}
string ,
name:
{
Description: Operation ID ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the operation ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Operation status ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
content-type: string ,
}
,
$schema:
{
Description: General error model ,
}
{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
,
}
PrivateClouds_List (new)
Description :  Returns list of private clouds in particular region
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
PrivateClouds_Get (new)
Description :  Returns private cloud by its name
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
pcName:
{
Description: The private cloud name ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
customizationPolicies_List (new)
Description :  Returns list of customization policies in region for private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/customizationPolicies
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
pcName:
{
Description: The private cloud name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation. only type is allowed here as a filter e.g. $filter=type eq 'xxxx' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of the Customization policy ,
Required: False ,
}
string ,
value:
{
Description: List of the customization policies ,
Required: False ,
}
[
{
id:
{
Description: Customization policy azure id ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: Customization policy name ,
Required: False ,
}
string ,
properties:
{
Description: Customization Policy properties ,
Required: False ,
}
{
description:
{
Description: Policy description ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private cloud id ,
Required: False ,
}
string ,
specification:
{
Description: Detailed customization policy specification ,
Required: False ,
}
{
identity:
{
Description: Customization Identity. It contains data about user and hostname ,
Required: False ,
}
{
data:
{
Description: Windows Text Identity. Prepared data ,
Required: False ,
}
string ,
hostName:
{
Description: Virtual machine host name settings ,
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
type:
{
Description: Type of host name ,
Enum:
{
USER_DEFINED: No description available. ,
PREFIX_BASED: No description available. ,
FIXED: No description available. ,
VIRTUAL_MACHINE_NAME: No description available. ,
CUSTOM_NAME: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
type:
{
Description: Identity type ,
Enum:
{
WINDOWS_TEXT: No description available. ,
WINDOWS: No description available. ,
LINUX: No description available. ,
}
,
Required: False ,
}
enum ,
userData:
{
Description: Windows Identity. User data customization ,
Required: False ,
}
{
isPasswordPredefined:
{
Description: Is password predefined in customization policy ,
Required: False ,
}
boolean ,
}
,
}
,
nicSettings:
{
Description: Network interface settings ,
Required: False ,
}
[
{
adapter:
{
Description: The list of adapters' settings ,
Required: False ,
}
{
gateway:
{
Description: The list of gateways ,
Required: False ,
}
[
string ,
]
,
ip:
{
Description: Ip address customization settings ,
Required: False ,
}
{
argument:
{
Description: Argument when Custom ip type is selected ,
Required: False ,
}
string ,
ipAddress:
{
Description: Defined Ip Address when Fixed ip type is selected ,
Required: False ,
}
string ,
type:
{
Description: Customization Specification ip type ,
Enum:
{
CUSTOM: No description available. ,
DHCP_IP: No description available. ,
FIXED_IP: No description available. ,
USER_DEFINED: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnetMask:
{
Description: Adapter subnet mask ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: NIC mac address ,
Required: False ,
}
string ,
}
,
]
,
}
,
type:
{
Description: The type of customization (Linux or Windows) ,
Enum:
{
LINUX: No description available. ,
WINDOWS: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Policy version ,
Required: False ,
}
string ,
}
,
type:
{
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
customizationPolicies_Get (new)
Description :  Returns customization policy by its name
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/customizationPolicies/{customizationPolicyName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
pcName:
{
Description: The private cloud name ,
Required: True ,
}
string ,
customizationPolicyName:
{
Description: customization policy name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Customization policy azure id ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: Customization policy name ,
Required: False ,
}
string ,
properties:
{
Description: Customization Policy properties ,
Required: False ,
}
{
description:
{
Description: Policy description ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private cloud id ,
Required: False ,
}
string ,
specification:
{
Description: Detailed customization policy specification ,
Required: False ,
}
{
identity:
{
Description: Customization Identity. It contains data about user and hostname ,
Required: False ,
}
{
data:
{
Description: Windows Text Identity. Prepared data ,
Required: False ,
}
string ,
hostName:
{
Description: Virtual machine host name settings ,
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
type:
{
Description: Type of host name ,
Enum:
{
USER_DEFINED: No description available. ,
PREFIX_BASED: No description available. ,
FIXED: No description available. ,
VIRTUAL_MACHINE_NAME: No description available. ,
CUSTOM_NAME: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
type:
{
Description: Identity type ,
Enum:
{
WINDOWS_TEXT: No description available. ,
WINDOWS: No description available. ,
LINUX: No description available. ,
}
,
Required: False ,
}
enum ,
userData:
{
Description: Windows Identity. User data customization ,
Required: False ,
}
{
isPasswordPredefined:
{
Description: Is password predefined in customization policy ,
Required: False ,
}
boolean ,
}
,
}
,
nicSettings:
{
Description: Network interface settings ,
Required: False ,
}
[
{
adapter:
{
Description: The list of adapters' settings ,
Required: False ,
}
{
gateway:
{
Description: The list of gateways ,
Required: False ,
}
[
string ,
]
,
ip:
{
Description: Ip address customization settings ,
Required: False ,
}
{
argument:
{
Description: Argument when Custom ip type is selected ,
Required: False ,
}
string ,
ipAddress:
{
Description: Defined Ip Address when Fixed ip type is selected ,
Required: False ,
}
string ,
type:
{
Description: Customization Specification ip type ,
Enum:
{
CUSTOM: No description available. ,
DHCP_IP: No description available. ,
FIXED_IP: No description available. ,
USER_DEFINED: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnetMask:
{
Description: Adapter subnet mask ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: NIC mac address ,
Required: False ,
}
string ,
}
,
]
,
}
,
type:
{
Description: The type of customization (Linux or Windows) ,
Enum:
{
LINUX: No description available. ,
WINDOWS: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Policy version ,
Required: False ,
}
string ,
}
,
type:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
ResourcePools_List (new)
Description :  Returns list of resource pools in region for private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/resourcePools
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
pcName:
{
Description: The private cloud name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of ResourcePoolsList ,
Required: False ,
}
string ,
value:
{
Description: Results of the Resource pools list ,
Required: False ,
}
[
{
id:
{
Description: resource pool id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {ResourcePoolName} ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: False ,
}
string ,
properties:
{
Description: Resource pool properties ,
Required: False ,
}
{
fullName:
{
Description: Hierarchical resource pool name ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
ResourcePools_Get (new)
Description :  Returns resource pool templates by its name
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/resourcePools/{resourcePoolName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
pcName:
{
Description: The private cloud name ,
Required: True ,
}
string ,
resourcePoolName:
{
Description: resource pool id (vsphereId) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: resource pool id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {ResourcePoolName} ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: False ,
}
string ,
properties:
{
Description: Resource pool properties ,
Required: False ,
}
{
fullName:
{
Description: Hierarchical resource pool name ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualMachineTemplates_List (new)
Description :  Returns list of virtual machine templates in region for private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/virtualMachineTemplates
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
pcName:
{
Description: The private cloud name ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
resourcePoolName:
{
Description: Resource pool used to derive vSphere cluster which contains VM templates ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of VirtualMachineTemplate ,
Required: False ,
}
string ,
value:
{
Description: Results of the VM template list ,
Required: False ,
}
[
{
id:
{
Description: virtual machine template id (privateCloudId:vsphereId) ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {virtualMachineTemplateName} ,
Required: False ,
}
string ,
properties:
{
Description: The Virtual Machine Template properties ,
Required: False ,
}
{
amountOfRam:
{
Description: The amount of memory ,
Required: False ,
}
integer ,
controllers:
{
Description: The list of Virtual Disk Controllers ,
Required: False ,
}
[
{
id:
{
Description: Controller's id ,
Required: False ,
}
string ,
name:
{
Description: The display name of Controller ,
Required: False ,
}
string ,
subType:
{
Description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) ,
Required: False ,
}
string ,
type:
{
Description: disk controller type (SCSI) ,
Required: False ,
}
string ,
}
,
]
,
description:
{
Description: The description of Virtual Machine Template ,
Required: False ,
}
string ,
disks:
{
Description: The list of Virtual Disks ,
Required: False ,
}
[
{
controllerId:
{
Description: Disk's Controller id ,
Required: True ,
}
string ,
independenceMode:
{
Description: Disk's independence mode type ,
Enum:
{
persistent: No description available. ,
independent_persistent: No description available. ,
independent_nonpersistent: No description available. ,
}
,
Required: True ,
}
enum ,
totalSize:
{
Description: Disk's total size ,
Required: True ,
}
integer ,
virtualDiskId:
{
Description: Disk's id ,
Required: False ,
}
string ,
virtualDiskName:
{
Description: Disk's display name ,
Required: False ,
}
string ,
}
,
]
,
exposeToGuestVM:
{
Description: Expose Guest OS or not ,
Required: False ,
}
boolean ,
guestOS:
{
Description: The Guest OS ,
Required: False ,
}
string ,
guestOSType:
{
Description: The Guest OS types ,
Required: False ,
}
string ,
nics:
{
Description: The list of Virtual NICs ,
Required: False ,
}
[
{
customization:
{
Description: guest OS customization for nic ,
Required: False ,
}
{
allocation:
{
Description: IP address allocation method ,
Enum:
{
static: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: Gateway addresses assigned to nic ,
Required: False ,
}
[
string ,
]
,
ipAddress:
{
Description: Static ip address for nic ,
Required: False ,
}
string ,
mask:
{
Description: Network mask for nic ,
Required: False ,
}
string ,
primaryWinsServer:
{
Description: primary WINS server for Windows ,
Required: False ,
}
string ,
secondaryWinsServer:
{
Description: secondary WINS server for Windows ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: NIC ip address ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: NIC MAC address ,
Required: False ,
}
string ,
network:
{
Description: Virtual Network ,
Required: True ,
}
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
nicType:
{
Description: NIC type ,
Enum:
{
E1000: No description available. ,
E1000E: No description available. ,
PCNET32: No description available. ,
VMXNET: No description available. ,
VMXNET2: No description available. ,
VMXNET3: No description available. ,
}
,
Required: True ,
}
enum ,
powerOnBoot:
{
Description: Is NIC powered on/off on boot ,
Required: False ,
}
boolean ,
virtualNicId:
{
Description: NIC id ,
Required: False ,
}
string ,
virtualNicName:
{
Description: NIC name ,
Required: False ,
}
string ,
}
,
]
,
numberOfCores:
{
Description: The number of CPU cores ,
Required: False ,
}
integer ,
path:
{
Description: path to folder ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: True ,
}
string ,
vSphereNetworks:
{
Description: The list of VSphere networks ,
Required: False ,
}
[
string ,
]
,
vSphereTags:
{
Description: The tags from VSphere ,
Required: False ,
}
[
string ,
]
,
vmwaretools:
{
Description: The VMware tools version ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualMachineTemplates_Get (new)
Description :  Returns virtual machine templates by its name
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/virtualMachineTemplates/{virtualMachineTemplateName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
pcName:
{
Description: The private cloud name ,
Required: True ,
}
string ,
virtualMachineTemplateName:
{
Description: virtual machine template id (vsphereId) ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: virtual machine template id (privateCloudId:vsphereId) ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {virtualMachineTemplateName} ,
Required: False ,
}
string ,
properties:
{
Description: The Virtual Machine Template properties ,
Required: False ,
}
{
amountOfRam:
{
Description: The amount of memory ,
Required: False ,
}
integer ,
controllers:
{
Description: The list of Virtual Disk Controllers ,
Required: False ,
}
[
{
id:
{
Description: Controller's id ,
Required: False ,
}
string ,
name:
{
Description: The display name of Controller ,
Required: False ,
}
string ,
subType:
{
Description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) ,
Required: False ,
}
string ,
type:
{
Description: disk controller type (SCSI) ,
Required: False ,
}
string ,
}
,
]
,
description:
{
Description: The description of Virtual Machine Template ,
Required: False ,
}
string ,
disks:
{
Description: The list of Virtual Disks ,
Required: False ,
}
[
{
controllerId:
{
Description: Disk's Controller id ,
Required: True ,
}
string ,
independenceMode:
{
Description: Disk's independence mode type ,
Enum:
{
persistent: No description available. ,
independent_persistent: No description available. ,
independent_nonpersistent: No description available. ,
}
,
Required: True ,
}
enum ,
totalSize:
{
Description: Disk's total size ,
Required: True ,
}
integer ,
virtualDiskId:
{
Description: Disk's id ,
Required: False ,
}
string ,
virtualDiskName:
{
Description: Disk's display name ,
Required: False ,
}
string ,
}
,
]
,
exposeToGuestVM:
{
Description: Expose Guest OS or not ,
Required: False ,
}
boolean ,
guestOS:
{
Description: The Guest OS ,
Required: False ,
}
string ,
guestOSType:
{
Description: The Guest OS types ,
Required: False ,
}
string ,
nics:
{
Description: The list of Virtual NICs ,
Required: False ,
}
[
{
customization:
{
Description: guest OS customization for nic ,
Required: False ,
}
{
allocation:
{
Description: IP address allocation method ,
Enum:
{
static: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: Gateway addresses assigned to nic ,
Required: False ,
}
[
string ,
]
,
ipAddress:
{
Description: Static ip address for nic ,
Required: False ,
}
string ,
mask:
{
Description: Network mask for nic ,
Required: False ,
}
string ,
primaryWinsServer:
{
Description: primary WINS server for Windows ,
Required: False ,
}
string ,
secondaryWinsServer:
{
Description: secondary WINS server for Windows ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: NIC ip address ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: NIC MAC address ,
Required: False ,
}
string ,
network:
{
Description: Virtual Network ,
Required: True ,
}
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
nicType:
{
Description: NIC type ,
Enum:
{
E1000: No description available. ,
E1000E: No description available. ,
PCNET32: No description available. ,
VMXNET: No description available. ,
VMXNET2: No description available. ,
VMXNET3: No description available. ,
}
,
Required: True ,
}
enum ,
powerOnBoot:
{
Description: Is NIC powered on/off on boot ,
Required: False ,
}
boolean ,
virtualNicId:
{
Description: NIC id ,
Required: False ,
}
string ,
virtualNicName:
{
Description: NIC name ,
Required: False ,
}
string ,
}
,
]
,
numberOfCores:
{
Description: The number of CPU cores ,
Required: False ,
}
integer ,
path:
{
Description: path to folder ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: True ,
}
string ,
vSphereNetworks:
{
Description: The list of VSphere networks ,
Required: False ,
}
[
string ,
]
,
vSphereTags:
{
Description: The tags from VSphere ,
Required: False ,
}
[
string ,
]
,
vmwaretools:
{
Description: The VMware tools version ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualNetworks_List (new)
Description :  Return list of virtual networks in location for private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/virtualNetworks
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
pcName:
{
Description: The private cloud name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
resourcePoolName:
{
Description: Resource pool used to derive vSphere cluster which contains virtual networks ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of VirtualNetwork ,
Required: False ,
}
string ,
value:
{
Description: Results of the VirtualNetwork list ,
Required: False ,
}
[
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualNetworks_Get (new)
Description :  Return virtual network by its name
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/virtualNetworks/{virtualNetworkName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
pcName:
{
Description: The private cloud name ,
Required: True ,
}
string ,
virtualNetworkName:
{
Description: virtual network id (vsphereId) ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
Usages_List (new)
Description :  Returns list of usage in region
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/usages
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation. only name.value is allowed here as a filter e.g. $filter=name.value eq 'xxxx' ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of DedicatedCloudNode ,
Required: False ,
}
string ,
value:
{
Description: The list of usages ,
Required: False ,
}
[
{
currentValue:
{
Description: The current usage value ,
Required: True ,
}
integer ,
limit:
{
Description: limit of a given sku in a region for a subscription. The maximum permitted value for the usage quota. If there is no limit, this value will be -1 ,
Required: True ,
}
integer ,
name:
{
Description: Usage name value and localized name ,
Required: False ,
}
{
localizedValue:
{
Description: e.g. "Virtual Machines" ,
Required: False ,
}
string ,
value:
{
Description: resource type or resource type sku name, e.g. virtualMachines ,
Required: False ,
}
string ,
}
,
unit:
{
Description: The usages' unit ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualMachines_ListBySubscription (new)
Description :  Returns list virtual machine within subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/virtualMachines
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of record sets to return ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: to be used by nextLink implementation ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of VirtualMachines ,
Required: False ,
}
string ,
value:
{
Description: Results of the VirtualMachine list ,
Required: False ,
}
[
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {virtualMachineName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual machine properties ,
Required: False ,
}
{
amountOfRam:
{
Description: The amount of memory ,
Required: True ,
}
integer ,
controllers:
{
Description: The list of Virtual Disks' Controllers ,
Required: False ,
}
[
{
id:
{
Description: Controller's id ,
Required: False ,
}
string ,
name:
{
Description: The display name of Controller ,
Required: False ,
}
string ,
subType:
{
Description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) ,
Required: False ,
}
string ,
type:
{
Description: disk controller type (SCSI) ,
Required: False ,
}
string ,
}
,
]
,
customization:
{
Description: Virtual machine properties ,
Required: False ,
}
{
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: Virtual Machine hostname ,
Required: False ,
}
string ,
password:
{
Description: Password for login ,
Required: False ,
}
string ,
policyId:
{
Description: id of customization policy ,
Required: False ,
}
string ,
username:
{
Description: Username for login ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The list of Virtual Disks ,
Required: False ,
}
[
{
controllerId:
{
Description: Disk's Controller id ,
Required: True ,
}
string ,
independenceMode:
{
Description: Disk's independence mode type ,
Enum:
{
persistent: No description available. ,
independent_persistent: No description available. ,
independent_nonpersistent: No description available. ,
}
,
Required: True ,
}
enum ,
totalSize:
{
Description: Disk's total size ,
Required: True ,
}
integer ,
virtualDiskId:
{
Description: Disk's id ,
Required: False ,
}
string ,
virtualDiskName:
{
Description: Disk's display name ,
Required: False ,
}
string ,
}
,
]
,
dnsname:
{
Description: The DNS name of Virtual Machine in VCenter ,
Required: False ,
}
string ,
exposeToGuestVM:
{
Description: Expose Guest OS or not ,
Required: False ,
}
boolean ,
folder:
{
Description: The path to virtual machine folder in VCenter ,
Required: False ,
}
string ,
guestOS:
{
Description: The name of Guest OS ,
Required: False ,
}
string ,
guestOSType:
{
Description: The Guest OS type ,
Enum:
{
linux: No description available. ,
windows: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
nics:
{
Description: The list of Virtual NICs ,
Required: False ,
}
[
{
customization:
{
Description: guest OS customization for nic ,
Required: False ,
}
{
allocation:
{
Description: IP address allocation method ,
Enum:
{
static: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: Gateway addresses assigned to nic ,
Required: False ,
}
[
string ,
]
,
ipAddress:
{
Description: Static ip address for nic ,
Required: False ,
}
string ,
mask:
{
Description: Network mask for nic ,
Required: False ,
}
string ,
primaryWinsServer:
{
Description: primary WINS server for Windows ,
Required: False ,
}
string ,
secondaryWinsServer:
{
Description: secondary WINS server for Windows ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: NIC ip address ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: NIC MAC address ,
Required: False ,
}
string ,
network:
{
Description: Virtual Network ,
Required: True ,
}
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
nicType:
{
Description: NIC type ,
Enum:
{
E1000: No description available. ,
E1000E: No description available. ,
PCNET32: No description available. ,
VMXNET: No description available. ,
VMXNET2: No description available. ,
VMXNET3: No description available. ,
}
,
Required: True ,
}
enum ,
powerOnBoot:
{
Description: Is NIC powered on/off on boot ,
Required: False ,
}
boolean ,
virtualNicId:
{
Description: NIC id ,
Required: False ,
}
string ,
virtualNicName:
{
Description: NIC name ,
Required: False ,
}
string ,
}
,
]
,
numberOfCores:
{
Description: The number of CPU cores ,
Required: True ,
}
integer ,
password:
{
Description: Password for login. Deprecated - use customization property ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
publicIP:
{
Description: The public ip of Virtual Machine ,
Required: False ,
}
string ,
resourcePool:
{
Description: Virtual Machines Resource Pool ,
Required: False ,
}
{
id:
{
Description: resource pool id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {ResourcePoolName} ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: False ,
}
string ,
properties:
{
Description: Resource pool properties ,
Required: False ,
}
{
fullName:
{
Description: Hierarchical resource pool name ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of Virtual machine ,
Enum:
{
running: No description available. ,
suspended: No description available. ,
poweredoff: No description available. ,
updating: No description available. ,
deallocating: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
templateId:
{
Description: Virtual Machine Template Id ,
Required: False ,
}
string ,
username:
{
Description: Username for login. Deprecated - use customization property ,
Required: False ,
}
string ,
vSphereNetworks:
{
Description: The list of Virtual VSphere Networks ,
Required: False ,
}
[
string ,
]
,
vmId:
{
Description: The internal id of Virtual Machine in VCenter ,
Required: False ,
}
string ,
vmwaretools:
{
Description: VMware tools version ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudNodes_ListByResourceGroup (new)
Description :  Returns list of dedicate cloud nodes within resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudNodes
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of record sets to return ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: to be used by nextLink implementation ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of DedicatedCloudNode ,
Required: False ,
}
string ,
value:
{
Description: Results of the DedicatedCloudNode list ,
Required: False ,
}
[
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudNodeName} ,
Required: False ,
}
string ,
properties:
{
Description: Dedicated Cloud Nodes properties ,
Required: False ,
}
{
availabilityZoneId:
{
Description: Availability Zone id, e.g. "az1" ,
Required: True ,
}
string ,
availabilityZoneName:
{
Description: Availability Zone name, e.g. "Availability Zone 1" ,
Required: False ,
}
string ,
cloudRackName:
{
Description: VMWare Cloud Rack Name ,
Required: False ,
}
string ,
created:
{
Description: date time the resource was created ,
Format: date-time ,
Required: False ,
}
string ,
nodesCount:
{
Description: count of nodes to create ,
Required: True ,
}
integer ,
placementGroupId:
{
Description: Placement Group id, e.g. "n1" ,
Required: True ,
}
string ,
placementGroupName:
{
Description: Placement Name, e.g. "Placement Group 1" ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: False ,
}
string ,
privateCloudName:
{
Description: Resource Pool Name ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
purchaseId:
{
Description: purchase id ,
Format: uuid ,
Required: True ,
}
string ,
skuDescription:
{
Description: Dedicated Cloud Nodes SKU's description ,
Required: False ,
}
{
id:
{
Description: SKU's id ,
Required: True ,
}
string ,
name:
{
Description: SKU's name ,
Required: True ,
}
string ,
}
,
status:
{
Description: Node status, indicates is private cloud set up on this node or not ,
Enum:
{
unused: No description available. ,
used: No description available. ,
}
,
Required: False ,
}
enum ,
vmwareClusterName:
{
Description: VMWare Cluster Name ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Dedicated Cloud Nodes SKU ,
Required: False ,
}
{
capacity:
{
Description: The capacity of the SKU ,
Required: False ,
}
string ,
description:
{
Description: dedicatedCloudNode example: 8 x Ten-Core Intel® Xeon® Processor E5-2640 v4 2.40GHz 25MB Cache (90W); 12 x 64GB PC4-19200 2400MHz DDR4 ECC Registered DIMM, ... ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU for VMWare CloudSimple Node ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the SKU ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Dedicated Cloud Nodes tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudNodes_Get (new)
Description :  Returns dedicated cloud node
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudNodes/{dedicatedCloudNodeName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
dedicatedCloudNodeName:
{
Description: dedicated cloud node name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudNodeName} ,
Required: False ,
}
string ,
properties:
{
Description: Dedicated Cloud Nodes properties ,
Required: False ,
}
{
availabilityZoneId:
{
Description: Availability Zone id, e.g. "az1" ,
Required: True ,
}
string ,
availabilityZoneName:
{
Description: Availability Zone name, e.g. "Availability Zone 1" ,
Required: False ,
}
string ,
cloudRackName:
{
Description: VMWare Cloud Rack Name ,
Required: False ,
}
string ,
created:
{
Description: date time the resource was created ,
Format: date-time ,
Required: False ,
}
string ,
nodesCount:
{
Description: count of nodes to create ,
Required: True ,
}
integer ,
placementGroupId:
{
Description: Placement Group id, e.g. "n1" ,
Required: True ,
}
string ,
placementGroupName:
{
Description: Placement Name, e.g. "Placement Group 1" ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: False ,
}
string ,
privateCloudName:
{
Description: Resource Pool Name ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
purchaseId:
{
Description: purchase id ,
Format: uuid ,
Required: True ,
}
string ,
skuDescription:
{
Description: Dedicated Cloud Nodes SKU's description ,
Required: False ,
}
{
id:
{
Description: SKU's id ,
Required: True ,
}
string ,
name:
{
Description: SKU's name ,
Required: True ,
}
string ,
}
,
status:
{
Description: Node status, indicates is private cloud set up on this node or not ,
Enum:
{
unused: No description available. ,
used: No description available. ,
}
,
Required: False ,
}
enum ,
vmwareClusterName:
{
Description: VMWare Cluster Name ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Dedicated Cloud Nodes SKU ,
Required: False ,
}
{
capacity:
{
Description: The capacity of the SKU ,
Required: False ,
}
string ,
description:
{
Description: dedicatedCloudNode example: 8 x Ten-Core Intel® Xeon® Processor E5-2640 v4 2.40GHz 25MB Cache (90W); 12 x 64GB PC4-19200 2400MHz DDR4 ECC Registered DIMM, ... ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU for VMWare CloudSimple Node ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the SKU ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Dedicated Cloud Nodes tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudNodes_CreateOrUpdate (new)
Description :  Returns dedicated cloud node by its name
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudNodes/{dedicatedCloudNodeName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
Referer:
{
Description: referer url ,
Required: True ,
}
string ,
dedicatedCloudNodeName:
{
Description: dedicated cloud node name ,
Required: True ,
}
string ,
dedicatedCloudNodeRequest:
{
Description: Create Dedicated Cloud Node request ,
Required: True ,
}
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudNodeName} ,
Required: False ,
}
string ,
properties:
{
Description: Dedicated Cloud Nodes properties ,
Required: False ,
}
{
availabilityZoneId:
{
Description: Availability Zone id, e.g. "az1" ,
Required: True ,
}
string ,
availabilityZoneName:
{
Description: Availability Zone name, e.g. "Availability Zone 1" ,
Required: False ,
}
string ,
cloudRackName:
{
Description: VMWare Cloud Rack Name ,
Required: False ,
}
string ,
created:
{
Description: date time the resource was created ,
Format: date-time ,
Required: False ,
}
string ,
nodesCount:
{
Description: count of nodes to create ,
Required: True ,
}
integer ,
placementGroupId:
{
Description: Placement Group id, e.g. "n1" ,
Required: True ,
}
string ,
placementGroupName:
{
Description: Placement Name, e.g. "Placement Group 1" ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: False ,
}
string ,
privateCloudName:
{
Description: Resource Pool Name ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
purchaseId:
{
Description: purchase id ,
Format: uuid ,
Required: True ,
}
string ,
skuDescription:
{
Description: Dedicated Cloud Nodes SKU's description ,
Required: False ,
}
{
id:
{
Description: SKU's id ,
Required: True ,
}
string ,
name:
{
Description: SKU's name ,
Required: True ,
}
string ,
}
,
status:
{
Description: Node status, indicates is private cloud set up on this node or not ,
Enum:
{
unused: No description available. ,
used: No description available. ,
}
,
Required: False ,
}
enum ,
vmwareClusterName:
{
Description: VMWare Cluster Name ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Dedicated Cloud Nodes SKU ,
Required: False ,
}
{
capacity:
{
Description: The capacity of the SKU ,
Required: False ,
}
string ,
description:
{
Description: dedicatedCloudNode example: 8 x Ten-Core Intel® Xeon® Processor E5-2640 v4 2.40GHz 25MB Cache (90W); 12 x 64GB PC4-19200 2400MHz DDR4 ECC Registered DIMM, ... ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU for VMWare CloudSimple Node ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the SKU ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Dedicated Cloud Nodes tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation: string ,
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: Dedicated cloud node model ,
}
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudNodeName} ,
Required: False ,
}
string ,
properties:
{
Description: Dedicated Cloud Nodes properties ,
Required: False ,
}
{
availabilityZoneId:
{
Description: Availability Zone id, e.g. "az1" ,
Required: True ,
}
string ,
availabilityZoneName:
{
Description: Availability Zone name, e.g. "Availability Zone 1" ,
Required: False ,
}
string ,
cloudRackName:
{
Description: VMWare Cloud Rack Name ,
Required: False ,
}
string ,
created:
{
Description: date time the resource was created ,
Format: date-time ,
Required: False ,
}
string ,
nodesCount:
{
Description: count of nodes to create ,
Required: True ,
}
integer ,
placementGroupId:
{
Description: Placement Group id, e.g. "n1" ,
Required: True ,
}
string ,
placementGroupName:
{
Description: Placement Name, e.g. "Placement Group 1" ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: False ,
}
string ,
privateCloudName:
{
Description: Resource Pool Name ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
purchaseId:
{
Description: purchase id ,
Format: uuid ,
Required: True ,
}
string ,
skuDescription:
{
Description: Dedicated Cloud Nodes SKU's description ,
Required: False ,
}
{
id:
{
Description: SKU's id ,
Required: True ,
}
string ,
name:
{
Description: SKU's name ,
Required: True ,
}
string ,
}
,
status:
{
Description: Node status, indicates is private cloud set up on this node or not ,
Enum:
{
unused: No description available. ,
used: No description available. ,
}
,
Required: False ,
}
enum ,
vmwareClusterName:
{
Description: VMWare Cluster Name ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Dedicated Cloud Nodes SKU ,
Required: False ,
}
{
capacity:
{
Description: The capacity of the SKU ,
Required: False ,
}
string ,
description:
{
Description: dedicatedCloudNode example: 8 x Ten-Core Intel® Xeon® Processor E5-2640 v4 2.40GHz 25MB Cache (90W); 12 x 64GB PC4-19200 2400MHz DDR4 ECC Registered DIMM, ... ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU for VMWare CloudSimple Node ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the SKU ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Dedicated Cloud Nodes tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudNodes_Delete (new)
Description :  Delete dedicated cloud node
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudNodes/{dedicatedCloudNodeName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
dedicatedCloudNodeName:
{
Description: dedicated cloud node name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
content-type: string ,
}
,
$schema:
{
Description: General error model ,
}
{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
,
}
DedicatedCloudNodes_Update (new)
Description :  Patches dedicated node properties
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudNodes/{dedicatedCloudNodeName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
dedicatedCloudNodeName:
{
Description: dedicated cloud node name ,
Required: True ,
}
string ,
dedicatedCloudNodeRequest:
{
Description: Patch Dedicated Cloud Node request ,
Required: True ,
}
{
tags:
{
Description: The tags key:value pairs ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudNodeName} ,
Required: False ,
}
string ,
properties:
{
Description: Dedicated Cloud Nodes properties ,
Required: False ,
}
{
availabilityZoneId:
{
Description: Availability Zone id, e.g. "az1" ,
Required: True ,
}
string ,
availabilityZoneName:
{
Description: Availability Zone name, e.g. "Availability Zone 1" ,
Required: False ,
}
string ,
cloudRackName:
{
Description: VMWare Cloud Rack Name ,
Required: False ,
}
string ,
created:
{
Description: date time the resource was created ,
Format: date-time ,
Required: False ,
}
string ,
nodesCount:
{
Description: count of nodes to create ,
Required: True ,
}
integer ,
placementGroupId:
{
Description: Placement Group id, e.g. "n1" ,
Required: True ,
}
string ,
placementGroupName:
{
Description: Placement Name, e.g. "Placement Group 1" ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: False ,
}
string ,
privateCloudName:
{
Description: Resource Pool Name ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
purchaseId:
{
Description: purchase id ,
Format: uuid ,
Required: True ,
}
string ,
skuDescription:
{
Description: Dedicated Cloud Nodes SKU's description ,
Required: False ,
}
{
id:
{
Description: SKU's id ,
Required: True ,
}
string ,
name:
{
Description: SKU's name ,
Required: True ,
}
string ,
}
,
status:
{
Description: Node status, indicates is private cloud set up on this node or not ,
Enum:
{
unused: No description available. ,
used: No description available. ,
}
,
Required: False ,
}
enum ,
vmwareClusterName:
{
Description: VMWare Cluster Name ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Dedicated Cloud Nodes SKU ,
Required: False ,
}
{
capacity:
{
Description: The capacity of the SKU ,
Required: False ,
}
string ,
description:
{
Description: dedicatedCloudNode example: 8 x Ten-Core Intel® Xeon® Processor E5-2640 v4 2.40GHz 25MB Cache (90W); 12 x 64GB PC4-19200 2400MHz DDR4 ECC Registered DIMM, ... ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU for VMWare CloudSimple Node ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the SKU ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Dedicated Cloud Nodes tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudServices_ListByResourceGroup (new)
Description :  Returns list of dedicated cloud services within a resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudServices
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of record sets to return ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: to be used by nextLink implementation ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of DedicatedCloudNode ,
Required: False ,
}
string ,
value:
{
Description: Results of the DedicatedCloudService list ,
Required: False ,
}
[
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudServices/{dedicatedCloudServiceName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudServiceName} ,
Required: False ,
}
string ,
properties:
{
Description: The properties of Dedicated Node Service ,
Required: False ,
}
{
gatewaySubnet:
{
Description: gateway Subnet for the account. It will collect the subnet address and always treat it as /28 ,
Required: True ,
}
string ,
isAccountOnboarded:
{
Description: indicates whether account onboarded or not in a given region ,
Enum:
{
notOnBoarded: No description available. ,
onBoarded: No description available. ,
onBoardingFailed: No description available. ,
onBoarding: No description available. ,
}
,
Required: False ,
}
enum ,
nodes:
{
Description: total nodes purchased ,
Required: False ,
}
integer ,
serviceURL:
{
Description: link to a service management web portal ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudServices_Get (new)
Description :  Returns Dedicate Cloud Service
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudServices/{dedicatedCloudServiceName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
dedicatedCloudServiceName:
{
Description: dedicated cloud Service name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudServices/{dedicatedCloudServiceName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudServiceName} ,
Required: False ,
}
string ,
properties:
{
Description: The properties of Dedicated Node Service ,
Required: False ,
}
{
gatewaySubnet:
{
Description: gateway Subnet for the account. It will collect the subnet address and always treat it as /28 ,
Required: True ,
}
string ,
isAccountOnboarded:
{
Description: indicates whether account onboarded or not in a given region ,
Enum:
{
notOnBoarded: No description available. ,
onBoarded: No description available. ,
onBoardingFailed: No description available. ,
onBoarding: No description available. ,
}
,
Required: False ,
}
enum ,
nodes:
{
Description: total nodes purchased ,
Required: False ,
}
integer ,
serviceURL:
{
Description: link to a service management web portal ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudServices_CreateOrUpdate (new)
Description :  Create dedicate cloud service
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudServices/{dedicatedCloudServiceName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
dedicatedCloudServiceName:
{
Description: dedicated cloud Service name ,
Required: True ,
}
string ,
dedicatedCloudServiceRequest:
{
Description: Create Dedicated Cloud Service request ,
Required: True ,
}
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudServices/{dedicatedCloudServiceName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudServiceName} ,
Required: False ,
}
string ,
properties:
{
Description: The properties of Dedicated Node Service ,
Required: False ,
}
{
gatewaySubnet:
{
Description: gateway Subnet for the account. It will collect the subnet address and always treat it as /28 ,
Required: True ,
}
string ,
isAccountOnboarded:
{
Description: indicates whether account onboarded or not in a given region ,
Enum:
{
notOnBoarded: No description available. ,
onBoarded: No description available. ,
onBoardingFailed: No description available. ,
onBoarding: No description available. ,
}
,
Required: False ,
}
enum ,
nodes:
{
Description: total nodes purchased ,
Required: False ,
}
integer ,
serviceURL:
{
Description: link to a service management web portal ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudServices/{dedicatedCloudServiceName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudServiceName} ,
Required: False ,
}
string ,
properties:
{
Description: The properties of Dedicated Node Service ,
Required: False ,
}
{
gatewaySubnet:
{
Description: gateway Subnet for the account. It will collect the subnet address and always treat it as /28 ,
Required: True ,
}
string ,
isAccountOnboarded:
{
Description: indicates whether account onboarded or not in a given region ,
Enum:
{
notOnBoarded: No description available. ,
onBoarded: No description available. ,
onBoardingFailed: No description available. ,
onBoarding: No description available. ,
}
,
Required: False ,
}
enum ,
nodes:
{
Description: total nodes purchased ,
Required: False ,
}
integer ,
serviceURL:
{
Description: link to a service management web portal ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudServices_Delete (new)
Description :  Delete dedicate cloud service
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudServices/{dedicatedCloudServiceName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
dedicatedCloudServiceName:
{
Description: dedicated cloud service name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
content-type: string ,
}
,
$schema:
{
Description: General error model ,
}
{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
,
}
DedicatedCloudServices_Update (new)
Description :  Patch dedicated cloud service's properties
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudServices/{dedicatedCloudServiceName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
dedicatedCloudServiceName:
{
Description: dedicated cloud service name ,
Required: True ,
}
string ,
dedicatedCloudServiceRequest:
{
Description: Patch Dedicated Cloud Service request ,
Required: True ,
}
{
tags:
{
Description: The tags key:value pairs ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudServices/{dedicatedCloudServiceName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudServiceName} ,
Required: False ,
}
string ,
properties:
{
Description: The properties of Dedicated Node Service ,
Required: False ,
}
{
gatewaySubnet:
{
Description: gateway Subnet for the account. It will collect the subnet address and always treat it as /28 ,
Required: True ,
}
string ,
isAccountOnboarded:
{
Description: indicates whether account onboarded or not in a given region ,
Enum:
{
notOnBoarded: No description available. ,
onBoarded: No description available. ,
onBoardingFailed: No description available. ,
onBoarding: No description available. ,
}
,
Required: False ,
}
enum ,
nodes:
{
Description: total nodes purchased ,
Required: False ,
}
integer ,
serviceURL:
{
Description: link to a service management web portal ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualMachines_ListByResourceGroup (new)
Description :  Returns list of virtual machine within resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of record sets to return ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: to be used by nextLink implementation ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of VirtualMachines ,
Required: False ,
}
string ,
value:
{
Description: Results of the VirtualMachine list ,
Required: False ,
}
[
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {virtualMachineName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual machine properties ,
Required: False ,
}
{
amountOfRam:
{
Description: The amount of memory ,
Required: True ,
}
integer ,
controllers:
{
Description: The list of Virtual Disks' Controllers ,
Required: False ,
}
[
{
id:
{
Description: Controller's id ,
Required: False ,
}
string ,
name:
{
Description: The display name of Controller ,
Required: False ,
}
string ,
subType:
{
Description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) ,
Required: False ,
}
string ,
type:
{
Description: disk controller type (SCSI) ,
Required: False ,
}
string ,
}
,
]
,
customization:
{
Description: Virtual machine properties ,
Required: False ,
}
{
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: Virtual Machine hostname ,
Required: False ,
}
string ,
password:
{
Description: Password for login ,
Required: False ,
}
string ,
policyId:
{
Description: id of customization policy ,
Required: False ,
}
string ,
username:
{
Description: Username for login ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The list of Virtual Disks ,
Required: False ,
}
[
{
controllerId:
{
Description: Disk's Controller id ,
Required: True ,
}
string ,
independenceMode:
{
Description: Disk's independence mode type ,
Enum:
{
persistent: No description available. ,
independent_persistent: No description available. ,
independent_nonpersistent: No description available. ,
}
,
Required: True ,
}
enum ,
totalSize:
{
Description: Disk's total size ,
Required: True ,
}
integer ,
virtualDiskId:
{
Description: Disk's id ,
Required: False ,
}
string ,
virtualDiskName:
{
Description: Disk's display name ,
Required: False ,
}
string ,
}
,
]
,
dnsname:
{
Description: The DNS name of Virtual Machine in VCenter ,
Required: False ,
}
string ,
exposeToGuestVM:
{
Description: Expose Guest OS or not ,
Required: False ,
}
boolean ,
folder:
{
Description: The path to virtual machine folder in VCenter ,
Required: False ,
}
string ,
guestOS:
{
Description: The name of Guest OS ,
Required: False ,
}
string ,
guestOSType:
{
Description: The Guest OS type ,
Enum:
{
linux: No description available. ,
windows: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
nics:
{
Description: The list of Virtual NICs ,
Required: False ,
}
[
{
customization:
{
Description: guest OS customization for nic ,
Required: False ,
}
{
allocation:
{
Description: IP address allocation method ,
Enum:
{
static: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: Gateway addresses assigned to nic ,
Required: False ,
}
[
string ,
]
,
ipAddress:
{
Description: Static ip address for nic ,
Required: False ,
}
string ,
mask:
{
Description: Network mask for nic ,
Required: False ,
}
string ,
primaryWinsServer:
{
Description: primary WINS server for Windows ,
Required: False ,
}
string ,
secondaryWinsServer:
{
Description: secondary WINS server for Windows ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: NIC ip address ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: NIC MAC address ,
Required: False ,
}
string ,
network:
{
Description: Virtual Network ,
Required: True ,
}
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
nicType:
{
Description: NIC type ,
Enum:
{
E1000: No description available. ,
E1000E: No description available. ,
PCNET32: No description available. ,
VMXNET: No description available. ,
VMXNET2: No description available. ,
VMXNET3: No description available. ,
}
,
Required: True ,
}
enum ,
powerOnBoot:
{
Description: Is NIC powered on/off on boot ,
Required: False ,
}
boolean ,
virtualNicId:
{
Description: NIC id ,
Required: False ,
}
string ,
virtualNicName:
{
Description: NIC name ,
Required: False ,
}
string ,
}
,
]
,
numberOfCores:
{
Description: The number of CPU cores ,
Required: True ,
}
integer ,
password:
{
Description: Password for login. Deprecated - use customization property ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
publicIP:
{
Description: The public ip of Virtual Machine ,
Required: False ,
}
string ,
resourcePool:
{
Description: Virtual Machines Resource Pool ,
Required: False ,
}
{
id:
{
Description: resource pool id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {ResourcePoolName} ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: False ,
}
string ,
properties:
{
Description: Resource pool properties ,
Required: False ,
}
{
fullName:
{
Description: Hierarchical resource pool name ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of Virtual machine ,
Enum:
{
running: No description available. ,
suspended: No description available. ,
poweredoff: No description available. ,
updating: No description available. ,
deallocating: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
templateId:
{
Description: Virtual Machine Template Id ,
Required: False ,
}
string ,
username:
{
Description: Username for login. Deprecated - use customization property ,
Required: False ,
}
string ,
vSphereNetworks:
{
Description: The list of Virtual VSphere Networks ,
Required: False ,
}
[
string ,
]
,
vmId:
{
Description: The internal id of Virtual Machine in VCenter ,
Required: False ,
}
string ,
vmwaretools:
{
Description: VMware tools version ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualMachines_Get (new)
Description :  Get virtual machine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtual machine name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {virtualMachineName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual machine properties ,
Required: False ,
}
{
amountOfRam:
{
Description: The amount of memory ,
Required: True ,
}
integer ,
controllers:
{
Description: The list of Virtual Disks' Controllers ,
Required: False ,
}
[
{
id:
{
Description: Controller's id ,
Required: False ,
}
string ,
name:
{
Description: The display name of Controller ,
Required: False ,
}
string ,
subType:
{
Description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) ,
Required: False ,
}
string ,
type:
{
Description: disk controller type (SCSI) ,
Required: False ,
}
string ,
}
,
]
,
customization:
{
Description: Virtual machine properties ,
Required: False ,
}
{
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: Virtual Machine hostname ,
Required: False ,
}
string ,
password:
{
Description: Password for login ,
Required: False ,
}
string ,
policyId:
{
Description: id of customization policy ,
Required: False ,
}
string ,
username:
{
Description: Username for login ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The list of Virtual Disks ,
Required: False ,
}
[
{
controllerId:
{
Description: Disk's Controller id ,
Required: True ,
}
string ,
independenceMode:
{
Description: Disk's independence mode type ,
Enum:
{
persistent: No description available. ,
independent_persistent: No description available. ,
independent_nonpersistent: No description available. ,
}
,
Required: True ,
}
enum ,
totalSize:
{
Description: Disk's total size ,
Required: True ,
}
integer ,
virtualDiskId:
{
Description: Disk's id ,
Required: False ,
}
string ,
virtualDiskName:
{
Description: Disk's display name ,
Required: False ,
}
string ,
}
,
]
,
dnsname:
{
Description: The DNS name of Virtual Machine in VCenter ,
Required: False ,
}
string ,
exposeToGuestVM:
{
Description: Expose Guest OS or not ,
Required: False ,
}
boolean ,
folder:
{
Description: The path to virtual machine folder in VCenter ,
Required: False ,
}
string ,
guestOS:
{
Description: The name of Guest OS ,
Required: False ,
}
string ,
guestOSType:
{
Description: The Guest OS type ,
Enum:
{
linux: No description available. ,
windows: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
nics:
{
Description: The list of Virtual NICs ,
Required: False ,
}
[
{
customization:
{
Description: guest OS customization for nic ,
Required: False ,
}
{
allocation:
{
Description: IP address allocation method ,
Enum:
{
static: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: Gateway addresses assigned to nic ,
Required: False ,
}
[
string ,
]
,
ipAddress:
{
Description: Static ip address for nic ,
Required: False ,
}
string ,
mask:
{
Description: Network mask for nic ,
Required: False ,
}
string ,
primaryWinsServer:
{
Description: primary WINS server for Windows ,
Required: False ,
}
string ,
secondaryWinsServer:
{
Description: secondary WINS server for Windows ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: NIC ip address ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: NIC MAC address ,
Required: False ,
}
string ,
network:
{
Description: Virtual Network ,
Required: True ,
}
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
nicType:
{
Description: NIC type ,
Enum:
{
E1000: No description available. ,
E1000E: No description available. ,
PCNET32: No description available. ,
VMXNET: No description available. ,
VMXNET2: No description available. ,
VMXNET3: No description available. ,
}
,
Required: True ,
}
enum ,
powerOnBoot:
{
Description: Is NIC powered on/off on boot ,
Required: False ,
}
boolean ,
virtualNicId:
{
Description: NIC id ,
Required: False ,
}
string ,
virtualNicName:
{
Description: NIC name ,
Required: False ,
}
string ,
}
,
]
,
numberOfCores:
{
Description: The number of CPU cores ,
Required: True ,
}
integer ,
password:
{
Description: Password for login. Deprecated - use customization property ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
publicIP:
{
Description: The public ip of Virtual Machine ,
Required: False ,
}
string ,
resourcePool:
{
Description: Virtual Machines Resource Pool ,
Required: False ,
}
{
id:
{
Description: resource pool id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {ResourcePoolName} ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: False ,
}
string ,
properties:
{
Description: Resource pool properties ,
Required: False ,
}
{
fullName:
{
Description: Hierarchical resource pool name ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of Virtual machine ,
Enum:
{
running: No description available. ,
suspended: No description available. ,
poweredoff: No description available. ,
updating: No description available. ,
deallocating: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
templateId:
{
Description: Virtual Machine Template Id ,
Required: False ,
}
string ,
username:
{
Description: Username for login. Deprecated - use customization property ,
Required: False ,
}
string ,
vSphereNetworks:
{
Description: The list of Virtual VSphere Networks ,
Required: False ,
}
[
string ,
]
,
vmId:
{
Description: The internal id of Virtual Machine in VCenter ,
Required: False ,
}
string ,
vmwaretools:
{
Description: VMware tools version ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualMachines_CreateOrUpdate (new)
Description :  Create Or Update Virtual Machine
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
Referer:
{
Description: referer url ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtual machine name ,
Required: True ,
}
string ,
virtualMachineRequest:
{
Description: Create or Update Virtual Machine request ,
Required: True ,
}
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {virtualMachineName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual machine properties ,
Required: False ,
}
{
amountOfRam:
{
Description: The amount of memory ,
Required: True ,
}
integer ,
controllers:
{
Description: The list of Virtual Disks' Controllers ,
Required: False ,
}
[
{
id:
{
Description: Controller's id ,
Required: False ,
}
string ,
name:
{
Description: The display name of Controller ,
Required: False ,
}
string ,
subType:
{
Description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) ,
Required: False ,
}
string ,
type:
{
Description: disk controller type (SCSI) ,
Required: False ,
}
string ,
}
,
]
,
customization:
{
Description: Virtual machine properties ,
Required: False ,
}
{
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: Virtual Machine hostname ,
Required: False ,
}
string ,
password:
{
Description: Password for login ,
Required: False ,
}
string ,
policyId:
{
Description: id of customization policy ,
Required: False ,
}
string ,
username:
{
Description: Username for login ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The list of Virtual Disks ,
Required: False ,
}
[
{
controllerId:
{
Description: Disk's Controller id ,
Required: True ,
}
string ,
independenceMode:
{
Description: Disk's independence mode type ,
Enum:
{
persistent: No description available. ,
independent_persistent: No description available. ,
independent_nonpersistent: No description available. ,
}
,
Required: True ,
}
enum ,
totalSize:
{
Description: Disk's total size ,
Required: True ,
}
integer ,
virtualDiskId:
{
Description: Disk's id ,
Required: False ,
}
string ,
virtualDiskName:
{
Description: Disk's display name ,
Required: False ,
}
string ,
}
,
]
,
dnsname:
{
Description: The DNS name of Virtual Machine in VCenter ,
Required: False ,
}
string ,
exposeToGuestVM:
{
Description: Expose Guest OS or not ,
Required: False ,
}
boolean ,
folder:
{
Description: The path to virtual machine folder in VCenter ,
Required: False ,
}
string ,
guestOS:
{
Description: The name of Guest OS ,
Required: False ,
}
string ,
guestOSType:
{
Description: The Guest OS type ,
Enum:
{
linux: No description available. ,
windows: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
nics:
{
Description: The list of Virtual NICs ,
Required: False ,
}
[
{
customization:
{
Description: guest OS customization for nic ,
Required: False ,
}
{
allocation:
{
Description: IP address allocation method ,
Enum:
{
static: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: Gateway addresses assigned to nic ,
Required: False ,
}
[
string ,
]
,
ipAddress:
{
Description: Static ip address for nic ,
Required: False ,
}
string ,
mask:
{
Description: Network mask for nic ,
Required: False ,
}
string ,
primaryWinsServer:
{
Description: primary WINS server for Windows ,
Required: False ,
}
string ,
secondaryWinsServer:
{
Description: secondary WINS server for Windows ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: NIC ip address ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: NIC MAC address ,
Required: False ,
}
string ,
network:
{
Description: Virtual Network ,
Required: True ,
}
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
nicType:
{
Description: NIC type ,
Enum:
{
E1000: No description available. ,
E1000E: No description available. ,
PCNET32: No description available. ,
VMXNET: No description available. ,
VMXNET2: No description available. ,
VMXNET3: No description available. ,
}
,
Required: True ,
}
enum ,
powerOnBoot:
{
Description: Is NIC powered on/off on boot ,
Required: False ,
}
boolean ,
virtualNicId:
{
Description: NIC id ,
Required: False ,
}
string ,
virtualNicName:
{
Description: NIC name ,
Required: False ,
}
string ,
}
,
]
,
numberOfCores:
{
Description: The number of CPU cores ,
Required: True ,
}
integer ,
password:
{
Description: Password for login. Deprecated - use customization property ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
publicIP:
{
Description: The public ip of Virtual Machine ,
Required: False ,
}
string ,
resourcePool:
{
Description: Virtual Machines Resource Pool ,
Required: False ,
}
{
id:
{
Description: resource pool id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {ResourcePoolName} ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: False ,
}
string ,
properties:
{
Description: Resource pool properties ,
Required: False ,
}
{
fullName:
{
Description: Hierarchical resource pool name ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of Virtual machine ,
Enum:
{
running: No description available. ,
suspended: No description available. ,
poweredoff: No description available. ,
updating: No description available. ,
deallocating: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
templateId:
{
Description: Virtual Machine Template Id ,
Required: False ,
}
string ,
username:
{
Description: Username for login. Deprecated - use customization property ,
Required: False ,
}
string ,
vSphereNetworks:
{
Description: The list of Virtual VSphere Networks ,
Required: False ,
}
[
string ,
]
,
vmId:
{
Description: The internal id of Virtual Machine in VCenter ,
Required: False ,
}
string ,
vmwaretools:
{
Description: VMware tools version ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
Description: Virtual machine model ,
}
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {virtualMachineName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual machine properties ,
Required: False ,
}
{
amountOfRam:
{
Description: The amount of memory ,
Required: True ,
}
integer ,
controllers:
{
Description: The list of Virtual Disks' Controllers ,
Required: False ,
}
[
{
id:
{
Description: Controller's id ,
Required: False ,
}
string ,
name:
{
Description: The display name of Controller ,
Required: False ,
}
string ,
subType:
{
Description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) ,
Required: False ,
}
string ,
type:
{
Description: disk controller type (SCSI) ,
Required: False ,
}
string ,
}
,
]
,
customization:
{
Description: Virtual machine properties ,
Required: False ,
}
{
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: Virtual Machine hostname ,
Required: False ,
}
string ,
password:
{
Description: Password for login ,
Required: False ,
}
string ,
policyId:
{
Description: id of customization policy ,
Required: False ,
}
string ,
username:
{
Description: Username for login ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The list of Virtual Disks ,
Required: False ,
}
[
{
controllerId:
{
Description: Disk's Controller id ,
Required: True ,
}
string ,
independenceMode:
{
Description: Disk's independence mode type ,
Enum:
{
persistent: No description available. ,
independent_persistent: No description available. ,
independent_nonpersistent: No description available. ,
}
,
Required: True ,
}
enum ,
totalSize:
{
Description: Disk's total size ,
Required: True ,
}
integer ,
virtualDiskId:
{
Description: Disk's id ,
Required: False ,
}
string ,
virtualDiskName:
{
Description: Disk's display name ,
Required: False ,
}
string ,
}
,
]
,
dnsname:
{
Description: The DNS name of Virtual Machine in VCenter ,
Required: False ,
}
string ,
exposeToGuestVM:
{
Description: Expose Guest OS or not ,
Required: False ,
}
boolean ,
folder:
{
Description: The path to virtual machine folder in VCenter ,
Required: False ,
}
string ,
guestOS:
{
Description: The name of Guest OS ,
Required: False ,
}
string ,
guestOSType:
{
Description: The Guest OS type ,
Enum:
{
linux: No description available. ,
windows: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
nics:
{
Description: The list of Virtual NICs ,
Required: False ,
}
[
{
customization:
{
Description: guest OS customization for nic ,
Required: False ,
}
{
allocation:
{
Description: IP address allocation method ,
Enum:
{
static: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: Gateway addresses assigned to nic ,
Required: False ,
}
[
string ,
]
,
ipAddress:
{
Description: Static ip address for nic ,
Required: False ,
}
string ,
mask:
{
Description: Network mask for nic ,
Required: False ,
}
string ,
primaryWinsServer:
{
Description: primary WINS server for Windows ,
Required: False ,
}
string ,
secondaryWinsServer:
{
Description: secondary WINS server for Windows ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: NIC ip address ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: NIC MAC address ,
Required: False ,
}
string ,
network:
{
Description: Virtual Network ,
Required: True ,
}
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
nicType:
{
Description: NIC type ,
Enum:
{
E1000: No description available. ,
E1000E: No description available. ,
PCNET32: No description available. ,
VMXNET: No description available. ,
VMXNET2: No description available. ,
VMXNET3: No description available. ,
}
,
Required: True ,
}
enum ,
powerOnBoot:
{
Description: Is NIC powered on/off on boot ,
Required: False ,
}
boolean ,
virtualNicId:
{
Description: NIC id ,
Required: False ,
}
string ,
virtualNicName:
{
Description: NIC name ,
Required: False ,
}
string ,
}
,
]
,
numberOfCores:
{
Description: The number of CPU cores ,
Required: True ,
}
integer ,
password:
{
Description: Password for login. Deprecated - use customization property ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
publicIP:
{
Description: The public ip of Virtual Machine ,
Required: False ,
}
string ,
resourcePool:
{
Description: Virtual Machines Resource Pool ,
Required: False ,
}
{
id:
{
Description: resource pool id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {ResourcePoolName} ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: False ,
}
string ,
properties:
{
Description: Resource pool properties ,
Required: False ,
}
{
fullName:
{
Description: Hierarchical resource pool name ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of Virtual machine ,
Enum:
{
running: No description available. ,
suspended: No description available. ,
poweredoff: No description available. ,
updating: No description available. ,
deallocating: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
templateId:
{
Description: Virtual Machine Template Id ,
Required: False ,
}
string ,
username:
{
Description: Username for login. Deprecated - use customization property ,
Required: False ,
}
string ,
vSphereNetworks:
{
Description: The list of Virtual VSphere Networks ,
Required: False ,
}
[
string ,
]
,
vmId:
{
Description: The internal id of Virtual Machine in VCenter ,
Required: False ,
}
string ,
vmwaretools:
{
Description: VMware tools version ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
Description: Virtual machine model ,
}
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {virtualMachineName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual machine properties ,
Required: False ,
}
{
amountOfRam:
{
Description: The amount of memory ,
Required: True ,
}
integer ,
controllers:
{
Description: The list of Virtual Disks' Controllers ,
Required: False ,
}
[
{
id:
{
Description: Controller's id ,
Required: False ,
}
string ,
name:
{
Description: The display name of Controller ,
Required: False ,
}
string ,
subType:
{
Description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) ,
Required: False ,
}
string ,
type:
{
Description: disk controller type (SCSI) ,
Required: False ,
}
string ,
}
,
]
,
customization:
{
Description: Virtual machine properties ,
Required: False ,
}
{
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: Virtual Machine hostname ,
Required: False ,
}
string ,
password:
{
Description: Password for login ,
Required: False ,
}
string ,
policyId:
{
Description: id of customization policy ,
Required: False ,
}
string ,
username:
{
Description: Username for login ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The list of Virtual Disks ,
Required: False ,
}
[
{
controllerId:
{
Description: Disk's Controller id ,
Required: True ,
}
string ,
independenceMode:
{
Description: Disk's independence mode type ,
Enum:
{
persistent: No description available. ,
independent_persistent: No description available. ,
independent_nonpersistent: No description available. ,
}
,
Required: True ,
}
enum ,
totalSize:
{
Description: Disk's total size ,
Required: True ,
}
integer ,
virtualDiskId:
{
Description: Disk's id ,
Required: False ,
}
string ,
virtualDiskName:
{
Description: Disk's display name ,
Required: False ,
}
string ,
}
,
]
,
dnsname:
{
Description: The DNS name of Virtual Machine in VCenter ,
Required: False ,
}
string ,
exposeToGuestVM:
{
Description: Expose Guest OS or not ,
Required: False ,
}
boolean ,
folder:
{
Description: The path to virtual machine folder in VCenter ,
Required: False ,
}
string ,
guestOS:
{
Description: The name of Guest OS ,
Required: False ,
}
string ,
guestOSType:
{
Description: The Guest OS type ,
Enum:
{
linux: No description available. ,
windows: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
nics:
{
Description: The list of Virtual NICs ,
Required: False ,
}
[
{
customization:
{
Description: guest OS customization for nic ,
Required: False ,
}
{
allocation:
{
Description: IP address allocation method ,
Enum:
{
static: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: Gateway addresses assigned to nic ,
Required: False ,
}
[
string ,
]
,
ipAddress:
{
Description: Static ip address for nic ,
Required: False ,
}
string ,
mask:
{
Description: Network mask for nic ,
Required: False ,
}
string ,
primaryWinsServer:
{
Description: primary WINS server for Windows ,
Required: False ,
}
string ,
secondaryWinsServer:
{
Description: secondary WINS server for Windows ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: NIC ip address ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: NIC MAC address ,
Required: False ,
}
string ,
network:
{
Description: Virtual Network ,
Required: True ,
}
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
nicType:
{
Description: NIC type ,
Enum:
{
E1000: No description available. ,
E1000E: No description available. ,
PCNET32: No description available. ,
VMXNET: No description available. ,
VMXNET2: No description available. ,
VMXNET3: No description available. ,
}
,
Required: True ,
}
enum ,
powerOnBoot:
{
Description: Is NIC powered on/off on boot ,
Required: False ,
}
boolean ,
virtualNicId:
{
Description: NIC id ,
Required: False ,
}
string ,
virtualNicName:
{
Description: NIC name ,
Required: False ,
}
string ,
}
,
]
,
numberOfCores:
{
Description: The number of CPU cores ,
Required: True ,
}
integer ,
password:
{
Description: Password for login. Deprecated - use customization property ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
publicIP:
{
Description: The public ip of Virtual Machine ,
Required: False ,
}
string ,
resourcePool:
{
Description: Virtual Machines Resource Pool ,
Required: False ,
}
{
id:
{
Description: resource pool id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {ResourcePoolName} ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: False ,
}
string ,
properties:
{
Description: Resource pool properties ,
Required: False ,
}
{
fullName:
{
Description: Hierarchical resource pool name ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of Virtual machine ,
Enum:
{
running: No description available. ,
suspended: No description available. ,
poweredoff: No description available. ,
updating: No description available. ,
deallocating: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
templateId:
{
Description: Virtual Machine Template Id ,
Required: False ,
}
string ,
username:
{
Description: Username for login. Deprecated - use customization property ,
Required: False ,
}
string ,
vSphereNetworks:
{
Description: The list of Virtual VSphere Networks ,
Required: False ,
}
[
string ,
]
,
vmId:
{
Description: The internal id of Virtual Machine in VCenter ,
Required: False ,
}
string ,
vmwaretools:
{
Description: VMware tools version ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualMachines_Delete (new)
Description :  Delete virtual machine
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
Referer:
{
Description: referer url ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtual machine name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
content-type: string ,
}
,
$schema:
{
Description: General error model ,
}
{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
,
}
VirtualMachines_Update (new)
Description :  Patch virtual machine properties
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtual machine name ,
Required: True ,
}
string ,
virtualMachineRequest:
{
Description: Patch virtual machine request ,
Required: True ,
}
{
tags:
{
Description: The tags key:value pairs ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {virtualMachineName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual machine properties ,
Required: False ,
}
{
amountOfRam:
{
Description: The amount of memory ,
Required: True ,
}
integer ,
controllers:
{
Description: The list of Virtual Disks' Controllers ,
Required: False ,
}
[
{
id:
{
Description: Controller's id ,
Required: False ,
}
string ,
name:
{
Description: The display name of Controller ,
Required: False ,
}
string ,
subType:
{
Description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) ,
Required: False ,
}
string ,
type:
{
Description: disk controller type (SCSI) ,
Required: False ,
}
string ,
}
,
]
,
customization:
{
Description: Virtual machine properties ,
Required: False ,
}
{
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: Virtual Machine hostname ,
Required: False ,
}
string ,
password:
{
Description: Password for login ,
Required: False ,
}
string ,
policyId:
{
Description: id of customization policy ,
Required: False ,
}
string ,
username:
{
Description: Username for login ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The list of Virtual Disks ,
Required: False ,
}
[
{
controllerId:
{
Description: Disk's Controller id ,
Required: True ,
}
string ,
independenceMode:
{
Description: Disk's independence mode type ,
Enum:
{
persistent: No description available. ,
independent_persistent: No description available. ,
independent_nonpersistent: No description available. ,
}
,
Required: True ,
}
enum ,
totalSize:
{
Description: Disk's total size ,
Required: True ,
}
integer ,
virtualDiskId:
{
Description: Disk's id ,
Required: False ,
}
string ,
virtualDiskName:
{
Description: Disk's display name ,
Required: False ,
}
string ,
}
,
]
,
dnsname:
{
Description: The DNS name of Virtual Machine in VCenter ,
Required: False ,
}
string ,
exposeToGuestVM:
{
Description: Expose Guest OS or not ,
Required: False ,
}
boolean ,
folder:
{
Description: The path to virtual machine folder in VCenter ,
Required: False ,
}
string ,
guestOS:
{
Description: The name of Guest OS ,
Required: False ,
}
string ,
guestOSType:
{
Description: The Guest OS type ,
Enum:
{
linux: No description available. ,
windows: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
nics:
{
Description: The list of Virtual NICs ,
Required: False ,
}
[
{
customization:
{
Description: guest OS customization for nic ,
Required: False ,
}
{
allocation:
{
Description: IP address allocation method ,
Enum:
{
static: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: Gateway addresses assigned to nic ,
Required: False ,
}
[
string ,
]
,
ipAddress:
{
Description: Static ip address for nic ,
Required: False ,
}
string ,
mask:
{
Description: Network mask for nic ,
Required: False ,
}
string ,
primaryWinsServer:
{
Description: primary WINS server for Windows ,
Required: False ,
}
string ,
secondaryWinsServer:
{
Description: secondary WINS server for Windows ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: NIC ip address ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: NIC MAC address ,
Required: False ,
}
string ,
network:
{
Description: Virtual Network ,
Required: True ,
}
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
nicType:
{
Description: NIC type ,
Enum:
{
E1000: No description available. ,
E1000E: No description available. ,
PCNET32: No description available. ,
VMXNET: No description available. ,
VMXNET2: No description available. ,
VMXNET3: No description available. ,
}
,
Required: True ,
}
enum ,
powerOnBoot:
{
Description: Is NIC powered on/off on boot ,
Required: False ,
}
boolean ,
virtualNicId:
{
Description: NIC id ,
Required: False ,
}
string ,
virtualNicName:
{
Description: NIC name ,
Required: False ,
}
string ,
}
,
]
,
numberOfCores:
{
Description: The number of CPU cores ,
Required: True ,
}
integer ,
password:
{
Description: Password for login. Deprecated - use customization property ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
publicIP:
{
Description: The public ip of Virtual Machine ,
Required: False ,
}
string ,
resourcePool:
{
Description: Virtual Machines Resource Pool ,
Required: False ,
}
{
id:
{
Description: resource pool id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {ResourcePoolName} ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: False ,
}
string ,
properties:
{
Description: Resource pool properties ,
Required: False ,
}
{
fullName:
{
Description: Hierarchical resource pool name ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of Virtual machine ,
Enum:
{
running: No description available. ,
suspended: No description available. ,
poweredoff: No description available. ,
updating: No description available. ,
deallocating: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
templateId:
{
Description: Virtual Machine Template Id ,
Required: False ,
}
string ,
username:
{
Description: Username for login. Deprecated - use customization property ,
Required: False ,
}
string ,
vSphereNetworks:
{
Description: The list of Virtual VSphere Networks ,
Required: False ,
}
[
string ,
]
,
vmId:
{
Description: The internal id of Virtual Machine in VCenter ,
Required: False ,
}
string ,
vmwaretools:
{
Description: VMware tools version ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualMachines_Start (new)
Description :  Power on virtual machine
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}/start
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
Referer:
{
Description: referer url ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtual machine name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
$headers:
{
content-type: string ,
}
,
$schema:
{
Description: General error model ,
}
{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
,
}
VirtualMachines_Stop (new)
Description :  Power off virtual machine, options: shutdown, poweroff, and suspend
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}/stop
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
Referer:
{
Description: referer url ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtual machine name ,
Required: True ,
}
string ,
m:
{
Description: body stop mode parameter (reboot, shutdown, etc...) ,
Required: False ,
}
{
mode:
{
Description: mode indicates a type of stop operation - reboot, suspend, shutdown or power-off ,
Enum:
{
reboot: No description available. ,
suspend: No description available. ,
shutdown: No description available. ,
poweroff: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
mode:
{
Description: query stop mode parameter (reboot, shutdown, etc...) ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
$headers:
{
content-type: string ,
}
,
$schema:
{
Description: General error model ,
}
{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
,
}
Operations_List (removed)
Description :  Return list of operations
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.VMwareCloudSimple/operations
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of available operations ,
Required: False ,
}
string ,
value:
{
Description: Returns a list of available operations ,
Required: False ,
}
[
{
display:
{
Description: The list of operations ,
Required: False ,
}
{
description:
{
Description: Description of the operation for display purposes ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation for display purposes ,
Required: False ,
}
string ,
provider:
{
Description: Name of the provider for display purposes ,
Required: False ,
}
string ,
resource:
{
Description: Name of the resource type for display purposes ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: Indicating whether the operation is a data action or not ,
Required: False ,
}
boolean ,
name:
{
Description: {resourceProviderNamespace}/{resourceType}/{read|write|delete|action} ,
Required: False ,
}
string ,
origin:
{
Description: The origin of operation ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The list of operation properties ,
Required: False ,
}
{
serviceSpecification:
{
Description: The list of specification's service metrics ,
Required: False ,
}
{
metricSpecifications:
{
Description: Metric specifications of operation ,
Required: False ,
}
[
{
aggregationType:
{
Description: Metric's aggregation type for e.g. (Average, Total) ,
Enum:
{
Average: No description available. ,
Total: No description available. ,
}
,
Required: True ,
}
enum ,
displayDescription:
{
Description: Metric's description ,
Required: True ,
}
string ,
displayName:
{
Description: Human readable metric's name ,
Required: True ,
}
string ,
name:
{
Description: Metric's name/id ,
Required: True ,
}
string ,
unit:
{
Description: Metric's unit ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudNodes_ListBySubscription (removed)
Description :  Returns list of dedicate cloud nodes within subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudNodes
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of record sets to return ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: to be used by nextLink implementation ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of DedicatedCloudNode ,
Required: False ,
}
string ,
value:
{
Description: Results of the DedicatedCloudNode list ,
Required: False ,
}
[
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudNodeName} ,
Required: False ,
}
string ,
properties:
{
Description: Dedicated Cloud Nodes properties ,
Required: False ,
}
{
availabilityZoneId:
{
Description: Availability Zone id, e.g. "az1" ,
Required: True ,
}
string ,
availabilityZoneName:
{
Description: Availability Zone name, e.g. "Availability Zone 1" ,
Required: False ,
}
string ,
cloudRackName:
{
Description: VMWare Cloud Rack Name ,
Required: False ,
}
string ,
created:
{
Description: date time the resource was created ,
Format: date-time ,
Required: False ,
}
string ,
nodesCount:
{
Description: count of nodes to create ,
Required: True ,
}
integer ,
placementGroupId:
{
Description: Placement Group id, e.g. "n1" ,
Required: True ,
}
string ,
placementGroupName:
{
Description: Placement Name, e.g. "Placement Group 1" ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: False ,
}
string ,
privateCloudName:
{
Description: Resource Pool Name ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
purchaseId:
{
Description: purchase id ,
Format: uuid ,
Required: True ,
}
string ,
skuDescription:
{
Description: Dedicated Cloud Nodes SKU's description ,
Required: False ,
}
{
id:
{
Description: SKU's id ,
Required: True ,
}
string ,
name:
{
Description: SKU's name ,
Required: True ,
}
string ,
}
,
status:
{
Description: Node status, indicates is private cloud set up on this node or not ,
Enum:
{
unused: No description available. ,
used: No description available. ,
}
,
Required: False ,
}
enum ,
vmwareClusterName:
{
Description: VMWare Cluster Name ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Dedicated Cloud Nodes SKU ,
Required: False ,
}
{
capacity:
{
Description: The capacity of the SKU ,
Required: False ,
}
string ,
description:
{
Description: dedicatedCloudNode example: 8 x Ten-Core Intel® Xeon® Processor E5-2640 v4 2.40GHz 25MB Cache (90W); 12 x 64GB PC4-19200 2400MHz DDR4 ECC Registered DIMM, ... ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU for VMWare CloudSimple Node ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the SKU ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Dedicated Cloud Nodes tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudServices_ListBySubscription (removed)
Description :  Returns list of dedicated cloud services within a subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudServices
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of record sets to return ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: to be used by nextLink implementation ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of DedicatedCloudNode ,
Required: False ,
}
string ,
value:
{
Description: Results of the DedicatedCloudService list ,
Required: False ,
}
[
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudServices/{dedicatedCloudServiceName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudServiceName} ,
Required: False ,
}
string ,
properties:
{
Description: The properties of Dedicated Node Service ,
Required: False ,
}
{
gatewaySubnet:
{
Description: gateway Subnet for the account. It will collect the subnet address and always treat it as /28 ,
Required: True ,
}
string ,
isAccountOnboarded:
{
Description: indicates whether account onboarded or not in a given region ,
Enum:
{
notOnBoarded: No description available. ,
onBoarded: No description available. ,
onBoardingFailed: No description available. ,
onBoarding: No description available. ,
}
,
Required: False ,
}
enum ,
nodes:
{
Description: total nodes purchased ,
Required: False ,
}
integer ,
serviceURL:
{
Description: link to a service management web portal ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
SkusAvailability_List (removed)
Description :  Returns list of available resources in region
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/availabilities
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
skuId:
{
Description: sku id, if no sku is passed availability for all skus will be returned ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of DedicatedCloudNode ,
Required: False ,
}
string ,
value:
{
Description: Results of the DedicatedPlacementGroupSkuAvailability list ,
Required: False ,
}
[
{
dedicatedAvailabilityZoneId:
{
Description: CloudSimple Availability Zone id ,
Required: False ,
}
string ,
dedicatedAvailabilityZoneName:
{
Description: CloudSimple Availability Zone Name ,
Required: False ,
}
string ,
dedicatedPlacementGroupId:
{
Description: CloudSimple Placement Group Id ,
Required: False ,
}
string ,
dedicatedPlacementGroupName:
{
Description: CloudSimple Placement Group name ,
Required: False ,
}
string ,
limit:
{
Description: indicates how many resources of a given SKU is available in a AZ->PG ,
Required: True ,
}
integer ,
resourceType:
{
Description: resource type e.g. DedicatedCloudNodes ,
Required: False ,
}
string ,
skuId:
{
Description: sku id ,
Required: False ,
}
string ,
skuName:
{
Description: sku name ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
Operations_Get (removed)
Description :  Return an async operation
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/operationResults/{operationId}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
Referer:
{
Description: referer url ,
Required: True ,
}
string ,
operationId:
{
Description: operation id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
endTime:
{
Description: End time of the operation ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error Message if operation failed ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
}
,
id:
{
Description: Operation Id ,
Required: False ,
}
string ,
name:
{
Description: Operation ID ,
Required: False ,
}
string ,
startTime:
{
Description: Start time of the operation ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Operation status ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
content-type: string ,
}
,
$schema:
{
Description: General error model ,
}
{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
,
}
PrivateClouds_List (removed)
Description :  Returns list of private clouds in particular region
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
PrivateClouds_Get (removed)
Description :  Returns private cloud by its name
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
pcName:
{
Description: The private cloud name ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
customizationPolicies_List (removed)
Description :  Returns list of customization policies in region for private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/customizationPolicies
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
pcName:
{
Description: The private cloud name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation. only type is allowed here as a filter e.g. $filter=type eq 'xxxx' ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of the Customization policy ,
Required: False ,
}
string ,
value:
{
Description: List of the customization policies ,
Required: False ,
}
[
{
id:
{
Description: Customization policy azure id ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: Customization policy name ,
Required: False ,
}
string ,
properties:
{
Description: Customization Policy properties ,
Required: False ,
}
{
description:
{
Description: Policy description ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private cloud id ,
Required: False ,
}
string ,
specification:
{
Description: Detailed customization policy specification ,
Required: False ,
}
{
identity:
{
Description: Customization Identity. It contains data about user and hostname ,
Required: False ,
}
{
data:
{
Description: Windows Text Identity. Prepared data ,
Required: False ,
}
string ,
hostName:
{
Description: Virtual machine host name settings ,
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
type:
{
Description: Type of host name ,
Enum:
{
USER_DEFINED: No description available. ,
PREFIX_BASED: No description available. ,
FIXED: No description available. ,
VIRTUAL_MACHINE_NAME: No description available. ,
CUSTOM_NAME: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
type:
{
Description: Identity type ,
Enum:
{
WINDOWS_TEXT: No description available. ,
WINDOWS: No description available. ,
LINUX: No description available. ,
}
,
Required: False ,
}
enum ,
userData:
{
Description: Windows Identity. User data customization ,
Required: False ,
}
{
isPasswordPredefined:
{
Description: Is password predefined in customization policy ,
Required: False ,
}
boolean ,
}
,
}
,
nicSettings:
{
Description: Network interface settings ,
Required: False ,
}
[
{
adapter:
{
Description: The list of adapters' settings ,
Required: False ,
}
{
gateway:
{
Description: The list of gateways ,
Required: False ,
}
[
string ,
]
,
ip:
{
Description: Ip address customization settings ,
Required: False ,
}
{
argument:
{
Description: Argument when Custom ip type is selected ,
Required: False ,
}
string ,
ipAddress:
{
Description: Defined Ip Address when Fixed ip type is selected ,
Required: False ,
}
string ,
type:
{
Description: Customization Specification ip type ,
Enum:
{
CUSTOM: No description available. ,
DHCP_IP: No description available. ,
FIXED_IP: No description available. ,
USER_DEFINED: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnetMask:
{
Description: Adapter subnet mask ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: NIC mac address ,
Required: False ,
}
string ,
}
,
]
,
}
,
type:
{
Description: The type of customization (Linux or Windows) ,
Enum:
{
LINUX: No description available. ,
WINDOWS: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Policy version ,
Required: False ,
}
string ,
}
,
type:
{
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
customizationPolicies_Get (removed)
Description :  Returns customization policy by its name
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/customizationPolicies/{customizationPolicyName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
pcName:
{
Description: The private cloud name ,
Required: True ,
}
string ,
customizationPolicyName:
{
Description: customization policy name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Customization policy azure id ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: Customization policy name ,
Required: False ,
}
string ,
properties:
{
Description: Customization Policy properties ,
Required: False ,
}
{
description:
{
Description: Policy description ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private cloud id ,
Required: False ,
}
string ,
specification:
{
Description: Detailed customization policy specification ,
Required: False ,
}
{
identity:
{
Description: Customization Identity. It contains data about user and hostname ,
Required: False ,
}
{
data:
{
Description: Windows Text Identity. Prepared data ,
Required: False ,
}
string ,
hostName:
{
Description: Virtual machine host name settings ,
Required: False ,
}
{
name:
{
Description: Hostname ,
Required: False ,
}
string ,
type:
{
Description: Type of host name ,
Enum:
{
USER_DEFINED: No description available. ,
PREFIX_BASED: No description available. ,
FIXED: No description available. ,
VIRTUAL_MACHINE_NAME: No description available. ,
CUSTOM_NAME: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
type:
{
Description: Identity type ,
Enum:
{
WINDOWS_TEXT: No description available. ,
WINDOWS: No description available. ,
LINUX: No description available. ,
}
,
Required: False ,
}
enum ,
userData:
{
Description: Windows Identity. User data customization ,
Required: False ,
}
{
isPasswordPredefined:
{
Description: Is password predefined in customization policy ,
Required: False ,
}
boolean ,
}
,
}
,
nicSettings:
{
Description: Network interface settings ,
Required: False ,
}
[
{
adapter:
{
Description: The list of adapters' settings ,
Required: False ,
}
{
gateway:
{
Description: The list of gateways ,
Required: False ,
}
[
string ,
]
,
ip:
{
Description: Ip address customization settings ,
Required: False ,
}
{
argument:
{
Description: Argument when Custom ip type is selected ,
Required: False ,
}
string ,
ipAddress:
{
Description: Defined Ip Address when Fixed ip type is selected ,
Required: False ,
}
string ,
type:
{
Description: Customization Specification ip type ,
Enum:
{
CUSTOM: No description available. ,
DHCP_IP: No description available. ,
FIXED_IP: No description available. ,
USER_DEFINED: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnetMask:
{
Description: Adapter subnet mask ,
Required: False ,
}
string ,
}
,
macAddress:
{
Description: NIC mac address ,
Required: False ,
}
string ,
}
,
]
,
}
,
type:
{
Description: The type of customization (Linux or Windows) ,
Enum:
{
LINUX: No description available. ,
WINDOWS: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Policy version ,
Required: False ,
}
string ,
}
,
type:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
ResourcePools_List (removed)
Description :  Returns list of resource pools in region for private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/resourcePools
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
pcName:
{
Description: The private cloud name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of ResourcePoolsList ,
Required: False ,
}
string ,
value:
{
Description: Results of the Resource pools list ,
Required: False ,
}
[
{
id:
{
Description: resource pool id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {ResourcePoolName} ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: False ,
}
string ,
properties:
{
Description: Resource pool properties ,
Required: False ,
}
{
fullName:
{
Description: Hierarchical resource pool name ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
ResourcePools_Get (removed)
Description :  Returns resource pool templates by its name
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/resourcePools/{resourcePoolName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
pcName:
{
Description: The private cloud name ,
Required: True ,
}
string ,
resourcePoolName:
{
Description: resource pool id (vsphereId) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: resource pool id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {ResourcePoolName} ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: False ,
}
string ,
properties:
{
Description: Resource pool properties ,
Required: False ,
}
{
fullName:
{
Description: Hierarchical resource pool name ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualMachineTemplates_List (removed)
Description :  Returns list of virtual machine templates in region for private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/virtualMachineTemplates
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
pcName:
{
Description: The private cloud name ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
resourcePoolName:
{
Description: Resource pool used to derive vSphere cluster which contains VM templates ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of VirtualMachineTemplate ,
Required: False ,
}
string ,
value:
{
Description: Results of the VM template list ,
Required: False ,
}
[
{
id:
{
Description: virtual machine template id (privateCloudId:vsphereId) ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {virtualMachineTemplateName} ,
Required: False ,
}
string ,
properties:
{
Description: The Virtual Machine Template properties ,
Required: False ,
}
{
amountOfRam:
{
Description: The amount of memory ,
Required: False ,
}
integer ,
controllers:
{
Description: The list of Virtual Disk Controllers ,
Required: False ,
}
[
{
id:
{
Description: Controller's id ,
Required: False ,
}
string ,
name:
{
Description: The display name of Controller ,
Required: False ,
}
string ,
subType:
{
Description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) ,
Required: False ,
}
string ,
type:
{
Description: disk controller type (SCSI) ,
Required: False ,
}
string ,
}
,
]
,
description:
{
Description: The description of Virtual Machine Template ,
Required: False ,
}
string ,
disks:
{
Description: The list of Virtual Disks ,
Required: False ,
}
[
{
controllerId:
{
Description: Disk's Controller id ,
Required: True ,
}
string ,
independenceMode:
{
Description: Disk's independence mode type ,
Enum:
{
persistent: No description available. ,
independent_persistent: No description available. ,
independent_nonpersistent: No description available. ,
}
,
Required: True ,
}
enum ,
totalSize:
{
Description: Disk's total size ,
Required: True ,
}
integer ,
virtualDiskId:
{
Description: Disk's id ,
Required: False ,
}
string ,
virtualDiskName:
{
Description: Disk's display name ,
Required: False ,
}
string ,
}
,
]
,
exposeToGuestVM:
{
Description: Expose Guest OS or not ,
Required: False ,
}
boolean ,
guestOS:
{
Description: The Guest OS ,
Required: False ,
}
string ,
guestOSType:
{
Description: The Guest OS types ,
Required: False ,
}
string ,
nics:
{
Description: The list of Virtual NICs ,
Required: False ,
}
[
{
customization:
{
Description: guest OS customization for nic ,
Required: False ,
}
{
allocation:
{
Description: IP address allocation method ,
Enum:
{
static: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: Gateway addresses assigned to nic ,
Required: False ,
}
[
string ,
]
,
ipAddress:
{
Description: Static ip address for nic ,
Required: False ,
}
string ,
mask:
{
Description: Network mask for nic ,
Required: False ,
}
string ,
primaryWinsServer:
{
Description: primary WINS server for Windows ,
Required: False ,
}
string ,
secondaryWinsServer:
{
Description: secondary WINS server for Windows ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: NIC ip address ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: NIC MAC address ,
Required: False ,
}
string ,
network:
{
Description: Virtual Network ,
Required: True ,
}
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
nicType:
{
Description: NIC type ,
Enum:
{
E1000: No description available. ,
E1000E: No description available. ,
PCNET32: No description available. ,
VMXNET: No description available. ,
VMXNET2: No description available. ,
VMXNET3: No description available. ,
}
,
Required: True ,
}
enum ,
powerOnBoot:
{
Description: Is NIC powered on/off on boot ,
Required: False ,
}
boolean ,
virtualNicId:
{
Description: NIC id ,
Required: False ,
}
string ,
virtualNicName:
{
Description: NIC name ,
Required: False ,
}
string ,
}
,
]
,
numberOfCores:
{
Description: The number of CPU cores ,
Required: False ,
}
integer ,
path:
{
Description: path to folder ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: True ,
}
string ,
vSphereNetworks:
{
Description: The list of VSphere networks ,
Required: False ,
}
[
string ,
]
,
vSphereTags:
{
Description: The tags from VSphere ,
Required: False ,
}
[
string ,
]
,
vmwaretools:
{
Description: The VMware tools version ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualMachineTemplates_Get (removed)
Description :  Returns virtual machine templates by its name
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/virtualMachineTemplates/{virtualMachineTemplateName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
pcName:
{
Description: The private cloud name ,
Required: True ,
}
string ,
virtualMachineTemplateName:
{
Description: virtual machine template id (vsphereId) ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: virtual machine template id (privateCloudId:vsphereId) ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {virtualMachineTemplateName} ,
Required: False ,
}
string ,
properties:
{
Description: The Virtual Machine Template properties ,
Required: False ,
}
{
amountOfRam:
{
Description: The amount of memory ,
Required: False ,
}
integer ,
controllers:
{
Description: The list of Virtual Disk Controllers ,
Required: False ,
}
[
{
id:
{
Description: Controller's id ,
Required: False ,
}
string ,
name:
{
Description: The display name of Controller ,
Required: False ,
}
string ,
subType:
{
Description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) ,
Required: False ,
}
string ,
type:
{
Description: disk controller type (SCSI) ,
Required: False ,
}
string ,
}
,
]
,
description:
{
Description: The description of Virtual Machine Template ,
Required: False ,
}
string ,
disks:
{
Description: The list of Virtual Disks ,
Required: False ,
}
[
{
controllerId:
{
Description: Disk's Controller id ,
Required: True ,
}
string ,
independenceMode:
{
Description: Disk's independence mode type ,
Enum:
{
persistent: No description available. ,
independent_persistent: No description available. ,
independent_nonpersistent: No description available. ,
}
,
Required: True ,
}
enum ,
totalSize:
{
Description: Disk's total size ,
Required: True ,
}
integer ,
virtualDiskId:
{
Description: Disk's id ,
Required: False ,
}
string ,
virtualDiskName:
{
Description: Disk's display name ,
Required: False ,
}
string ,
}
,
]
,
exposeToGuestVM:
{
Description: Expose Guest OS or not ,
Required: False ,
}
boolean ,
guestOS:
{
Description: The Guest OS ,
Required: False ,
}
string ,
guestOSType:
{
Description: The Guest OS types ,
Required: False ,
}
string ,
nics:
{
Description: The list of Virtual NICs ,
Required: False ,
}
[
{
customization:
{
Description: guest OS customization for nic ,
Required: False ,
}
{
allocation:
{
Description: IP address allocation method ,
Enum:
{
static: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: Gateway addresses assigned to nic ,
Required: False ,
}
[
string ,
]
,
ipAddress:
{
Description: Static ip address for nic ,
Required: False ,
}
string ,
mask:
{
Description: Network mask for nic ,
Required: False ,
}
string ,
primaryWinsServer:
{
Description: primary WINS server for Windows ,
Required: False ,
}
string ,
secondaryWinsServer:
{
Description: secondary WINS server for Windows ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: NIC ip address ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: NIC MAC address ,
Required: False ,
}
string ,
network:
{
Description: Virtual Network ,
Required: True ,
}
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
nicType:
{
Description: NIC type ,
Enum:
{
E1000: No description available. ,
E1000E: No description available. ,
PCNET32: No description available. ,
VMXNET: No description available. ,
VMXNET2: No description available. ,
VMXNET3: No description available. ,
}
,
Required: True ,
}
enum ,
powerOnBoot:
{
Description: Is NIC powered on/off on boot ,
Required: False ,
}
boolean ,
virtualNicId:
{
Description: NIC id ,
Required: False ,
}
string ,
virtualNicName:
{
Description: NIC name ,
Required: False ,
}
string ,
}
,
]
,
numberOfCores:
{
Description: The number of CPU cores ,
Required: False ,
}
integer ,
path:
{
Description: path to folder ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: True ,
}
string ,
vSphereNetworks:
{
Description: The list of VSphere networks ,
Required: False ,
}
[
string ,
]
,
vSphereTags:
{
Description: The tags from VSphere ,
Required: False ,
}
[
string ,
]
,
vmwaretools:
{
Description: The VMware tools version ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualNetworks_List (removed)
Description :  Return list of virtual networks in location for private cloud
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/virtualNetworks
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
pcName:
{
Description: The private cloud name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
resourcePoolName:
{
Description: Resource pool used to derive vSphere cluster which contains virtual networks ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of VirtualNetwork ,
Required: False ,
}
string ,
value:
{
Description: Results of the VirtualNetwork list ,
Required: False ,
}
[
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualNetworks_Get (removed)
Description :  Return virtual network by its name
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/virtualNetworks/{virtualNetworkName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
pcName:
{
Description: The private cloud name ,
Required: True ,
}
string ,
virtualNetworkName:
{
Description: virtual network id (vsphereId) ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
Usages_List (removed)
Description :  Returns list of usage in region
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/usages
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
regionId:
{
Description: The region Id (westus, eastus) ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation. only name.value is allowed here as a filter e.g. $filter=name.value eq 'xxxx' ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of DedicatedCloudNode ,
Required: False ,
}
string ,
value:
{
Description: The list of usages ,
Required: False ,
}
[
{
currentValue:
{
Description: The current usage value ,
Required: True ,
}
integer ,
limit:
{
Description: limit of a given sku in a region for a subscription. The maximum permitted value for the usage quota. If there is no limit, this value will be -1 ,
Required: True ,
}
integer ,
name:
{
Description: Usage name value and localized name ,
Required: False ,
}
{
localizedValue:
{
Description: e.g. "Virtual Machines" ,
Required: False ,
}
string ,
value:
{
Description: resource type or resource type sku name, e.g. virtualMachines ,
Required: False ,
}
string ,
}
,
unit:
{
Description: The usages' unit ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualMachines_ListBySubscription (removed)
Description :  Returns list virtual machine within subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/virtualMachines
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of record sets to return ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: to be used by nextLink implementation ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of VirtualMachines ,
Required: False ,
}
string ,
value:
{
Description: Results of the VirtualMachine list ,
Required: False ,
}
[
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {virtualMachineName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual machine properties ,
Required: False ,
}
{
amountOfRam:
{
Description: The amount of memory ,
Required: True ,
}
integer ,
controllers:
{
Description: The list of Virtual Disks' Controllers ,
Required: False ,
}
[
{
id:
{
Description: Controller's id ,
Required: False ,
}
string ,
name:
{
Description: The display name of Controller ,
Required: False ,
}
string ,
subType:
{
Description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) ,
Required: False ,
}
string ,
type:
{
Description: disk controller type (SCSI) ,
Required: False ,
}
string ,
}
,
]
,
customization:
{
Description: Virtual machine properties ,
Required: False ,
}
{
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: Virtual Machine hostname ,
Required: False ,
}
string ,
password:
{
Description: Password for login ,
Required: False ,
}
string ,
policyId:
{
Description: id of customization policy ,
Required: False ,
}
string ,
username:
{
Description: Username for login ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The list of Virtual Disks ,
Required: False ,
}
[
{
controllerId:
{
Description: Disk's Controller id ,
Required: True ,
}
string ,
independenceMode:
{
Description: Disk's independence mode type ,
Enum:
{
persistent: No description available. ,
independent_persistent: No description available. ,
independent_nonpersistent: No description available. ,
}
,
Required: True ,
}
enum ,
totalSize:
{
Description: Disk's total size ,
Required: True ,
}
integer ,
virtualDiskId:
{
Description: Disk's id ,
Required: False ,
}
string ,
virtualDiskName:
{
Description: Disk's display name ,
Required: False ,
}
string ,
}
,
]
,
dnsname:
{
Description: The DNS name of Virtual Machine in VCenter ,
Required: False ,
}
string ,
exposeToGuestVM:
{
Description: Expose Guest OS or not ,
Required: False ,
}
boolean ,
folder:
{
Description: The path to virtual machine folder in VCenter ,
Required: False ,
}
string ,
guestOS:
{
Description: The name of Guest OS ,
Required: False ,
}
string ,
guestOSType:
{
Description: The Guest OS type ,
Enum:
{
linux: No description available. ,
windows: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
nics:
{
Description: The list of Virtual NICs ,
Required: False ,
}
[
{
customization:
{
Description: guest OS customization for nic ,
Required: False ,
}
{
allocation:
{
Description: IP address allocation method ,
Enum:
{
static: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: Gateway addresses assigned to nic ,
Required: False ,
}
[
string ,
]
,
ipAddress:
{
Description: Static ip address for nic ,
Required: False ,
}
string ,
mask:
{
Description: Network mask for nic ,
Required: False ,
}
string ,
primaryWinsServer:
{
Description: primary WINS server for Windows ,
Required: False ,
}
string ,
secondaryWinsServer:
{
Description: secondary WINS server for Windows ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: NIC ip address ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: NIC MAC address ,
Required: False ,
}
string ,
network:
{
Description: Virtual Network ,
Required: True ,
}
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
nicType:
{
Description: NIC type ,
Enum:
{
E1000: No description available. ,
E1000E: No description available. ,
PCNET32: No description available. ,
VMXNET: No description available. ,
VMXNET2: No description available. ,
VMXNET3: No description available. ,
}
,
Required: True ,
}
enum ,
powerOnBoot:
{
Description: Is NIC powered on/off on boot ,
Required: False ,
}
boolean ,
virtualNicId:
{
Description: NIC id ,
Required: False ,
}
string ,
virtualNicName:
{
Description: NIC name ,
Required: False ,
}
string ,
}
,
]
,
numberOfCores:
{
Description: The number of CPU cores ,
Required: True ,
}
integer ,
password:
{
Description: Password for login. Deprecated - use customization property ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
publicIP:
{
Description: The public ip of Virtual Machine ,
Required: False ,
}
string ,
resourcePool:
{
Description: Virtual Machines Resource Pool ,
Required: False ,
}
{
id:
{
Description: resource pool id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {ResourcePoolName} ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: False ,
}
string ,
properties:
{
Description: Resource pool properties ,
Required: False ,
}
{
fullName:
{
Description: Hierarchical resource pool name ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of Virtual machine ,
Enum:
{
running: No description available. ,
suspended: No description available. ,
poweredoff: No description available. ,
updating: No description available. ,
deallocating: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
templateId:
{
Description: Virtual Machine Template Id ,
Required: False ,
}
string ,
username:
{
Description: Username for login. Deprecated - use customization property ,
Required: False ,
}
string ,
vSphereNetworks:
{
Description: The list of Virtual VSphere Networks ,
Required: False ,
}
[
string ,
]
,
vmId:
{
Description: The internal id of Virtual Machine in VCenter ,
Required: False ,
}
string ,
vmwaretools:
{
Description: VMware tools version ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudNodes_ListByResourceGroup (removed)
Description :  Returns list of dedicate cloud nodes within resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudNodes
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of record sets to return ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: to be used by nextLink implementation ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of DedicatedCloudNode ,
Required: False ,
}
string ,
value:
{
Description: Results of the DedicatedCloudNode list ,
Required: False ,
}
[
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudNodeName} ,
Required: False ,
}
string ,
properties:
{
Description: Dedicated Cloud Nodes properties ,
Required: False ,
}
{
availabilityZoneId:
{
Description: Availability Zone id, e.g. "az1" ,
Required: True ,
}
string ,
availabilityZoneName:
{
Description: Availability Zone name, e.g. "Availability Zone 1" ,
Required: False ,
}
string ,
cloudRackName:
{
Description: VMWare Cloud Rack Name ,
Required: False ,
}
string ,
created:
{
Description: date time the resource was created ,
Format: date-time ,
Required: False ,
}
string ,
nodesCount:
{
Description: count of nodes to create ,
Required: True ,
}
integer ,
placementGroupId:
{
Description: Placement Group id, e.g. "n1" ,
Required: True ,
}
string ,
placementGroupName:
{
Description: Placement Name, e.g. "Placement Group 1" ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: False ,
}
string ,
privateCloudName:
{
Description: Resource Pool Name ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
purchaseId:
{
Description: purchase id ,
Format: uuid ,
Required: True ,
}
string ,
skuDescription:
{
Description: Dedicated Cloud Nodes SKU's description ,
Required: False ,
}
{
id:
{
Description: SKU's id ,
Required: True ,
}
string ,
name:
{
Description: SKU's name ,
Required: True ,
}
string ,
}
,
status:
{
Description: Node status, indicates is private cloud set up on this node or not ,
Enum:
{
unused: No description available. ,
used: No description available. ,
}
,
Required: False ,
}
enum ,
vmwareClusterName:
{
Description: VMWare Cluster Name ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Dedicated Cloud Nodes SKU ,
Required: False ,
}
{
capacity:
{
Description: The capacity of the SKU ,
Required: False ,
}
string ,
description:
{
Description: dedicatedCloudNode example: 8 x Ten-Core Intel® Xeon® Processor E5-2640 v4 2.40GHz 25MB Cache (90W); 12 x 64GB PC4-19200 2400MHz DDR4 ECC Registered DIMM, ... ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU for VMWare CloudSimple Node ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the SKU ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Dedicated Cloud Nodes tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudNodes_Get (removed)
Description :  Returns dedicated cloud node
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudNodes/{dedicatedCloudNodeName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
dedicatedCloudNodeName:
{
Description: dedicated cloud node name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudNodeName} ,
Required: False ,
}
string ,
properties:
{
Description: Dedicated Cloud Nodes properties ,
Required: False ,
}
{
availabilityZoneId:
{
Description: Availability Zone id, e.g. "az1" ,
Required: True ,
}
string ,
availabilityZoneName:
{
Description: Availability Zone name, e.g. "Availability Zone 1" ,
Required: False ,
}
string ,
cloudRackName:
{
Description: VMWare Cloud Rack Name ,
Required: False ,
}
string ,
created:
{
Description: date time the resource was created ,
Format: date-time ,
Required: False ,
}
string ,
nodesCount:
{
Description: count of nodes to create ,
Required: True ,
}
integer ,
placementGroupId:
{
Description: Placement Group id, e.g. "n1" ,
Required: True ,
}
string ,
placementGroupName:
{
Description: Placement Name, e.g. "Placement Group 1" ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: False ,
}
string ,
privateCloudName:
{
Description: Resource Pool Name ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
purchaseId:
{
Description: purchase id ,
Format: uuid ,
Required: True ,
}
string ,
skuDescription:
{
Description: Dedicated Cloud Nodes SKU's description ,
Required: False ,
}
{
id:
{
Description: SKU's id ,
Required: True ,
}
string ,
name:
{
Description: SKU's name ,
Required: True ,
}
string ,
}
,
status:
{
Description: Node status, indicates is private cloud set up on this node or not ,
Enum:
{
unused: No description available. ,
used: No description available. ,
}
,
Required: False ,
}
enum ,
vmwareClusterName:
{
Description: VMWare Cluster Name ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Dedicated Cloud Nodes SKU ,
Required: False ,
}
{
capacity:
{
Description: The capacity of the SKU ,
Required: False ,
}
string ,
description:
{
Description: dedicatedCloudNode example: 8 x Ten-Core Intel® Xeon® Processor E5-2640 v4 2.40GHz 25MB Cache (90W); 12 x 64GB PC4-19200 2400MHz DDR4 ECC Registered DIMM, ... ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU for VMWare CloudSimple Node ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the SKU ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Dedicated Cloud Nodes tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudNodes_CreateOrUpdate (removed)
Description :  Returns dedicated cloud node by its name
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudNodes/{dedicatedCloudNodeName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
Referer:
{
Description: referer url ,
Required: True ,
}
string ,
dedicatedCloudNodeName:
{
Description: dedicated cloud node name ,
Required: True ,
}
string ,
dedicatedCloudNodeRequest:
{
Description: Create Dedicated Cloud Node request ,
Required: True ,
}
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudNodeName} ,
Required: False ,
}
string ,
properties:
{
Description: Dedicated Cloud Nodes properties ,
Required: False ,
}
{
availabilityZoneId:
{
Description: Availability Zone id, e.g. "az1" ,
Required: True ,
}
string ,
availabilityZoneName:
{
Description: Availability Zone name, e.g. "Availability Zone 1" ,
Required: False ,
}
string ,
cloudRackName:
{
Description: VMWare Cloud Rack Name ,
Required: False ,
}
string ,
created:
{
Description: date time the resource was created ,
Format: date-time ,
Required: False ,
}
string ,
nodesCount:
{
Description: count of nodes to create ,
Required: True ,
}
integer ,
placementGroupId:
{
Description: Placement Group id, e.g. "n1" ,
Required: True ,
}
string ,
placementGroupName:
{
Description: Placement Name, e.g. "Placement Group 1" ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: False ,
}
string ,
privateCloudName:
{
Description: Resource Pool Name ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
purchaseId:
{
Description: purchase id ,
Format: uuid ,
Required: True ,
}
string ,
skuDescription:
{
Description: Dedicated Cloud Nodes SKU's description ,
Required: False ,
}
{
id:
{
Description: SKU's id ,
Required: True ,
}
string ,
name:
{
Description: SKU's name ,
Required: True ,
}
string ,
}
,
status:
{
Description: Node status, indicates is private cloud set up on this node or not ,
Enum:
{
unused: No description available. ,
used: No description available. ,
}
,
Required: False ,
}
enum ,
vmwareClusterName:
{
Description: VMWare Cluster Name ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Dedicated Cloud Nodes SKU ,
Required: False ,
}
{
capacity:
{
Description: The capacity of the SKU ,
Required: False ,
}
string ,
description:
{
Description: dedicatedCloudNode example: 8 x Ten-Core Intel® Xeon® Processor E5-2640 v4 2.40GHz 25MB Cache (90W); 12 x 64GB PC4-19200 2400MHz DDR4 ECC Registered DIMM, ... ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU for VMWare CloudSimple Node ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the SKU ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Dedicated Cloud Nodes tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation: string ,
location: string ,
retry-after: integer ,
}
,
$schema:
{
Description: Dedicated cloud node model ,
}
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudNodeName} ,
Required: False ,
}
string ,
properties:
{
Description: Dedicated Cloud Nodes properties ,
Required: False ,
}
{
availabilityZoneId:
{
Description: Availability Zone id, e.g. "az1" ,
Required: True ,
}
string ,
availabilityZoneName:
{
Description: Availability Zone name, e.g. "Availability Zone 1" ,
Required: False ,
}
string ,
cloudRackName:
{
Description: VMWare Cloud Rack Name ,
Required: False ,
}
string ,
created:
{
Description: date time the resource was created ,
Format: date-time ,
Required: False ,
}
string ,
nodesCount:
{
Description: count of nodes to create ,
Required: True ,
}
integer ,
placementGroupId:
{
Description: Placement Group id, e.g. "n1" ,
Required: True ,
}
string ,
placementGroupName:
{
Description: Placement Name, e.g. "Placement Group 1" ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: False ,
}
string ,
privateCloudName:
{
Description: Resource Pool Name ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
purchaseId:
{
Description: purchase id ,
Format: uuid ,
Required: True ,
}
string ,
skuDescription:
{
Description: Dedicated Cloud Nodes SKU's description ,
Required: False ,
}
{
id:
{
Description: SKU's id ,
Required: True ,
}
string ,
name:
{
Description: SKU's name ,
Required: True ,
}
string ,
}
,
status:
{
Description: Node status, indicates is private cloud set up on this node or not ,
Enum:
{
unused: No description available. ,
used: No description available. ,
}
,
Required: False ,
}
enum ,
vmwareClusterName:
{
Description: VMWare Cluster Name ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Dedicated Cloud Nodes SKU ,
Required: False ,
}
{
capacity:
{
Description: The capacity of the SKU ,
Required: False ,
}
string ,
description:
{
Description: dedicatedCloudNode example: 8 x Ten-Core Intel® Xeon® Processor E5-2640 v4 2.40GHz 25MB Cache (90W); 12 x 64GB PC4-19200 2400MHz DDR4 ECC Registered DIMM, ... ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU for VMWare CloudSimple Node ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the SKU ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Dedicated Cloud Nodes tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudNodes_Delete (removed)
Description :  Delete dedicated cloud node
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudNodes/{dedicatedCloudNodeName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
dedicatedCloudNodeName:
{
Description: dedicated cloud node name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
content-type: string ,
}
,
$schema:
{
Description: General error model ,
}
{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
,
}
DedicatedCloudNodes_Update (removed)
Description :  Patches dedicated node properties
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudNodes/{dedicatedCloudNodeName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
dedicatedCloudNodeName:
{
Description: dedicated cloud node name ,
Required: True ,
}
string ,
dedicatedCloudNodeRequest:
{
Description: Patch Dedicated Cloud Node request ,
Required: True ,
}
{
tags:
{
Description: The tags key:value pairs ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudNodeName} ,
Required: False ,
}
string ,
properties:
{
Description: Dedicated Cloud Nodes properties ,
Required: False ,
}
{
availabilityZoneId:
{
Description: Availability Zone id, e.g. "az1" ,
Required: True ,
}
string ,
availabilityZoneName:
{
Description: Availability Zone name, e.g. "Availability Zone 1" ,
Required: False ,
}
string ,
cloudRackName:
{
Description: VMWare Cloud Rack Name ,
Required: False ,
}
string ,
created:
{
Description: date time the resource was created ,
Format: date-time ,
Required: False ,
}
string ,
nodesCount:
{
Description: count of nodes to create ,
Required: True ,
}
integer ,
placementGroupId:
{
Description: Placement Group id, e.g. "n1" ,
Required: True ,
}
string ,
placementGroupName:
{
Description: Placement Name, e.g. "Placement Group 1" ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: False ,
}
string ,
privateCloudName:
{
Description: Resource Pool Name ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
purchaseId:
{
Description: purchase id ,
Format: uuid ,
Required: True ,
}
string ,
skuDescription:
{
Description: Dedicated Cloud Nodes SKU's description ,
Required: False ,
}
{
id:
{
Description: SKU's id ,
Required: True ,
}
string ,
name:
{
Description: SKU's name ,
Required: True ,
}
string ,
}
,
status:
{
Description: Node status, indicates is private cloud set up on this node or not ,
Enum:
{
unused: No description available. ,
used: No description available. ,
}
,
Required: False ,
}
enum ,
vmwareClusterName:
{
Description: VMWare Cluster Name ,
Required: False ,
}
string ,
}
,
sku:
{
Description: Dedicated Cloud Nodes SKU ,
Required: False ,
}
{
capacity:
{
Description: The capacity of the SKU ,
Required: False ,
}
string ,
description:
{
Description: dedicatedCloudNode example: 8 x Ten-Core Intel® Xeon® Processor E5-2640 v4 2.40GHz 25MB Cache (90W); 12 x 64GB PC4-19200 2400MHz DDR4 ECC Registered DIMM, ... ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here ,
Required: False ,
}
string ,
name:
{
Description: The name of the SKU for VMWare CloudSimple Node ,
Required: True ,
}
string ,
tier:
{
Description: The tier of the SKU ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Dedicated Cloud Nodes tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudServices_ListByResourceGroup (removed)
Description :  Returns list of dedicated cloud services within a resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudServices
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of record sets to return ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: to be used by nextLink implementation ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of DedicatedCloudNode ,
Required: False ,
}
string ,
value:
{
Description: Results of the DedicatedCloudService list ,
Required: False ,
}
[
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudServices/{dedicatedCloudServiceName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudServiceName} ,
Required: False ,
}
string ,
properties:
{
Description: The properties of Dedicated Node Service ,
Required: False ,
}
{
gatewaySubnet:
{
Description: gateway Subnet for the account. It will collect the subnet address and always treat it as /28 ,
Required: True ,
}
string ,
isAccountOnboarded:
{
Description: indicates whether account onboarded or not in a given region ,
Enum:
{
notOnBoarded: No description available. ,
onBoarded: No description available. ,
onBoardingFailed: No description available. ,
onBoarding: No description available. ,
}
,
Required: False ,
}
enum ,
nodes:
{
Description: total nodes purchased ,
Required: False ,
}
integer ,
serviceURL:
{
Description: link to a service management web portal ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudServices_Get (removed)
Description :  Returns Dedicate Cloud Service
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudServices/{dedicatedCloudServiceName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
dedicatedCloudServiceName:
{
Description: dedicated cloud Service name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudServices/{dedicatedCloudServiceName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudServiceName} ,
Required: False ,
}
string ,
properties:
{
Description: The properties of Dedicated Node Service ,
Required: False ,
}
{
gatewaySubnet:
{
Description: gateway Subnet for the account. It will collect the subnet address and always treat it as /28 ,
Required: True ,
}
string ,
isAccountOnboarded:
{
Description: indicates whether account onboarded or not in a given region ,
Enum:
{
notOnBoarded: No description available. ,
onBoarded: No description available. ,
onBoardingFailed: No description available. ,
onBoarding: No description available. ,
}
,
Required: False ,
}
enum ,
nodes:
{
Description: total nodes purchased ,
Required: False ,
}
integer ,
serviceURL:
{
Description: link to a service management web portal ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudServices_CreateOrUpdate (removed)
Description :  Create dedicate cloud service
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudServices/{dedicatedCloudServiceName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
dedicatedCloudServiceName:
{
Description: dedicated cloud Service name ,
Required: True ,
}
string ,
dedicatedCloudServiceRequest:
{
Description: Create Dedicated Cloud Service request ,
Required: True ,
}
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudServices/{dedicatedCloudServiceName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudServiceName} ,
Required: False ,
}
string ,
properties:
{
Description: The properties of Dedicated Node Service ,
Required: False ,
}
{
gatewaySubnet:
{
Description: gateway Subnet for the account. It will collect the subnet address and always treat it as /28 ,
Required: True ,
}
string ,
isAccountOnboarded:
{
Description: indicates whether account onboarded or not in a given region ,
Enum:
{
notOnBoarded: No description available. ,
onBoarded: No description available. ,
onBoardingFailed: No description available. ,
onBoarding: No description available. ,
}
,
Required: False ,
}
enum ,
nodes:
{
Description: total nodes purchased ,
Required: False ,
}
integer ,
serviceURL:
{
Description: link to a service management web portal ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudServices/{dedicatedCloudServiceName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudServiceName} ,
Required: False ,
}
string ,
properties:
{
Description: The properties of Dedicated Node Service ,
Required: False ,
}
{
gatewaySubnet:
{
Description: gateway Subnet for the account. It will collect the subnet address and always treat it as /28 ,
Required: True ,
}
string ,
isAccountOnboarded:
{
Description: indicates whether account onboarded or not in a given region ,
Enum:
{
notOnBoarded: No description available. ,
onBoarded: No description available. ,
onBoardingFailed: No description available. ,
onBoarding: No description available. ,
}
,
Required: False ,
}
enum ,
nodes:
{
Description: total nodes purchased ,
Required: False ,
}
integer ,
serviceURL:
{
Description: link to a service management web portal ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
DedicatedCloudServices_Delete (removed)
Description :  Delete dedicate cloud service
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudServices/{dedicatedCloudServiceName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
dedicatedCloudServiceName:
{
Description: dedicated cloud service name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
content-type: string ,
}
,
$schema:
{
Description: General error model ,
}
{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
,
}
DedicatedCloudServices_Update (removed)
Description :  Patch dedicated cloud service's properties
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudServices/{dedicatedCloudServiceName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
dedicatedCloudServiceName:
{
Description: dedicated cloud service name ,
Required: True ,
}
string ,
dedicatedCloudServiceRequest:
{
Description: Patch Dedicated Cloud Service request ,
Required: True ,
}
{
tags:
{
Description: The tags key:value pairs ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudServices/{dedicatedCloudServiceName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {dedicatedCloudServiceName} ,
Required: False ,
}
string ,
properties:
{
Description: The properties of Dedicated Node Service ,
Required: False ,
}
{
gatewaySubnet:
{
Description: gateway Subnet for the account. It will collect the subnet address and always treat it as /28 ,
Required: True ,
}
string ,
isAccountOnboarded:
{
Description: indicates whether account onboarded or not in a given region ,
Enum:
{
notOnBoarded: No description available. ,
onBoarded: No description available. ,
onBoardingFailed: No description available. ,
onBoarding: No description available. ,
}
,
Required: False ,
}
enum ,
nodes:
{
Description: total nodes purchased ,
Required: False ,
}
integer ,
serviceURL:
{
Description: link to a service management web portal ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualMachines_ListByResourceGroup (removed)
Description :  Returns list of virtual machine within resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the list operation ,
Required: False ,
}
string ,
$top:
{
Description: The maximum number of record sets to return ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: to be used by nextLink implementation ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: Link for next list of VirtualMachines ,
Required: False ,
}
string ,
value:
{
Description: Results of the VirtualMachine list ,
Required: False ,
}
[
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {virtualMachineName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual machine properties ,
Required: False ,
}
{
amountOfRam:
{
Description: The amount of memory ,
Required: True ,
}
integer ,
controllers:
{
Description: The list of Virtual Disks' Controllers ,
Required: False ,
}
[
{
id:
{
Description: Controller's id ,
Required: False ,
}
string ,
name:
{
Description: The display name of Controller ,
Required: False ,
}
string ,
subType:
{
Description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) ,
Required: False ,
}
string ,
type:
{
Description: disk controller type (SCSI) ,
Required: False ,
}
string ,
}
,
]
,
customization:
{
Description: Virtual machine properties ,
Required: False ,
}
{
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: Virtual Machine hostname ,
Required: False ,
}
string ,
password:
{
Description: Password for login ,
Required: False ,
}
string ,
policyId:
{
Description: id of customization policy ,
Required: False ,
}
string ,
username:
{
Description: Username for login ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The list of Virtual Disks ,
Required: False ,
}
[
{
controllerId:
{
Description: Disk's Controller id ,
Required: True ,
}
string ,
independenceMode:
{
Description: Disk's independence mode type ,
Enum:
{
persistent: No description available. ,
independent_persistent: No description available. ,
independent_nonpersistent: No description available. ,
}
,
Required: True ,
}
enum ,
totalSize:
{
Description: Disk's total size ,
Required: True ,
}
integer ,
virtualDiskId:
{
Description: Disk's id ,
Required: False ,
}
string ,
virtualDiskName:
{
Description: Disk's display name ,
Required: False ,
}
string ,
}
,
]
,
dnsname:
{
Description: The DNS name of Virtual Machine in VCenter ,
Required: False ,
}
string ,
exposeToGuestVM:
{
Description: Expose Guest OS or not ,
Required: False ,
}
boolean ,
folder:
{
Description: The path to virtual machine folder in VCenter ,
Required: False ,
}
string ,
guestOS:
{
Description: The name of Guest OS ,
Required: False ,
}
string ,
guestOSType:
{
Description: The Guest OS type ,
Enum:
{
linux: No description available. ,
windows: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
nics:
{
Description: The list of Virtual NICs ,
Required: False ,
}
[
{
customization:
{
Description: guest OS customization for nic ,
Required: False ,
}
{
allocation:
{
Description: IP address allocation method ,
Enum:
{
static: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: Gateway addresses assigned to nic ,
Required: False ,
}
[
string ,
]
,
ipAddress:
{
Description: Static ip address for nic ,
Required: False ,
}
string ,
mask:
{
Description: Network mask for nic ,
Required: False ,
}
string ,
primaryWinsServer:
{
Description: primary WINS server for Windows ,
Required: False ,
}
string ,
secondaryWinsServer:
{
Description: secondary WINS server for Windows ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: NIC ip address ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: NIC MAC address ,
Required: False ,
}
string ,
network:
{
Description: Virtual Network ,
Required: True ,
}
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
nicType:
{
Description: NIC type ,
Enum:
{
E1000: No description available. ,
E1000E: No description available. ,
PCNET32: No description available. ,
VMXNET: No description available. ,
VMXNET2: No description available. ,
VMXNET3: No description available. ,
}
,
Required: True ,
}
enum ,
powerOnBoot:
{
Description: Is NIC powered on/off on boot ,
Required: False ,
}
boolean ,
virtualNicId:
{
Description: NIC id ,
Required: False ,
}
string ,
virtualNicName:
{
Description: NIC name ,
Required: False ,
}
string ,
}
,
]
,
numberOfCores:
{
Description: The number of CPU cores ,
Required: True ,
}
integer ,
password:
{
Description: Password for login. Deprecated - use customization property ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
publicIP:
{
Description: The public ip of Virtual Machine ,
Required: False ,
}
string ,
resourcePool:
{
Description: Virtual Machines Resource Pool ,
Required: False ,
}
{
id:
{
Description: resource pool id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {ResourcePoolName} ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: False ,
}
string ,
properties:
{
Description: Resource pool properties ,
Required: False ,
}
{
fullName:
{
Description: Hierarchical resource pool name ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of Virtual machine ,
Enum:
{
running: No description available. ,
suspended: No description available. ,
poweredoff: No description available. ,
updating: No description available. ,
deallocating: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
templateId:
{
Description: Virtual Machine Template Id ,
Required: False ,
}
string ,
username:
{
Description: Username for login. Deprecated - use customization property ,
Required: False ,
}
string ,
vSphereNetworks:
{
Description: The list of Virtual VSphere Networks ,
Required: False ,
}
[
string ,
]
,
vmId:
{
Description: The internal id of Virtual Machine in VCenter ,
Required: False ,
}
string ,
vmwaretools:
{
Description: VMware tools version ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualMachines_Get (removed)
Description :  Get virtual machine
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtual machine name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {virtualMachineName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual machine properties ,
Required: False ,
}
{
amountOfRam:
{
Description: The amount of memory ,
Required: True ,
}
integer ,
controllers:
{
Description: The list of Virtual Disks' Controllers ,
Required: False ,
}
[
{
id:
{
Description: Controller's id ,
Required: False ,
}
string ,
name:
{
Description: The display name of Controller ,
Required: False ,
}
string ,
subType:
{
Description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) ,
Required: False ,
}
string ,
type:
{
Description: disk controller type (SCSI) ,
Required: False ,
}
string ,
}
,
]
,
customization:
{
Description: Virtual machine properties ,
Required: False ,
}
{
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: Virtual Machine hostname ,
Required: False ,
}
string ,
password:
{
Description: Password for login ,
Required: False ,
}
string ,
policyId:
{
Description: id of customization policy ,
Required: False ,
}
string ,
username:
{
Description: Username for login ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The list of Virtual Disks ,
Required: False ,
}
[
{
controllerId:
{
Description: Disk's Controller id ,
Required: True ,
}
string ,
independenceMode:
{
Description: Disk's independence mode type ,
Enum:
{
persistent: No description available. ,
independent_persistent: No description available. ,
independent_nonpersistent: No description available. ,
}
,
Required: True ,
}
enum ,
totalSize:
{
Description: Disk's total size ,
Required: True ,
}
integer ,
virtualDiskId:
{
Description: Disk's id ,
Required: False ,
}
string ,
virtualDiskName:
{
Description: Disk's display name ,
Required: False ,
}
string ,
}
,
]
,
dnsname:
{
Description: The DNS name of Virtual Machine in VCenter ,
Required: False ,
}
string ,
exposeToGuestVM:
{
Description: Expose Guest OS or not ,
Required: False ,
}
boolean ,
folder:
{
Description: The path to virtual machine folder in VCenter ,
Required: False ,
}
string ,
guestOS:
{
Description: The name of Guest OS ,
Required: False ,
}
string ,
guestOSType:
{
Description: The Guest OS type ,
Enum:
{
linux: No description available. ,
windows: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
nics:
{
Description: The list of Virtual NICs ,
Required: False ,
}
[
{
customization:
{
Description: guest OS customization for nic ,
Required: False ,
}
{
allocation:
{
Description: IP address allocation method ,
Enum:
{
static: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: Gateway addresses assigned to nic ,
Required: False ,
}
[
string ,
]
,
ipAddress:
{
Description: Static ip address for nic ,
Required: False ,
}
string ,
mask:
{
Description: Network mask for nic ,
Required: False ,
}
string ,
primaryWinsServer:
{
Description: primary WINS server for Windows ,
Required: False ,
}
string ,
secondaryWinsServer:
{
Description: secondary WINS server for Windows ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: NIC ip address ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: NIC MAC address ,
Required: False ,
}
string ,
network:
{
Description: Virtual Network ,
Required: True ,
}
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
nicType:
{
Description: NIC type ,
Enum:
{
E1000: No description available. ,
E1000E: No description available. ,
PCNET32: No description available. ,
VMXNET: No description available. ,
VMXNET2: No description available. ,
VMXNET3: No description available. ,
}
,
Required: True ,
}
enum ,
powerOnBoot:
{
Description: Is NIC powered on/off on boot ,
Required: False ,
}
boolean ,
virtualNicId:
{
Description: NIC id ,
Required: False ,
}
string ,
virtualNicName:
{
Description: NIC name ,
Required: False ,
}
string ,
}
,
]
,
numberOfCores:
{
Description: The number of CPU cores ,
Required: True ,
}
integer ,
password:
{
Description: Password for login. Deprecated - use customization property ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
publicIP:
{
Description: The public ip of Virtual Machine ,
Required: False ,
}
string ,
resourcePool:
{
Description: Virtual Machines Resource Pool ,
Required: False ,
}
{
id:
{
Description: resource pool id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {ResourcePoolName} ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: False ,
}
string ,
properties:
{
Description: Resource pool properties ,
Required: False ,
}
{
fullName:
{
Description: Hierarchical resource pool name ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of Virtual machine ,
Enum:
{
running: No description available. ,
suspended: No description available. ,
poweredoff: No description available. ,
updating: No description available. ,
deallocating: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
templateId:
{
Description: Virtual Machine Template Id ,
Required: False ,
}
string ,
username:
{
Description: Username for login. Deprecated - use customization property ,
Required: False ,
}
string ,
vSphereNetworks:
{
Description: The list of Virtual VSphere Networks ,
Required: False ,
}
[
string ,
]
,
vmId:
{
Description: The internal id of Virtual Machine in VCenter ,
Required: False ,
}
string ,
vmwaretools:
{
Description: VMware tools version ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualMachines_CreateOrUpdate (removed)
Description :  Create Or Update Virtual Machine
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
Referer:
{
Description: referer url ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtual machine name ,
Required: True ,
}
string ,
virtualMachineRequest:
{
Description: Create or Update Virtual Machine request ,
Required: True ,
}
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {virtualMachineName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual machine properties ,
Required: False ,
}
{
amountOfRam:
{
Description: The amount of memory ,
Required: True ,
}
integer ,
controllers:
{
Description: The list of Virtual Disks' Controllers ,
Required: False ,
}
[
{
id:
{
Description: Controller's id ,
Required: False ,
}
string ,
name:
{
Description: The display name of Controller ,
Required: False ,
}
string ,
subType:
{
Description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) ,
Required: False ,
}
string ,
type:
{
Description: disk controller type (SCSI) ,
Required: False ,
}
string ,
}
,
]
,
customization:
{
Description: Virtual machine properties ,
Required: False ,
}
{
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: Virtual Machine hostname ,
Required: False ,
}
string ,
password:
{
Description: Password for login ,
Required: False ,
}
string ,
policyId:
{
Description: id of customization policy ,
Required: False ,
}
string ,
username:
{
Description: Username for login ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The list of Virtual Disks ,
Required: False ,
}
[
{
controllerId:
{
Description: Disk's Controller id ,
Required: True ,
}
string ,
independenceMode:
{
Description: Disk's independence mode type ,
Enum:
{
persistent: No description available. ,
independent_persistent: No description available. ,
independent_nonpersistent: No description available. ,
}
,
Required: True ,
}
enum ,
totalSize:
{
Description: Disk's total size ,
Required: True ,
}
integer ,
virtualDiskId:
{
Description: Disk's id ,
Required: False ,
}
string ,
virtualDiskName:
{
Description: Disk's display name ,
Required: False ,
}
string ,
}
,
]
,
dnsname:
{
Description: The DNS name of Virtual Machine in VCenter ,
Required: False ,
}
string ,
exposeToGuestVM:
{
Description: Expose Guest OS or not ,
Required: False ,
}
boolean ,
folder:
{
Description: The path to virtual machine folder in VCenter ,
Required: False ,
}
string ,
guestOS:
{
Description: The name of Guest OS ,
Required: False ,
}
string ,
guestOSType:
{
Description: The Guest OS type ,
Enum:
{
linux: No description available. ,
windows: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
nics:
{
Description: The list of Virtual NICs ,
Required: False ,
}
[
{
customization:
{
Description: guest OS customization for nic ,
Required: False ,
}
{
allocation:
{
Description: IP address allocation method ,
Enum:
{
static: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: Gateway addresses assigned to nic ,
Required: False ,
}
[
string ,
]
,
ipAddress:
{
Description: Static ip address for nic ,
Required: False ,
}
string ,
mask:
{
Description: Network mask for nic ,
Required: False ,
}
string ,
primaryWinsServer:
{
Description: primary WINS server for Windows ,
Required: False ,
}
string ,
secondaryWinsServer:
{
Description: secondary WINS server for Windows ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: NIC ip address ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: NIC MAC address ,
Required: False ,
}
string ,
network:
{
Description: Virtual Network ,
Required: True ,
}
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
nicType:
{
Description: NIC type ,
Enum:
{
E1000: No description available. ,
E1000E: No description available. ,
PCNET32: No description available. ,
VMXNET: No description available. ,
VMXNET2: No description available. ,
VMXNET3: No description available. ,
}
,
Required: True ,
}
enum ,
powerOnBoot:
{
Description: Is NIC powered on/off on boot ,
Required: False ,
}
boolean ,
virtualNicId:
{
Description: NIC id ,
Required: False ,
}
string ,
virtualNicName:
{
Description: NIC name ,
Required: False ,
}
string ,
}
,
]
,
numberOfCores:
{
Description: The number of CPU cores ,
Required: True ,
}
integer ,
password:
{
Description: Password for login. Deprecated - use customization property ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
publicIP:
{
Description: The public ip of Virtual Machine ,
Required: False ,
}
string ,
resourcePool:
{
Description: Virtual Machines Resource Pool ,
Required: False ,
}
{
id:
{
Description: resource pool id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {ResourcePoolName} ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: False ,
}
string ,
properties:
{
Description: Resource pool properties ,
Required: False ,
}
{
fullName:
{
Description: Hierarchical resource pool name ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of Virtual machine ,
Enum:
{
running: No description available. ,
suspended: No description available. ,
poweredoff: No description available. ,
updating: No description available. ,
deallocating: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
templateId:
{
Description: Virtual Machine Template Id ,
Required: False ,
}
string ,
username:
{
Description: Username for login. Deprecated - use customization property ,
Required: False ,
}
string ,
vSphereNetworks:
{
Description: The list of Virtual VSphere Networks ,
Required: False ,
}
[
string ,
]
,
vmId:
{
Description: The internal id of Virtual Machine in VCenter ,
Required: False ,
}
string ,
vmwaretools:
{
Description: VMware tools version ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
Description: Virtual machine model ,
}
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {virtualMachineName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual machine properties ,
Required: False ,
}
{
amountOfRam:
{
Description: The amount of memory ,
Required: True ,
}
integer ,
controllers:
{
Description: The list of Virtual Disks' Controllers ,
Required: False ,
}
[
{
id:
{
Description: Controller's id ,
Required: False ,
}
string ,
name:
{
Description: The display name of Controller ,
Required: False ,
}
string ,
subType:
{
Description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) ,
Required: False ,
}
string ,
type:
{
Description: disk controller type (SCSI) ,
Required: False ,
}
string ,
}
,
]
,
customization:
{
Description: Virtual machine properties ,
Required: False ,
}
{
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: Virtual Machine hostname ,
Required: False ,
}
string ,
password:
{
Description: Password for login ,
Required: False ,
}
string ,
policyId:
{
Description: id of customization policy ,
Required: False ,
}
string ,
username:
{
Description: Username for login ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The list of Virtual Disks ,
Required: False ,
}
[
{
controllerId:
{
Description: Disk's Controller id ,
Required: True ,
}
string ,
independenceMode:
{
Description: Disk's independence mode type ,
Enum:
{
persistent: No description available. ,
independent_persistent: No description available. ,
independent_nonpersistent: No description available. ,
}
,
Required: True ,
}
enum ,
totalSize:
{
Description: Disk's total size ,
Required: True ,
}
integer ,
virtualDiskId:
{
Description: Disk's id ,
Required: False ,
}
string ,
virtualDiskName:
{
Description: Disk's display name ,
Required: False ,
}
string ,
}
,
]
,
dnsname:
{
Description: The DNS name of Virtual Machine in VCenter ,
Required: False ,
}
string ,
exposeToGuestVM:
{
Description: Expose Guest OS or not ,
Required: False ,
}
boolean ,
folder:
{
Description: The path to virtual machine folder in VCenter ,
Required: False ,
}
string ,
guestOS:
{
Description: The name of Guest OS ,
Required: False ,
}
string ,
guestOSType:
{
Description: The Guest OS type ,
Enum:
{
linux: No description available. ,
windows: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
nics:
{
Description: The list of Virtual NICs ,
Required: False ,
}
[
{
customization:
{
Description: guest OS customization for nic ,
Required: False ,
}
{
allocation:
{
Description: IP address allocation method ,
Enum:
{
static: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: Gateway addresses assigned to nic ,
Required: False ,
}
[
string ,
]
,
ipAddress:
{
Description: Static ip address for nic ,
Required: False ,
}
string ,
mask:
{
Description: Network mask for nic ,
Required: False ,
}
string ,
primaryWinsServer:
{
Description: primary WINS server for Windows ,
Required: False ,
}
string ,
secondaryWinsServer:
{
Description: secondary WINS server for Windows ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: NIC ip address ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: NIC MAC address ,
Required: False ,
}
string ,
network:
{
Description: Virtual Network ,
Required: True ,
}
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
nicType:
{
Description: NIC type ,
Enum:
{
E1000: No description available. ,
E1000E: No description available. ,
PCNET32: No description available. ,
VMXNET: No description available. ,
VMXNET2: No description available. ,
VMXNET3: No description available. ,
}
,
Required: True ,
}
enum ,
powerOnBoot:
{
Description: Is NIC powered on/off on boot ,
Required: False ,
}
boolean ,
virtualNicId:
{
Description: NIC id ,
Required: False ,
}
string ,
virtualNicName:
{
Description: NIC name ,
Required: False ,
}
string ,
}
,
]
,
numberOfCores:
{
Description: The number of CPU cores ,
Required: True ,
}
integer ,
password:
{
Description: Password for login. Deprecated - use customization property ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
publicIP:
{
Description: The public ip of Virtual Machine ,
Required: False ,
}
string ,
resourcePool:
{
Description: Virtual Machines Resource Pool ,
Required: False ,
}
{
id:
{
Description: resource pool id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {ResourcePoolName} ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: False ,
}
string ,
properties:
{
Description: Resource pool properties ,
Required: False ,
}
{
fullName:
{
Description: Hierarchical resource pool name ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of Virtual machine ,
Enum:
{
running: No description available. ,
suspended: No description available. ,
poweredoff: No description available. ,
updating: No description available. ,
deallocating: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
templateId:
{
Description: Virtual Machine Template Id ,
Required: False ,
}
string ,
username:
{
Description: Username for login. Deprecated - use customization property ,
Required: False ,
}
string ,
vSphereNetworks:
{
Description: The list of Virtual VSphere Networks ,
Required: False ,
}
[
string ,
]
,
vmId:
{
Description: The internal id of Virtual Machine in VCenter ,
Required: False ,
}
string ,
vmwaretools:
{
Description: VMware tools version ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation: string ,
}
,
$schema:
{
Description: Virtual machine model ,
}
{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {virtualMachineName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual machine properties ,
Required: False ,
}
{
amountOfRam:
{
Description: The amount of memory ,
Required: True ,
}
integer ,
controllers:
{
Description: The list of Virtual Disks' Controllers ,
Required: False ,
}
[
{
id:
{
Description: Controller's id ,
Required: False ,
}
string ,
name:
{
Description: The display name of Controller ,
Required: False ,
}
string ,
subType:
{
Description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) ,
Required: False ,
}
string ,
type:
{
Description: disk controller type (SCSI) ,
Required: False ,
}
string ,
}
,
]
,
customization:
{
Description: Virtual machine properties ,
Required: False ,
}
{
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: Virtual Machine hostname ,
Required: False ,
}
string ,
password:
{
Description: Password for login ,
Required: False ,
}
string ,
policyId:
{
Description: id of customization policy ,
Required: False ,
}
string ,
username:
{
Description: Username for login ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The list of Virtual Disks ,
Required: False ,
}
[
{
controllerId:
{
Description: Disk's Controller id ,
Required: True ,
}
string ,
independenceMode:
{
Description: Disk's independence mode type ,
Enum:
{
persistent: No description available. ,
independent_persistent: No description available. ,
independent_nonpersistent: No description available. ,
}
,
Required: True ,
}
enum ,
totalSize:
{
Description: Disk's total size ,
Required: True ,
}
integer ,
virtualDiskId:
{
Description: Disk's id ,
Required: False ,
}
string ,
virtualDiskName:
{
Description: Disk's display name ,
Required: False ,
}
string ,
}
,
]
,
dnsname:
{
Description: The DNS name of Virtual Machine in VCenter ,
Required: False ,
}
string ,
exposeToGuestVM:
{
Description: Expose Guest OS or not ,
Required: False ,
}
boolean ,
folder:
{
Description: The path to virtual machine folder in VCenter ,
Required: False ,
}
string ,
guestOS:
{
Description: The name of Guest OS ,
Required: False ,
}
string ,
guestOSType:
{
Description: The Guest OS type ,
Enum:
{
linux: No description available. ,
windows: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
nics:
{
Description: The list of Virtual NICs ,
Required: False ,
}
[
{
customization:
{
Description: guest OS customization for nic ,
Required: False ,
}
{
allocation:
{
Description: IP address allocation method ,
Enum:
{
static: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: Gateway addresses assigned to nic ,
Required: False ,
}
[
string ,
]
,
ipAddress:
{
Description: Static ip address for nic ,
Required: False ,
}
string ,
mask:
{
Description: Network mask for nic ,
Required: False ,
}
string ,
primaryWinsServer:
{
Description: primary WINS server for Windows ,
Required: False ,
}
string ,
secondaryWinsServer:
{
Description: secondary WINS server for Windows ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: NIC ip address ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: NIC MAC address ,
Required: False ,
}
string ,
network:
{
Description: Virtual Network ,
Required: True ,
}
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
nicType:
{
Description: NIC type ,
Enum:
{
E1000: No description available. ,
E1000E: No description available. ,
PCNET32: No description available. ,
VMXNET: No description available. ,
VMXNET2: No description available. ,
VMXNET3: No description available. ,
}
,
Required: True ,
}
enum ,
powerOnBoot:
{
Description: Is NIC powered on/off on boot ,
Required: False ,
}
boolean ,
virtualNicId:
{
Description: NIC id ,
Required: False ,
}
string ,
virtualNicName:
{
Description: NIC name ,
Required: False ,
}
string ,
}
,
]
,
numberOfCores:
{
Description: The number of CPU cores ,
Required: True ,
}
integer ,
password:
{
Description: Password for login. Deprecated - use customization property ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
publicIP:
{
Description: The public ip of Virtual Machine ,
Required: False ,
}
string ,
resourcePool:
{
Description: Virtual Machines Resource Pool ,
Required: False ,
}
{
id:
{
Description: resource pool id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {ResourcePoolName} ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: False ,
}
string ,
properties:
{
Description: Resource pool properties ,
Required: False ,
}
{
fullName:
{
Description: Hierarchical resource pool name ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of Virtual machine ,
Enum:
{
running: No description available. ,
suspended: No description available. ,
poweredoff: No description available. ,
updating: No description available. ,
deallocating: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
templateId:
{
Description: Virtual Machine Template Id ,
Required: False ,
}
string ,
username:
{
Description: Username for login. Deprecated - use customization property ,
Required: False ,
}
string ,
vSphereNetworks:
{
Description: The list of Virtual VSphere Networks ,
Required: False ,
}
[
string ,
]
,
vmId:
{
Description: The internal id of Virtual Machine in VCenter ,
Required: False ,
}
string ,
vmwaretools:
{
Description: VMware tools version ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualMachines_Delete (removed)
Description :  Delete virtual machine
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
Referer:
{
Description: referer url ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtual machine name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
retry-after: integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
content-type: string ,
}
,
$schema:
{
Description: General error model ,
}
{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
,
}
VirtualMachines_Update (removed)
Description :  Patch virtual machine properties
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtual machine name ,
Required: True ,
}
string ,
virtualMachineRequest:
{
Description: Patch virtual machine request ,
Required: True ,
}
{
tags:
{
Description: The tags key:value pairs ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName} ,
Required: False ,
}
string ,
location:
{
Description: Azure region ,
Required: True ,
}
string ,
name:
{
Description: {virtualMachineName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual machine properties ,
Required: False ,
}
{
amountOfRam:
{
Description: The amount of memory ,
Required: True ,
}
integer ,
controllers:
{
Description: The list of Virtual Disks' Controllers ,
Required: False ,
}
[
{
id:
{
Description: Controller's id ,
Required: False ,
}
string ,
name:
{
Description: The display name of Controller ,
Required: False ,
}
string ,
subType:
{
Description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) ,
Required: False ,
}
string ,
type:
{
Description: disk controller type (SCSI) ,
Required: False ,
}
string ,
}
,
]
,
customization:
{
Description: Virtual machine properties ,
Required: False ,
}
{
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: Virtual Machine hostname ,
Required: False ,
}
string ,
password:
{
Description: Password for login ,
Required: False ,
}
string ,
policyId:
{
Description: id of customization policy ,
Required: False ,
}
string ,
username:
{
Description: Username for login ,
Required: False ,
}
string ,
}
,
disks:
{
Description: The list of Virtual Disks ,
Required: False ,
}
[
{
controllerId:
{
Description: Disk's Controller id ,
Required: True ,
}
string ,
independenceMode:
{
Description: Disk's independence mode type ,
Enum:
{
persistent: No description available. ,
independent_persistent: No description available. ,
independent_nonpersistent: No description available. ,
}
,
Required: True ,
}
enum ,
totalSize:
{
Description: Disk's total size ,
Required: True ,
}
integer ,
virtualDiskId:
{
Description: Disk's id ,
Required: False ,
}
string ,
virtualDiskName:
{
Description: Disk's display name ,
Required: False ,
}
string ,
}
,
]
,
dnsname:
{
Description: The DNS name of Virtual Machine in VCenter ,
Required: False ,
}
string ,
exposeToGuestVM:
{
Description: Expose Guest OS or not ,
Required: False ,
}
boolean ,
folder:
{
Description: The path to virtual machine folder in VCenter ,
Required: False ,
}
string ,
guestOS:
{
Description: The name of Guest OS ,
Required: False ,
}
string ,
guestOSType:
{
Description: The Guest OS type ,
Enum:
{
linux: No description available. ,
windows: No description available. ,
other: No description available. ,
}
,
Required: False ,
}
enum ,
nics:
{
Description: The list of Virtual NICs ,
Required: False ,
}
[
{
customization:
{
Description: guest OS customization for nic ,
Required: False ,
}
{
allocation:
{
Description: IP address allocation method ,
Enum:
{
static: No description available. ,
dynamic: No description available. ,
}
,
Required: False ,
}
enum ,
dnsServers:
{
Description: List of dns servers to use ,
Required: False ,
}
[
string ,
]
,
gateway:
{
Description: Gateway addresses assigned to nic ,
Required: False ,
}
[
string ,
]
,
ipAddress:
{
Description: Static ip address for nic ,
Required: False ,
}
string ,
mask:
{
Description: Network mask for nic ,
Required: False ,
}
string ,
primaryWinsServer:
{
Description: primary WINS server for Windows ,
Required: False ,
}
string ,
secondaryWinsServer:
{
Description: secondary WINS server for Windows ,
Required: False ,
}
string ,
}
,
ipAddresses:
{
Description: NIC ip address ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: NIC MAC address ,
Required: False ,
}
string ,
network:
{
Description: Virtual Network ,
Required: True ,
}
{
assignable:
{
Description: can be used in vm creation/deletion ,
Required: False ,
}
boolean ,
id:
{
Description: virtual network id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {VirtualNetworkName} ,
Required: False ,
}
string ,
properties:
{
Description: Virtual Network properties ,
Required: False ,
}
{
privateCloudId:
{
Description: The Private Cloud id ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
nicType:
{
Description: NIC type ,
Enum:
{
E1000: No description available. ,
E1000E: No description available. ,
PCNET32: No description available. ,
VMXNET: No description available. ,
VMXNET2: No description available. ,
VMXNET3: No description available. ,
}
,
Required: True ,
}
enum ,
powerOnBoot:
{
Description: Is NIC powered on/off on boot ,
Required: False ,
}
boolean ,
virtualNicId:
{
Description: NIC id ,
Required: False ,
}
string ,
virtualNicName:
{
Description: NIC name ,
Required: False ,
}
string ,
}
,
]
,
numberOfCores:
{
Description: The number of CPU cores ,
Required: True ,
}
integer ,
password:
{
Description: Password for login. Deprecated - use customization property ,
Required: False ,
}
string ,
privateCloudId:
{
Description: Private Cloud Id ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning status of the resource ,
Required: False ,
}
string ,
publicIP:
{
Description: The public ip of Virtual Machine ,
Required: False ,
}
string ,
resourcePool:
{
Description: Virtual Machines Resource Pool ,
Required: False ,
}
{
id:
{
Description: resource pool id (privateCloudId:vsphereId) ,
Required: True ,
}
string ,
location:
{
Description: Azure region ,
Required: False ,
}
string ,
name:
{
Description: {ResourcePoolName} ,
Required: False ,
}
string ,
privateCloudId:
{
Description: The Private Cloud Id ,
Required: False ,
}
string ,
properties:
{
Description: Resource pool properties ,
Required: False ,
}
{
fullName:
{
Description: Hierarchical resource pool name ,
Required: False ,
}
string ,
}
,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}
,
status:
{
Description: The status of Virtual machine ,
Enum:
{
running: No description available. ,
suspended: No description available. ,
poweredoff: No description available. ,
updating: No description available. ,
deallocating: No description available. ,
deleting: No description available. ,
}
,
Required: False ,
}
enum ,
templateId:
{
Description: Virtual Machine Template Id ,
Required: False ,
}
string ,
username:
{
Description: Username for login. Deprecated - use customization property ,
Required: False ,
}
string ,
vSphereNetworks:
{
Description: The list of Virtual VSphere Networks ,
Required: False ,
}
[
string ,
]
,
vmId:
{
Description: The internal id of Virtual Machine in VCenter ,
Required: False ,
}
string ,
vmwaretools:
{
Description: VMware tools version ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The list of tags ,
Required: False ,
}
string ,
type:
{
Description: {resourceProviderNamespace}/{resourceType} ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
VirtualMachines_Start (removed)
Description :  Power on virtual machine
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}/start
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
Referer:
{
Description: referer url ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtual machine name ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
$headers:
{
content-type: string ,
}
,
$schema:
{
Description: General error model ,
}
{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
,
}
VirtualMachines_Stop (removed)
Description :  Power off virtual machine, options: shutdown, poweroff, and suspend
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}/stop
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group ,
Required: True ,
}
string ,
Referer:
{
Description: referer url ,
Required: True ,
}
string ,
virtualMachineName:
{
Description: virtual machine name ,
Required: True ,
}
string ,
m:
{
Description: body stop mode parameter (reboot, shutdown, etc...) ,
Required: False ,
}
{
mode:
{
Description: mode indicates a type of stop operation - reboot, suspend, shutdown or power-off ,
Enum:
{
reboot: No description available. ,
suspend: No description available. ,
shutdown: No description available. ,
poweroff: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
mode:
{
Description: query stop mode parameter (reboot, shutdown, etc...) ,
Required: False ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation: string ,
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
$headers:
{
content-type: string ,
}
,
$schema:
{
Description: General error model ,
}
{
error:
{
Description: Error's body ,
Required: False ,
}
{
code:
{
Description: Error's code ,
Required: False ,
}
string ,
details:
{
Description: Error's details ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Error's message ,
Required: False ,
}
string ,
target:
{
Description: Error's target ,
Required: False ,
}
string ,
}
,
}
,
}