Microsoft.ScVmm (stable:2025-03-13)

2025/04/04 • 52 new methods

VirtualMachineInstances_List (new)
Description :  Lists all of the virtual machine instances within the specified parent resource.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The VirtualMachineInstance items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
availabilitySets:
{
Description: Availability Sets in vm. ,
Required: False ,
}
[
{
id:
{
Description: Gets the ARM Id of the microsoft.scvmm/availabilitySets resource. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the availability set. ,
Required: False ,
}
string ,
}
,
]
,
osProfile:
{
Description: OS properties. ,
Required: False ,
}
{
adminUsername:
{
Description: Gets or sets the admin username. ,
Required: False ,
}
string ,
adminPassword:
{
Description: Admin password of the virtual machine. ,
Format: password ,
Required: False ,
}
string ,
computerName:
{
Description: Gets or sets computer name. ,
Required: False ,
}
string ,
osType:
{
Description: Gets the type of the os. ,
Enum:
{
Windows: Windows operating system. ,
Linux: Linux operating system. ,
Other: Other operating system. ,
}
,
Required: False ,
}
enum ,
osSku:
{
Description: Gets os sku. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets os version. ,
Required: False ,
}
string ,
domainName:
{
Description: Gets or sets the domain name. ,
Required: False ,
}
string ,
domainUsername:
{
Description: Gets or sets the domain username. ,
Required: False ,
}
string ,
domainPassword:
{
Description: Password of the domain the VM has to join. ,
Format: password ,
Required: False ,
}
string ,
workgroup:
{
Description: Gets or sets the workgroup. ,
Required: False ,
}
string ,
productKey:
{
Description: Gets or sets the product key.Input format xxxxx-xxxxx-xxxxx-xxxxx-xxxxx ,
Format: password ,
Required: False ,
}
string ,
timezone:
{
Description: Gets or sets the index value of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
runOnceCommands:
{
Description: Get or sets the commands to be run once at the time of creation separated by semicolons. ,
Required: False ,
}
string ,
}
,
hardwareProfile:
{
Description: Hardware properties. ,
Required: False ,
}
{
memoryMB:
{
Description: MemoryMB is the size of a virtual machine's memory, in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuCount:
{
Description: Gets or sets the number of vCPUs for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
limitCpuForMigration:
{
Description: Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs. ,
Enum:
{
true: Enable limit CPU for migration. ,
false: Disable limit CPU for migration. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryEnabled:
{
Description: Gets or sets a value indicating whether to enable dynamic memory or not. ,
Enum:
{
true: Enable dynamic memory. ,
false: Disable dynamic memory. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryMaxMB:
{
Description: Gets or sets the max dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
dynamicMemoryMinMB:
{
Description: Gets or sets the min dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
isHighlyAvailable:
{
Description: Gets highly available property. ,
Enum:
{
true: Enable highly available. ,
false: Disable highly available. ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Network properties. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Gets or sets the list of network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the network interface. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set. ,
Required: False ,
}
string ,
ipv4Addresses:
{
Description: Gets the nic ipv4 addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Gets the nic ipv6 addresses. ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: Gets or sets the nic MAC address. ,
Required: False ,
}
string ,
virtualNetworkId:
{
Description: Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Gets the name of the virtual network in vmmServer that the nic is connected to. ,
Required: False ,
}
string ,
ipv4AddressType:
{
Description: Gets or sets the ipv4 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
ipv6AddressType:
{
Description: Gets or sets the ipv6 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
macAddressType:
{
Description: Gets or sets the mac address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
nicId:
{
Description: Gets or sets the nic id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
storageProfile:
{
Description: Storage properties. ,
Required: False ,
}
{
disks:
{
Description: Gets or sets the list of virtual disks associated with the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the disk. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set. ,
Required: False ,
}
string ,
diskId:
{
Description: Gets or sets the disk id. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Gets or sets the disk total size. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDiskSizeGB:
{
Description: Gets the max disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
bus:
{
Description: Gets or sets the disk bus. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Gets or sets the disk lun. ,
Format: int32 ,
Required: False ,
}
integer ,
busType:
{
Description: Gets or sets the disk bus type. ,
Required: False ,
}
string ,
vhdType:
{
Description: Gets or sets the disk vhd type. ,
Required: False ,
}
string ,
volumeType:
{
Description: Gets the disk volume type. ,
Required: False ,
}
string ,
vhdFormatType:
{
Description: Gets the disk vhd format type. ,
Required: False ,
}
string ,
templateDiskId:
{
Description: Gets or sets the disk id in the template. ,
Required: False ,
}
string ,
storageQoSPolicy:
{
Description: The QoS policy for the disk. ,
Required: False ,
}
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
}
,
createDiffDisk:
{
Description: Gets or sets a value indicating diff disk. ,
Enum:
{
true: Enable create diff disk. ,
false: Disable create diff disk. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
infrastructureProfile:
{
Description: Gets the infrastructure profile. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
cloudId:
{
Description: ARM Id of the cloud resource to use for deploying the vm. ,
Format: arm-id ,
Required: False ,
}
string ,
templateId:
{
Description: ARM Id of the template resource to use for deploying the vm. ,
Format: arm-id ,
Required: False ,
}
string ,
vmName:
{
Description: VMName is the name of VM on the SCVmm server. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual machine. ,
Required: False ,
}
string ,
lastRestoredVMCheckpoint:
{
Description: Last restored checkpoint in the vm. ,
Required: False ,
}
{
parentCheckpointID:
{
Description: Gets ID of parent of the checkpoint. ,
Required: False ,
}
string ,
checkpointID:
{
Description: Gets ID of the checkpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets name of the checkpoint. ,
Required: False ,
}
string ,
description:
{
Description: Gets description of the checkpoint. ,
Required: False ,
}
string ,
}
,
checkpoints:
{
Description: Checkpoints in the vm. ,
Required: False ,
}
[
{
parentCheckpointID:
{
Description: Gets ID of parent of the checkpoint. ,
Required: False ,
}
string ,
checkpointID:
{
Description: Gets ID of the checkpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets name of the checkpoint. ,
Required: False ,
}
string ,
description:
{
Description: Gets description of the checkpoint. ,
Required: False ,
}
string ,
}
,
]
,
checkpointType:
{
Description: Type of checkpoint supported for the vm. ,
Required: False ,
}
string ,
generation:
{
Description: Gets or sets the generation for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
biosGuid:
{
Description: Gets or sets the bios guid for the vm. ,
Required: False ,
}
string ,
}
,
powerState:
{
Description: Gets the power state of the virtual machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Gets or sets the extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_Get (new)
Description :  Retrieves information about a virtual machine instance.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
availabilitySets:
{
Description: Availability Sets in vm. ,
Required: False ,
}
[
{
id:
{
Description: Gets the ARM Id of the microsoft.scvmm/availabilitySets resource. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the availability set. ,
Required: False ,
}
string ,
}
,
]
,
osProfile:
{
Description: OS properties. ,
Required: False ,
}
{
adminUsername:
{
Description: Gets or sets the admin username. ,
Required: False ,
}
string ,
adminPassword:
{
Description: Admin password of the virtual machine. ,
Format: password ,
Required: False ,
}
string ,
computerName:
{
Description: Gets or sets computer name. ,
Required: False ,
}
string ,
osType:
{
Description: Gets the type of the os. ,
Enum:
{
Windows: Windows operating system. ,
Linux: Linux operating system. ,
Other: Other operating system. ,
}
,
Required: False ,
}
enum ,
osSku:
{
Description: Gets os sku. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets os version. ,
Required: False ,
}
string ,
domainName:
{
Description: Gets or sets the domain name. ,
Required: False ,
}
string ,
domainUsername:
{
Description: Gets or sets the domain username. ,
Required: False ,
}
string ,
domainPassword:
{
Description: Password of the domain the VM has to join. ,
Format: password ,
Required: False ,
}
string ,
workgroup:
{
Description: Gets or sets the workgroup. ,
Required: False ,
}
string ,
productKey:
{
Description: Gets or sets the product key.Input format xxxxx-xxxxx-xxxxx-xxxxx-xxxxx ,
Format: password ,
Required: False ,
}
string ,
timezone:
{
Description: Gets or sets the index value of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
runOnceCommands:
{
Description: Get or sets the commands to be run once at the time of creation separated by semicolons. ,
Required: False ,
}
string ,
}
,
hardwareProfile:
{
Description: Hardware properties. ,
Required: False ,
}
{
memoryMB:
{
Description: MemoryMB is the size of a virtual machine's memory, in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuCount:
{
Description: Gets or sets the number of vCPUs for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
limitCpuForMigration:
{
Description: Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs. ,
Enum:
{
true: Enable limit CPU for migration. ,
false: Disable limit CPU for migration. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryEnabled:
{
Description: Gets or sets a value indicating whether to enable dynamic memory or not. ,
Enum:
{
true: Enable dynamic memory. ,
false: Disable dynamic memory. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryMaxMB:
{
Description: Gets or sets the max dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
dynamicMemoryMinMB:
{
Description: Gets or sets the min dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
isHighlyAvailable:
{
Description: Gets highly available property. ,
Enum:
{
true: Enable highly available. ,
false: Disable highly available. ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Network properties. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Gets or sets the list of network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the network interface. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set. ,
Required: False ,
}
string ,
ipv4Addresses:
{
Description: Gets the nic ipv4 addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Gets the nic ipv6 addresses. ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: Gets or sets the nic MAC address. ,
Required: False ,
}
string ,
virtualNetworkId:
{
Description: Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Gets the name of the virtual network in vmmServer that the nic is connected to. ,
Required: False ,
}
string ,
ipv4AddressType:
{
Description: Gets or sets the ipv4 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
ipv6AddressType:
{
Description: Gets or sets the ipv6 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
macAddressType:
{
Description: Gets or sets the mac address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
nicId:
{
Description: Gets or sets the nic id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
storageProfile:
{
Description: Storage properties. ,
Required: False ,
}
{
disks:
{
Description: Gets or sets the list of virtual disks associated with the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the disk. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set. ,
Required: False ,
}
string ,
diskId:
{
Description: Gets or sets the disk id. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Gets or sets the disk total size. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDiskSizeGB:
{
Description: Gets the max disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
bus:
{
Description: Gets or sets the disk bus. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Gets or sets the disk lun. ,
Format: int32 ,
Required: False ,
}
integer ,
busType:
{
Description: Gets or sets the disk bus type. ,
Required: False ,
}
string ,
vhdType:
{
Description: Gets or sets the disk vhd type. ,
Required: False ,
}
string ,
volumeType:
{
Description: Gets the disk volume type. ,
Required: False ,
}
string ,
vhdFormatType:
{
Description: Gets the disk vhd format type. ,
Required: False ,
}
string ,
templateDiskId:
{
Description: Gets or sets the disk id in the template. ,
Required: False ,
}
string ,
storageQoSPolicy:
{
Description: The QoS policy for the disk. ,
Required: False ,
}
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
}
,
createDiffDisk:
{
Description: Gets or sets a value indicating diff disk. ,
Enum:
{
true: Enable create diff disk. ,
false: Disable create diff disk. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
infrastructureProfile:
{
Description: Gets the infrastructure profile. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
cloudId:
{
Description: ARM Id of the cloud resource to use for deploying the vm. ,
Format: arm-id ,
Required: False ,
}
string ,
templateId:
{
Description: ARM Id of the template resource to use for deploying the vm. ,
Format: arm-id ,
Required: False ,
}
string ,
vmName:
{
Description: VMName is the name of VM on the SCVmm server. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual machine. ,
Required: False ,
}
string ,
lastRestoredVMCheckpoint:
{
Description: Last restored checkpoint in the vm. ,
Required: False ,
}
{
parentCheckpointID:
{
Description: Gets ID of parent of the checkpoint. ,
Required: False ,
}
string ,
checkpointID:
{
Description: Gets ID of the checkpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets name of the checkpoint. ,
Required: False ,
}
string ,
description:
{
Description: Gets description of the checkpoint. ,
Required: False ,
}
string ,
}
,
checkpoints:
{
Description: Checkpoints in the vm. ,
Required: False ,
}
[
{
parentCheckpointID:
{
Description: Gets ID of parent of the checkpoint. ,
Required: False ,
}
string ,
checkpointID:
{
Description: Gets ID of the checkpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets name of the checkpoint. ,
Required: False ,
}
string ,
description:
{
Description: Gets description of the checkpoint. ,
Required: False ,
}
string ,
}
,
]
,
checkpointType:
{
Description: Type of checkpoint supported for the vm. ,
Required: False ,
}
string ,
generation:
{
Description: Gets or sets the generation for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
biosGuid:
{
Description: Gets or sets the bios guid for the vm. ,
Required: False ,
}
string ,
}
,
powerState:
{
Description: Gets the power state of the virtual machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Gets or sets the extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_CreateOrUpdate (new)
Description :  The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.
Reference :  Link ¶

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
availabilitySets:
{
Description: Availability Sets in vm. ,
Required: False ,
}
[
{
id:
{
Description: Gets the ARM Id of the microsoft.scvmm/availabilitySets resource. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the availability set. ,
Required: False ,
}
string ,
}
,
]
,
osProfile:
{
Description: OS properties. ,
Required: False ,
}
{
adminUsername:
{
Description: Gets or sets the admin username. ,
Required: False ,
}
string ,
adminPassword:
{
Description: Admin password of the virtual machine. ,
Format: password ,
Required: False ,
}
string ,
computerName:
{
Description: Gets or sets computer name. ,
Required: False ,
}
string ,
osType:
{
Description: Gets the type of the os. ,
Enum:
{
Windows: Windows operating system. ,
Linux: Linux operating system. ,
Other: Other operating system. ,
}
,
Required: False ,
}
enum ,
osSku:
{
Description: Gets os sku. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets os version. ,
Required: False ,
}
string ,
domainName:
{
Description: Gets or sets the domain name. ,
Required: False ,
}
string ,
domainUsername:
{
Description: Gets or sets the domain username. ,
Required: False ,
}
string ,
domainPassword:
{
Description: Password of the domain the VM has to join. ,
Format: password ,
Required: False ,
}
string ,
workgroup:
{
Description: Gets or sets the workgroup. ,
Required: False ,
}
string ,
productKey:
{
Description: Gets or sets the product key.Input format xxxxx-xxxxx-xxxxx-xxxxx-xxxxx ,
Format: password ,
Required: False ,
}
string ,
timezone:
{
Description: Gets or sets the index value of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
runOnceCommands:
{
Description: Get or sets the commands to be run once at the time of creation separated by semicolons. ,
Required: False ,
}
string ,
}
,
hardwareProfile:
{
Description: Hardware properties. ,
Required: False ,
}
{
memoryMB:
{
Description: MemoryMB is the size of a virtual machine's memory, in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuCount:
{
Description: Gets or sets the number of vCPUs for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
limitCpuForMigration:
{
Description: Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs. ,
Enum:
{
true: Enable limit CPU for migration. ,
false: Disable limit CPU for migration. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryEnabled:
{
Description: Gets or sets a value indicating whether to enable dynamic memory or not. ,
Enum:
{
true: Enable dynamic memory. ,
false: Disable dynamic memory. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryMaxMB:
{
Description: Gets or sets the max dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
dynamicMemoryMinMB:
{
Description: Gets or sets the min dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
isHighlyAvailable:
{
Description: Gets highly available property. ,
Enum:
{
true: Enable highly available. ,
false: Disable highly available. ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Network properties. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Gets or sets the list of network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the network interface. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set. ,
Required: False ,
}
string ,
ipv4Addresses:
{
Description: Gets the nic ipv4 addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Gets the nic ipv6 addresses. ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: Gets or sets the nic MAC address. ,
Required: False ,
}
string ,
virtualNetworkId:
{
Description: Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Gets the name of the virtual network in vmmServer that the nic is connected to. ,
Required: False ,
}
string ,
ipv4AddressType:
{
Description: Gets or sets the ipv4 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
ipv6AddressType:
{
Description: Gets or sets the ipv6 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
macAddressType:
{
Description: Gets or sets the mac address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
nicId:
{
Description: Gets or sets the nic id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
storageProfile:
{
Description: Storage properties. ,
Required: False ,
}
{
disks:
{
Description: Gets or sets the list of virtual disks associated with the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the disk. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set. ,
Required: False ,
}
string ,
diskId:
{
Description: Gets or sets the disk id. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Gets or sets the disk total size. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDiskSizeGB:
{
Description: Gets the max disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
bus:
{
Description: Gets or sets the disk bus. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Gets or sets the disk lun. ,
Format: int32 ,
Required: False ,
}
integer ,
busType:
{
Description: Gets or sets the disk bus type. ,
Required: False ,
}
string ,
vhdType:
{
Description: Gets or sets the disk vhd type. ,
Required: False ,
}
string ,
volumeType:
{
Description: Gets the disk volume type. ,
Required: False ,
}
string ,
vhdFormatType:
{
Description: Gets the disk vhd format type. ,
Required: False ,
}
string ,
templateDiskId:
{
Description: Gets or sets the disk id in the template. ,
Required: False ,
}
string ,
storageQoSPolicy:
{
Description: The QoS policy for the disk. ,
Required: False ,
}
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
}
,
createDiffDisk:
{
Description: Gets or sets a value indicating diff disk. ,
Enum:
{
true: Enable create diff disk. ,
false: Disable create diff disk. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
infrastructureProfile:
{
Description: Gets the infrastructure profile. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
cloudId:
{
Description: ARM Id of the cloud resource to use for deploying the vm. ,
Format: arm-id ,
Required: False ,
}
string ,
templateId:
{
Description: ARM Id of the template resource to use for deploying the vm. ,
Format: arm-id ,
Required: False ,
}
string ,
vmName:
{
Description: VMName is the name of VM on the SCVmm server. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual machine. ,
Required: False ,
}
string ,
lastRestoredVMCheckpoint:
{
Description: Last restored checkpoint in the vm. ,
Required: False ,
}
{
parentCheckpointID:
{
Description: Gets ID of parent of the checkpoint. ,
Required: False ,
}
string ,
checkpointID:
{
Description: Gets ID of the checkpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets name of the checkpoint. ,
Required: False ,
}
string ,
description:
{
Description: Gets description of the checkpoint. ,
Required: False ,
}
string ,
}
,
checkpoints:
{
Description: Checkpoints in the vm. ,
Required: False ,
}
[
{
parentCheckpointID:
{
Description: Gets ID of parent of the checkpoint. ,
Required: False ,
}
string ,
checkpointID:
{
Description: Gets ID of the checkpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets name of the checkpoint. ,
Required: False ,
}
string ,
description:
{
Description: Gets description of the checkpoint. ,
Required: False ,
}
string ,
}
,
]
,
checkpointType:
{
Description: Type of checkpoint supported for the vm. ,
Required: False ,
}
string ,
generation:
{
Description: Gets or sets the generation for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
biosGuid:
{
Description: Gets or sets the bios guid for the vm. ,
Required: False ,
}
string ,
}
,
powerState:
{
Description: Gets the power state of the virtual machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Gets or sets the extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
availabilitySets:
{
Description: Availability Sets in vm. ,
Required: False ,
}
[
{
id:
{
Description: Gets the ARM Id of the microsoft.scvmm/availabilitySets resource. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the availability set. ,
Required: False ,
}
string ,
}
,
]
,
osProfile:
{
Description: OS properties. ,
Required: False ,
}
{
adminUsername:
{
Description: Gets or sets the admin username. ,
Required: False ,
}
string ,
adminPassword:
{
Description: Admin password of the virtual machine. ,
Format: password ,
Required: False ,
}
string ,
computerName:
{
Description: Gets or sets computer name. ,
Required: False ,
}
string ,
osType:
{
Description: Gets the type of the os. ,
Enum:
{
Windows: Windows operating system. ,
Linux: Linux operating system. ,
Other: Other operating system. ,
}
,
Required: False ,
}
enum ,
osSku:
{
Description: Gets os sku. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets os version. ,
Required: False ,
}
string ,
domainName:
{
Description: Gets or sets the domain name. ,
Required: False ,
}
string ,
domainUsername:
{
Description: Gets or sets the domain username. ,
Required: False ,
}
string ,
domainPassword:
{
Description: Password of the domain the VM has to join. ,
Format: password ,
Required: False ,
}
string ,
workgroup:
{
Description: Gets or sets the workgroup. ,
Required: False ,
}
string ,
productKey:
{
Description: Gets or sets the product key.Input format xxxxx-xxxxx-xxxxx-xxxxx-xxxxx ,
Format: password ,
Required: False ,
}
string ,
timezone:
{
Description: Gets or sets the index value of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
runOnceCommands:
{
Description: Get or sets the commands to be run once at the time of creation separated by semicolons. ,
Required: False ,
}
string ,
}
,
hardwareProfile:
{
Description: Hardware properties. ,
Required: False ,
}
{
memoryMB:
{
Description: MemoryMB is the size of a virtual machine's memory, in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuCount:
{
Description: Gets or sets the number of vCPUs for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
limitCpuForMigration:
{
Description: Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs. ,
Enum:
{
true: Enable limit CPU for migration. ,
false: Disable limit CPU for migration. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryEnabled:
{
Description: Gets or sets a value indicating whether to enable dynamic memory or not. ,
Enum:
{
true: Enable dynamic memory. ,
false: Disable dynamic memory. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryMaxMB:
{
Description: Gets or sets the max dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
dynamicMemoryMinMB:
{
Description: Gets or sets the min dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
isHighlyAvailable:
{
Description: Gets highly available property. ,
Enum:
{
true: Enable highly available. ,
false: Disable highly available. ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Network properties. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Gets or sets the list of network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the network interface. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set. ,
Required: False ,
}
string ,
ipv4Addresses:
{
Description: Gets the nic ipv4 addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Gets the nic ipv6 addresses. ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: Gets or sets the nic MAC address. ,
Required: False ,
}
string ,
virtualNetworkId:
{
Description: Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Gets the name of the virtual network in vmmServer that the nic is connected to. ,
Required: False ,
}
string ,
ipv4AddressType:
{
Description: Gets or sets the ipv4 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
ipv6AddressType:
{
Description: Gets or sets the ipv6 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
macAddressType:
{
Description: Gets or sets the mac address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
nicId:
{
Description: Gets or sets the nic id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
storageProfile:
{
Description: Storage properties. ,
Required: False ,
}
{
disks:
{
Description: Gets or sets the list of virtual disks associated with the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the disk. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set. ,
Required: False ,
}
string ,
diskId:
{
Description: Gets or sets the disk id. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Gets or sets the disk total size. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDiskSizeGB:
{
Description: Gets the max disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
bus:
{
Description: Gets or sets the disk bus. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Gets or sets the disk lun. ,
Format: int32 ,
Required: False ,
}
integer ,
busType:
{
Description: Gets or sets the disk bus type. ,
Required: False ,
}
string ,
vhdType:
{
Description: Gets or sets the disk vhd type. ,
Required: False ,
}
string ,
volumeType:
{
Description: Gets the disk volume type. ,
Required: False ,
}
string ,
vhdFormatType:
{
Description: Gets the disk vhd format type. ,
Required: False ,
}
string ,
templateDiskId:
{
Description: Gets or sets the disk id in the template. ,
Required: False ,
}
string ,
storageQoSPolicy:
{
Description: The QoS policy for the disk. ,
Required: False ,
}
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
}
,
createDiffDisk:
{
Description: Gets or sets a value indicating diff disk. ,
Enum:
{
true: Enable create diff disk. ,
false: Disable create diff disk. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
infrastructureProfile:
{
Description: Gets the infrastructure profile. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
cloudId:
{
Description: ARM Id of the cloud resource to use for deploying the vm. ,
Format: arm-id ,
Required: False ,
}
string ,
templateId:
{
Description: ARM Id of the template resource to use for deploying the vm. ,
Format: arm-id ,
Required: False ,
}
string ,
vmName:
{
Description: VMName is the name of VM on the SCVmm server. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual machine. ,
Required: False ,
}
string ,
lastRestoredVMCheckpoint:
{
Description: Last restored checkpoint in the vm. ,
Required: False ,
}
{
parentCheckpointID:
{
Description: Gets ID of parent of the checkpoint. ,
Required: False ,
}
string ,
checkpointID:
{
Description: Gets ID of the checkpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets name of the checkpoint. ,
Required: False ,
}
string ,
description:
{
Description: Gets description of the checkpoint. ,
Required: False ,
}
string ,
}
,
checkpoints:
{
Description: Checkpoints in the vm. ,
Required: False ,
}
[
{
parentCheckpointID:
{
Description: Gets ID of parent of the checkpoint. ,
Required: False ,
}
string ,
checkpointID:
{
Description: Gets ID of the checkpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets name of the checkpoint. ,
Required: False ,
}
string ,
description:
{
Description: Gets description of the checkpoint. ,
Required: False ,
}
string ,
}
,
]
,
checkpointType:
{
Description: Type of checkpoint supported for the vm. ,
Required: False ,
}
string ,
generation:
{
Description: Gets or sets the generation for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
biosGuid:
{
Description: Gets or sets the bios guid for the vm. ,
Required: False ,
}
string ,
}
,
powerState:
{
Description: Gets the power state of the virtual machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Gets or sets the extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Define the virtualMachineInstance. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
availabilitySets:
{
Description: Availability Sets in vm. ,
Required: False ,
}
[
{
id:
{
Description: Gets the ARM Id of the microsoft.scvmm/availabilitySets resource. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the availability set. ,
Required: False ,
}
string ,
}
,
]
,
osProfile:
{
Description: OS properties. ,
Required: False ,
}
{
adminUsername:
{
Description: Gets or sets the admin username. ,
Required: False ,
}
string ,
adminPassword:
{
Description: Admin password of the virtual machine. ,
Format: password ,
Required: False ,
}
string ,
computerName:
{
Description: Gets or sets computer name. ,
Required: False ,
}
string ,
osType:
{
Description: Gets the type of the os. ,
Enum:
{
Windows: Windows operating system. ,
Linux: Linux operating system. ,
Other: Other operating system. ,
}
,
Required: False ,
}
enum ,
osSku:
{
Description: Gets os sku. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets os version. ,
Required: False ,
}
string ,
domainName:
{
Description: Gets or sets the domain name. ,
Required: False ,
}
string ,
domainUsername:
{
Description: Gets or sets the domain username. ,
Required: False ,
}
string ,
domainPassword:
{
Description: Password of the domain the VM has to join. ,
Format: password ,
Required: False ,
}
string ,
workgroup:
{
Description: Gets or sets the workgroup. ,
Required: False ,
}
string ,
productKey:
{
Description: Gets or sets the product key.Input format xxxxx-xxxxx-xxxxx-xxxxx-xxxxx ,
Format: password ,
Required: False ,
}
string ,
timezone:
{
Description: Gets or sets the index value of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
runOnceCommands:
{
Description: Get or sets the commands to be run once at the time of creation separated by semicolons. ,
Required: False ,
}
string ,
}
,
hardwareProfile:
{
Description: Hardware properties. ,
Required: False ,
}
{
memoryMB:
{
Description: MemoryMB is the size of a virtual machine's memory, in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuCount:
{
Description: Gets or sets the number of vCPUs for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
limitCpuForMigration:
{
Description: Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs. ,
Enum:
{
true: Enable limit CPU for migration. ,
false: Disable limit CPU for migration. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryEnabled:
{
Description: Gets or sets a value indicating whether to enable dynamic memory or not. ,
Enum:
{
true: Enable dynamic memory. ,
false: Disable dynamic memory. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryMaxMB:
{
Description: Gets or sets the max dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
dynamicMemoryMinMB:
{
Description: Gets or sets the min dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
isHighlyAvailable:
{
Description: Gets highly available property. ,
Enum:
{
true: Enable highly available. ,
false: Disable highly available. ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Network properties. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Gets or sets the list of network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the network interface. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set. ,
Required: False ,
}
string ,
ipv4Addresses:
{
Description: Gets the nic ipv4 addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Gets the nic ipv6 addresses. ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: Gets or sets the nic MAC address. ,
Required: False ,
}
string ,
virtualNetworkId:
{
Description: Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Gets the name of the virtual network in vmmServer that the nic is connected to. ,
Required: False ,
}
string ,
ipv4AddressType:
{
Description: Gets or sets the ipv4 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
ipv6AddressType:
{
Description: Gets or sets the ipv6 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
macAddressType:
{
Description: Gets or sets the mac address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
nicId:
{
Description: Gets or sets the nic id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
storageProfile:
{
Description: Storage properties. ,
Required: False ,
}
{
disks:
{
Description: Gets or sets the list of virtual disks associated with the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the disk. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set. ,
Required: False ,
}
string ,
diskId:
{
Description: Gets or sets the disk id. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Gets or sets the disk total size. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDiskSizeGB:
{
Description: Gets the max disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
bus:
{
Description: Gets or sets the disk bus. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Gets or sets the disk lun. ,
Format: int32 ,
Required: False ,
}
integer ,
busType:
{
Description: Gets or sets the disk bus type. ,
Required: False ,
}
string ,
vhdType:
{
Description: Gets or sets the disk vhd type. ,
Required: False ,
}
string ,
volumeType:
{
Description: Gets the disk volume type. ,
Required: False ,
}
string ,
vhdFormatType:
{
Description: Gets the disk vhd format type. ,
Required: False ,
}
string ,
templateDiskId:
{
Description: Gets or sets the disk id in the template. ,
Required: False ,
}
string ,
storageQoSPolicy:
{
Description: The QoS policy for the disk. ,
Required: False ,
}
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
}
,
createDiffDisk:
{
Description: Gets or sets a value indicating diff disk. ,
Enum:
{
true: Enable create diff disk. ,
false: Disable create diff disk. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
infrastructureProfile:
{
Description: Gets the infrastructure profile. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
cloudId:
{
Description: ARM Id of the cloud resource to use for deploying the vm. ,
Format: arm-id ,
Required: False ,
}
string ,
templateId:
{
Description: ARM Id of the template resource to use for deploying the vm. ,
Format: arm-id ,
Required: False ,
}
string ,
vmName:
{
Description: VMName is the name of VM on the SCVmm server. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual machine. ,
Required: False ,
}
string ,
lastRestoredVMCheckpoint:
{
Description: Last restored checkpoint in the vm. ,
Required: False ,
}
{
parentCheckpointID:
{
Description: Gets ID of parent of the checkpoint. ,
Required: False ,
}
string ,
checkpointID:
{
Description: Gets ID of the checkpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets name of the checkpoint. ,
Required: False ,
}
string ,
description:
{
Description: Gets description of the checkpoint. ,
Required: False ,
}
string ,
}
,
checkpoints:
{
Description: Checkpoints in the vm. ,
Required: False ,
}
[
{
parentCheckpointID:
{
Description: Gets ID of parent of the checkpoint. ,
Required: False ,
}
string ,
checkpointID:
{
Description: Gets ID of the checkpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets name of the checkpoint. ,
Required: False ,
}
string ,
description:
{
Description: Gets description of the checkpoint. ,
Required: False ,
}
string ,
}
,
]
,
checkpointType:
{
Description: Type of checkpoint supported for the vm. ,
Required: False ,
}
string ,
generation:
{
Description: Gets or sets the generation for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
biosGuid:
{
Description: Gets or sets the bios guid for the vm. ,
Required: False ,
}
string ,
}
,
powerState:
{
Description: Gets the power state of the virtual machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Gets or sets the extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_Update (new)
Description :  The operation to update a virtual machine instance.
Reference :  Link ¶

⚼ Request

PATCH:  /{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The update properties of the VirtualMachineInstance. ,
Required: False ,
}
{
availabilitySets:
{
Description: Availability Sets in vm. ,
Required: False ,
}
[
{
id:
{
Description: Gets the ARM Id of the microsoft.scvmm/availabilitySets resource. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the availability set. ,
Required: False ,
}
string ,
}
,
]
,
hardwareProfile:
{
Description: Hardware properties. ,
Required: False ,
}
{
memoryMB:
{
Description: MemoryMB is the size of a virtual machine's memory, in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuCount:
{
Description: Gets or sets the number of vCPUs for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
limitCpuForMigration:
{
Description: Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs. ,
Enum:
{
true: Enable limit CPU for migration. ,
false: Disable limit CPU for migration. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryEnabled:
{
Description: Gets or sets a value indicating whether to enable dynamic memory or not. ,
Enum:
{
true: Enable dynamic memory. ,
false: Disable dynamic memory. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryMaxMB:
{
Description: Gets or sets the max dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
dynamicMemoryMinMB:
{
Description: Gets or sets the min dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
networkProfile:
{
Description: Network properties. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Gets or sets the list of network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the network interface. ,
Required: False ,
}
string ,
macAddress:
{
Description: Gets or sets the nic MAC address. ,
Required: False ,
}
string ,
virtualNetworkId:
{
Description: Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. ,
Format: arm-id ,
Required: False ,
}
string ,
ipv4AddressType:
{
Description: Gets or sets the ipv4 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
ipv6AddressType:
{
Description: Gets or sets the ipv6 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
macAddressType:
{
Description: Gets or sets the mac address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
nicId:
{
Description: Gets or sets the nic id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
storageProfile:
{
Description: Storage properties. ,
Required: False ,
}
{
disks:
{
Description: Gets or sets the list of virtual disks associated with the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the disk. ,
Required: False ,
}
string ,
diskId:
{
Description: Gets or sets the disk id. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Gets or sets the disk total size. ,
Format: int32 ,
Required: False ,
}
integer ,
bus:
{
Description: Gets or sets the disk bus. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Gets or sets the disk lun. ,
Format: int32 ,
Required: False ,
}
integer ,
busType:
{
Description: Gets or sets the disk bus type. ,
Required: False ,
}
string ,
vhdType:
{
Description: Gets or sets the disk vhd type. ,
Required: False ,
}
string ,
storageQoSPolicy:
{
Description: The QoS policy for the disk. ,
Required: False ,
}
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
infrastructureProfile:
{
Description: Gets the infrastructure profile. ,
Required: False ,
}
{
checkpointType:
{
Description: Type of checkpoint supported for the vm. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
availabilitySets:
{
Description: Availability Sets in vm. ,
Required: False ,
}
[
{
id:
{
Description: Gets the ARM Id of the microsoft.scvmm/availabilitySets resource. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Gets or sets the name of the availability set. ,
Required: False ,
}
string ,
}
,
]
,
osProfile:
{
Description: OS properties. ,
Required: False ,
}
{
adminUsername:
{
Description: Gets or sets the admin username. ,
Required: False ,
}
string ,
adminPassword:
{
Description: Admin password of the virtual machine. ,
Format: password ,
Required: False ,
}
string ,
computerName:
{
Description: Gets or sets computer name. ,
Required: False ,
}
string ,
osType:
{
Description: Gets the type of the os. ,
Enum:
{
Windows: Windows operating system. ,
Linux: Linux operating system. ,
Other: Other operating system. ,
}
,
Required: False ,
}
enum ,
osSku:
{
Description: Gets os sku. ,
Required: False ,
}
string ,
osVersion:
{
Description: Gets os version. ,
Required: False ,
}
string ,
domainName:
{
Description: Gets or sets the domain name. ,
Required: False ,
}
string ,
domainUsername:
{
Description: Gets or sets the domain username. ,
Required: False ,
}
string ,
domainPassword:
{
Description: Password of the domain the VM has to join. ,
Format: password ,
Required: False ,
}
string ,
workgroup:
{
Description: Gets or sets the workgroup. ,
Required: False ,
}
string ,
productKey:
{
Description: Gets or sets the product key.Input format xxxxx-xxxxx-xxxxx-xxxxx-xxxxx ,
Format: password ,
Required: False ,
}
string ,
timezone:
{
Description: Gets or sets the index value of the timezone. ,
Format: int32 ,
Required: False ,
}
integer ,
runOnceCommands:
{
Description: Get or sets the commands to be run once at the time of creation separated by semicolons. ,
Required: False ,
}
string ,
}
,
hardwareProfile:
{
Description: Hardware properties. ,
Required: False ,
}
{
memoryMB:
{
Description: MemoryMB is the size of a virtual machine's memory, in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuCount:
{
Description: Gets or sets the number of vCPUs for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
limitCpuForMigration:
{
Description: Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs. ,
Enum:
{
true: Enable limit CPU for migration. ,
false: Disable limit CPU for migration. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryEnabled:
{
Description: Gets or sets a value indicating whether to enable dynamic memory or not. ,
Enum:
{
true: Enable dynamic memory. ,
false: Disable dynamic memory. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryMaxMB:
{
Description: Gets or sets the max dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
dynamicMemoryMinMB:
{
Description: Gets or sets the min dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
isHighlyAvailable:
{
Description: Gets highly available property. ,
Enum:
{
true: Enable highly available. ,
false: Disable highly available. ,
}
,
Required: False ,
}
enum ,
}
,
networkProfile:
{
Description: Network properties. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Gets or sets the list of network interfaces associated with the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the network interface. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set. ,
Required: False ,
}
string ,
ipv4Addresses:
{
Description: Gets the nic ipv4 addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Gets the nic ipv6 addresses. ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: Gets or sets the nic MAC address. ,
Required: False ,
}
string ,
virtualNetworkId:
{
Description: Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Gets the name of the virtual network in vmmServer that the nic is connected to. ,
Required: False ,
}
string ,
ipv4AddressType:
{
Description: Gets or sets the ipv4 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
ipv6AddressType:
{
Description: Gets or sets the ipv6 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
macAddressType:
{
Description: Gets or sets the mac address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
nicId:
{
Description: Gets or sets the nic id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
storageProfile:
{
Description: Storage properties. ,
Required: False ,
}
{
disks:
{
Description: Gets or sets the list of virtual disks associated with the virtual machine. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the disk. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set. ,
Required: False ,
}
string ,
diskId:
{
Description: Gets or sets the disk id. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Gets or sets the disk total size. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDiskSizeGB:
{
Description: Gets the max disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
bus:
{
Description: Gets or sets the disk bus. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Gets or sets the disk lun. ,
Format: int32 ,
Required: False ,
}
integer ,
busType:
{
Description: Gets or sets the disk bus type. ,
Required: False ,
}
string ,
vhdType:
{
Description: Gets or sets the disk vhd type. ,
Required: False ,
}
string ,
volumeType:
{
Description: Gets the disk volume type. ,
Required: False ,
}
string ,
vhdFormatType:
{
Description: Gets the disk vhd format type. ,
Required: False ,
}
string ,
templateDiskId:
{
Description: Gets or sets the disk id in the template. ,
Required: False ,
}
string ,
storageQoSPolicy:
{
Description: The QoS policy for the disk. ,
Required: False ,
}
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
}
,
createDiffDisk:
{
Description: Gets or sets a value indicating diff disk. ,
Enum:
{
true: Enable create diff disk. ,
false: Disable create diff disk. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
infrastructureProfile:
{
Description: Gets the infrastructure profile. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
cloudId:
{
Description: ARM Id of the cloud resource to use for deploying the vm. ,
Format: arm-id ,
Required: False ,
}
string ,
templateId:
{
Description: ARM Id of the template resource to use for deploying the vm. ,
Format: arm-id ,
Required: False ,
}
string ,
vmName:
{
Description: VMName is the name of VM on the SCVmm server. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual machine. ,
Required: False ,
}
string ,
lastRestoredVMCheckpoint:
{
Description: Last restored checkpoint in the vm. ,
Required: False ,
}
{
parentCheckpointID:
{
Description: Gets ID of parent of the checkpoint. ,
Required: False ,
}
string ,
checkpointID:
{
Description: Gets ID of the checkpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets name of the checkpoint. ,
Required: False ,
}
string ,
description:
{
Description: Gets description of the checkpoint. ,
Required: False ,
}
string ,
}
,
checkpoints:
{
Description: Checkpoints in the vm. ,
Required: False ,
}
[
{
parentCheckpointID:
{
Description: Gets ID of parent of the checkpoint. ,
Required: False ,
}
string ,
checkpointID:
{
Description: Gets ID of the checkpoint. ,
Required: False ,
}
string ,
name:
{
Description: Gets name of the checkpoint. ,
Required: False ,
}
string ,
description:
{
Description: Gets description of the checkpoint. ,
Required: False ,
}
string ,
}
,
]
,
checkpointType:
{
Description: Type of checkpoint supported for the vm. ,
Required: False ,
}
string ,
generation:
{
Description: Gets or sets the generation for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
biosGuid:
{
Description: Gets or sets the bios guid for the vm. ,
Required: False ,
}
string ,
}
,
powerState:
{
Description: Gets the power state of the virtual machine. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Gets or sets the extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_Delete (new)
Description :  The operation to delete a virtual machine instance.
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
force:
{
Description: Forces the resource to be deleted. ,
Required: False ,
}
string ,
deleteFromHost:
{
Description: Whether to disable the VM from azure and also delete it from Vmm. ,
Required: False ,
}
string ,
}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_CreateCheckpoint (new)
Description :  Creates a checkpoint in virtual machine instance.
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/createCheckpoint
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
name:
{
Description: Name of the checkpoint. ,
Required: False ,
}
string ,
description:
{
Description: Description of the checkpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_DeleteCheckpoint (new)
Description :  Deletes a checkpoint in virtual machine instance.
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/deleteCheckpoint
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
id:
{
Description: ID of the checkpoint to be deleted. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestAgents_ListByVirtualMachineInstance (new)
Description :  Returns the list of GuestAgent of the given vm.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The GuestAgent items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Gets a unique identifier for this resource. ,
Required: False ,
}
string ,
credentials:
{
Description: Username / Password Credentials to provision guest agent. ,
Required: False ,
}
{
username:
{
Description: Gets or sets username to connect with the guest. ,
Required: True ,
}
string ,
password:
{
Description: Gets or sets the password to connect with the guest. ,
Format: password ,
Required: True ,
}
string ,
}
,
httpProxyConfig:
{
Description: HTTP Proxy configuration for the VM. ,
Required: False ,
}
{
httpsProxy:
{
Description: Gets or sets httpsProxy url. ,
Required: False ,
}
string ,
}
,
provisioningAction:
{
Description: Gets or sets the guest agent provisioning action. ,
Enum:
{
install: Install guest agent. ,
uninstall: Uninstall guest agent. ,
repair: Repair guest agent. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the guest agent status. ,
Required: False ,
}
string ,
customResourceName:
{
Description: Gets the name of the corresponding resource in Kubernetes. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestAgents_Get (new)
Description :  Implements GuestAgent GET method.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Gets a unique identifier for this resource. ,
Required: False ,
}
string ,
credentials:
{
Description: Username / Password Credentials to provision guest agent. ,
Required: False ,
}
{
username:
{
Description: Gets or sets username to connect with the guest. ,
Required: True ,
}
string ,
password:
{
Description: Gets or sets the password to connect with the guest. ,
Format: password ,
Required: True ,
}
string ,
}
,
httpProxyConfig:
{
Description: HTTP Proxy configuration for the VM. ,
Required: False ,
}
{
httpsProxy:
{
Description: Gets or sets httpsProxy url. ,
Required: False ,
}
string ,
}
,
provisioningAction:
{
Description: Gets or sets the guest agent provisioning action. ,
Enum:
{
install: Install guest agent. ,
uninstall: Uninstall guest agent. ,
repair: Repair guest agent. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the guest agent status. ,
Required: False ,
}
string ,
customResourceName:
{
Description: Gets the name of the corresponding resource in Kubernetes. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Gets a unique identifier for this resource. ,
Required: False ,
}
string ,
credentials:
{
Description: Username / Password Credentials to provision guest agent. ,
Required: False ,
}
{
username:
{
Description: Gets or sets username to connect with the guest. ,
Required: True ,
}
string ,
password:
{
Description: Gets or sets the password to connect with the guest. ,
Format: password ,
Required: True ,
}
string ,
}
,
httpProxyConfig:
{
Description: HTTP Proxy configuration for the VM. ,
Required: False ,
}
{
httpsProxy:
{
Description: Gets or sets httpsProxy url. ,
Required: False ,
}
string ,
}
,
provisioningAction:
{
Description: Gets or sets the guest agent provisioning action. ,
Enum:
{
install: Install guest agent. ,
uninstall: Uninstall guest agent. ,
repair: Repair guest agent. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the guest agent status. ,
Required: False ,
}
string ,
customResourceName:
{
Description: Gets the name of the corresponding resource in Kubernetes. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Gets a unique identifier for this resource. ,
Required: False ,
}
string ,
credentials:
{
Description: Username / Password Credentials to provision guest agent. ,
Required: False ,
}
{
username:
{
Description: Gets or sets username to connect with the guest. ,
Required: True ,
}
string ,
password:
{
Description: Gets or sets the password to connect with the guest. ,
Format: password ,
Required: True ,
}
string ,
}
,
httpProxyConfig:
{
Description: HTTP Proxy configuration for the VM. ,
Required: False ,
}
{
httpsProxy:
{
Description: Gets or sets httpsProxy url. ,
Required: False ,
}
string ,
}
,
provisioningAction:
{
Description: Gets or sets the guest agent provisioning action. ,
Enum:
{
install: Install guest agent. ,
uninstall: Uninstall guest agent. ,
repair: Repair guest agent. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the guest agent status. ,
Required: False ,
}
string ,
customResourceName:
{
Description: Gets the name of the corresponding resource in Kubernetes. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Defines the GuestAgent. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Gets a unique identifier for this resource. ,
Required: False ,
}
string ,
credentials:
{
Description: Username / Password Credentials to provision guest agent. ,
Required: False ,
}
{
username:
{
Description: Gets or sets username to connect with the guest. ,
Required: True ,
}
string ,
password:
{
Description: Gets or sets the password to connect with the guest. ,
Format: password ,
Required: True ,
}
string ,
}
,
httpProxyConfig:
{
Description: HTTP Proxy configuration for the VM. ,
Required: False ,
}
{
httpsProxy:
{
Description: Gets or sets httpsProxy url. ,
Required: False ,
}
string ,
}
,
provisioningAction:
{
Description: Gets or sets the guest agent provisioning action. ,
Enum:
{
install: Install guest agent. ,
uninstall: Uninstall guest agent. ,
repair: Repair guest agent. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the guest agent status. ,
Required: False ,
}
string ,
customResourceName:
{
Description: Gets the name of the corresponding resource in Kubernetes. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
privateLinkScopeResourceId:
{
Description: The resource id of the private link scope this machine is assigned to, if any. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GuestAgents_Delete (new)
Description :  Implements GuestAgent DELETE method.
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VmInstanceHybridIdentityMetadatas_ListByVirtualMachineInstance (new)
Description :  Returns the list of HybridIdentityMetadata of the given VM.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The VmInstanceHybridIdentityMetadata items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
resourceUid:
{
Description: The unique identifier for the resource. ,
Required: False ,
}
string ,
publicKey:
{
Description: Gets or sets the Public Key. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VmInstanceHybridIdentityMetadatas_Get (new)
Description :  Implements HybridIdentityMetadata GET method.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/hybridIdentityMetadata/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
resourceUid:
{
Description: The unique identifier for the resource. ,
Required: False ,
}
string ,
publicKey:
{
Description: Gets or sets the Public Key. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_Restart (new)
Description :  The operation to restart a virtual machine instance.
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/restart
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_RestoreCheckpoint (new)
Description :  Restores to a checkpoint in virtual machine instance.
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/restoreCheckpoint
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
id:
{
Description: ID of the checkpoint to be restored to. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_Start (new)
Description :  The operation to start a virtual machine instance.
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/start
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineInstances_Stop (new)
Description :  The operation to power off (stop) a virtual machine instance.
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/stop
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: False ,
}
{
skipShutdown:
{
Description: Gets or sets a value indicating whether to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Defaults to false. ,
Enum:
{
true: Enable skip shutdown. ,
false: Disable skip shutdown. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvailabilitySets_ListBySubscription (new)
Description :  List of AvailabilitySets in a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The AvailabilitySet items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
availabilitySetName:
{
Description: Name of the availability set. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clouds_ListBySubscription (new)
Description :  List of Clouds in a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The Cloud items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the cloud. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
cloudName:
{
Description: Name of the cloud in VmmServer. ,
Required: False ,
}
string ,
cloudCapacity:
{
Description: Capacity of the cloud. ,
Required: False ,
}
{
cpuCount:
{
Description: CPUCount specifies the maximum number of CPUs that can be allocated in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
memoryMB:
{
Description: MemoryMB specifies a memory usage limit in megabytes. ,
Format: int64 ,
Required: False ,
}
integer ,
vmCount:
{
Description: VMCount gives the max number of VMs that can be deployed in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
storageGB:
{
Description: StorageGB gives the storage in GB present in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
storageQoSPolicies:
{
Description: List of QoS policies available for the cloud. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
iopsMaximum:
{
Description: The maximum IO operations per second. ,
Format: int64 ,
Required: False ,
}
integer ,
iopsMinimum:
{
Description: The minimum IO operations per second. ,
Format: int64 ,
Required: False ,
}
integer ,
bandwidthLimit:
{
Description: The Bandwidth Limit for internet traffic. ,
Format: int64 ,
Required: False ,
}
integer ,
policyId:
{
Description: The underlying policy. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineTemplates_ListBySubscription (new)
Description :  List of VirtualMachineTemplates in a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The VirtualMachineTemplate items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual machine template. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: Gets the type of the os. ,
Enum:
{
Windows: Windows operating system. ,
Linux: Linux operating system. ,
Other: Other operating system. ,
}
,
Required: False ,
}
enum ,
osName:
{
Description: Gets os name. ,
Required: False ,
}
string ,
computerName:
{
Description: Gets computer name. ,
Required: False ,
}
string ,
memoryMB:
{
Description: MemoryMB is the desired size of a virtual machine's memory, in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuCount:
{
Description: Gets the desired number of vCPUs for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
limitCpuForMigration:
{
Description: Gets a value indicating whether to enable processor compatibility mode for live migration of VMs. ,
Enum:
{
true: Enable limit CPU for migration. ,
false: Disable limit CPU for migration. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryEnabled:
{
Description: Gets a value indicating whether to enable dynamic memory or not. ,
Enum:
{
true: Enable dynamic memory. ,
false: Disable dynamic memory. ,
}
,
Required: False ,
}
enum ,
isCustomizable:
{
Description: Gets a value indicating whether the vm template is customizable or not. ,
Enum:
{
true: Enable customizable. ,
false: Disable customizable. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryMaxMB:
{
Description: Gets the max dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
dynamicMemoryMinMB:
{
Description: Gets the min dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
isHighlyAvailable:
{
Description: Gets highly available property. ,
Enum:
{
true: Enable highly available. ,
false: Disable highly available. ,
}
,
Required: False ,
}
enum ,
generation:
{
Description: Gets the generation for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
networkInterfaces:
{
Description: Gets the network interfaces of the template. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the network interface. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set. ,
Required: False ,
}
string ,
ipv4Addresses:
{
Description: Gets the nic ipv4 addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Gets the nic ipv6 addresses. ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: Gets or sets the nic MAC address. ,
Required: False ,
}
string ,
virtualNetworkId:
{
Description: Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Gets the name of the virtual network in vmmServer that the nic is connected to. ,
Required: False ,
}
string ,
ipv4AddressType:
{
Description: Gets or sets the ipv4 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
ipv6AddressType:
{
Description: Gets or sets the ipv6 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
macAddressType:
{
Description: Gets or sets the mac address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
nicId:
{
Description: Gets or sets the nic id. ,
Required: False ,
}
string ,
}
,
]
,
disks:
{
Description: Gets the disks of the template. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the disk. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set. ,
Required: False ,
}
string ,
diskId:
{
Description: Gets or sets the disk id. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Gets or sets the disk total size. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDiskSizeGB:
{
Description: Gets the max disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
bus:
{
Description: Gets or sets the disk bus. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Gets or sets the disk lun. ,
Format: int32 ,
Required: False ,
}
integer ,
busType:
{
Description: Gets or sets the disk bus type. ,
Required: False ,
}
string ,
vhdType:
{
Description: Gets or sets the disk vhd type. ,
Required: False ,
}
string ,
volumeType:
{
Description: Gets the disk volume type. ,
Required: False ,
}
string ,
vhdFormatType:
{
Description: Gets the disk vhd format type. ,
Required: False ,
}
string ,
templateDiskId:
{
Description: Gets or sets the disk id in the template. ,
Required: False ,
}
string ,
storageQoSPolicy:
{
Description: The QoS policy for the disk. ,
Required: False ,
}
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
}
,
createDiffDisk:
{
Description: Gets or sets a value indicating diff disk. ,
Enum:
{
true: Enable create diff disk. ,
false: Disable create diff disk. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworks_ListBySubscription (new)
Description :  List of VirtualNetworks in a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The VirtualNetwork items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual network. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Name of the virtual network in vmmServer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VmmServers_ListBySubscription (new)
Description :  List of VmmServers in a subscription.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The VmmServer items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
credentials:
{
Description: Credentials to connect to VmmServer. ,
Required: False ,
}
{
username:
{
Description: Username to use to connect to VmmServer. ,
Required: False ,
}
string ,
password:
{
Description: Password to use to connect to VmmServer. ,
Format: password ,
Required: False ,
}
string ,
}
,
fqdn:
{
Description: Fqdn is the hostname/ip of the vmmServer. ,
Required: True ,
}
string ,
port:
{
Description: Port is the port on which the vmmServer is listening. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionStatus:
{
Description: Gets the connection status to the vmmServer. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Gets any error message if connection to vmmServer is having any issue. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of vmmServer. ,
Required: False ,
}
string ,
version:
{
Description: Version is the version of the vmmSever. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvailabilitySets_ListByResourceGroup (new)
Description :  List of AvailabilitySets in a resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The AvailabilitySet items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
availabilitySetName:
{
Description: Name of the availability set. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvailabilitySets_Get (new)
Description :  Implements AvailabilitySet GET method.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
availabilitySetName:
{
Description: Name of the availability set. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvailabilitySets_CreateOrUpdate (new)
Description :  Onboards the ScVmm availability set as an Azure resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/availabilitySets/{availabilitySetResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
availabilitySetResourceName:
{
Description: Name of the AvailabilitySet. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
availabilitySetName:
{
Description: Name of the availability set. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
availabilitySetName:
{
Description: Name of the availability set. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The AvailabilitySets resource definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
availabilitySetName:
{
Description: Name of the availability set. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvailabilitySets_Update (new)
Description :  Updates the AvailabilitySets resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/availabilitySets/{availabilitySetResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
availabilitySetResourceName:
{
Description: Name of the AvailabilitySet. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
availabilitySetName:
{
Description: Name of the availability set. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AvailabilitySets_Delete (new)
Description :  Deregisters the ScVmm availability set from Azure.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/availabilitySets/{availabilitySetResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
force:
{
Description: Forces the resource to be deleted. ,
Required: False ,
}
string ,
availabilitySetResourceName:
{
Description: Name of the AvailabilitySet. ,
Required: True ,
}
string ,
}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clouds_ListByResourceGroup (new)
Description :  List of Clouds in a resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The Cloud items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the cloud. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
cloudName:
{
Description: Name of the cloud in VmmServer. ,
Required: False ,
}
string ,
cloudCapacity:
{
Description: Capacity of the cloud. ,
Required: False ,
}
{
cpuCount:
{
Description: CPUCount specifies the maximum number of CPUs that can be allocated in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
memoryMB:
{
Description: MemoryMB specifies a memory usage limit in megabytes. ,
Format: int64 ,
Required: False ,
}
integer ,
vmCount:
{
Description: VMCount gives the max number of VMs that can be deployed in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
storageGB:
{
Description: StorageGB gives the storage in GB present in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
storageQoSPolicies:
{
Description: List of QoS policies available for the cloud. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
iopsMaximum:
{
Description: The maximum IO operations per second. ,
Format: int64 ,
Required: False ,
}
integer ,
iopsMinimum:
{
Description: The minimum IO operations per second. ,
Format: int64 ,
Required: False ,
}
integer ,
bandwidthLimit:
{
Description: The Bandwidth Limit for internet traffic. ,
Format: int64 ,
Required: False ,
}
integer ,
policyId:
{
Description: The underlying policy. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clouds_Get (new)
Description :  Implements Cloud GET method.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the cloud. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
cloudName:
{
Description: Name of the cloud in VmmServer. ,
Required: False ,
}
string ,
cloudCapacity:
{
Description: Capacity of the cloud. ,
Required: False ,
}
{
cpuCount:
{
Description: CPUCount specifies the maximum number of CPUs that can be allocated in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
memoryMB:
{
Description: MemoryMB specifies a memory usage limit in megabytes. ,
Format: int64 ,
Required: False ,
}
integer ,
vmCount:
{
Description: VMCount gives the max number of VMs that can be deployed in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
storageGB:
{
Description: StorageGB gives the storage in GB present in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
storageQoSPolicies:
{
Description: List of QoS policies available for the cloud. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
iopsMaximum:
{
Description: The maximum IO operations per second. ,
Format: int64 ,
Required: False ,
}
integer ,
iopsMinimum:
{
Description: The minimum IO operations per second. ,
Format: int64 ,
Required: False ,
}
integer ,
bandwidthLimit:
{
Description: The Bandwidth Limit for internet traffic. ,
Format: int64 ,
Required: False ,
}
integer ,
policyId:
{
Description: The underlying policy. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clouds_CreateOrUpdate (new)
Description :  Onboards the ScVmm fabric cloud as an Azure cloud resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/clouds/{cloudResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudResourceName:
{
Description: Name of the Cloud. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the cloud. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
cloudName:
{
Description: Name of the cloud in VmmServer. ,
Required: False ,
}
string ,
cloudCapacity:
{
Description: Capacity of the cloud. ,
Required: False ,
}
{
cpuCount:
{
Description: CPUCount specifies the maximum number of CPUs that can be allocated in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
memoryMB:
{
Description: MemoryMB specifies a memory usage limit in megabytes. ,
Format: int64 ,
Required: False ,
}
integer ,
vmCount:
{
Description: VMCount gives the max number of VMs that can be deployed in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
storageGB:
{
Description: StorageGB gives the storage in GB present in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
storageQoSPolicies:
{
Description: List of QoS policies available for the cloud. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
iopsMaximum:
{
Description: The maximum IO operations per second. ,
Format: int64 ,
Required: False ,
}
integer ,
iopsMinimum:
{
Description: The minimum IO operations per second. ,
Format: int64 ,
Required: False ,
}
integer ,
bandwidthLimit:
{
Description: The Bandwidth Limit for internet traffic. ,
Format: int64 ,
Required: False ,
}
integer ,
policyId:
{
Description: The underlying policy. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the cloud. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
cloudName:
{
Description: Name of the cloud in VmmServer. ,
Required: False ,
}
string ,
cloudCapacity:
{
Description: Capacity of the cloud. ,
Required: False ,
}
{
cpuCount:
{
Description: CPUCount specifies the maximum number of CPUs that can be allocated in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
memoryMB:
{
Description: MemoryMB specifies a memory usage limit in megabytes. ,
Format: int64 ,
Required: False ,
}
integer ,
vmCount:
{
Description: VMCount gives the max number of VMs that can be deployed in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
storageGB:
{
Description: StorageGB gives the storage in GB present in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
storageQoSPolicies:
{
Description: List of QoS policies available for the cloud. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
iopsMaximum:
{
Description: The maximum IO operations per second. ,
Format: int64 ,
Required: False ,
}
integer ,
iopsMinimum:
{
Description: The minimum IO operations per second. ,
Format: int64 ,
Required: False ,
}
integer ,
bandwidthLimit:
{
Description: The Bandwidth Limit for internet traffic. ,
Format: int64 ,
Required: False ,
}
integer ,
policyId:
{
Description: The underlying policy. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Clouds resource definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the cloud. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
cloudName:
{
Description: Name of the cloud in VmmServer. ,
Required: False ,
}
string ,
cloudCapacity:
{
Description: Capacity of the cloud. ,
Required: False ,
}
{
cpuCount:
{
Description: CPUCount specifies the maximum number of CPUs that can be allocated in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
memoryMB:
{
Description: MemoryMB specifies a memory usage limit in megabytes. ,
Format: int64 ,
Required: False ,
}
integer ,
vmCount:
{
Description: VMCount gives the max number of VMs that can be deployed in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
storageGB:
{
Description: StorageGB gives the storage in GB present in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
storageQoSPolicies:
{
Description: List of QoS policies available for the cloud. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
iopsMaximum:
{
Description: The maximum IO operations per second. ,
Format: int64 ,
Required: False ,
}
integer ,
iopsMinimum:
{
Description: The minimum IO operations per second. ,
Format: int64 ,
Required: False ,
}
integer ,
bandwidthLimit:
{
Description: The Bandwidth Limit for internet traffic. ,
Format: int64 ,
Required: False ,
}
integer ,
policyId:
{
Description: The underlying policy. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clouds_Update (new)
Description :  Updates the Clouds resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/clouds/{cloudResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudResourceName:
{
Description: Name of the Cloud. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the cloud. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
cloudName:
{
Description: Name of the cloud in VmmServer. ,
Required: False ,
}
string ,
cloudCapacity:
{
Description: Capacity of the cloud. ,
Required: False ,
}
{
cpuCount:
{
Description: CPUCount specifies the maximum number of CPUs that can be allocated in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
memoryMB:
{
Description: MemoryMB specifies a memory usage limit in megabytes. ,
Format: int64 ,
Required: False ,
}
integer ,
vmCount:
{
Description: VMCount gives the max number of VMs that can be deployed in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
storageGB:
{
Description: StorageGB gives the storage in GB present in the cloud. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
storageQoSPolicies:
{
Description: List of QoS policies available for the cloud. ,
Required: False ,
}
[
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
iopsMaximum:
{
Description: The maximum IO operations per second. ,
Format: int64 ,
Required: False ,
}
integer ,
iopsMinimum:
{
Description: The minimum IO operations per second. ,
Format: int64 ,
Required: False ,
}
integer ,
bandwidthLimit:
{
Description: The Bandwidth Limit for internet traffic. ,
Format: int64 ,
Required: False ,
}
integer ,
policyId:
{
Description: The underlying policy. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clouds_Delete (new)
Description :  Deregisters the ScVmm fabric cloud from Azure.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/clouds/{cloudResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
force:
{
Description: Forces the resource to be deleted. ,
Required: False ,
}
string ,
cloudResourceName:
{
Description: Name of the Cloud. ,
Required: True ,
}
string ,
}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineTemplates_ListByResourceGroup (new)
Description :  List of VirtualMachineTemplates in a resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The VirtualMachineTemplate items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual machine template. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: Gets the type of the os. ,
Enum:
{
Windows: Windows operating system. ,
Linux: Linux operating system. ,
Other: Other operating system. ,
}
,
Required: False ,
}
enum ,
osName:
{
Description: Gets os name. ,
Required: False ,
}
string ,
computerName:
{
Description: Gets computer name. ,
Required: False ,
}
string ,
memoryMB:
{
Description: MemoryMB is the desired size of a virtual machine's memory, in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuCount:
{
Description: Gets the desired number of vCPUs for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
limitCpuForMigration:
{
Description: Gets a value indicating whether to enable processor compatibility mode for live migration of VMs. ,
Enum:
{
true: Enable limit CPU for migration. ,
false: Disable limit CPU for migration. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryEnabled:
{
Description: Gets a value indicating whether to enable dynamic memory or not. ,
Enum:
{
true: Enable dynamic memory. ,
false: Disable dynamic memory. ,
}
,
Required: False ,
}
enum ,
isCustomizable:
{
Description: Gets a value indicating whether the vm template is customizable or not. ,
Enum:
{
true: Enable customizable. ,
false: Disable customizable. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryMaxMB:
{
Description: Gets the max dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
dynamicMemoryMinMB:
{
Description: Gets the min dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
isHighlyAvailable:
{
Description: Gets highly available property. ,
Enum:
{
true: Enable highly available. ,
false: Disable highly available. ,
}
,
Required: False ,
}
enum ,
generation:
{
Description: Gets the generation for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
networkInterfaces:
{
Description: Gets the network interfaces of the template. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the network interface. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set. ,
Required: False ,
}
string ,
ipv4Addresses:
{
Description: Gets the nic ipv4 addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Gets the nic ipv6 addresses. ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: Gets or sets the nic MAC address. ,
Required: False ,
}
string ,
virtualNetworkId:
{
Description: Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Gets the name of the virtual network in vmmServer that the nic is connected to. ,
Required: False ,
}
string ,
ipv4AddressType:
{
Description: Gets or sets the ipv4 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
ipv6AddressType:
{
Description: Gets or sets the ipv6 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
macAddressType:
{
Description: Gets or sets the mac address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
nicId:
{
Description: Gets or sets the nic id. ,
Required: False ,
}
string ,
}
,
]
,
disks:
{
Description: Gets the disks of the template. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the disk. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set. ,
Required: False ,
}
string ,
diskId:
{
Description: Gets or sets the disk id. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Gets or sets the disk total size. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDiskSizeGB:
{
Description: Gets the max disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
bus:
{
Description: Gets or sets the disk bus. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Gets or sets the disk lun. ,
Format: int32 ,
Required: False ,
}
integer ,
busType:
{
Description: Gets or sets the disk bus type. ,
Required: False ,
}
string ,
vhdType:
{
Description: Gets or sets the disk vhd type. ,
Required: False ,
}
string ,
volumeType:
{
Description: Gets the disk volume type. ,
Required: False ,
}
string ,
vhdFormatType:
{
Description: Gets the disk vhd format type. ,
Required: False ,
}
string ,
templateDiskId:
{
Description: Gets or sets the disk id in the template. ,
Required: False ,
}
string ,
storageQoSPolicy:
{
Description: The QoS policy for the disk. ,
Required: False ,
}
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
}
,
createDiffDisk:
{
Description: Gets or sets a value indicating diff disk. ,
Enum:
{
true: Enable create diff disk. ,
false: Disable create diff disk. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineTemplates_Get (new)
Description :  Implements VirtualMachineTemplate GET method.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual machine template. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: Gets the type of the os. ,
Enum:
{
Windows: Windows operating system. ,
Linux: Linux operating system. ,
Other: Other operating system. ,
}
,
Required: False ,
}
enum ,
osName:
{
Description: Gets os name. ,
Required: False ,
}
string ,
computerName:
{
Description: Gets computer name. ,
Required: False ,
}
string ,
memoryMB:
{
Description: MemoryMB is the desired size of a virtual machine's memory, in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuCount:
{
Description: Gets the desired number of vCPUs for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
limitCpuForMigration:
{
Description: Gets a value indicating whether to enable processor compatibility mode for live migration of VMs. ,
Enum:
{
true: Enable limit CPU for migration. ,
false: Disable limit CPU for migration. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryEnabled:
{
Description: Gets a value indicating whether to enable dynamic memory or not. ,
Enum:
{
true: Enable dynamic memory. ,
false: Disable dynamic memory. ,
}
,
Required: False ,
}
enum ,
isCustomizable:
{
Description: Gets a value indicating whether the vm template is customizable or not. ,
Enum:
{
true: Enable customizable. ,
false: Disable customizable. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryMaxMB:
{
Description: Gets the max dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
dynamicMemoryMinMB:
{
Description: Gets the min dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
isHighlyAvailable:
{
Description: Gets highly available property. ,
Enum:
{
true: Enable highly available. ,
false: Disable highly available. ,
}
,
Required: False ,
}
enum ,
generation:
{
Description: Gets the generation for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
networkInterfaces:
{
Description: Gets the network interfaces of the template. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the network interface. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set. ,
Required: False ,
}
string ,
ipv4Addresses:
{
Description: Gets the nic ipv4 addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Gets the nic ipv6 addresses. ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: Gets or sets the nic MAC address. ,
Required: False ,
}
string ,
virtualNetworkId:
{
Description: Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Gets the name of the virtual network in vmmServer that the nic is connected to. ,
Required: False ,
}
string ,
ipv4AddressType:
{
Description: Gets or sets the ipv4 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
ipv6AddressType:
{
Description: Gets or sets the ipv6 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
macAddressType:
{
Description: Gets or sets the mac address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
nicId:
{
Description: Gets or sets the nic id. ,
Required: False ,
}
string ,
}
,
]
,
disks:
{
Description: Gets the disks of the template. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the disk. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set. ,
Required: False ,
}
string ,
diskId:
{
Description: Gets or sets the disk id. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Gets or sets the disk total size. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDiskSizeGB:
{
Description: Gets the max disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
bus:
{
Description: Gets or sets the disk bus. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Gets or sets the disk lun. ,
Format: int32 ,
Required: False ,
}
integer ,
busType:
{
Description: Gets or sets the disk bus type. ,
Required: False ,
}
string ,
vhdType:
{
Description: Gets or sets the disk vhd type. ,
Required: False ,
}
string ,
volumeType:
{
Description: Gets the disk volume type. ,
Required: False ,
}
string ,
vhdFormatType:
{
Description: Gets the disk vhd format type. ,
Required: False ,
}
string ,
templateDiskId:
{
Description: Gets or sets the disk id in the template. ,
Required: False ,
}
string ,
storageQoSPolicy:
{
Description: The QoS policy for the disk. ,
Required: False ,
}
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
}
,
createDiffDisk:
{
Description: Gets or sets a value indicating diff disk. ,
Enum:
{
true: Enable create diff disk. ,
false: Disable create diff disk. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineTemplates_CreateOrUpdate (new)
Description :  Onboards the ScVmm VM Template as an Azure VM Template resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachineTemplates/{virtualMachineTemplateName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualMachineTemplateName:
{
Description: Name of the VirtualMachineTemplate. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual machine template. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: Gets the type of the os. ,
Enum:
{
Windows: Windows operating system. ,
Linux: Linux operating system. ,
Other: Other operating system. ,
}
,
Required: False ,
}
enum ,
osName:
{
Description: Gets os name. ,
Required: False ,
}
string ,
computerName:
{
Description: Gets computer name. ,
Required: False ,
}
string ,
memoryMB:
{
Description: MemoryMB is the desired size of a virtual machine's memory, in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuCount:
{
Description: Gets the desired number of vCPUs for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
limitCpuForMigration:
{
Description: Gets a value indicating whether to enable processor compatibility mode for live migration of VMs. ,
Enum:
{
true: Enable limit CPU for migration. ,
false: Disable limit CPU for migration. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryEnabled:
{
Description: Gets a value indicating whether to enable dynamic memory or not. ,
Enum:
{
true: Enable dynamic memory. ,
false: Disable dynamic memory. ,
}
,
Required: False ,
}
enum ,
isCustomizable:
{
Description: Gets a value indicating whether the vm template is customizable or not. ,
Enum:
{
true: Enable customizable. ,
false: Disable customizable. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryMaxMB:
{
Description: Gets the max dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
dynamicMemoryMinMB:
{
Description: Gets the min dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
isHighlyAvailable:
{
Description: Gets highly available property. ,
Enum:
{
true: Enable highly available. ,
false: Disable highly available. ,
}
,
Required: False ,
}
enum ,
generation:
{
Description: Gets the generation for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
networkInterfaces:
{
Description: Gets the network interfaces of the template. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the network interface. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set. ,
Required: False ,
}
string ,
ipv4Addresses:
{
Description: Gets the nic ipv4 addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Gets the nic ipv6 addresses. ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: Gets or sets the nic MAC address. ,
Required: False ,
}
string ,
virtualNetworkId:
{
Description: Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Gets the name of the virtual network in vmmServer that the nic is connected to. ,
Required: False ,
}
string ,
ipv4AddressType:
{
Description: Gets or sets the ipv4 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
ipv6AddressType:
{
Description: Gets or sets the ipv6 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
macAddressType:
{
Description: Gets or sets the mac address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
nicId:
{
Description: Gets or sets the nic id. ,
Required: False ,
}
string ,
}
,
]
,
disks:
{
Description: Gets the disks of the template. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the disk. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set. ,
Required: False ,
}
string ,
diskId:
{
Description: Gets or sets the disk id. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Gets or sets the disk total size. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDiskSizeGB:
{
Description: Gets the max disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
bus:
{
Description: Gets or sets the disk bus. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Gets or sets the disk lun. ,
Format: int32 ,
Required: False ,
}
integer ,
busType:
{
Description: Gets or sets the disk bus type. ,
Required: False ,
}
string ,
vhdType:
{
Description: Gets or sets the disk vhd type. ,
Required: False ,
}
string ,
volumeType:
{
Description: Gets the disk volume type. ,
Required: False ,
}
string ,
vhdFormatType:
{
Description: Gets the disk vhd format type. ,
Required: False ,
}
string ,
templateDiskId:
{
Description: Gets or sets the disk id in the template. ,
Required: False ,
}
string ,
storageQoSPolicy:
{
Description: The QoS policy for the disk. ,
Required: False ,
}
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
}
,
createDiffDisk:
{
Description: Gets or sets a value indicating diff disk. ,
Enum:
{
true: Enable create diff disk. ,
false: Disable create diff disk. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual machine template. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: Gets the type of the os. ,
Enum:
{
Windows: Windows operating system. ,
Linux: Linux operating system. ,
Other: Other operating system. ,
}
,
Required: False ,
}
enum ,
osName:
{
Description: Gets os name. ,
Required: False ,
}
string ,
computerName:
{
Description: Gets computer name. ,
Required: False ,
}
string ,
memoryMB:
{
Description: MemoryMB is the desired size of a virtual machine's memory, in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuCount:
{
Description: Gets the desired number of vCPUs for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
limitCpuForMigration:
{
Description: Gets a value indicating whether to enable processor compatibility mode for live migration of VMs. ,
Enum:
{
true: Enable limit CPU for migration. ,
false: Disable limit CPU for migration. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryEnabled:
{
Description: Gets a value indicating whether to enable dynamic memory or not. ,
Enum:
{
true: Enable dynamic memory. ,
false: Disable dynamic memory. ,
}
,
Required: False ,
}
enum ,
isCustomizable:
{
Description: Gets a value indicating whether the vm template is customizable or not. ,
Enum:
{
true: Enable customizable. ,
false: Disable customizable. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryMaxMB:
{
Description: Gets the max dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
dynamicMemoryMinMB:
{
Description: Gets the min dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
isHighlyAvailable:
{
Description: Gets highly available property. ,
Enum:
{
true: Enable highly available. ,
false: Disable highly available. ,
}
,
Required: False ,
}
enum ,
generation:
{
Description: Gets the generation for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
networkInterfaces:
{
Description: Gets the network interfaces of the template. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the network interface. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set. ,
Required: False ,
}
string ,
ipv4Addresses:
{
Description: Gets the nic ipv4 addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Gets the nic ipv6 addresses. ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: Gets or sets the nic MAC address. ,
Required: False ,
}
string ,
virtualNetworkId:
{
Description: Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Gets the name of the virtual network in vmmServer that the nic is connected to. ,
Required: False ,
}
string ,
ipv4AddressType:
{
Description: Gets or sets the ipv4 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
ipv6AddressType:
{
Description: Gets or sets the ipv6 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
macAddressType:
{
Description: Gets or sets the mac address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
nicId:
{
Description: Gets or sets the nic id. ,
Required: False ,
}
string ,
}
,
]
,
disks:
{
Description: Gets the disks of the template. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the disk. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set. ,
Required: False ,
}
string ,
diskId:
{
Description: Gets or sets the disk id. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Gets or sets the disk total size. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDiskSizeGB:
{
Description: Gets the max disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
bus:
{
Description: Gets or sets the disk bus. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Gets or sets the disk lun. ,
Format: int32 ,
Required: False ,
}
integer ,
busType:
{
Description: Gets or sets the disk bus type. ,
Required: False ,
}
string ,
vhdType:
{
Description: Gets or sets the disk vhd type. ,
Required: False ,
}
string ,
volumeType:
{
Description: Gets the disk volume type. ,
Required: False ,
}
string ,
vhdFormatType:
{
Description: Gets the disk vhd format type. ,
Required: False ,
}
string ,
templateDiskId:
{
Description: Gets or sets the disk id in the template. ,
Required: False ,
}
string ,
storageQoSPolicy:
{
Description: The QoS policy for the disk. ,
Required: False ,
}
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
}
,
createDiffDisk:
{
Description: Gets or sets a value indicating diff disk. ,
Enum:
{
true: Enable create diff disk. ,
false: Disable create diff disk. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The VirtualMachineTemplates resource definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual machine template. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: Gets the type of the os. ,
Enum:
{
Windows: Windows operating system. ,
Linux: Linux operating system. ,
Other: Other operating system. ,
}
,
Required: False ,
}
enum ,
osName:
{
Description: Gets os name. ,
Required: False ,
}
string ,
computerName:
{
Description: Gets computer name. ,
Required: False ,
}
string ,
memoryMB:
{
Description: MemoryMB is the desired size of a virtual machine's memory, in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuCount:
{
Description: Gets the desired number of vCPUs for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
limitCpuForMigration:
{
Description: Gets a value indicating whether to enable processor compatibility mode for live migration of VMs. ,
Enum:
{
true: Enable limit CPU for migration. ,
false: Disable limit CPU for migration. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryEnabled:
{
Description: Gets a value indicating whether to enable dynamic memory or not. ,
Enum:
{
true: Enable dynamic memory. ,
false: Disable dynamic memory. ,
}
,
Required: False ,
}
enum ,
isCustomizable:
{
Description: Gets a value indicating whether the vm template is customizable or not. ,
Enum:
{
true: Enable customizable. ,
false: Disable customizable. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryMaxMB:
{
Description: Gets the max dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
dynamicMemoryMinMB:
{
Description: Gets the min dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
isHighlyAvailable:
{
Description: Gets highly available property. ,
Enum:
{
true: Enable highly available. ,
false: Disable highly available. ,
}
,
Required: False ,
}
enum ,
generation:
{
Description: Gets the generation for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
networkInterfaces:
{
Description: Gets the network interfaces of the template. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the network interface. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set. ,
Required: False ,
}
string ,
ipv4Addresses:
{
Description: Gets the nic ipv4 addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Gets the nic ipv6 addresses. ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: Gets or sets the nic MAC address. ,
Required: False ,
}
string ,
virtualNetworkId:
{
Description: Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Gets the name of the virtual network in vmmServer that the nic is connected to. ,
Required: False ,
}
string ,
ipv4AddressType:
{
Description: Gets or sets the ipv4 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
ipv6AddressType:
{
Description: Gets or sets the ipv6 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
macAddressType:
{
Description: Gets or sets the mac address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
nicId:
{
Description: Gets or sets the nic id. ,
Required: False ,
}
string ,
}
,
]
,
disks:
{
Description: Gets the disks of the template. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the disk. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set. ,
Required: False ,
}
string ,
diskId:
{
Description: Gets or sets the disk id. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Gets or sets the disk total size. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDiskSizeGB:
{
Description: Gets the max disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
bus:
{
Description: Gets or sets the disk bus. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Gets or sets the disk lun. ,
Format: int32 ,
Required: False ,
}
integer ,
busType:
{
Description: Gets or sets the disk bus type. ,
Required: False ,
}
string ,
vhdType:
{
Description: Gets or sets the disk vhd type. ,
Required: False ,
}
string ,
volumeType:
{
Description: Gets the disk volume type. ,
Required: False ,
}
string ,
vhdFormatType:
{
Description: Gets the disk vhd format type. ,
Required: False ,
}
string ,
templateDiskId:
{
Description: Gets or sets the disk id in the template. ,
Required: False ,
}
string ,
storageQoSPolicy:
{
Description: The QoS policy for the disk. ,
Required: False ,
}
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
}
,
createDiffDisk:
{
Description: Gets or sets a value indicating diff disk. ,
Enum:
{
true: Enable create diff disk. ,
false: Disable create diff disk. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineTemplates_Update (new)
Description :  Updates the VirtualMachineTemplate resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachineTemplates/{virtualMachineTemplateName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualMachineTemplateName:
{
Description: Name of the VirtualMachineTemplate. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual machine template. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
osType:
{
Description: Gets the type of the os. ,
Enum:
{
Windows: Windows operating system. ,
Linux: Linux operating system. ,
Other: Other operating system. ,
}
,
Required: False ,
}
enum ,
osName:
{
Description: Gets os name. ,
Required: False ,
}
string ,
computerName:
{
Description: Gets computer name. ,
Required: False ,
}
string ,
memoryMB:
{
Description: MemoryMB is the desired size of a virtual machine's memory, in MB. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuCount:
{
Description: Gets the desired number of vCPUs for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
limitCpuForMigration:
{
Description: Gets a value indicating whether to enable processor compatibility mode for live migration of VMs. ,
Enum:
{
true: Enable limit CPU for migration. ,
false: Disable limit CPU for migration. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryEnabled:
{
Description: Gets a value indicating whether to enable dynamic memory or not. ,
Enum:
{
true: Enable dynamic memory. ,
false: Disable dynamic memory. ,
}
,
Required: False ,
}
enum ,
isCustomizable:
{
Description: Gets a value indicating whether the vm template is customizable or not. ,
Enum:
{
true: Enable customizable. ,
false: Disable customizable. ,
}
,
Required: False ,
}
enum ,
dynamicMemoryMaxMB:
{
Description: Gets the max dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
dynamicMemoryMinMB:
{
Description: Gets the min dynamic memory for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
isHighlyAvailable:
{
Description: Gets highly available property. ,
Enum:
{
true: Enable highly available. ,
false: Disable highly available. ,
}
,
Required: False ,
}
enum ,
generation:
{
Description: Gets the generation for the vm. ,
Format: int32 ,
Required: False ,
}
integer ,
networkInterfaces:
{
Description: Gets the network interfaces of the template. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the network interface. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set. ,
Required: False ,
}
string ,
ipv4Addresses:
{
Description: Gets the nic ipv4 addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Gets the nic ipv6 addresses. ,
Required: False ,
}
[
string ,
]
,
macAddress:
{
Description: Gets or sets the nic MAC address. ,
Required: False ,
}
string ,
virtualNetworkId:
{
Description: Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Gets the name of the virtual network in vmmServer that the nic is connected to. ,
Required: False ,
}
string ,
ipv4AddressType:
{
Description: Gets or sets the ipv4 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
ipv6AddressType:
{
Description: Gets or sets the ipv6 address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
macAddressType:
{
Description: Gets or sets the mac address type. ,
Enum:
{
Dynamic: Dynamically allocated address. ,
Static: Statically allocated address. ,
}
,
Required: False ,
}
enum ,
nicId:
{
Description: Gets or sets the nic id. ,
Required: False ,
}
string ,
}
,
]
,
disks:
{
Description: Gets the disks of the template. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets the name of the disk. ,
Required: False ,
}
string ,
displayName:
{
Description: Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set. ,
Required: False ,
}
string ,
diskId:
{
Description: Gets or sets the disk id. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Gets or sets the disk total size. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDiskSizeGB:
{
Description: Gets the max disk size. ,
Format: int32 ,
Required: False ,
}
integer ,
bus:
{
Description: Gets or sets the disk bus. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Gets or sets the disk lun. ,
Format: int32 ,
Required: False ,
}
integer ,
busType:
{
Description: Gets or sets the disk bus type. ,
Required: False ,
}
string ,
vhdType:
{
Description: Gets or sets the disk vhd type. ,
Required: False ,
}
string ,
volumeType:
{
Description: Gets the disk volume type. ,
Required: False ,
}
string ,
vhdFormatType:
{
Description: Gets the disk vhd format type. ,
Required: False ,
}
string ,
templateDiskId:
{
Description: Gets or sets the disk id in the template. ,
Required: False ,
}
string ,
storageQoSPolicy:
{
Description: The QoS policy for the disk. ,
Required: False ,
}
{
name:
{
Description: The name of the policy. ,
Required: False ,
}
string ,
id:
{
Description: The ID of the QoS policy. ,
Required: False ,
}
string ,
}
,
createDiffDisk:
{
Description: Gets or sets a value indicating diff disk. ,
Enum:
{
true: Enable create diff disk. ,
false: Disable create diff disk. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualMachineTemplates_Delete (new)
Description :  Deregisters the ScVmm VM Template from Azure.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachineTemplates/{virtualMachineTemplateName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
force:
{
Description: Forces the resource to be deleted. ,
Required: False ,
}
string ,
virtualMachineTemplateName:
{
Description: Name of the VirtualMachineTemplate. ,
Required: True ,
}
string ,
}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworks_ListByResourceGroup (new)
Description :  List of VirtualNetworks in a resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The VirtualNetwork items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual network. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Name of the virtual network in vmmServer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworks_Get (new)
Description :  Implements VirtualNetwork GET method.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual network. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Name of the virtual network in vmmServer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworks_CreateOrUpdate (new)
Description :  Onboards the ScVmm virtual network as an Azure virtual network resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualNetworks/{virtualNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualNetworkName:
{
Description: Name of the VirtualNetwork. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual network. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Name of the virtual network in vmmServer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual network. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Name of the virtual network in vmmServer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The VirtualNetworks resource definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual network. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Name of the virtual network in vmmServer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworks_Update (new)
Description :  Updates the VirtualNetworks resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualNetworks/{virtualNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
virtualNetworkName:
{
Description: Name of the VirtualNetwork. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryItemId:
{
Description: Gets or sets the inventory Item ID for the resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of the virtual network. ,
Required: False ,
}
string ,
vmmServerId:
{
Description: ARM Id of the vmmServer resource in which this resource resides. ,
Format: arm-id ,
Required: False ,
}
string ,
networkName:
{
Description: Name of the virtual network in vmmServer. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworks_Delete (new)
Description :  Deregisters the ScVmm virtual network from Azure.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualNetworks/{virtualNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
force:
{
Description: Forces the resource to be deleted. ,
Required: False ,
}
string ,
virtualNetworkName:
{
Description: Name of the VirtualNetwork. ,
Required: True ,
}
string ,
}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VmmServers_ListByResourceGroup (new)
Description :  List of VmmServers in a resource group.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The VmmServer items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
credentials:
{
Description: Credentials to connect to VmmServer. ,
Required: False ,
}
{
username:
{
Description: Username to use to connect to VmmServer. ,
Required: False ,
}
string ,
password:
{
Description: Password to use to connect to VmmServer. ,
Format: password ,
Required: False ,
}
string ,
}
,
fqdn:
{
Description: Fqdn is the hostname/ip of the vmmServer. ,
Required: True ,
}
string ,
port:
{
Description: Port is the port on which the vmmServer is listening. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionStatus:
{
Description: Gets the connection status to the vmmServer. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Gets any error message if connection to vmmServer is having any issue. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of vmmServer. ,
Required: False ,
}
string ,
version:
{
Description: Version is the version of the vmmSever. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VmmServers_Get (new)
Description :  Implements VmmServer GET method.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
credentials:
{
Description: Credentials to connect to VmmServer. ,
Required: False ,
}
{
username:
{
Description: Username to use to connect to VmmServer. ,
Required: False ,
}
string ,
password:
{
Description: Password to use to connect to VmmServer. ,
Format: password ,
Required: False ,
}
string ,
}
,
fqdn:
{
Description: Fqdn is the hostname/ip of the vmmServer. ,
Required: True ,
}
string ,
port:
{
Description: Port is the port on which the vmmServer is listening. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionStatus:
{
Description: Gets the connection status to the vmmServer. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Gets any error message if connection to vmmServer is having any issue. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of vmmServer. ,
Required: False ,
}
string ,
version:
{
Description: Version is the version of the vmmSever. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VmmServers_CreateOrUpdate (new)
Description :  Onboards the SCVmm fabric as an Azure VmmServer resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vmmServerName:
{
Description: Name of the VmmServer. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
credentials:
{
Description: Credentials to connect to VmmServer. ,
Required: False ,
}
{
username:
{
Description: Username to use to connect to VmmServer. ,
Required: False ,
}
string ,
password:
{
Description: Password to use to connect to VmmServer. ,
Format: password ,
Required: False ,
}
string ,
}
,
fqdn:
{
Description: Fqdn is the hostname/ip of the vmmServer. ,
Required: True ,
}
string ,
port:
{
Description: Port is the port on which the vmmServer is listening. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionStatus:
{
Description: Gets the connection status to the vmmServer. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Gets any error message if connection to vmmServer is having any issue. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of vmmServer. ,
Required: False ,
}
string ,
version:
{
Description: Version is the version of the vmmSever. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
credentials:
{
Description: Credentials to connect to VmmServer. ,
Required: False ,
}
{
username:
{
Description: Username to use to connect to VmmServer. ,
Required: False ,
}
string ,
password:
{
Description: Password to use to connect to VmmServer. ,
Format: password ,
Required: False ,
}
string ,
}
,
fqdn:
{
Description: Fqdn is the hostname/ip of the vmmServer. ,
Required: True ,
}
string ,
port:
{
Description: Port is the port on which the vmmServer is listening. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionStatus:
{
Description: Gets the connection status to the vmmServer. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Gets any error message if connection to vmmServer is having any issue. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of vmmServer. ,
Required: False ,
}
string ,
version:
{
Description: Version is the version of the vmmSever. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The VmmServers resource definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
credentials:
{
Description: Credentials to connect to VmmServer. ,
Required: False ,
}
{
username:
{
Description: Username to use to connect to VmmServer. ,
Required: False ,
}
string ,
password:
{
Description: Password to use to connect to VmmServer. ,
Format: password ,
Required: False ,
}
string ,
}
,
fqdn:
{
Description: Fqdn is the hostname/ip of the vmmServer. ,
Required: True ,
}
string ,
port:
{
Description: Port is the port on which the vmmServer is listening. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionStatus:
{
Description: Gets the connection status to the vmmServer. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Gets any error message if connection to vmmServer is having any issue. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of vmmServer. ,
Required: False ,
}
string ,
version:
{
Description: Version is the version of the vmmSever. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VmmServers_Update (new)
Description :  Updates the VmmServers resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vmmServerName:
{
Description: Name of the VmmServer. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
credentials:
{
Description: Credentials to connect to VmmServer. ,
Required: False ,
}
{
username:
{
Description: Username to use to connect to VmmServer. ,
Required: False ,
}
string ,
password:
{
Description: Password to use to connect to VmmServer. ,
Format: password ,
Required: False ,
}
string ,
}
,
fqdn:
{
Description: Fqdn is the hostname/ip of the vmmServer. ,
Required: True ,
}
string ,
port:
{
Description: Port is the port on which the vmmServer is listening. ,
Format: int32 ,
Required: False ,
}
integer ,
connectionStatus:
{
Description: Gets the connection status to the vmmServer. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Gets any error message if connection to vmmServer is having any issue. ,
Required: False ,
}
string ,
uuid:
{
Description: Unique ID of vmmServer. ,
Required: False ,
}
string ,
version:
{
Description: Version is the version of the vmmSever. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
name:
{
Description: The extended location name. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VmmServers_Delete (new)
Description :  Removes the SCVmm fabric from Azure.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
force:
{
Description: Forces the resource to be deleted. ,
Required: False ,
}
string ,
vmmServerName:
{
Description: Name of the VmmServer. ,
Required: True ,
}
string ,
}

⚐ Response (202)

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

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InventoryItems_ListByVmmServer (new)
Description :  Returns the list of inventoryItems in the given VmmServer.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The InventoryItem items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryType:
{
Description: They inventory type. ,
Enum:
{
Cloud: Cloud inventory type ,
VirtualNetwork: VirtualNetwork inventory type ,
VirtualMachine: VirtualMachine inventory type ,
VirtualMachineTemplate: VirtualMachineTemplate inventory type ,
}
,
Required: True ,
}
enum ,
managedResourceId:
{
Description: Gets the tracked resource id corresponding to the inventory resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Gets the UUID (which is assigned by Vmm) for the inventory item. ,
Required: False ,
}
string ,
inventoryItemName:
{
Description: Gets the Managed Object name in Vmm for the inventory item. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InventoryItems_Get (new)
Description :  Shows an inventory item.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryType:
{
Description: They inventory type. ,
Enum:
{
Cloud: Cloud inventory type ,
VirtualNetwork: VirtualNetwork inventory type ,
VirtualMachine: VirtualMachine inventory type ,
VirtualMachineTemplate: VirtualMachineTemplate inventory type ,
}
,
Required: True ,
}
enum ,
managedResourceId:
{
Description: Gets the tracked resource id corresponding to the inventory resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Gets the UUID (which is assigned by Vmm) for the inventory item. ,
Required: False ,
}
string ,
inventoryItemName:
{
Description: Gets the Managed Object name in Vmm for the inventory item. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/{inventoryItemResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vmmServerName:
{
Description: Name of the VmmServer. ,
Required: True ,
}
string ,
inventoryItemResourceName:
{
Description: Name of the inventoryItem. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryType:
{
Description: They inventory type. ,
Enum:
{
Cloud: Cloud inventory type ,
VirtualNetwork: VirtualNetwork inventory type ,
VirtualMachine: VirtualMachine inventory type ,
VirtualMachineTemplate: VirtualMachineTemplate inventory type ,
}
,
Required: True ,
}
enum ,
managedResourceId:
{
Description: Gets the tracked resource id corresponding to the inventory resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Gets the UUID (which is assigned by Vmm) for the inventory item. ,
Required: False ,
}
string ,
inventoryItemName:
{
Description: Gets the Managed Object name in Vmm for the inventory item. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryType:
{
Description: They inventory type. ,
Enum:
{
Cloud: Cloud inventory type ,
VirtualNetwork: VirtualNetwork inventory type ,
VirtualMachine: VirtualMachine inventory type ,
VirtualMachineTemplate: VirtualMachineTemplate inventory type ,
}
,
Required: True ,
}
enum ,
managedResourceId:
{
Description: Gets the tracked resource id corresponding to the inventory resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Gets the UUID (which is assigned by Vmm) for the inventory item. ,
Required: False ,
}
string ,
inventoryItemName:
{
Description: Gets the Managed Object name in Vmm for the inventory item. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
inventoryType:
{
Description: They inventory type. ,
Enum:
{
Cloud: Cloud inventory type ,
VirtualNetwork: VirtualNetwork inventory type ,
VirtualMachine: VirtualMachine inventory type ,
VirtualMachineTemplate: VirtualMachineTemplate inventory type ,
}
,
Required: True ,
}
enum ,
managedResourceId:
{
Description: Gets the tracked resource id corresponding to the inventory resource. ,
Required: False ,
}
string ,
uuid:
{
Description: Gets the UUID (which is assigned by Vmm) for the inventory item. ,
Required: False ,
}
string ,
inventoryItemName:
{
Description: Gets the Managed Object name in Vmm for the inventory item. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is provisioning. ,
Updating: The resource is updating. ,
Deleting: The resource is being deleted. ,
Accepted: The resource has been accepted. ,
Created: The resource was created. ,
}
,
Required: False ,
}
enum ,
}
,
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InventoryItems_Delete (new)
Description :  Deletes an inventoryItem.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/{inventoryItemResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vmmServerName:
{
Description: Name of the VmmServer. ,
Required: True ,
}
string ,
inventoryItemResourceName:
{
Description: Name of the inventoryItem. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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