@datafire/azure_compute v5.0.0

@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

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 `