cancel_rolling_upgrade_for_vm_scale_set
Cancels the current virtual machine scale set rolling upgrade.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
capture_virtual_machine
Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string
$body
Parameters supplied to the Capture Virtual Machine operation.
Type: object
{
"overwriteVhds" : "Specifies whether to overwrite the destination virtual hard disk, in case of conflict.",
"vhdPrefix" : "The captured virtual hard disk's name prefix.",
"destinationContainerName" : "The destination container name."
}
convert_to_managed_disk
Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string
convert_vm_scale_set_to_single_placement_group
Converts SinglePlacementGroup property to false for a existing virtual machine scale set.
Parameters
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the virtual machine scale set to create or update.
Type: string
$body
The input object for ConvertToSinglePlacementGroup API.
Type: object
{
"activePlacementGroupId" : "Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances."
}
create_ssh_public_key
Creates a new SSH public key resource.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
sshPublicKeyName (required)
The name of the SSH public key.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
$body
Parameters supplied to create the SSH public key.
Type: object
{
"name" : "Resource name",
"location" : "Resource location",
"id" : "Resource Id",
"type" : "Resource type",
"tags" : "Resource tags"
}
create_update_availability_set
Create or update an availability set.
Parameters
api-version (required)
Client Api Version.
Type: string
availabilitySetName (required)
The name of the availability set.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
$body
Parameters supplied to the Create Availability Set operation.
Type: object
{
"name" : "Resource name",
"location" : "Resource location",
"id" : "Resource Id",
"type" : "Resource type",
"tags" : "Resource tags"
}
create_update_dedicated_host
Create or update a dedicated host .
Parameters
api-version (required)
Client Api Version.
Type: string
hostGroupName (required)
The name of the dedicated host group.
Type: string
hostName (required)
The name of the dedicated host .
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
$body
Parameters supplied to the Create Dedicated Host.
Type: object
{
"name" : "Resource name",
"location" : "Resource location",
"id" : "Resource Id",
"type" : "Resource type",
"tags" : "Resource tags"
}
create_update_dedicated_host_group
Create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596)
Parameters
api-version (required)
Client Api Version.
Type: string
hostGroupName (required)
The name of the dedicated host group.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
$body
Parameters supplied to the Create Dedicated Host Group.
Type: object
{
"name" : "Resource name",
"location" : "Resource location",
"id" : "Resource Id",
"type" : "Resource type",
"tags" : "Resource tags"
}
create_update_image
Create or update an image.
Parameters
api-version (required)
Client Api Version.
Type: string
imageName (required)
The name of the image.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
$body
Parameters supplied to the Create Image operation.
Type: object
{
"name" : "Resource name",
"location" : "Resource location",
"id" : "Resource Id",
"type" : "Resource type",
"tags" : "Resource tags"
}
create_update_proximity_placement_group
Create or update a proximity placement group.
Parameters
api-version (required)
Client Api Version.
Type: string
proximityPlacementGroupName (required)
The name of the proximity placement group.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
$body
Parameters supplied to the Create Proximity Placement Group operation.
Type: object
{
"name" : "Resource name",
"location" : "Resource location",
"id" : "Resource Id",
"type" : "Resource type",
"tags" : "Resource tags"
}
create_update_virtual_machine
The operation to create or update a virtual machine. Please note some properties can be set only during virtual machine creation.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string
$body
Parameters supplied to the Create Virtual Machine operation.
Type: object
{
"name" : "Resource name",
"location" : "Resource location",
"id" : "Resource Id",
"type" : "Resource type",
"tags" : "Resource tags"
}
create_update_virtual_machine_extension
The operation to create or update the extension.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmExtensionName (required)
The name of the virtual machine extension.
Type: string
vmName (required)
The name of the virtual machine where the extension should be created or updated.
Type: string
$body
Parameters supplied to the Create Virtual Machine Extension operation.
Type: object
{
"name" : "Resource name",
"location" : "Resource location",
"id" : "Resource Id",
"type" : "Resource type",
"tags" : "Resource tags"
}
create_update_vm_scale_set
Create or update a VM scale set.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set to create or update.
Type: string
$body
The scale set object.
Type: object
{
"name" : "Resource name",
"location" : "Resource location",
"id" : "Resource Id",
"type" : "Resource type",
"tags" : "Resource tags"
}
create_update_vm_scale_set_extension
The operation to create or update an extension.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set where the extension should be create or updated.
Type: string
vmssExtensionName (required)
The name of the VM scale set extension.
Type: string
$body
Parameters supplied to the Create VM scale set Extension operation.
Type: object
{
"id" : "Resource Id"
}
create_update_vm_scale_set_vm_extension
The operation to create or update the VMSS VM extension.
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmExtensionName (required)
The name of the virtual machine extension.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
$body
Parameters supplied to the Create Virtual Machine Extension operation.
Type: object
{
"name" : "Resource name",
"location" : "Resource location",
"id" : "Resource Id",
"type" : "Resource type",
"tags" : "Resource tags"
}
deallocate_virtual_machine
Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string
deallocate_vm_scale_set
Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
$body
A list of virtual machine instance IDs from the VM scale set.
Type: object
{
"instanceIds" : [ "string" ]
}
deallocate_vm_scale_set_vm
Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
delete_availability_set
Delete an availability set.
Parameters
api-version (required)
Client Api Version.
Type: string
availabilitySetName (required)
The name of the availability set.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
delete_dedicated_host
Delete a dedicated host.
Parameters
api-version (required)
Client Api Version.
Type: string
hostGroupName (required)
The name of the dedicated host group.
Type: string
hostName (required)
The name of the dedicated host.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
delete_dedicated_host_group
Delete a dedicated host group.
Parameters
api-version (required)
Client Api Version.
Type: string
hostGroupName (required)
The name of the dedicated host group.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
delete_image
Deletes an Image.
Parameters
api-version (required)
Client Api Version.
Type: string
imageName (required)
The name of the image.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
delete_instances_in_vm_scale_set
Deletes virtual machines in a VM scale set.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
$body
A list of virtual machine instance IDs from the VM scale set.
Type: object
{
"instanceIds" : [ "string" ]
}
delete_proximity_placement_group
Delete a proximity placement group.
Parameters
api-version (required)
Client Api Version.
Type: string
proximityPlacementGroupName (required)
The name of the proximity placement group.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
delete_ssh_public_key
Delete an SSH public key.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
sshPublicKeyName (required)
The name of the SSH public key.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
delete_virtual_machine
The operation to delete a virtual machine.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string
delete_virtual_machine_extension
The operation to delete the extension.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmExtensionName (required)
The name of the virtual machine extension.
Type: string
vmName (required)
The name of the virtual machine where the extension should be deleted.
Type: string
delete_vm_scale_set
Deletes a VM scale set.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
delete_vm_scale_set_extension
The operation to delete the extension.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set where the extension should be deleted.
Type: string
vmssExtensionName (required)
The name of the VM scale set extension.
Type: string
delete_vm_scale_set_vm
Deletes a virtual machine from a VM scale set.
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
delete_vm_scale_set_vm_extension
The operation to delete the VMSS VM extension.
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmExtensionName (required)
The name of the virtual machine extension.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
export_request_rate_by_interval
Export logs that show Api requests made by this subscription in the given time window to show throttling activities.
Parameters
api-version (required)
Client Api Version.
Type: string
location (required)
The location upon which virtual-machine-sizes is queried.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
$body
Parameters supplied to the LogAnalytics getRequestRateByInterval Api.
Type: object
{
"groupByResourceName" : "Group query result by Resource Name.",
"groupByThrottlePolicy" : "Group query result by Throttle Policy applied.",
"groupByOperationName" : "Group query result by Operation Name.",
"fromTime" : "From time of the query",
"blobContainerSasUri" : "SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to.",
"toTime" : "To time of the query"
}
export_throttled_requests
Export logs that show total throttled Api requests for this subscription in the given time window.
Parameters
api-version (required)
Client Api Version.
Type: string
location (required)
The location upon which virtual-machine-sizes is queried.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
$body
Parameters supplied to the LogAnalytics getThrottledRequests Api.
Type: object
{
"groupByResourceName" : "Group query result by Resource Name.",
"groupByThrottlePolicy" : "Group query result by Throttle Policy applied.",
"groupByOperationName" : "Group query result by Operation Name.",
"fromTime" : "From time of the query",
"blobContainerSasUri" : "SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to.",
"toTime" : "To time of the query"
}
force_recovery_walk_for_update_domain_in_vmss
Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.
Parameters
api-version (required)
Client Api Version.
Type: string
platformUpdateDomain (required)
The platform update domain for which a manual recovery walk is requested
Type: integer
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
generalize_virtual_machine
Sets the OS state of the virtual machine to generalized. It is recommended to sysprep the virtual machine before performing this operation. For Windows, please refer to Create a managed image of a generalized VM in Azure. For Linux, please refer to How to create an image of a virtual machine or VHD.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string
generate_key_pair
Generates and returns a public/private key pair and populates the SSH public key resource with the public key. The length of the key will be 3072 bits. This operation can only be performed once per SSH public key resource.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
sshPublicKeyName (required)
The name of the SSH public key.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
get_availability_set
Retrieves information about an availability set.
Parameters
api-version (required)
Client Api Version.
Type: string
availabilitySetName (required)
The name of the availability set.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
get_dedicated_host
Retrieves information about a dedicated host.
Parameters
api-version (required)
Client Api Version.
Type: string
hostGroupName (required)
The name of the dedicated host group.
Type: string
hostName (required)
The name of the dedicated host.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
$expand
The expand expression to apply on the operation.
Type: string
Potential values: instanceView
get_dedicated_host_group
Retrieves information about a dedicated host group.
Parameters
api-version (required)
Client Api Version.
Type: string
hostGroupName (required)
The name of the dedicated host group.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
get_image
Gets an image.
Parameters
api-version (required)
Client Api Version.
Type: string
imageName (required)
The name of the image.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
$expand
The expand expression to apply on the operation.
Type: string
get_latest_rolling_upgrade_for_vm_scale_set
Gets the status of the latest virtual machine scale set rolling upgrade.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
get_os_upgrade_history_for_vm_scale_set
Gets list of OS upgrades on a VM scale set instance.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
get_proximity_placement_group
Retrieves information about a proximity placement group .
Parameters
api-version (required)
Client Api Version.
Type: string
proximityPlacementGroupName (required)
The name of the proximity placement group.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
includeColocationStatus
includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group.
Type: string
get_ssh_public_key
Retrieves information about an SSH public key.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
sshPublicKeyName (required)
The name of the SSH public key.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
get_virtual_machine
Retrieves information about the model view or the instance view of a virtual machine.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string
$expand
The expand expression to apply on the operation.
Type: string
Potential values: instanceView
get_virtual_machine_extension
The operation to get the extension.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmExtensionName (required)
The name of the virtual machine extension.
Type: string
vmName (required)
The name of the virtual machine containing the extension.
Type: string
$expand
The expand expression to apply on the operation.
Type: string
get_virtual_machine_extension_image
Gets a virtual machine extension image.
Parameters
api-version (required)
Client Api Version.
Type: string
location (required)
The name of a supported Azure region.
Type: string
publisherName (required)
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
type (required)
Type: string
version (required)
Type: string
get_virtual_machine_image
Gets a virtual machine image.
Parameters
api-version (required)
Client Api Version.
Type: string
location (required)
The name of a supported Azure region.
Type: string
offer (required)
A valid image publisher offer.
Type: string
publisherName (required)
A valid image publisher.
Type: string
skus (required)
A valid image SKU.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
version (required)
A valid image SKU version.
Type: string
get_virtual_machine_run_command
Gets specific run command for a subscription in a location.
Parameters
api-version (required)
Client Api Version.
Type: string
commandId (required)
The command id.
Type: string
location (required)
The location upon which run commands is queried.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
get_vm_scale_set
Display information about a virtual machine scale set.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
get_vm_scale_set_extension
The operation to get the extension.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set containing the extension.
Type: string
vmssExtensionName (required)
The name of the VM scale set extension.
Type: string
$expand
The expand expression to apply on the operation.
Type: string
get_vm_scale_set_vm
Gets a virtual machine from a VM scale set.
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
$expand
The expand expression to apply on the operation.
Type: string
Potential values: instanceView
get_vm_scale_set_vm_extension
The operation to get the VMSS VM extension.
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmExtensionName (required)
The name of the virtual machine extension.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
$expand
The expand expression to apply on the operation.
Type: string
list_availability_sets
Lists all availability sets in a resource group.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_availability_sets_for_subscription
Lists all availability sets in a subscription.
Parameters
api-version (required)
Client Api Version.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
$expand
The expand expression to apply to the operation.
Type: string
list_available_sizes_for_availability_set
Lists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.
Parameters
api-version (required)
Client Api Version.
Type: string
availabilitySetName (required)
The name of the availability set.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_available_sizes_for_virtual_machine
Lists all available virtual machine sizes to which the specified virtual machine can be resized.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string
list_dedicated_host_groups_for_resource_group
Lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_dedicated_host_groups_for_subscription
Lists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.
Parameters
api-version (required)
Client Api Version.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_dedicated_hosts_for_host_group
Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.
Parameters
api-version (required)
Client Api Version.
Type: string
hostGroupName (required)
The name of the dedicated host group.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_images
Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.
Parameters
api-version (required)
Client Api Version.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_images_for_resource_group
Gets the list of images under a resource group.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_offers_for_virtual_machine_image
Gets a list of virtual machine image offers for the specified location and publisher.
Parameters
api-version (required)
Client Api Version.
Type: string
location (required)
The name of a supported Azure region.
Type: string
publisherName (required)
A valid image publisher.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_operations
Gets a list of compute operations.
Parameters
api-version (required)
Client Api Version.
Type: string
list_proximity_placement_groups_for_res_group
Lists all proximity placement groups in a resource group.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_proximity_placement_groups_for_subscription
Lists all proximity placement groups in a subscription.
Parameters
api-version (required)
Client Api Version.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_publishers_for_virtual_machine_image
Gets a list of virtual machine image publishers for the specified Azure location.
Parameters
api-version (required)
Client Api Version.
Type: string
location (required)
The name of a supported Azure region.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_skus_for_virtual_machine_image
Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.
Parameters
api-version (required)
Client Api Version.
Type: string
location (required)
The name of a supported Azure region.
Type: string
offer (required)
A valid image publisher offer.
Type: string
publisherName (required)
A valid image publisher.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_skus_for_vm_scale_sets
Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
list_ssh_public_keys_for_resource_group
Lists all of the SSH public keys in the specified resource group. Use the nextLink property in the response to get the next page of SSH public keys.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_ssh_public_keys_for_subscription
Lists all of the SSH public keys in the subscription. Use the nextLink property in the response to get the next page of SSH public keys.
Parameters
api-version (required)
Client Api Version.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_types_virtual_machine_extension_images
Gets a list of virtual machine extension image types.
Parameters
api-version (required)
Client Api Version.
Type: string
location (required)
The name of a supported Azure region.
Type: string
publisherName (required)
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_usage
Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.
Parameters
api-version (required)
Client Api Version.
Type: string
location (required)
The location for which resource usage is queried.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_versions_of_virtual_machine_extension_image
Gets a list of virtual machine extension image versions.
Parameters
api-version (required)
Client Api Version.
Type: string
location (required)
The name of a supported Azure region.
Type: string
publisherName (required)
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
type (required)
Type: string
$filter
The filter to apply on the operation.
Type: string
$orderby
Type: string
$top
Type: integer
list_virtual_machine_extensions
The operation to get all extensions of a Virtual Machine.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine containing the extension.
Type: string
$expand
The expand expression to apply on the operation.
Type: string
list_virtual_machine_images
Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.
Parameters
api-version (required)
Client Api Version.
Type: string
location (required)
The name of a supported Azure region.
Type: string
offer (required)
A valid image publisher offer.
Type: string
publisherName (required)
A valid image publisher.
Type: string
skus (required)
A valid image SKU.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
$expand
The expand expression to apply on the operation.
Type: string
$orderby
Type: string
$top
Type: integer
list_virtual_machine_run_commands
Lists all available run commands for a subscription in a location.
Parameters
api-version (required)
Client Api Version.
Type: string
location (required)
The location upon which run commands is queried.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_virtual_machine_sizes
This API is deprecated. Use Resources Skus
Parameters
api-version (required)
Client Api Version.
Type: string
location (required)
The location upon which virtual-machine-sizes is queried.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_virtual_machines
Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.
Parameters
api-version (required)
Client Api Version.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
statusOnly
statusOnly=true enables fetching run time status of all Virtual Machines in the subscription.
Type: string
list_virtual_machines_for_location
Gets all the virtual machines under the specified subscription for the specified location.
Parameters
api-version (required)
Client Api Version.
Type: string
location (required)
The location for which virtual machines under the subscription are queried.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_virtual_machines_in_resource_group
Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_vm_scale_set_extensions
Gets a list of all extensions in a VM scale set.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set containing the extension.
Type: string
list_vm_scale_set_vm_extensions
The operation to get all extensions of an instance in Virtual Machine Scaleset.
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
$expand
The expand expression to apply on the operation.
Type: string
list_vm_scale_set_vms
Gets a list of all virtual machines in a VM scale sets.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
virtualMachineScaleSetName (required)
The name of the VM scale set.
Type: string
$expand
The expand expression to apply to the operation.
Type: string
$filter
The filter to apply to the operation.
Type: string
$select
The list parameters.
Type: string
list_vm_scale_sets
Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.
Parameters
api-version (required)
Client Api Version.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
list_vm_scale_sets_in_resource_group
Gets a list of all VM scale sets under a resource group.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
perform_maintenance_for_vm_scale_set_vm
Performs maintenance on a virtual machine in a VM scale set.
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
perform_maintenance_on_vm
The operation to perform maintenance on a virtual machine.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string
perform_maintenance_vm_scale_set
Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
$body
A list of virtual machine instance IDs from the VM scale set.
Type: object
{
"instanceIds" : [ "string" ]
}
power_off_virtual_machine
The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string
skipShutdown
The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified
Type: boolean
power_off_vm_scale_set
Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
$body
A list of virtual machine instance IDs from the VM scale set.
Type: object
{
"instanceIds" : [ "string" ]
}
skipShutdown
The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified
Type: boolean
power_off_vm_scale_set_vm
Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
skipShutdown
The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified
Type: boolean
reapply_state_to_virtual_machine
The operation to reapply a virtual machine's state.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string
redeploy_virtual_machine
Shuts down the virtual machine, moves it to a new node, and powers it back on.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string
redeploy_vm_scale_set
Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
$body
A list of virtual machine instance IDs from the VM scale set.
Type: object
{
"instanceIds" : [ "string" ]
}
redeploy_vm_scale_set_vm
Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
reimage_all_disks_for_vm_scale_set
Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
$body
A list of virtual machine instance IDs from the VM scale set.
Type: object
{
"instanceIds" : [ "string" ]
}
reimage_all_disks_for_vm_scale_set_vm
Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
reimage_virtual_machine
Reimages the virtual machine which has an ephemeral OS disk back to its initial state.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string
$body
Parameters supplied to the Reimage Virtual Machine operation.
Type: object
{
"tempDisk" : "Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk."
}
reimage_vm_scale_set
Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
$body
Parameters for Reimaging VM ScaleSet.
Type: object
{
"tempDisk" : "Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk."
}
reimage_vm_scale_set_vm
Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
$body
Parameters for the Reimaging Virtual machine in ScaleSet.
Type: object
{
"tempDisk" : "Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk."
}
restart_virtual_machine
The operation to restart a virtual machine.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string
restart_vm_scale_set
Restarts one or more virtual machines in a VM scale set.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
$body
A list of virtual machine instance IDs from the VM scale set.
Type: object
{
"instanceIds" : [ "string" ]
}
restart_vm_scale_set_vm
Restarts a virtual machine in a VM scale set.
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
run_command_on_virtual_machine
Run command on the VM.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string
$body
Parameters supplied to the Run command operation.
Type: object
{
"commandId" : "The run command id.",
"parameters" : [ {
"name" : "The run command parameter name.",
"value" : "The run command parameter value."
} ],
"script" : [ "string" ]
}
run_command_on_vm_scale_set_vm
Run command on a virtual machine in a VM scale set.
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
$body
Parameters supplied to the Run command operation.
Type: object
{
"commandId" : "The run command id.",
"parameters" : [ {
"name" : "The run command parameter name.",
"value" : "The run command parameter value."
} ],
"script" : [ "string" ]
}
set_orchestration_service_state_for_vm_scale_set
Changes ServiceState property for a given service
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the virtual machine scale set to create or update.
Type: string
$body
The input object for SetOrchestrationServiceState API.
Type: object
{
"action" : "The action to be performed.",
"serviceName" : "The name of the service."
}
simulate_eviction_of_virtual_machine
The operation to simulate the eviction of spot virtual machine. The eviction will occur within 30 minutes of calling the API
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string
simulate_eviction_on_vm_scale_set_vm
The operation to simulate the eviction of spot virtual machine in a VM scale set. The eviction will occur within 30 minutes of calling the API
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
start_extension_upgrade_for_vm_scale_set
Starts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are already running the latest extension versions are not affected.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
start_os_upgrade_for_vm_scale_set
Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
start_virtual_machine
The operation to start a virtual machine.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string
start_vm_scale_set
Starts one or more virtual machines in a VM scale set.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
$body
A list of virtual machine instance IDs from the VM scale set.
Type: object
{
"instanceIds" : [ "string" ]
}
start_vm_scale_set_vm
Starts a virtual machine in a VM scale set.
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
update_availability_set
Update an availability set.
Parameters
api-version (required)
Client Api Version.
Type: string
availabilitySetName (required)
The name of the availability set.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
$body
Parameters supplied to the Update Availability Set operation.
Type: object
{
"tags" : "Resource tags"
}
update_dedicated_host_group
Update an dedicated host group.
Parameters
api-version (required)
Client Api Version.
Type: string
hostGroupName (required)
The name of the dedicated host group.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
$body
Parameters supplied to the Update Dedicated Host Group operation.
Type: object
{
"tags" : "Resource tags"
}
update_dedicated_hosts
Update an dedicated host .
Parameters
api-version (required)
Client Api Version.
Type: string
hostGroupName (required)
The name of the dedicated host group.
Type: string
hostName (required)
The name of the dedicated host .
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
$body
Parameters supplied to the Update Dedicated Host operation.
Type: object
{
"tags" : "Resource tags"
}
update_image
Update an image.
Parameters
api-version (required)
Client Api Version.
Type: string
imageName (required)
The name of the image.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
$body
Parameters supplied to the Update Image operation.
Type: object
{
"tags" : "Resource tags"
}
update_instances_in_vm_scale_set
Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
$body
A list of virtual machine instance IDs from the VM scale set.
Type: object
{
"instanceIds" : [ "string" ]
}
update_proximity_placement_group
Update a proximity placement group.
Parameters
api-version (required)
Client Api Version.
Type: string
proximityPlacementGroupName (required)
The name of the proximity placement group.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
$body
Parameters supplied to the Update Proximity Placement Group operation.
Type: object
{
"tags" : "Resource tags"
}
update_ssh_public_key
Updates a new SSH public key resource.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
sshPublicKeyName (required)
The name of the SSH public key.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
$body
Parameters supplied to update the SSH public key.
Type: object
{
"tags" : "Resource tags"
}
update_virtual_machine
The operation to update a virtual machine.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string
$body
Parameters supplied to the Update Virtual Machine operation.
Type: object
{
"tags" : "Resource tags"
}
update_virtual_machine_extension
The operation to update the extension.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmExtensionName (required)
The name of the virtual machine extension.
Type: string
vmName (required)
The name of the virtual machine where the extension should be updated.
Type: string
$body
Parameters supplied to the Update Virtual Machine Extension operation.
Type: object
{
"tags" : "Resource tags"
}
update_vm_scale_set
Update a VM scale set.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set to create or update.
Type: string
$body
The scale set object.
Type: object
{
"tags" : "Resource tags"
}
update_vm_scale_set_extension
The operation to update an extension.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set where the extension should be updated.
Type: string
vmssExtensionName (required)
The name of the VM scale set extension.
Type: string
$body
Parameters supplied to the Update VM scale set Extension operation.
Type: object
{
"id" : "Resource Id"
}
update_vm_scale_set_vm
Updates a virtual machine of a VM scale set.
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set where the extension should be create or updated.
Type: string
$body
Parameters supplied to the Update Virtual Machine Scale Sets VM operation.
Type: object
{
"name" : "Resource name",
"location" : "Resource location",
"id" : "Resource Id",
"type" : "Resource type",
"tags" : "Resource tags"
}
update_vm_scale_set_vm_extension
The operation to update the VMSS VM extension.
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmExtensionName (required)
The name of the virtual machine extension.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
$body
Parameters supplied to the Update Virtual Machine Extension operation.
Type: object
{
"tags" : "Resource tags"
}
view_instance_in_vm_scale_set
Gets the status of a VM scale set instance.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
view_instance_in_vm_scale_set_vm
Gets the status of a virtual machine from a VM scale set.
Parameters
api-version (required)
Client Api Version.
Type: string
instanceId (required)
The instance ID of the virtual machine.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmScaleSetName (required)
The name of the VM scale set.
Type: string
view_instance_of_virtual_machine
Retrieves information about the run-time state of a virtual machine.
Parameters
api-version (required)
Client Api Version.
Type: string
resourceGroupName (required)
The name of the resource group.
Type: string
subscriptionId (required)
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Type: string
vmName (required)
The name of the virtual machine.
Type: string