@datafire/azure_compute

Client library for ComputeManagementClient

Installation and Usage

npm install --save @datafire/azure_compute

let azure_compute = require('@datafire/azure_compute').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

The Compute Management Client.

Actions

Operations_List

Gets a list of compute operations.

azure_compute.Operations_List({
  "api-version": ""
}, context)

Input

input object
- api-version required string: Client Api Version.

Output

output ComputeOperationListResult

AvailabilitySets_ListBySubscription

Lists all availability sets in a subscription.

azure_compute.AvailabilitySets_ListBySubscription({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- $expand string: The expand expression to apply to the operation.

Output

output AvailabilitySetListResult

DedicatedHostGroups_ListBySubscription

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.

azure_compute.DedicatedHostGroups_ListBySubscription({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output DedicatedHostGroupListResult

Images_List

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.

azure_compute.Images_List({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output ImageListResult

LogAnalytics_ExportRequestRateByInterval

Export logs that show Api requests made by this subscription in the given time window to show throttling activities.

azure_compute.LogAnalytics_ExportRequestRateByInterval({
  "parameters": null,
  "location": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- parameters required RequestRateByIntervalInput
- location required string: The location upon which virtual-machine-sizes is queried.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output LogAnalyticsOperationResult

LogAnalytics_ExportThrottledRequests

Export logs that show total throttled Api requests for this subscription in the given time window.

azure_compute.LogAnalytics_ExportThrottledRequests({
  "parameters": null,
  "location": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- parameters required ThrottledRequestsInput
- location required string: The location upon which virtual-machine-sizes is queried.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output LogAnalyticsOperationResult

VirtualMachineImages_ListPublishers

Gets a list of virtual machine image publishers for the specified Azure location.

azure_compute.VirtualMachineImages_ListPublishers({
  "location": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- location required string: The name of a supported Azure region.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output array
- items VirtualMachineImageResource

VirtualMachineExtensionImages_ListTypes

Gets a list of virtual machine extension image types.

azure_compute.VirtualMachineExtensionImages_ListTypes({
  "location": "",
  "publisherName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- location required string: The name of a supported Azure region.
- publisherName required string
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output array
- items VirtualMachineExtensionImage

VirtualMachineExtensionImages_ListVersions

Gets a list of virtual machine extension image versions.

azure_compute.VirtualMachineExtensionImages_ListVersions({
  "location": "",
  "publisherName": "",
  "type": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- location required string: The name of a supported Azure region.
- publisherName required string
- type required string
- $filter string: The filter to apply on the operation.
- $top integer
- $orderby string
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output array
- items VirtualMachineExtensionImage

VirtualMachineExtensionImages_Get

Gets a virtual machine extension image.

azure_compute.VirtualMachineExtensionImages_Get({
  "location": "",
  "publisherName": "",
  "type": "",
  "version": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- location required string: The name of a supported Azure region.
- publisherName required string
- type required string
- version required string
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineExtensionImage

VirtualMachineImages_ListOffers

Gets a list of virtual machine image offers for the specified location and publisher.

azure_compute.VirtualMachineImages_ListOffers({
  "location": "",
  "publisherName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- location required string: The name of a supported Azure region.
- publisherName required string: A valid image publisher.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output array
- items VirtualMachineImageResource

VirtualMachineImages_ListSkus

Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.

azure_compute.VirtualMachineImages_ListSkus({
  "location": "",
  "publisherName": "",
  "offer": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- location required string: The name of a supported Azure region.
- publisherName required string: A valid image publisher.
- offer required string: A valid image publisher offer.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output array
- items VirtualMachineImageResource

VirtualMachineImages_List

Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.

azure_compute.VirtualMachineImages_List({
  "location": "",
  "publisherName": "",
  "offer": "",
  "skus": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- location required string: The name of a supported Azure region.
- publisherName required string: A valid image publisher.
- offer required string: A valid image publisher offer.
- skus required string: A valid image SKU.
- $filter string: The filter to apply on the operation.
- $top integer
- $orderby string
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output array
- items VirtualMachineImageResource

VirtualMachineImages_Get

Gets a virtual machine image.

azure_compute.VirtualMachineImages_Get({
  "location": "",
  "publisherName": "",
  "offer": "",
  "skus": "",
  "version": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- location required string: The name of a supported Azure region.
- publisherName required string: A valid image publisher.
- offer required string: A valid image publisher offer.
- skus required string: A valid image SKU.
- version required string: A valid image SKU version.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineImage

Usage_List

Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.

azure_compute.Usage_List({
  "location": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- location required string: The location for which resource usage is queried.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output ListUsagesResult

VirtualMachines_ListByLocation

Gets all the virtual machines under the specified subscription for the specified location.

azure_compute.VirtualMachines_ListByLocation({
  "location": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- location required string: The location for which virtual machines under the subscription are queried.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineListResult

VirtualMachineSizes_List

This API is deprecated. Use Resources Skus

azure_compute.VirtualMachineSizes_List({
  "location": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- location required string: The location upon which virtual-machine-sizes is queried.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineSizeListResult

ProximityPlacementGroups_ListBySubscription

Lists all proximity placement groups in a subscription.

azure_compute.ProximityPlacementGroups_ListBySubscription({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output ProximityPlacementGroupListResult

VirtualMachineScaleSets_ListAll

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.

azure_compute.VirtualMachineScaleSets_ListAll({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineScaleSetListWithLinkResult

VirtualMachines_ListAll

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.

azure_compute.VirtualMachines_ListAll({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineListResult

AvailabilitySets_List

Lists all availability sets in a resource group.

azure_compute.AvailabilitySets_List({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output AvailabilitySetListResult

AvailabilitySets_Delete

Delete an availability set.

azure_compute.AvailabilitySets_Delete({
  "resourceGroupName": "",
  "availabilitySetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- availabilitySetName required string: The name of the availability set.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

AvailabilitySets_Get

Retrieves information about an availability set.

azure_compute.AvailabilitySets_Get({
  "resourceGroupName": "",
  "availabilitySetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- availabilitySetName required string: The name of the availability set.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output AvailabilitySet

AvailabilitySets_Update

Update an availability set.

azure_compute.AvailabilitySets_Update({
  "resourceGroupName": "",
  "availabilitySetName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- availabilitySetName required string: The name of the availability set.
- parameters required AvailabilitySetUpdate
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output AvailabilitySet

AvailabilitySets_CreateOrUpdate

Create or update an availability set.

azure_compute.AvailabilitySets_CreateOrUpdate({
  "resourceGroupName": "",
  "availabilitySetName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- availabilitySetName required string: The name of the availability set.
- parameters required AvailabilitySet
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output AvailabilitySet

AvailabilitySets_ListAvailableSizes

Lists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.

azure_compute.AvailabilitySets_ListAvailableSizes({
  "resourceGroupName": "",
  "availabilitySetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- availabilitySetName required string: The name of the availability set.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineSizeListResult

DedicatedHostGroups_ListByResourceGroup

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.

azure_compute.DedicatedHostGroups_ListByResourceGroup({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output DedicatedHostGroupListResult

DedicatedHostGroups_Delete

Delete a dedicated host group.

azure_compute.DedicatedHostGroups_Delete({
  "resourceGroupName": "",
  "hostGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- hostGroupName required string: The name of the dedicated host group.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

DedicatedHostGroups_Get

Retrieves information about a dedicated host group.

azure_compute.DedicatedHostGroups_Get({
  "resourceGroupName": "",
  "hostGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- hostGroupName required string: The name of the dedicated host group.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output DedicatedHostGroup

DedicatedHostGroups_Update

Update an dedicated host group.

azure_compute.DedicatedHostGroups_Update({
  "resourceGroupName": "",
  "hostGroupName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- hostGroupName required string: The name of the dedicated host group.
- parameters required DedicatedHostGroupUpdate
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output DedicatedHostGroup

DedicatedHostGroups_CreateOrUpdate

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)

azure_compute.DedicatedHostGroups_CreateOrUpdate({
  "resourceGroupName": "",
  "hostGroupName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- hostGroupName required string: The name of the dedicated host group.
- parameters required DedicatedHostGroup
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output DedicatedHostGroup

DedicatedHosts_ListByHostGroup

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.

azure_compute.DedicatedHosts_ListByHostGroup({
  "resourceGroupName": "",
  "hostGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- hostGroupName required string: The name of the dedicated host group.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output DedicatedHostListResult

DedicatedHosts_Delete

Delete a dedicated host.

azure_compute.DedicatedHosts_Delete({
  "resourceGroupName": "",
  "hostGroupName": "",
  "hostName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- hostGroupName required string: The name of the dedicated host group.
- hostName required string: The name of the dedicated host.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

DedicatedHosts_Get

Retrieves information about a dedicated host.

azure_compute.DedicatedHosts_Get({
  "resourceGroupName": "",
  "hostGroupName": "",
  "hostName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- hostGroupName required string: The name of the dedicated host group.
- hostName required string: The name of the dedicated host.
- $expand string (values: instanceView): The expand expression to apply on the operation.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output DedicatedHost

DedicatedHosts_Update

Update an dedicated host .

azure_compute.DedicatedHosts_Update({
  "resourceGroupName": "",
  "hostGroupName": "",
  "hostName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- hostGroupName required string: The name of the dedicated host group.
- hostName required string: The name of the dedicated host .
- parameters required DedicatedHostUpdate
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output DedicatedHost

DedicatedHosts_CreateOrUpdate

Create or update a dedicated host .

azure_compute.DedicatedHosts_CreateOrUpdate({
  "resourceGroupName": "",
  "hostGroupName": "",
  "hostName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- hostGroupName required string: The name of the dedicated host group.
- hostName required string: The name of the dedicated host .
- parameters required DedicatedHost
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output DedicatedHost

Images_ListByResourceGroup

Gets the list of images under a resource group.

azure_compute.Images_ListByResourceGroup({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output ImageListResult

Images_Delete

Deletes an Image.

azure_compute.Images_Delete({
  "resourceGroupName": "",
  "imageName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- imageName required string: The name of the image.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Images_Get

Gets an image.

azure_compute.Images_Get({
  "resourceGroupName": "",
  "imageName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- imageName required string: The name of the image.
- $expand string: The expand expression to apply on the operation.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output Image

Images_Update

Update an image.

azure_compute.Images_Update({
  "resourceGroupName": "",
  "imageName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- imageName required string: The name of the image.
- parameters required ImageUpdate
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output Image

Images_CreateOrUpdate

Create or update an image.

azure_compute.Images_CreateOrUpdate({
  "resourceGroupName": "",
  "imageName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- imageName required string: The name of the image.
- parameters required Image
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output Image

ProximityPlacementGroups_ListByResourceGroup

Lists all proximity placement groups in a resource group.

azure_compute.ProximityPlacementGroups_ListByResourceGroup({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output ProximityPlacementGroupListResult

ProximityPlacementGroups_Delete

Delete a proximity placement group.

azure_compute.ProximityPlacementGroups_Delete({
  "resourceGroupName": "",
  "proximityPlacementGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- proximityPlacementGroupName required string: The name of the proximity placement group.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

ProximityPlacementGroups_Get

Retrieves information about a proximity placement group .

azure_compute.ProximityPlacementGroups_Get({
  "resourceGroupName": "",
  "proximityPlacementGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- proximityPlacementGroupName required string: The name of the proximity placement group.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output ProximityPlacementGroup

ProximityPlacementGroups_Update

Update a proximity placement group.

azure_compute.ProximityPlacementGroups_Update({
  "resourceGroupName": "",
  "proximityPlacementGroupName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- proximityPlacementGroupName required string: The name of the proximity placement group.
- parameters required ProximityPlacementGroupUpdate
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output ProximityPlacementGroup

ProximityPlacementGroups_CreateOrUpdate

Create or update a proximity placement group.

azure_compute.ProximityPlacementGroups_CreateOrUpdate({
  "resourceGroupName": "",
  "proximityPlacementGroupName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- proximityPlacementGroupName required string: The name of the proximity placement group.
- parameters required ProximityPlacementGroup
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output ProximityPlacementGroup

VirtualMachineScaleSets_List

Gets a list of all VM scale sets under a resource group.

azure_compute.VirtualMachineScaleSets_List({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineScaleSetListResult

VirtualMachineScaleSetVMs_List

Gets a list of all virtual machines in a VM scale sets.

azure_compute.VirtualMachineScaleSetVMs_List({
  "resourceGroupName": "",
  "virtualMachineScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- virtualMachineScaleSetName required string: The name of the VM scale set.
- $filter string: The filter to apply to the operation.
- $select string: The list parameters.
- $expand string: The expand expression to apply to the operation.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineScaleSetVMListResult

VirtualMachineScaleSets_Delete

Deletes a VM scale set.

azure_compute.VirtualMachineScaleSets_Delete({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSets_Get

Display information about a virtual machine scale set.

azure_compute.VirtualMachineScaleSets_Get({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineScaleSet

VirtualMachineScaleSets_Update

Update a VM scale set.

azure_compute.VirtualMachineScaleSets_Update({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set to create or update.
- parameters required VirtualMachineScaleSetUpdate
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineScaleSet

VirtualMachineScaleSets_CreateOrUpdate

Create or update a VM scale set.

azure_compute.VirtualMachineScaleSets_CreateOrUpdate({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set to create or update.
- parameters required VirtualMachineScaleSet
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineScaleSet

VirtualMachineScaleSets_ConvertToSinglePlacementGroup

Converts SinglePlacementGroup property to false for a existing virtual machine scale set.

azure_compute.VirtualMachineScaleSets_ConvertToSinglePlacementGroup({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "parameters": null,
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the virtual machine scale set to create or update.
- parameters required VMScaleSetConvertToSinglePlacementGroupInput
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSets_Deallocate

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.

azure_compute.VirtualMachineScaleSets_Deallocate({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- vmInstanceIDs VirtualMachineScaleSetVMInstanceIDs
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSets_DeleteInstances

Deletes virtual machines in a VM scale set.

azure_compute.VirtualMachineScaleSets_DeleteInstances({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "vmInstanceIDs": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- vmInstanceIDs required VirtualMachineScaleSetVMInstanceRequiredIDs
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSetRollingUpgrades_StartExtensionUpgrade

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.

azure_compute.VirtualMachineScaleSetRollingUpgrades_StartExtensionUpgrade({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSetExtensions_List

Gets a list of all extensions in a VM scale set.

azure_compute.VirtualMachineScaleSetExtensions_List({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set containing the extension.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineScaleSetExtensionListResult

VirtualMachineScaleSetExtensions_Delete

The operation to delete the extension.

azure_compute.VirtualMachineScaleSetExtensions_Delete({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "vmssExtensionName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set where the extension should be deleted.
- vmssExtensionName required string: The name of the VM scale set extension.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSetExtensions_Get

The operation to get the extension.

azure_compute.VirtualMachineScaleSetExtensions_Get({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "vmssExtensionName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set containing the extension.
- vmssExtensionName required string: The name of the VM scale set extension.
- $expand string: The expand expression to apply on the operation.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineScaleSetExtension

VirtualMachineScaleSetExtensions_CreateOrUpdate

The operation to create or update an extension.

azure_compute.VirtualMachineScaleSetExtensions_CreateOrUpdate({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "vmssExtensionName": "",
  "extensionParameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set where the extension should be create or updated.
- vmssExtensionName required string: The name of the VM scale set extension.
- extensionParameters required VirtualMachineScaleSetExtension
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineScaleSetExtension

VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk

Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.

azure_compute.VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": "",
  "platformUpdateDomain": 0
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
- platformUpdateDomain required integer: The platform update domain for which a manual recovery walk is requested

Output

output RecoveryWalkResponse

VirtualMachineScaleSets_GetInstanceView

Gets the status of a VM scale set instance.

azure_compute.VirtualMachineScaleSets_GetInstanceView({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineScaleSetInstanceView

VirtualMachineScaleSets_UpdateInstances

Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.

azure_compute.VirtualMachineScaleSets_UpdateInstances({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "vmInstanceIDs": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- vmInstanceIDs required VirtualMachineScaleSetVMInstanceRequiredIDs
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade

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.

azure_compute.VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSets_GetOSUpgradeHistory

Gets list of OS upgrades on a VM scale set instance.

azure_compute.VirtualMachineScaleSets_GetOSUpgradeHistory({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineScaleSetListOSUpgradeHistory

VirtualMachineScaleSets_PerformMaintenance

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

azure_compute.VirtualMachineScaleSets_PerformMaintenance({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- vmInstanceIDs VirtualMachineScaleSetVMInstanceIDs
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSets_PowerOff

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.

azure_compute.VirtualMachineScaleSets_PowerOff({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- vmInstanceIDs VirtualMachineScaleSetVMInstanceIDs
- skipShutdown boolean: 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
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSets_Redeploy

Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.

azure_compute.VirtualMachineScaleSets_Redeploy({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- vmInstanceIDs VirtualMachineScaleSetVMInstanceIDs
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSets_Reimage

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.

azure_compute.VirtualMachineScaleSets_Reimage({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- vmScaleSetReimageInput VirtualMachineScaleSetReimageParameters
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSets_ReimageAll

Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.

azure_compute.VirtualMachineScaleSets_ReimageAll({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- vmInstanceIDs VirtualMachineScaleSetVMInstanceIDs
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSets_Restart

Restarts one or more virtual machines in a VM scale set.

azure_compute.VirtualMachineScaleSets_Restart({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- vmInstanceIDs VirtualMachineScaleSetVMInstanceIDs
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSetRollingUpgrades_Cancel

Cancels the current virtual machine scale set rolling upgrade.

azure_compute.VirtualMachineScaleSetRollingUpgrades_Cancel({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSetRollingUpgrades_GetLatest

Gets the status of the latest virtual machine scale set rolling upgrade.

azure_compute.VirtualMachineScaleSetRollingUpgrades_GetLatest({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output RollingUpgradeStatusInfo

VirtualMachineScaleSets_ListSkus

Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.

azure_compute.VirtualMachineScaleSets_ListSkus({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineScaleSetListSkusResult

VirtualMachineScaleSets_Start

Starts one or more virtual machines in a VM scale set.

azure_compute.VirtualMachineScaleSets_Start({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- vmInstanceIDs VirtualMachineScaleSetVMInstanceIDs
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSetVMs_Delete

Deletes a virtual machine from a VM scale set.

azure_compute.VirtualMachineScaleSetVMs_Delete({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "instanceId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- instanceId required string: The instance ID of the virtual machine.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSetVMs_Get

Gets a virtual machine from a VM scale set.

azure_compute.VirtualMachineScaleSetVMs_Get({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "instanceId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- instanceId required string: The instance ID of the virtual machine.
- $expand string (values: instanceView): The expand expression to apply on the operation.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineScaleSetVM

VirtualMachineScaleSetVMs_Update

Updates a virtual machine of a VM scale set.

azure_compute.VirtualMachineScaleSetVMs_Update({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "instanceId": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set where the extension should be create or updated.
- instanceId required string: The instance ID of the virtual machine.
- parameters required VirtualMachineScaleSetVM
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineScaleSetVM

VirtualMachineScaleSetVMs_Deallocate

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.

azure_compute.VirtualMachineScaleSetVMs_Deallocate({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "instanceId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- instanceId required string: The instance ID of the virtual machine.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSetVMs_GetInstanceView

Gets the status of a virtual machine from a VM scale set.

azure_compute.VirtualMachineScaleSetVMs_GetInstanceView({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "instanceId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- instanceId required string: The instance ID of the virtual machine.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineScaleSetVMInstanceView

VirtualMachineScaleSetVMs_PerformMaintenance

Performs maintenance on a virtual machine in a VM scale set.

azure_compute.VirtualMachineScaleSetVMs_PerformMaintenance({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "instanceId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- instanceId required string: The instance ID of the virtual machine.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSetVMs_PowerOff

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.

azure_compute.VirtualMachineScaleSetVMs_PowerOff({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "instanceId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- instanceId required string: The instance ID of the virtual machine.
- skipShutdown boolean: 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
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSetVMs_Redeploy

Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.

azure_compute.VirtualMachineScaleSetVMs_Redeploy({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "instanceId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- instanceId required string: The instance ID of the virtual machine.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSetVMs_Reimage

Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.

azure_compute.VirtualMachineScaleSetVMs_Reimage({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "instanceId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- instanceId required string: The instance ID of the virtual machine.
- vmScaleSetVMReimageInput VirtualMachineScaleSetVMReimageParameters
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSetVMs_ReimageAll

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.

azure_compute.VirtualMachineScaleSetVMs_ReimageAll({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "instanceId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- instanceId required string: The instance ID of the virtual machine.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSetVMs_Restart

Restarts a virtual machine in a VM scale set.

azure_compute.VirtualMachineScaleSetVMs_Restart({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "instanceId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- instanceId required string: The instance ID of the virtual machine.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineScaleSetVMs_Start

Starts a virtual machine in a VM scale set.

azure_compute.VirtualMachineScaleSetVMs_Start({
  "resourceGroupName": "",
  "vmScaleSetName": "",
  "instanceId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmScaleSetName required string: The name of the VM scale set.
- instanceId required string: The instance ID of the virtual machine.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachines_List

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.

azure_compute.VirtualMachines_List({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineListResult

VirtualMachines_Delete

The operation to delete a virtual machine.

azure_compute.VirtualMachines_Delete({
  "resourceGroupName": "",
  "vmName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachines_Get

Retrieves information about the model view or the instance view of a virtual machine.

azure_compute.VirtualMachines_Get({
  "resourceGroupName": "",
  "vmName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine.
- $expand string (values: instanceView): The expand expression to apply on the operation.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachine

VirtualMachines_Update

The operation to update a virtual machine.

azure_compute.VirtualMachines_Update({
  "resourceGroupName": "",
  "vmName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine.
- parameters required VirtualMachineUpdate
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachine

VirtualMachines_CreateOrUpdate

The operation to create or update a virtual machine.

azure_compute.VirtualMachines_CreateOrUpdate({
  "resourceGroupName": "",
  "vmName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine.
- parameters required VirtualMachine
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachine

VirtualMachines_Capture

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

azure_compute.VirtualMachines_Capture({
  "resourceGroupName": "",
  "vmName": "",
  "parameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine.
- parameters required VirtualMachineCaptureParameters
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineCaptureResult

VirtualMachines_ConvertToManagedDisks

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

azure_compute.VirtualMachines_ConvertToManagedDisks({
  "resourceGroupName": "",
  "vmName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachines_Deallocate

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

azure_compute.VirtualMachines_Deallocate({
  "resourceGroupName": "",
  "vmName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineExtensions_List

The operation to get all extensions of a Virtual Machine.

azure_compute.VirtualMachineExtensions_List({
  "resourceGroupName": "",
  "vmName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine containing the extension.
- $expand string: The expand expression to apply on the operation.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineExtensionsListResult

VirtualMachineExtensions_Delete

The operation to delete the extension.

azure_compute.VirtualMachineExtensions_Delete({
  "resourceGroupName": "",
  "vmName": "",
  "vmExtensionName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine where the extension should be deleted.
- vmExtensionName required string: The name of the virtual machine extension.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachineExtensions_Get

The operation to get the extension.

azure_compute.VirtualMachineExtensions_Get({
  "resourceGroupName": "",
  "vmName": "",
  "vmExtensionName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine containing the extension.
- vmExtensionName required string: The name of the virtual machine extension.
- $expand string: The expand expression to apply on the operation.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineExtension

VirtualMachineExtensions_Update

The operation to update the extension.

azure_compute.VirtualMachineExtensions_Update({
  "resourceGroupName": "",
  "vmName": "",
  "vmExtensionName": "",
  "extensionParameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine where the extension should be updated.
- vmExtensionName required string: The name of the virtual machine extension.
- extensionParameters required VirtualMachineExtensionUpdate
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineExtension

VirtualMachineExtensions_CreateOrUpdate

The operation to create or update the extension.

azure_compute.VirtualMachineExtensions_CreateOrUpdate({
  "resourceGroupName": "",
  "vmName": "",
  "vmExtensionName": "",
  "extensionParameters": null,
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine where the extension should be created or updated.
- vmExtensionName required string: The name of the virtual machine extension.
- extensionParameters required VirtualMachineExtension
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineExtension

VirtualMachines_Generalize

Sets the state of the virtual machine to generalized.

azure_compute.VirtualMachines_Generalize({
  "resourceGroupName": "",
  "vmName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachines_InstanceView

Retrieves information about the run-time state of a virtual machine.

azure_compute.VirtualMachines_InstanceView({
  "resourceGroupName": "",
  "vmName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineInstanceView

VirtualMachines_PerformMaintenance

The operation to perform maintenance on a virtual machine.

azure_compute.VirtualMachines_PerformMaintenance({
  "resourceGroupName": "",
  "vmName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachines_PowerOff

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.

azure_compute.VirtualMachines_PowerOff({
  "resourceGroupName": "",
  "vmName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine.
- skipShutdown boolean: 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
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachines_Redeploy

Shuts down the virtual machine, moves it to a new node, and powers it back on.

azure_compute.VirtualMachines_Redeploy({
  "resourceGroupName": "",
  "vmName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachines_Reimage

Reimages the virtual machine which has an ephemeral OS disk back to its initial state.

azure_compute.VirtualMachines_Reimage({
  "resourceGroupName": "",
  "vmName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine.
- parameters VirtualMachineReimageParameters
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachines_Restart

The operation to restart a virtual machine.

azure_compute.VirtualMachines_Restart({
  "resourceGroupName": "",
  "vmName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachines_Start

The operation to start a virtual machine.

azure_compute.VirtualMachines_Start({
  "resourceGroupName": "",
  "vmName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

VirtualMachines_ListAvailableSizes

Lists all available virtual machine sizes to which the specified virtual machine can be resized.

azure_compute.VirtualMachines_ListAvailableSizes({
  "resourceGroupName": "",
  "vmName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required string: The name of the resource group.
- vmName required string: The name of the virtual machine.
- api-version required string: Client Api Version.
- subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output VirtualMachineSizeListResult

Definitions

AdditionalCapabilities

AdditionalCapabilities object: Enables or disables a capability on the virtual machine or virtual machine scale set.
- ultraSSDEnabled boolean: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled.

AdditionalUnattendContent

AdditionalUnattendContent object: Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied.
- componentName string (values: Microsoft-Windows-Shell-Setup): The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.
- content string: Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.
- passName string (values: OobeSystem): The pass name. Currently, the only allowable value is OobeSystem.
- settingName string (values: AutoLogon, FirstLogonCommands): Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

ApiEntityReference

ApiEntityReference object: The API entity reference.
- id string: The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

ApiError object: Api error.
- code string: The error code.
- details array: The Api error details
  - items ApiErrorBase
- innererror InnerError
- message string: The error message.
- target string: The target of the particular error.

ApiErrorBase

ApiErrorBase object: Api error base.
- code string: The error code.
- message string: The error message.
- target string: The target of the particular error.

AutomaticOSUpgradePolicy

AutomaticOSUpgradePolicy object: The configuration parameters used for performing automatic OS upgrade.
- disableAutomaticRollback boolean: Whether OS image rollback feature should be disabled. Default value is false.
- enableAutomaticOSUpgrade boolean: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false.
  
  If this is set to true for Windows based scale sets, enableAutomaticUpdates is automatically set to false and cannot be set to true.

AutomaticOSUpgradeProperties

AutomaticOSUpgradeProperties object: Describes automatic OS upgrade properties on the image.
- automaticOSUpgradeSupported required boolean: Specifies whether automatic OS upgrade is supported on the image.

AvailabilitySet

AvailabilitySet object: Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Manage the availability of virtual machines.

For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.
- properties AvailabilitySetProperties
- sku Sku
- id string: Resource Id
- location required string: Resource location
- name string: Resource name
- tags object: Resource tags
- type string: Resource type

AvailabilitySetListResult

AvailabilitySetListResult object: The List Availability Set operation response.
- nextLink string: The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets.
- value required array: The list of availability sets
  - items AvailabilitySet

AvailabilitySetProperties

AvailabilitySetProperties object: The instance view of a resource.
- platformFaultDomainCount integer: Fault Domain count.
- platformUpdateDomainCount integer: Update Domain count.
- proximityPlacementGroup SubResource
- statuses array: The resource status information.
  - items InstanceViewStatus
- virtualMachines array: A list of references to all virtual machines in the availability set.
  - items SubResource

AvailabilitySetSkuType

AvailabilitySetSkuType string (values: Classic, Aligned): Specifies the sku of an Availability Set. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.

AvailabilitySetUpdate

AvailabilitySetUpdate object: Specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated.
- properties AvailabilitySetProperties
- sku Sku
- tags object: Resource tags

BillingProfile

BillingProfile object: Specifies the billing related details of a low priority VM or VMSS.

Minimum api-version: 2019-03-01.
- maxPrice number: Specifies the maximum price you are willing to pay for a low priority VM/VMSS. This price is in US Dollars.
  
  This price will be compared with the current low priority price for the VM size. Also, the prices are compared at the time of create/update of low priority VM/VMSS and the operation will only succeed if the maxPrice is greater than the current low priority price.
  
  The maxPrice will also be used for evicting a low priority VM/VMSS if the current low priority price goes beyond the maxPrice after creation of VM/VMSS.
  
  Possible values are:
  
  - Any decimal value greater than zero. Example: $0.01538
  
  -1 – indicates default price to be up-to on-demand.
  
  You can set the maxPrice to -1 to indicate that the low priority VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.
  
  Minimum api-version: 2019-03-01.

BootDiagnostics

BootDiagnostics object: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

You can easily view the output of your console log.

Azure also enables you to see a screenshot of the VM from the hypervisor.
- enabled boolean: Whether boot diagnostics should be enabled on the Virtual Machine.
- storageUri string: Uri of the storage account to use for placing the console output and screenshot.

BootDiagnosticsInstanceView

BootDiagnosticsInstanceView object: The instance view of a virtual machine boot diagnostics.
- consoleScreenshotBlobUri string: The console screenshot blob URI.
- serialConsoleLogBlobUri string: The Linux serial console log blob Uri.
- status InstanceViewStatus

Caching

Caching string (values: None, ReadOnly, ReadWrite): Specifies the caching requirements.

Possible values are:

None

ReadOnly

ReadWrite

Default: None for Standard storage. ReadOnly for Premium storage

ComputeOperationListResult

ComputeOperationListResult object: The List Compute Operation operation response.
- value array: The list of compute operations
  - items ComputeOperationValue

ComputeOperationValue

ComputeOperationValue object: Describes the properties of a Compute Operation value.
- display ComputeOperationValueDisplay
- name string: The name of the compute operation.
- origin string: The origin of the compute operation.

ComputeOperationValueDisplay

ComputeOperationValueDisplay object: Describes the properties of a Compute Operation Value Display.
- description string: The description of the operation.
- operation string: The display name of the compute operation.
- provider string: The resource provider for the operation.
- resource string: The display name of the resource the operation applies to.

CreateOption

CreateOption string (values: FromImage, Empty, Attach): Specifies how the virtual machine should be created.

Possible values are:

Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine.

FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.

DataDisk

DataDisk object: Describes a data disk.
- caching Caching
- createOption required CreateOption
- diskSizeGB integer: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.
  
  This value cannot be larger than 1023 GB
- image VirtualHardDisk
- lun required integer: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
- managedDisk ManagedDiskParameters
- name string: The disk name.
- toBeDetached boolean: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset
- vhd VirtualHardDisk
- writeAcceleratorEnabled boolean: Specifies whether writeAccelerator should be enabled or disabled on the disk.

DataDiskImage

DataDiskImage object: Contains the data disk images information.
- lun integer: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.

DedicatedHost

DedicatedHost object: Specifies information about the Dedicated host.
- properties DedicatedHostProperties
- sku required Sku
- id string: Resource Id
- location required string: Resource location
- name string: Resource name
- tags object: Resource tags
- type string: Resource type

DedicatedHostAllocatableVM

DedicatedHostAllocatableVM object: Represents the dedicated host unutilized capacity in terms of a specific VM size.
- count number: Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity.
- vmSize string: VM size in terms of which the unutilized capacity is represented.

DedicatedHostAvailableCapacity

DedicatedHostAvailableCapacity object: Dedicated host unutilized capacity.
- allocatableVMs array: The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host.
  - items DedicatedHostAllocatableVM

DedicatedHostGroup

DedicatedHostGroup object: Specifies information about the dedicated host group that the dedicated hosts should be assigned to.

Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group.
- properties DedicatedHostGroupProperties
- zones array: Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.
  - items string
- id string: Resource Id
- location required string: Resource location
- name string: Resource name
- tags object: Resource tags
- type string: Resource type

DedicatedHostGroupListResult

DedicatedHostGroupListResult object: The List Dedicated Host Group with resource group response.
- nextLink string: The URI to fetch the next page of Dedicated Host Groups. Call ListNext() with this URI to fetch the next page of Dedicated Host Groups.
- value required array: The list of dedicated host groups
  - items DedicatedHostGroup

DedicatedHostGroupProperties

DedicatedHostGroupProperties object: Dedicated Host Group Properties.
- hosts array: A list of references to all dedicated hosts in the dedicated host group.
  - items SubResourceReadOnly
- platformFaultDomainCount required integer: Number of fault domains that the host group can span.

DedicatedHostGroupUpdate

DedicatedHostGroupUpdate object: Specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated.
- properties DedicatedHostGroupProperties
- zones array: Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.
  - items string
- tags object: Resource tags

DedicatedHostInstanceView

DedicatedHostInstanceView object: The instance view of a dedicated host.
- assetId string: Specifies the unique id of the dedicated physical machine on which the dedicated host resides.
- availableCapacity DedicatedHostAvailableCapacity
- statuses array: The resource status information.
  - items InstanceViewStatus

DedicatedHostLicenseType

DedicatedHostLicenseType string (values: None, Windows_Server_Hybrid, Windows_Server_Perpetual): Specifies the software license type that will be applied to the VMs deployed on the dedicated host.

Possible values are:

None

Windows_Server_Hybrid

Windows_Server_Perpetual

Default: None

DedicatedHostListResult

DedicatedHostListResult object: The list dedicated host operation response.
- nextLink string: The URI to fetch the next page of dedicated hosts. Call ListNext() with this URI to fetch the next page of dedicated hosts.
- value required array: The list of dedicated hosts
  - items DedicatedHost

DedicatedHostProperties

DedicatedHostProperties object: Properties of the dedicated host.
- autoReplaceOnFailure boolean: Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided.
- hostId string: A unique id generated and assigned to the dedicated host by the platform.
  
  Does not change throughout the lifetime of the host.
- instanceView DedicatedHostInstanceView
- licenseType DedicatedHostLicenseType
- platformFaultDomain integer: Fault domain of the dedicated host within a dedicated host group.
- provisioningState string: The provisioning state, which only appears in the response.
- provisioningTime string: The date when the host was first provisioned.
- virtualMachines array: A list of references to all virtual machines in the Dedicated Host.
  - items SubResourceReadOnly

DedicatedHostUpdate

DedicatedHostUpdate object: Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated.
- properties DedicatedHostProperties
- tags object: Resource tags

DiagnosticsProfile

DiagnosticsProfile object: Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15.
- bootDiagnostics BootDiagnostics

DiffDiskOption

DiffDiskOption string (values: Local): Specifies the ephemeral disk option for operating system disk.

DiffDiskSettings

DiffDiskSettings object: Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

NOTE: The ephemeral disk settings can only be specified for managed disk.
- option DiffDiskOption

DiskEncryptionSettings

DiskEncryptionSettings object: Describes a Encryption Settings for a Disk
- diskEncryptionKey KeyVaultSecretReference
- enabled boolean: Specifies whether disk encryption should be enabled on the virtual machine.
- keyEncryptionKey KeyVaultKeyReference

DiskInstanceView

DiskInstanceView object: The instance view of the disk.
- encryptionSettings array: Specifies the encryption settings for the OS Disk.
  
  Minimum api-version: 2015-06-15
  - items DiskEncryptionSettings
- name string: The disk name.
- statuses array: The resource status information.
  - items InstanceViewStatus

HardwareProfile

HardwareProfile object: Specifies the hardware settings for the virtual machine.
- vmSize string (values: Basic_A0, Basic_A1, Basic_A2, Basic_A3, Basic_A4, Standard_A0, Standard_A1, Standard_A2, Standard_A3, Standard_A4, Standard_A5, Standard_A6, Standard_A7, Standard_A8, Standard_A9, Standard_A10, Standard_A11, Standard_A1_v2, Standard_A2_v2, Standard_A4_v2, Standard_A8_v2, Standard_A2m_v2, Standard_A4m_v2, Standard_A8m_v2, Standard_B1s, Standard_B1ms, Standard_B2s, Standard_B2ms, Standard_B4ms, Standard_B8ms, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14, Standard_D1_v2, Standard_D2_v2, Standard_D3_v2, Standard_D4_v2, Standard_D5_v2, Standard_D2_v3, Standard_D4_v3, Standard_D8_v3, Standard_D16_v3, Standard_D32_v3, Standard_D64_v3, Standard_D2s_v3, Standard_D4s_v3, Standard_D8s_v3, Standard_D16s_v3, Standard_D32s_v3, Standard_D64s_v3, Standard_D11_v2, Standard_D12_v2, Standard_D13_v2, Standard_D14_v2, Standard_D15_v2, Standard_DS1, Standard_DS2, Standard_DS3, Standard_DS4, Standard_DS11, Standard_DS12, Standard_DS13, Standard_DS14, Standard_DS1_v2, Standard_DS2_v2, Standard_DS3_v2, Standard_DS4_v2, Standard_DS5_v2, Standard_DS11_v2, Standard_DS12_v2, Standard_DS13_v2, Standard_DS14_v2, Standard_DS15_v2, Standard_DS13-4_v2, Standard_DS13-2_v2, Standard_DS14-8_v2, Standard_DS14-4_v2, Standard_E2_v3, Standard_E4_v3, Standard_E8_v3, Standard_E16_v3, Standard_E32_v3, Standard_E64_v3, Standard_E2s_v3, Standard_E4s_v3, Standard_E8s_v3, Standard_E16s_v3, Standard_E32s_v3, Standard_E64s_v3, Standard_E32-16_v3, Standard_E32-8s_v3, Standard_E64-32s_v3, Standard_E64-16s_v3, Standard_F1, Standard_F2, Standard_F4, Standard_F8, Standard_F16, Standard_F1s, Standard_F2s, Standard_F4s, Standard_F8s, Standard_F16s, Standard_F2s_v2, Standard_F4s_v2, Standard_F8s_v2, Standard_F16s_v2, Standard_F32s_v2, Standard_F64s_v2, Standard_F72s_v2, Standard_G1, Standard_G2, Standard_G3, Standard_G4, Standard_G5, Standard_GS1, Standard_GS2, Standard_GS3, Standard_GS4, Standard_GS5, Standard_GS4-8, Standard_GS4-4, Standard_GS5-16, Standard_GS5-8, Standard_H8, Standard_H16, Standard_H8m, Standard_H16m, Standard_H16r, Standard_H16mr, Standard_L4s, Standard_L8s, Standard_L16s, Standard_L32s, Standard_M64s, Standard_M64ms, Standard_M128s, Standard_M128ms, Standard_M64-32ms, Standard_M64-16ms, Standard_M128-64ms, Standard_M128-32ms, Standard_NC6, Standard_NC12, Standard_NC24, Standard_NC24r, Standard_NC6s_v2, Standard_NC12s_v2, Standard_NC24s_v2, Standard_NC24rs_v2, Standard_NC6s_v3, Standard_NC12s_v3, Standard_NC24s_v3, Standard_NC24rs_v3, Standard_ND6s, Standard_ND12s, Standard_ND24s, Standard_ND24rs, Standard_NV6, Standard_NV12, Standard_NV24): Specifies the size of the virtual machine. For more information about virtual machine sizes, see Sizes for virtual machines.
  
  The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:
  
  List all available virtual machine sizes in an availability set
  
  List all available virtual machine sizes in a region
  
  List all available virtual machine sizes for resizing

HyperVGenerationType

HyperVGenerationType string (values: V1, V2): Specifies the HyperVGeneration Type

Image

Image object: The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.
- properties ImageProperties
- id string: Resource Id
- location required string: Resource location
- name string: Resource name
- tags object: Resource tags
- type string: Resource type

ImageDataDisk

ImageDataDisk object: Describes a data disk.
- blobUri string: The Virtual Hard Disk.
- caching string (values: None, ReadOnly, ReadWrite): Specifies the caching requirements.
  
  Possible values are:
  
  None
  
  ReadOnly
  
  ReadWrite
  
  Default: None for Standard storage. ReadOnly for Premium storage
- diskSizeGB integer: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.
  
  This value cannot be larger than 1023 GB
- lun required integer: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
- managedDisk SubResource
- snapshot SubResource
- storageAccountType StorageAccountType

ImageListResult

ImageListResult object: The List Image operation response.
- nextLink string: The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images.
- value required array: The list of Images.
  - items Image

ImageOSDisk

ImageOSDisk object: Describes an Operating System disk.
- blobUri string: The Virtual Hard Disk.
- caching string (values: None, ReadOnly, ReadWrite): Specifies the caching requirements.
  
  Possible values are:
  
  None
  
  ReadOnly
  
  ReadWrite
  
  Default: None for Standard storage. ReadOnly for Premium storage
- diskSizeGB integer: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.
  
  This value cannot be larger than 1023 GB
- managedDisk SubResource
- osState required string (values: Generalized, Specialized): The OS State.
- osType required string (values: Windows, Linux): This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.
  
  Possible values are:
  
  Windows
  
  Linux
- snapshot SubResource
- storageAccountType StorageAccountType

ImageProperties

ImageProperties object: Describes the properties of an Image.
- hyperVGeneration HyperVGenerationType
- provisioningState string: The provisioning state.
- sourceVirtualMachine SubResource
- storageProfile ImageStorageProfile

ImageReference

ImageReference object: Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations.
- offer string: Specifies the offer of the platform image or marketplace image used to create the virtual machine.
- publisher string: The image publisher.
- sku string: The image SKU.
- version string: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available.
- id string: Resource Id

ImageStorageProfile

ImageStorageProfile object: Describes a storage profile.
- dataDisks array: Specifies the parameters that are used to add a data disk to a virtual machine.
  
  For more information about disks, see About disks and VHDs for Azure virtual machines.
  - items ImageDataDisk
- osDisk ImageOSDisk
- zoneResilient boolean: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).

ImageUpdate

ImageUpdate object: The source user image virtual hard disk. Only tags may be updated.
- properties ImageProperties
- tags object: Resource tags

InnerError

InnerError object: Inner error details.
- errordetail string: The internal error message or exception dump.
- exceptiontype string: The exception type.

InstanceViewStatus

InstanceViewStatus object: Instance view status.
- code string: The status code.
- displayStatus string: The short localizable label for the status.
- level string (values: Info, Warning, Error): The level code.
- message string: The detailed status message, including for alerts and error messages.
- time string: The time of the status.

KeyVaultKeyReference

KeyVaultKeyReference object: Describes a reference to Key Vault Key
- keyUrl required string: The URL referencing a key encryption key in Key Vault.
- sourceVault required SubResource

KeyVaultSecretReference

KeyVaultSecretReference object: Describes a reference to Key Vault Secret
- secretUrl required string: The URL referencing a secret in a Key Vault.
- sourceVault required SubResource

LinuxConfiguration

LinuxConfiguration object: Specifies the Linux operating system settings on the virtual machine.

For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions

For running non-endorsed distributions, see Information for Non-Endorsed Distributions.
- disablePasswordAuthentication boolean: Specifies whether password authentication should be disabled.
- provisionVMAgent boolean: Indicates whether virtual machine agent should be provisioned on the virtual machine.
  
  When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
- ssh SshConfiguration

ListUsagesResult

ListUsagesResult object: The List Usages operation response.
- nextLink string: The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information.
- value required array: The list of compute resource usages.
  - items Usage

LogAnalyticsInputBase

LogAnalyticsInputBase object: Api input base class for LogAnalytics Api.
- blobContainerSasUri required string: SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to.
- fromTime required string: From time of the query
- groupByOperationName boolean: Group query result by Operation Name.
- groupByResourceName boolean: Group query result by Resource Name.
- groupByThrottlePolicy boolean: Group query result by Throttle Policy applied.
- toTime required string: To time of the query

LogAnalyticsOperationResult

LogAnalyticsOperationResult object: LogAnalytics operation status response
- properties LogAnalyticsOutput

LogAnalyticsOutput

LogAnalyticsOutput object: LogAnalytics output properties
- output string: Output file Uri path to blob container.

MaintenanceRedeployStatus

MaintenanceRedeployStatus object: Maintenance Operation Status.
- isCustomerInitiatedMaintenanceAllowed boolean: True, if customer is allowed to perform Maintenance.
- lastOperationMessage string: Message returned for the last Maintenance Operation.
- lastOperationResultCode string (values: None, RetryLater, MaintenanceAborted, MaintenanceCompleted): The Last Maintenance Operation Result Code.
- maintenanceWindowEndTime string: End Time for the Maintenance Window.
- maintenanceWindowStartTime string: Start Time for the Maintenance Window.
- preMaintenanceWindowEndTime string: End Time for the Pre Maintenance Window.
- preMaintenanceWindowStartTime string: Start Time for the Pre Maintenance Window.

ManagedDiskParameters

ManagedDiskParameters object: The parameters of a managed disk.
- storageAccountType StorageAccountType
- id string: Resource Id

NetworkInterfaceReference

NetworkInterfaceReference object: Describes a network interface reference.
- properties NetworkInterfaceReferenceProperties
- id string: Resource Id

NetworkInterfaceReferenceProperties

NetworkInterfaceReferenceProperties object: Describes a network interface reference properties.
- primary boolean: Specifies the primary network interface in case the virtual machine has more than 1 network interface.

NetworkProfile

NetworkProfile object: Specifies the network interfaces of the virtual machine.
- networkInterfaces array: Specifies the list of resource Ids for the network interfaces associated with the virtual machine.
  - items NetworkInterfaceReference

OSDisk

OSDisk object: Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see About disks and VHDs for Azure virtual machines.
- caching Caching
- createOption required CreateOption
- diffDiskSettings DiffDiskSettings
- diskSizeGB integer: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.
  
  This value cannot be larger than 1023 GB
- encryptionSettings DiskEncryptionSettings
- image VirtualHardDisk
- managedDisk ManagedDiskParameters
- name string: The disk name.
- osType string (values: Windows, Linux): This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.
  
  Possible values are:
  
  Windows
  
  Linux
- vhd VirtualHardDisk
- writeAcceleratorEnabled boolean: Specifies whether writeAccelerator should be enabled or disabled on the disk.

OSDiskImage

OSDiskImage object: Contains the os disk image information.
- operatingSystem required string (values: Windows, Linux): The operating system of the osDiskImage.

OSProfile

OSProfile object: Specifies the operating system settings for the virtual machine.
- adminPassword string: Specifies the password of the administrator account.
  
  Minimum-length (Windows): 8 characters
  
  Minimum-length (Linux): 6 characters
  
  Max-length (Windows): 123 characters
  
  Max-length (Linux): 72 characters
  
  Complexity requirements: 3 out of 4 conditions below need to be fulfilled
  Has lower characters
  Has upper characters
  Has a digit
  Has a special character (Regex match [\W_])
  
  Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"
  
  For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM
  
  For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension
- adminUsername string: Specifies the name of the administrator account.
  
  Windows-only restriction: Cannot end in "."
  
  Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".
  
  Minimum-length (Linux): 1 character
  
  Max-length (Linux): 64 characters
  
  Max-length (Windows): 20 characters
- For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure
- For a list of built-in system users on Linux that should not be used in this field, see Selecting User Names for Linux on Azure
- allowExtensionOperations boolean: Specifies whether extension operations should be allowed on the virtual machine.
  
  This may only be set to False when no extensions are present on the virtual machine.
- computerName string: Specifies the host OS name of the virtual machine.
  
  This name cannot be updated after the VM is created.
  
  Max-length (Windows): 15 characters
  
  Max-length (Linux): 64 characters.
  
  For naming conventions and restrictions see Azure infrastructure services implementation guidelines.
- customData string: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.
  
  For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation
- linuxConfiguration LinuxConfiguration
- secrets array: Specifies set of certificates that should be installed onto the virtual machine.
  - items VaultSecretGroup
- windowsConfiguration WindowsConfiguration

Plan

Plan object: Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.
- name string: The plan ID.
- product string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
- promotionCode string: The promotion code.
- publisher string: The publisher ID.

ProximityPlacementGroup

ProximityPlacementGroup object: Specifies information about the proximity placement group.
- properties ProximityPlacementGroupProperties
- id string: Resource Id
- location required string: Resource location
- name string: Resource name
- tags object: Resource tags
- type string: Resource type

ProximityPlacementGroupListResult

ProximityPlacementGroupListResult object: The List Proximity Placement Group operation response.
- nextLink string: The URI to fetch the next page of proximity placement groups.
- value required array: The list of proximity placement groups
  - items ProximityPlacementGroup

ProximityPlacementGroupProperties

ProximityPlacementGroupProperties object: Describes the properties of a Proximity Placement Group.
- availabilitySets array: A list of references to all availability sets in the proximity placement group.
  - items SubResource
- proximityPlacementGroupType string (values: Standard, Ultra): Specifies the type of the proximity placement group.
  
  Possible values are:
  
  Standard : Co-locate resources within an Azure region or Availability Zone.
  
  Ultra : For future use.
- virtualMachineScaleSets array: A list of references to all virtual machine scale sets in the proximity placement group.
  - items SubResource
- virtualMachines array: A list of references to all virtual machines in the proximity placement group.
  - items SubResource

ProximityPlacementGroupUpdate

ProximityPlacementGroupUpdate: Specifies information about the proximity placement group.
- tags object: Resource tags

PurchasePlan

PurchasePlan object: Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
- name required string: The plan ID.
- product required string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
- publisher required string: The publisher ID.

RecoveryWalkResponse

RecoveryWalkResponse object: Response after calling a manual recovery walk
- nextPlatformUpdateDomain integer: The next update domain that needs to be walked. Null means walk spanning all update domains has been completed
- walkPerformed boolean: Whether the recovery walk was performed

RequestRateByIntervalInput

RequestRateByIntervalInput object: Api request input for LogAnalytics getRequestRateByInterval Api.
- intervalLength required string (values: ThreeMins, FiveMins, ThirtyMins, SixtyMins): Interval value in minutes used to create LogAnalytics call rate logs.
- blobContainerSasUri required string: SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to.
- fromTime required string: From time of the query
- groupByOperationName boolean: Group query result by Operation Name.
- groupByResourceName boolean: Group query result by Resource Name.
- groupByThrottlePolicy boolean: Group query result by Throttle Policy applied.
- toTime required string: To time of the query

Resource

Resource object: The Resource model definition.
- id string: Resource Id
- location required string: Resource location
- name string: Resource name
- tags object: Resource tags
- type string: Resource type

RollbackStatusInfo

RollbackStatusInfo object: Information about rollback on failed VM instances after a OS Upgrade operation.
- failedRolledbackInstanceCount integer: The number of instances which failed to rollback.
- rollbackError ApiError
- successfullyRolledbackInstanceCount integer: The number of instances which have been successfully rolled back.

RollingUpgradePolicy

RollingUpgradePolicy object: The configuration parameters used while performing a rolling upgrade.
- maxBatchInstancePercent integer: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%.
- maxUnhealthyInstancePercent integer: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%.
- maxUnhealthyUpgradedInstancePercent integer: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%.
- pauseTimeBetweenBatches string: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S).

RollingUpgradeProgressInfo

RollingUpgradeProgressInfo object: Information about the number of virtual machine instances in each upgrade state.
- failedInstanceCount integer: The number of instances that have failed to be upgraded successfully.
- inProgressInstanceCount integer: The number of instances that are currently being upgraded.
- pendingInstanceCount integer: The number of instances that have not yet begun to be upgraded.
- successfulInstanceCount integer: The number of instances that have been successfully upgraded.

RollingUpgradeRunningStatus

RollingUpgradeRunningStatus object: Information about the current running state of the overall upgrade.
- code string (values: RollingForward, Cancelled, Completed, Faulted): Code indicating the current status of the upgrade.
- lastAction string (values: Start, Cancel): The last action performed on the rolling upgrade.
- lastActionTime string: Last action time of the upgrade.
- startTime string: Start time of the upgrade.

RollingUpgradeStatusInfo

RollingUpgradeStatusInfo object: The status of the latest virtual machine scale set rolling upgrade.
- properties RollingUpgradeStatusInfoProperties
- id string: Resource Id
- location required string: Resource location
- name string: Resource name
- tags object: Resource tags
- type string: Resource type

RollingUpgradeStatusInfoProperties

RollingUpgradeStatusInfoProperties object: The status of the latest virtual machine scale set rolling upgrade.
- error ApiError
- policy RollingUpgradePolicy
- progress RollingUpgradeProgressInfo
- runningStatus RollingUpgradeRunningStatus

ScaleInPolicy

ScaleInPolicy object: Describes a scale-in policy for a virtual machine scale set.
- rules array: The rules to be followed when scaling-in a virtual machine scale set.
  
  Possible values are:
  
  Default When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.
  
  OldestVM When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.
  
  NewestVM When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.
  - items string (values: Default, OldestVM, NewestVM)

ScheduledEventsProfile

ScheduledEventsProfile object
- terminateNotificationProfile TerminateNotificationProfile

Sku

Sku object: Describes a virtual machine scale set sku.
- capacity integer: Specifies the number of virtual machines in the scale set.
- name string: The sku name.
- tier string: Specifies the tier of virtual machines in a scale set.
  
  Possible Values:
  
  Standard
  
  Basic

SshConfiguration

SshConfiguration object: SSH configuration for Linux based VMs running on Azure
- publicKeys array: The list of SSH public keys used to authenticate with linux based VMs.
  - items SshPublicKey

SshPublicKey

SshPublicKey object: Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.
- keyData string: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.
  
  For creating ssh keys, see Create SSH keys on Linux and Mac for Linux VMs in Azure.
- path string: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys

StorageAccountType

StorageAccountType string (values: Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS): Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

StorageProfile

StorageProfile object: Specifies the storage settings for the virtual machine disks.
- dataDisks array: Specifies the parameters that are used to add a data disk to a virtual machine.
  
  For more information about disks, see About disks and VHDs for Azure virtual machines.
  - items DataDisk
- imageReference ImageReference
- osDisk OSDisk

SubResource

SubResource object
- id string: Resource Id

SubResourceReadOnly

SubResourceReadOnly object
- id string: Resource Id

TerminateNotificationProfile

TerminateNotificationProfile object
- enable boolean: Specifies whether the Terminate Scheduled event is enabled or disabled.
- notBeforeTimeout string: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M)

ThrottledRequestsInput

ThrottledRequestsInput: Api request input for LogAnalytics getThrottledRequests Api.
- blobContainerSasUri required string: SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to.
- fromTime required string: From time of the query
- groupByOperationName boolean: Group query result by Operation Name.
- groupByResourceName boolean: Group query result by Resource Name.
- groupByThrottlePolicy boolean: Group query result by Throttle Policy applied.
- toTime required string: To time of the query

UpdateResource

UpdateResource object: The Update Resource model definition.
- tags object: Resource tags

UpgradeOperationHistoricalStatusInfo

UpgradeOperationHistoricalStatusInfo object: Virtual Machine Scale Set OS Upgrade History operation response.
- location string: Resource location
- properties UpgradeOperationHistoricalStatusInfoProperties
- type string: Resource type

UpgradeOperationHistoricalStatusInfoProperties

UpgradeOperationHistoricalStatusInfoProperties object: Describes each OS upgrade on the Virtual Machine Scale Set.
- error ApiError
- progress RollingUpgradeProgressInfo
- rollbackInfo RollbackStatusInfo
- runningStatus UpgradeOperationHistoryStatus
- startedBy string (values: Unknown, User, Platform): Invoker of the Upgrade Operation
- targetImageReference ImageReference

UpgradeOperationHistoryStatus

UpgradeOperationHistoryStatus object: Information about the current running state of the overall upgrade.
- code string (values: RollingForward, Cancelled, Completed, Faulted): Code indicating the current status of the upgrade.
- endTime string: End time of the upgrade.
- startTime string: Start time of the upgrade.

UpgradePolicy

UpgradePolicy object: Describes an upgrade policy - automatic, manual, or rolling.
- automaticOSUpgradePolicy AutomaticOSUpgradePolicy
- mode string (values: Automatic, Manual, Rolling): Specifies the mode of an upgrade to virtual machines in the scale set.
  
  Possible values are:
  
  Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.
  
  Automatic - All virtual machines in the scale set are automatically updated at the same time.
- rollingUpgradePolicy RollingUpgradePolicy

Usage

Usage object: Describes Compute Resource Usage.
- currentValue required integer: The current usage of the resource.
- limit required integer: The maximum permitted usage of the resource.
- name required UsageName
- unit required string (values: Count): An enum describing the unit of usage measurement.

UsageName

UsageName object: The Usage Names.
- localizedValue string: The localized name of the resource.
- value string: The name of the resource.

VMScaleSetConvertToSinglePlacementGroupInput

VMScaleSetConvertToSinglePlacementGroupInput object
- activePlacementGroupId string: 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.

VaultCertificate

VaultCertificate object: Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.
- certificateStore string: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.
  
  For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.
- certificateUrl string: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:
  
  {
  "data":"",
  "dataType":"pfx",
  "password":""
  }

VaultSecretGroup

VaultSecretGroup object: Describes a set of certificates which are all in the same Key Vault.
- sourceVault SubResource
- vaultCertificates array: The list of key vault references in SourceVault which contain certificates.
  - items VaultCertificate

VirtualHardDisk

VirtualHardDisk object: Describes the uri of a disk.
- uri string: Specifies the virtual hard disk's uri.

VirtualMachine

VirtualMachine object: Describes a Virtual Machine.
- identity VirtualMachineIdentity
- plan Plan
- properties VirtualMachineProperties
- resources array: The virtual machine child extension resources.
  - items VirtualMachineExtension
- zones array: The virtual machine zones.
  - items string
- id string: Resource Id
- location required string: Resource location
- name string: Resource name
- tags object: Resource tags
- type string: Resource type

VirtualMachineAgentInstanceView

VirtualMachineAgentInstanceView object: The instance view of the VM Agent running on the virtual machine.
- extensionHandlers array: The virtual machine extension handler instance view.
  - items VirtualMachineExtensionHandlerInstanceView
- statuses array: The resource status information.
  - items InstanceViewStatus
- vmAgentVersion string: The VM Agent full version.

VirtualMachineCaptureParameters

VirtualMachineCaptureParameters object: Capture Virtual Machine parameters.
- destinationContainerName required string: The destination container name.
- overwriteVhds required boolean: Specifies whether to overwrite the destination virtual hard disk, in case of conflict.
- vhdPrefix required string: The captured virtual hard disk's name prefix.

VirtualMachineCaptureResult

VirtualMachineCaptureResult object: Output of virtual machine capture operation.
- $schema string: the schema of the captured virtual machine
- contentVersion string: the version of the content
- parameters object: parameters of the captured virtual machine
- resources array: a list of resource items of the captured virtual machine
  - items object: resource item
- id string: Resource Id

VirtualMachineExtension

VirtualMachineExtension object: Describes a Virtual Machine Extension.
- properties VirtualMachineExtensionProperties
- id string: Resource Id
- location required string: Resource location
- name string: Resource name
- tags object: Resource tags
- type string: Resource type

VirtualMachineExtensionHandlerInstanceView

VirtualMachineExtensionHandlerInstanceView object: The instance view of a virtual machine extension handler.
- status InstanceViewStatus
- type string: Specifies the type of the extension; an example is "CustomScriptExtension".
- typeHandlerVersion string: Specifies the version of the script handler.

VirtualMachineExtensionImage

VirtualMachineExtensionImage object: Describes a Virtual Machine Extension Image.
- properties VirtualMachineExtensionImageProperties
- id string: Resource Id
- location required string: Resource location
- name string: Resource name
- tags object: Resource tags
- type string: Resource type

VirtualMachineExtensionImageProperties

VirtualMachineExtensionImageProperties object: Describes the properties of a Virtual Machine Extension Image.
- computeRole required string: The type of role (IaaS or PaaS) this extension supports.
- handlerSchema required string: The schema defined by publisher, where extension consumers should provide settings in a matching schema.
- operatingSystem required string: The operating system this extension supports.
- supportsMultipleExtensions boolean: Whether the handler can support multiple extensions.
- vmScaleSetEnabled boolean: Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS.

VirtualMachineExtensionInstanceView

VirtualMachineExtensionInstanceView object: The instance view of a virtual machine extension.
- name string: The virtual machine extension name.
- statuses array: The resource status information.
  - items InstanceViewStatus
- substatuses array: The resource status information.
  - items InstanceViewStatus
- type string: Specifies the type of the extension; an example is "CustomScriptExtension".
- typeHandlerVersion string: Specifies the version of the script handler.

VirtualMachineExtensionProperties

VirtualMachineExtensionProperties object: Describes the properties of a Virtual Machine Extension.
- autoUpgradeMinorVersion boolean: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- forceUpdateTag string: How the extension handler should be forced to update even if the extension configuration has not changed.
- instanceView VirtualMachineExtensionInstanceView
- protectedSettings object: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- provisioningState string: The provisioning state, which only appears in the response.
- publisher string: The name of the extension handler publisher.
- settings object: Json formatted public settings for the extension.
- type string: Specifies the type of the extension; an example is "CustomScriptExtension".
- typeHandlerVersion string: Specifies the version of the script handler.

VirtualMachineExtensionUpdate

VirtualMachineExtensionUpdate object: Describes a Virtual Machine Extension.
- properties VirtualMachineExtensionUpdateProperties
- tags object: Resource tags

VirtualMachineExtensionUpdateProperties

VirtualMachineExtensionUpdateProperties object: Describes the properties of a Virtual Machine Extension.
- autoUpgradeMinorVersion boolean: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- forceUpdateTag string: How the extension handler should be forced to update even if the extension configuration has not changed.
- protectedSettings object: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- publisher string: The name of the extension handler publisher.
- settings object: Json formatted public settings for the extension.
- type string: Specifies the type of the extension; an example is "CustomScriptExtension".
- typeHandlerVersion string: Specifies the version of the script handler.

VirtualMachineExtensionsListResult

VirtualMachineExtensionsListResult object: The List Extension operation response
- value array: The list of extensions
  - items VirtualMachineExtension

VirtualMachineHealthStatus

VirtualMachineHealthStatus object: The health status of the VM.
- status InstanceViewStatus

VirtualMachineIdentity

VirtualMachineIdentity object: Identity for the virtual machine.
- principalId string: The principal id of virtual machine identity. This property will only be provided for a system assigned identity.
- tenantId string: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity.
- type string (values: SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None): The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
- userAssignedIdentities object: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

VirtualMachineImage

VirtualMachineImage object: Describes a Virtual Machine Image.
- properties VirtualMachineImageProperties
- location required string: The supported Azure location of the resource.
- name required string: The name of the resource.
- tags object: Specifies the tags that are assigned to the virtual machine. For more information about using tags, see Using tags to organize your Azure resources.
- id string: Resource Id

VirtualMachineImageProperties

VirtualMachineImageProperties object: Describes the properties of a Virtual Machine Image.
- automaticOSUpgradeProperties AutomaticOSUpgradeProperties
- dataDiskImages array
  - items DataDiskImage
- hyperVGeneration HyperVGenerationType
- osDiskImage OSDiskImage
- plan PurchasePlan

VirtualMachineImageResource

VirtualMachineImageResource object: Virtual machine image resource information.
- location required string: The supported Azure location of the resource.
- name required string: The name of the resource.
- tags object: Specifies the tags that are assigned to the virtual machine. For more information about using tags, see Using tags to organize your Azure resources.
- id string: Resource Id

VirtualMachineInstanceView

VirtualMachineInstanceView object: The instance view of a virtual machine.
- bootDiagnostics BootDiagnosticsInstanceView
- computerName string: The computer name assigned to the virtual machine.
- disks array: The virtual machine disk information.
  - items DiskInstanceView
- extensions array: The extensions information.
  - items VirtualMachineExtensionInstanceView
- hyperVGeneration string (values: V1, V2): Specifies the HyperVGeneration Type associated with a resource
- maintenanceRedeployStatus MaintenanceRedeployStatus
- osName string: The Operating System running on the virtual machine.
- osVersion string: The version of Operating System running on the virtual machine.
- platformFaultDomain integer: Specifies the fault domain of the virtual machine.
- platformUpdateDomain integer: Specifies the update domain of the virtual machine.
- rdpThumbPrint string: The Remote desktop certificate thumbprint.
- statuses array: The resource status information.
  - items InstanceViewStatus
- vmAgent VirtualMachineAgentInstanceView

VirtualMachineListResult

VirtualMachineListResult object: The List Virtual Machine operation response.
- nextLink string: The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines.
- value required array: The list of virtual machines.
  - items VirtualMachine

VirtualMachineProperties

VirtualMachineProperties object: Describes the properties of a Virtual Machine.
- additionalCapabilities AdditionalCapabilities
- availabilitySet SubResource
- billingProfile BillingProfile
- diagnosticsProfile DiagnosticsProfile
- evictionPolicy string (values: Deallocate, Delete): Specifies the eviction policy for the low priority virtual machine. Only supported value is 'Deallocate'.
  
  Minimum api-version: 2019-03-01
- hardwareProfile HardwareProfile
- host SubResource
- instanceView VirtualMachineInstanceView
- licenseType string: Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.
  
  Possible values are:
  
  Windows_Client
  
  Windows_Server
  
  If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.
  
  For more information, see Azure Hybrid Use Benefit for Windows Server
  
  Minimum api-version: 2015-06-15
- networkProfile NetworkProfile
- osProfile OSProfile
- priority string (values: Regular, Low): Specifies the priority for the virtual machine.
  
  Minimum api-version: 2019-03-01
- provisioningState string: The provisioning state, which only appears in the response.
- proximityPlacementGroup SubResource
- storageProfile StorageProfile
- virtualMachineScaleSet SubResource
- vmId string: Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

VirtualMachineReimageParameters

VirtualMachineReimageParameters object: Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged
- tempDisk boolean: 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.

VirtualMachineScaleSet

VirtualMachineScaleSet object: Describes a Virtual Machine Scale Set.
- identity VirtualMachineScaleSetIdentity
- plan Plan
- properties VirtualMachineScaleSetProperties
- sku Sku
- zones array: The virtual machine scale set zones.
  - items string
- id string: Resource Id
- location required string: Resource location
- name string: Resource name
- tags object: Resource tags
- type string: Resource type

VirtualMachineScaleSetDataDisk

VirtualMachineScaleSetDataDisk object: Describes a virtual machine scale set data disk.
- caching Caching
- createOption required CreateOption
- diskSizeGB integer: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.
  
  This value cannot be larger than 1023 GB
- lun required integer: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.
- managedDisk VirtualMachineScaleSetManagedDiskParameters
- name string: The disk name.
- writeAcceleratorEnabled boolean: Specifies whether writeAccelerator should be enabled or disabled on the disk.

VirtualMachineScaleSetExtension

VirtualMachineScaleSetExtension object: Describes a Virtual Machine Scale Set Extension.
- name string: The name of the extension.
- properties VirtualMachineScaleSetExtensionProperties
- id string: Resource Id

VirtualMachineScaleSetExtensionListResult

VirtualMachineScaleSetExtensionListResult object: The List VM scale set extension operation response.
- nextLink string: The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions.
- value required array: The list of VM scale set extensions.
  - items VirtualMachineScaleSetExtension

VirtualMachineScaleSetExtensionProfile

VirtualMachineScaleSetExtensionProfile object: Describes a virtual machine scale set extension profile.
- extensions array: The virtual machine scale set child extension resources.
  - items VirtualMachineScaleSetExtension

VirtualMachineScaleSetExtensionProperties

VirtualMachineScaleSetExtensionProperties object: Describes the properties of a Virtual Machine Scale Set Extension.
- autoUpgradeMinorVersion boolean: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
- forceUpdateTag string: If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.
- protectedSettings object: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
- provisionAfterExtensions array: Collection of extension names after which this extension needs to be provisioned.
  - items string
- provisioningState string: The provisioning state, which only appears in the response.
- publisher string: The name of the extension handler publisher.
- settings object: Json formatted public settings for the extension.
- type string: Specifies the type of the extension; an example is "CustomScriptExtension".
- typeHandlerVersion string: Specifies the version of the script handler.

VirtualMachineScaleSetIPConfiguration

VirtualMachineScaleSetIPConfiguration object: Describes a virtual machine scale set network profile's IP configuration.
- name required string: The IP configuration name.
- properties VirtualMachineScaleSetIPConfigurationProperties
- id string: Resource Id

VirtualMachineScaleSetIPConfigurationProperties

VirtualMachineScaleSetIPConfigurationProperties object: Describes a virtual machine scale set network profile's IP configuration properties.
- applicationGatewayBackendAddressPools array: Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway.
  - items SubResource
- applicationSecurityGroups array: Specifies an array of references to application security group.
  - items SubResource
- loadBalancerBackendAddressPools array: Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer.
  - items SubResource
- loadBalancerInboundNatPools array: Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer
  - items SubResource
- primary boolean: Specifies the primary network interface in case the virtual machine has more than 1 network interface.
- privateIPAddressVersion string (values: IPv4, IPv6): Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.
- publicIPAddressConfiguration VirtualMachineScaleSetPublicIPAddressConfiguration
- subnet ApiEntityReference

VirtualMachineScaleSetIdentity

VirtualMachineScaleSetIdentity object: Identity for the virtual machine scale set.
- principalId string: The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity.
- tenantId string: The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity.
- type string (values: SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None): The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.
- userAssignedIdentities object: The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

VirtualMachineScaleSetInstanceView

VirtualMachineScaleSetInstanceView object: The instance view of a virtual machine scale set.
- extensions array: The extensions information.
  - items VirtualMachineScaleSetVMExtensionsSummary
- statuses array: The resource status information.
  - items InstanceViewStatus
- virtualMachine VirtualMachineScaleSetInstanceViewStatusesSummary

VirtualMachineScaleSetInstanceViewStatusesSummary

VirtualMachineScaleSetInstanceViewStatusesSummary object: Instance view statuses summary for virtual machines of a virtual machine scale set.
- statusesSummary array: The extensions information.
  - items VirtualMachineStatusCodeCount

VirtualMachineScaleSetIpTag

VirtualMachineScaleSetIpTag object: Contains the IP tag associated with the public IP address.
- ipTagType string: IP tag type. Example: FirstPartyUsage.
- tag string: IP tag associated with the public IP. Example: SQL, Storage etc.

VirtualMachineScaleSetListOSUpgradeHistory

VirtualMachineScaleSetListOSUpgradeHistory object: List of Virtual Machine Scale Set OS Upgrade History operation response.
- nextLink string: The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades.
- value required array: The list of OS upgrades performed on the virtual machine scale set.
  - items UpgradeOperationHistoricalStatusInfo

VirtualMachineScaleSetListResult

VirtualMachineScaleSetListResult object: The List Virtual Machine operation response.
- nextLink string: The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS.
- value required array: The list of virtual machine scale sets.
  - items VirtualMachineScaleSet

VirtualMachineScaleSetListSkusResult

VirtualMachineScaleSetListSkusResult object: The Virtual Machine Scale Set List Skus operation response.
- nextLink string: The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus.
- value required array: The list of skus available for the virtual machine scale set.
  - items VirtualMachineScaleSetSku

VirtualMachineScaleSetListWithLinkResult

VirtualMachineScaleSetListWithLinkResult object: The List Virtual Machine operation response.
- nextLink string: The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets.
- value required array: The list of virtual machine scale sets.
  - items VirtualMachineScaleSet

VirtualMachineScaleSetManagedDiskParameters

VirtualMachineScaleSetManagedDiskParameters object: Describes the parameters of a ScaleSet managed disk.
- storageAccountType StorageAccountType

VirtualMachineScaleSetNetworkConfiguration

VirtualMachineScaleSetNetworkConfiguration object: Describes a virtual machine scale set network profile's network configurations.
- name required string: The network configuration name.
- properties VirtualMachineScaleSetNetworkConfigurationProperties
- id string: Resource Id

VirtualMachineScaleSetNetworkConfigurationDnsSettings

VirtualMachineScaleSetNetworkConfigurationDnsSettings object: Describes a virtual machines scale sets network configuration's DNS settings.
- dnsServers array: List of DNS servers IP addresses
  - items string

VirtualMachineScaleSetNetworkConfigurationProperties

VirtualMachineScaleSetNetworkConfigurationProperties object: Describes a virtual machine scale set network profile's IP configuration.
- dnsSettings VirtualMachineScaleSetNetworkConfigurationDnsSettings
- enableAcceleratedNetworking boolean: Specifies whether the network interface is accelerated networking-enabled.
- enableIPForwarding boolean: Whether IP forwarding enabled on this NIC.
- ipConfigurations required array: Specifies the IP configurations of the network interface.
  - items VirtualMachineScaleSetIPConfiguration
- networkSecurityGroup SubResource
- primary boolean: Specifies the primary network interface in case the virtual machine has more than 1 network interface.

VirtualMachineScaleSetNetworkProfile

VirtualMachineScaleSetNetworkProfile object: Describes a virtual machine scale set network profile.
- healthProbe ApiEntityReference
- networkInterfaceConfigurations array: The list of network configurations.
  - items VirtualMachineScaleSetNetworkConfiguration

VirtualMachineScaleSetOSDisk

VirtualMachineScaleSetOSDisk object: Describes a virtual machine scale set operating system disk.
- caching Caching
- createOption required CreateOption
- diffDiskSettings DiffDiskSettings
- diskSizeGB integer: Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.
  
  This value cannot be larger than 1023 GB
- image VirtualHardDisk
- managedDisk VirtualMachineScaleSetManagedDiskParameters
- name string: The disk name.
- osType string (values: Windows, Linux): This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.
  
  Possible values are:
  
  Windows
  
  Linux
- vhdContainers array: Specifies the container urls that are used to store operating system disks for the scale set.
  - items string
- writeAcceleratorEnabled boolean: Specifies whether writeAccelerator should be enabled or disabled on the disk.

VirtualMachineScaleSetOSProfile

VirtualMachineScaleSetOSProfile object: Describes a virtual machine scale set OS profile.
- adminPassword string: Specifies the password of the administrator account.
  
  Minimum-length (Windows): 8 characters
  
  Minimum-length (Linux): 6 characters
  
  Max-length (Windows): 123 characters
  
  Max-length (Linux): 72 characters
  
  Complexity requirements: 3 out of 4 conditions below need to be fulfilled
  Has lower characters
  Has upper characters
  Has a digit
  Has a special character (Regex match [\W_])
  
  Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"
  
  For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM
  
  For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension
- adminUsername string: Specifies the name of the administrator account.
  
  Windows-only restriction: Cannot end in "."
  
  Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".
  
  Minimum-length (Linux): 1 character
  
  Max-length (Linux): 64 characters
  
  Max-length (Windows): 20 characters
- For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure
- For a list of built-in system users on Linux that should not be used in this field, see Selecting User Names for Linux on Azure
- computerNamePrefix string: Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long.
- customData string: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.
  
  For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation
- linuxConfiguration LinuxConfiguration
- secrets array: Specifies set of certificates that should be installed onto the virtual machines in the scale set.
  - items VaultSecretGroup
- windowsConfiguration WindowsConfiguration

VirtualMachineScaleSetProperties

VirtualMachineScaleSetProperties object: Describes the properties of a Virtual Machine Scale Set.
- additionalCapabilities AdditionalCapabilities
- doNotRunExtensionsOnOverprovisionedVMs boolean: When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.
- overprovision boolean: Specifies whether the Virtual Machine Scale Set should be overprovisioned.
- platformFaultDomainCount integer: Fault Domain count for each placement group.
- provisioningState string: The provisioning state, which only appears in the response.
- proximityPlacementGroup SubResource
- scaleInPolicy ScaleInPolicy
- singlePlacementGroup boolean: When true this limits the scale set to a single placement group, of max size 100 virtual machines.
- uniqueId string: Specifies the ID which uniquely identifies a Virtual Machine Scale Set.
- upgradePolicy UpgradePolicy
- virtualMachineProfile VirtualMachineScaleSetVMProfile
- zoneBalance boolean: Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.

VirtualMachineScaleSetPublicIPAddressConfiguration

VirtualMachineScaleSetPublicIPAddressConfiguration object: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
- name required string: The publicIP address configuration name.
- properties VirtualMachineScaleSetPublicIPAddressConfigurationProperties

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings object: Describes a virtual machines scale sets network configuration's DNS settings.
- domainNameLabel required string: The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created

VirtualMachineScaleSetPublicIPAddressConfigurationProperties

VirtualMachineScaleSetPublicIPAddressConfigurationProperties object: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
- dnsSettings VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings
- idleTimeoutInMinutes integer: The idle timeout of the public IP address.
- ipTags array: The list of IP tags associated with the public IP address.
  - items VirtualMachineScaleSetIpTag
- publicIPPrefix SubResource

VirtualMachineScaleSetReimageParameters

VirtualMachineScaleSetReimageParameters object: Describes a Virtual Machine Scale Set VM Reimage Parameters.
- instanceIds array: The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.
  - items string
- tempDisk boolean: 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.

VirtualMachineScaleSetSku

VirtualMachineScaleSetSku object: Describes an available virtual machine scale set sku.
- capacity VirtualMachineScaleSetSkuCapacity
- resourceType string: The type of resource the sku applies to.
- sku Sku

VirtualMachineScaleSetSkuCapacity

VirtualMachineScaleSetSkuCapacity object: Describes scaling information of a sku.
- defaultCapacity integer: The default capacity.
- maximum integer: The maximum capacity that can be set.
- minimum integer: The minimum capacity.
- scaleType string (values: Automatic, None): The scale type applicable to the sku.

VirtualMachineScaleSetStorageProfile

VirtualMachineScaleSetStorageProfile object: Describes a virtual machine scale set storage profile.
- dataDisks array: Specifies the parameters that are used to add data disks to the virtual machines in the scale set.
  
  For more information about disks, see About disks and VHDs for Azure virtual machines.
  - items VirtualMachineScaleSetDataDisk
- imageReference ImageReference
- osDisk VirtualMachineScaleSetOSDisk

VirtualMachineScaleSetUpdate

VirtualMachineScaleSetUpdate object: Describes a Virtual Machine Scale Set.
- identity VirtualMachineScaleSetIdentity
- plan Plan
- properties VirtualMachineScaleSetUpdateProperties
- sku Sku
- tags object: Resource tags

VirtualMachineScaleSetUpdateIPConfiguration

VirtualMachineScaleSetUpdateIPConfiguration object: Describes a virtual machine scale set network profile's IP configuration.
- name string: The IP configuration name.
- properties VirtualMachineScaleSetUpdateIPConfigurationProperties
- id string: Resource Id

VirtualMachineScaleSetUpdateIPConfigurationProperties

VirtualMachineScaleSetUpdateIPConfigurationProperties object: Describes a virtual machine scale set network profile's IP configuration properties.
- applicationGatewayBackendAddressPools array: The application gateway backend address pools.
  - items SubResource
- applicationSecurityGroups array: Specifies an array of references to application security group.
  - items SubResource
- loadBalancerBackendAddressPools array: The load balancer backend address pools.
  - items SubResource
- loadBalancerInboundNatPools array: The load balancer inbound nat pools.
  - items SubResource
- primary boolean: Specifies the primary IP Configuration in case the network interface has more than one IP Configuration.
- privateIPAddressVersion string (values: IPv4, IPv6): Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.
- publicIPAddressConfiguration VirtualMachineScaleSetUpdatePublicIPAddressConfiguration
- subnet ApiEntityReference

VirtualMachineScaleSetUpdateNetworkConfiguration

VirtualMachineScaleSetUpdateNetworkConfiguration object: Describes a virtual machine scale set network profile's network configurations.
- name string: The network configuration name.
- properties VirtualMachineScaleSetUpdateNetworkConfigurationProperties
- id string: Resource Id

VirtualMachineScaleSetUpdateNetworkConfigurationProperties

VirtualMachineScaleSetUpdateNetworkConfigurationProperties object: Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration.
- dnsSettings VirtualMachineScaleSetNetworkConfigurationDnsSettings
- enableAcceleratedNetworking boolean: Specifies whether the network interface is accelerated networking-enabled.
- enableIPForwarding boolean: Whether IP forwarding enabled on this NIC.
- ipConfigurations array: The virtual machine scale set IP Configuration.
  - items VirtualMachineScaleSetUpdateIPConfiguration
- networkSecurityGroup SubResource
- primary boolean: Whether this is a primary NIC on a virtual machine.

VirtualMachineScaleSetUpdateNetworkProfile

VirtualMachineScaleSetUpdateNetworkProfile object: Describes a virtual machine scale set network profile.
- networkInterfaceConfigurations array: The list of network configurations.
  - items VirtualMachineScaleSetUpdateNetworkConfiguration

VirtualMachineScaleSetUpdateOSDisk

VirtualMachineScaleSetUpdateOSDisk object: Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk.
- caching Caching
- diskSizeGB integer: Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.
  
  This value cannot be larger than 1023 GB
- image VirtualHardDisk
- managedDisk VirtualMachineScaleSetManagedDiskParameters
- vhdContainers array: The list of virtual hard disk container uris.
  - items string
- writeAcceleratorEnabled boolean: Specifies whether writeAccelerator should be enabled or disabled on the disk.

VirtualMachineScaleSetUpdateOSProfile

VirtualMachineScaleSetUpdateOSProfile object: Describes a virtual machine scale set OS profile.
- customData string: A base-64 encoded string of custom data.
- linuxConfiguration LinuxConfiguration
- secrets array: The List of certificates for addition to the VM.
  - items VaultSecretGroup
- windowsConfiguration WindowsConfiguration

VirtualMachineScaleSetUpdateProperties

VirtualMachineScaleSetUpdateProperties object: Describes the properties of a Virtual Machine Scale Set.
- additionalCapabilities AdditionalCapabilities
- overprovision boolean: Specifies whether the Virtual Machine Scale Set should be overprovisioned.
- scaleInPolicy ScaleInPolicy
- singlePlacementGroup boolean: When true this limits the scale set to a single placement group, of max size 100 virtual machines.
- upgradePolicy UpgradePolicy
- virtualMachineProfile VirtualMachineScaleSetUpdateVMProfile

VirtualMachineScaleSetUpdatePublicIPAddressConfiguration

VirtualMachineScaleSetUpdatePublicIPAddressConfiguration object: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
- name string: The publicIP address configuration name.
- properties VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties

VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties

VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties object: Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
- dnsSettings VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings
- idleTimeoutInMinutes integer: The idle timeout of the public IP address.

VirtualMachineScaleSetUpdateStorageProfile

VirtualMachineScaleSetUpdateStorageProfile object: Describes a virtual machine scale set storage profile.
- dataDisks array: The data disks.
  - items VirtualMachineScaleSetDataDisk
- imageReference ImageReference
- osDisk VirtualMachineScaleSetUpdateOSDisk

VirtualMachineScaleSetUpdateVMProfile

VirtualMachineScaleSetUpdateVMProfile object: Describes a virtual machine scale set virtual machine profile.
- billingProfile BillingProfile
- diagnosticsProfile DiagnosticsProfile
- extensionProfile VirtualMachineScaleSetExtensionProfile
- licenseType string: The license type, which is for bring your own license scenario.
- networkProfile VirtualMachineScaleSetUpdateNetworkProfile
- osProfile VirtualMachineScaleSetUpdateOSProfile
- scheduledEventsProfile ScheduledEventsProfile
- storageProfile VirtualMachineScaleSetUpdateStorageProfile

VirtualMachineScaleSetVM

VirtualMachineScaleSetVM object: Describes a virtual machine scale set virtual machine.
- instanceId string: The virtual machine instance ID.
- plan Plan
- properties VirtualMachineScaleSetVMProperties
- resources array: The virtual machine child extension resources.
  - items VirtualMachineExtension
- sku Sku
- zones array: The virtual machine zones.
  - items string
- id string: Resource Id
- location required string: Resource location
- name string: Resource name
- tags object: Resource tags
- type string: Resource type

VirtualMachineScaleSetVMExtensionsSummary

VirtualMachineScaleSetVMExtensionsSummary object: Extensions summary for virtual machines of a virtual machine scale set.
- name string: The extension name.
- statusesSummary array: The extensions information.
  - items VirtualMachineStatusCodeCount

VirtualMachineScaleSetVMInstanceIDs

VirtualMachineScaleSetVMInstanceIDs object: Specifies a list of virtual machine instance IDs from the VM scale set.
- instanceIds array: The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.
  - items string

VirtualMachineScaleSetVMInstanceRequiredIDs

VirtualMachineScaleSetVMInstanceRequiredIDs object: Specifies a list of virtual machine instance IDs from the VM scale set.
- instanceIds required array: The virtual machine scale set instance ids.
  - items string

VirtualMachineScaleSetVMInstanceView

VirtualMachineScaleSetVMInstanceView object: The instance view of a virtual machine scale set VM.
- bootDiagnostics BootDiagnosticsInstanceView
- disks array: The disks information.
  - items DiskInstanceView
- extensions array: The extensions information.
  - items VirtualMachineExtensionInstanceView
- maintenanceRedeployStatus MaintenanceRedeployStatus
- placementGroupId string: The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId.
- platformFaultDomain integer: The Fault Domain count.
- platformUpdateDomain integer: The Update Domain count.
- rdpThumbPrint string: The Remote desktop certificate thumbprint.
- statuses array: The resource status information.
  - items InstanceViewStatus
- vmAgent VirtualMachineAgentInstanceView
- vmHealth VirtualMachineHealthStatus

VirtualMachineScaleSetVMListResult

VirtualMachineScaleSetVMListResult object: The List Virtual Machine Scale Set VMs operation response.
- nextLink string: The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs
- value required array: The list of virtual machine scale sets VMs.
  - items VirtualMachineScaleSetVM

VirtualMachineScaleSetVMNetworkProfileConfiguration

VirtualMachineScaleSetVMNetworkProfileConfiguration object: Describes a virtual machine scale set VM network profile.
- networkInterfaceConfigurations array: The list of network configurations.
  - items VirtualMachineScaleSetNetworkConfiguration

VirtualMachineScaleSetVMProfile

VirtualMachineScaleSetVMProfile object: Describes a virtual machine scale set virtual machine profile.
- billingProfile BillingProfile
- diagnosticsProfile DiagnosticsProfile
- evictionPolicy string (values: Deallocate, Delete): Specifies the eviction policy for virtual machines in a low priority scale set.
  
  Minimum api-version: 2017-10-30-preview
- extensionProfile VirtualMachineScaleSetExtensionProfile
- licenseType string: Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.
  
  Possible values are:
  
  Windows_Client
  
  Windows_Server
  
  If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.
  
  For more information, see Azure Hybrid Use Benefit for Windows Server
  
  Minimum api-version: 2015-06-15
- networkProfile VirtualMachineScaleSetNetworkProfile
- osProfile VirtualMachineScaleSetOSProfile
- priority string (values: Regular, Low): Specifies the priority for the virtual machines in the scale set.
  
  Minimum api-version: 2017-10-30-preview
- scheduledEventsProfile ScheduledEventsProfile
- storageProfile VirtualMachineScaleSetStorageProfile

VirtualMachineScaleSetVMProperties

VirtualMachineScaleSetVMProperties object: Describes the properties of a virtual machine scale set virtual machine.
- additionalCapabilities AdditionalCapabilities
- availabilitySet SubResource
- diagnosticsProfile DiagnosticsProfile
- hardwareProfile HardwareProfile
- instanceView VirtualMachineScaleSetVMInstanceView
- latestModelApplied boolean: Specifies whether the latest model has been applied to the virtual machine.
- licenseType string: Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.
  
  Possible values are:
  
  Windows_Client
  
  Windows_Server
  
  If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.
  
  For more information, see Azure Hybrid Use Benefit for Windows Server
  
  Minimum api-version: 2015-06-15
- modelDefinitionApplied string: Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine.
- networkProfile NetworkProfile
- networkProfileConfiguration VirtualMachineScaleSetVMNetworkProfileConfiguration
- osProfile OSProfile
- protectionPolicy VirtualMachineScaleSetVMProtectionPolicy
- provisioningState string: The provisioning state, which only appears in the response.
- storageProfile StorageProfile
- vmId string: Azure VM unique ID.

VirtualMachineScaleSetVMProtectionPolicy

VirtualMachineScaleSetVMProtectionPolicy object: The protection policy of a virtual machine scale set VM.
- protectFromScaleIn boolean: Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation.
- protectFromScaleSetActions boolean: Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM.

VirtualMachineScaleSetVMReimageParameters

VirtualMachineScaleSetVMReimageParameters: Describes a Virtual Machine Scale Set VM Reimage Parameters.
- tempDisk boolean: 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.

VirtualMachineSize

VirtualMachineSize object: Describes the properties of a VM size.
- maxDataDiskCount integer: The maximum number of data disks that can be attached to the virtual machine size.
- memoryInMB integer: The amount of memory, in MB, supported by the virtual machine size.
- name string: The name of the virtual machine size.
- numberOfCores integer: The number of cores supported by the virtual machine size.
- osDiskSizeInMB integer: The OS disk size, in MB, allowed by the virtual machine size.
- resourceDiskSizeInMB integer: The resource disk size, in MB, allowed by the virtual machine size.

VirtualMachineSizeListResult

VirtualMachineSizeListResult object: The List Virtual Machine operation response.
- value array: The list of virtual machine sizes.
  - items VirtualMachineSize

VirtualMachineStatusCodeCount

VirtualMachineStatusCodeCount object: The status code and count of the virtual machine scale set instance view status summary.
- code string: The instance view status code.
- count integer: The number of instances having a particular status code.

VirtualMachineUpdate

VirtualMachineUpdate object: Describes a Virtual Machine Update.
- identity VirtualMachineIdentity
- plan Plan
- properties VirtualMachineProperties
- zones array: The virtual machine zones.
  - items string
- tags object: Resource tags

WinRMConfiguration

WinRMConfiguration object: Describes Windows Remote Management configuration of the VM
- listeners array: The list of Windows Remote Management listeners
  - items WinRMListener

WinRMListener

WinRMListener object: Describes Protocol and thumbprint of Windows Remote Management listener
- certificateUrl string: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:
  
  {
  "data":"",
  "dataType":"pfx",
  "password":""
  }
- protocol string (values: Http, Https): Specifies the protocol of listener.
  
  Possible values are:
  http
  
  https

WindowsConfiguration

WindowsConfiguration object: Specifies Windows operating system settings on the virtual machine.
- additionalUnattendContent array: Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.
  - items AdditionalUnattendContent
- enableAutomaticUpdates boolean: Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true.
  
  For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.
- provisionVMAgent boolean: Indicates whether virtual machine agent should be provisioned on the virtual machine.
  
  When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.
- timeZone string: Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"
- winRM WinRMConfiguration