UNPKG

@azure/arm-compute

Version:
299 lines 22 kB
import type { PagedAsyncIterableIterator } from "@azure/core-paging"; import type { VirtualMachineScaleSetVMs } from "../operationsInterfaces/index.js"; import type { ComputeManagementClient } from "../computeManagementClient.js"; import type { SimplePollerLike, OperationState } from "@azure/core-lro"; import type { VirtualMachineScaleSetVM, VirtualMachineScaleSetVMsListOptionalParams, VirtualMachineScaleSetVMsGetOptionalParams, VirtualMachineScaleSetVMsGetResponse, VirtualMachineScaleSetVMsUpdateOptionalParams, VirtualMachineScaleSetVMsUpdateResponse, VirtualMachineScaleSetVMsDeleteOptionalParams, VirtualMachineScaleSetVMsApproveRollingUpgradeOptionalParams, VirtualMachineScaleSetVMsApproveRollingUpgradeResponse, AttachDetachDataDisksRequest, VirtualMachineScaleSetVMsAttachDetachDataDisksOptionalParams, VirtualMachineScaleSetVMsAttachDetachDataDisksResponse, VirtualMachineScaleSetVMsDeallocateOptionalParams, VirtualMachineScaleSetVMsGetInstanceViewOptionalParams, VirtualMachineScaleSetVMsGetInstanceViewResponse, VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams, VirtualMachineScaleSetVMsPowerOffOptionalParams, VirtualMachineScaleSetVMsRedeployOptionalParams, VirtualMachineScaleSetVMsReimageOptionalParams, VirtualMachineScaleSetVMsReimageAllOptionalParams, VirtualMachineScaleSetVMsRestartOptionalParams, VirtualMachineScaleSetVMsRetrieveBootDiagnosticsDataOptionalParams, VirtualMachineScaleSetVMsRetrieveBootDiagnosticsDataResponse, RunCommandInput, VirtualMachineScaleSetVMsRunCommandOptionalParams, VirtualMachineScaleSetVMsRunCommandResponse, VirtualMachineScaleSetVMsSimulateEvictionOptionalParams, VirtualMachineScaleSetVMsStartOptionalParams } from "../models/index.js"; /** Class containing VirtualMachineScaleSetVMs operations. */ export declare class VirtualMachineScaleSetVMsImpl implements VirtualMachineScaleSetVMs { private readonly client; /** * Initialize a new instance of the class VirtualMachineScaleSetVMs class. * @param client Reference to the service client */ constructor(client: ComputeManagementClient); /** * Gets a list of all virtual machines in a VM scale sets. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param virtualMachineScaleSetName The name of the VirtualMachineScaleSet * @param options The options parameters. */ list(resourceGroupName: string, virtualMachineScaleSetName: string, options?: VirtualMachineScaleSetVMsListOptionalParams): PagedAsyncIterableIterator<VirtualMachineScaleSetVM>; private listPagingPage; private listPagingAll; /** * Gets a list of all virtual machines in a VM scale sets. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param virtualMachineScaleSetName The name of the VirtualMachineScaleSet * @param options The options parameters. */ private _list; /** * Gets a virtual machine from a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ get(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsGetOptionalParams): Promise<VirtualMachineScaleSetVMsGetResponse>; /** * Updates a virtual machine of a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param parameters Parameters supplied to the Update Virtual Machine Scale Sets VM operation. * @param options The options parameters. */ beginUpdate(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: VirtualMachineScaleSetVM, options?: VirtualMachineScaleSetVMsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetVMsUpdateResponse>, VirtualMachineScaleSetVMsUpdateResponse>>; /** * Updates a virtual machine of a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param parameters Parameters supplied to the Update Virtual Machine Scale Sets VM operation. * @param options The options parameters. */ beginUpdateAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: VirtualMachineScaleSetVM, options?: VirtualMachineScaleSetVMsUpdateOptionalParams): Promise<VirtualMachineScaleSetVMsUpdateResponse>; /** * Deletes a virtual machine from a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginDelete(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>; /** * Deletes a virtual machine from a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginDeleteAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsDeleteOptionalParams): Promise<void>; /** * Approve upgrade on deferred rolling upgrade for OS disk on a VM scale set instance. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginApproveRollingUpgrade(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsApproveRollingUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetVMsApproveRollingUpgradeResponse>, VirtualMachineScaleSetVMsApproveRollingUpgradeResponse>>; /** * Approve upgrade on deferred rolling upgrade for OS disk on a VM scale set instance. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginApproveRollingUpgradeAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsApproveRollingUpgradeOptionalParams): Promise<VirtualMachineScaleSetVMsApproveRollingUpgradeResponse>; /** * Attach and detach data disks to/from a virtual machine in a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param parameters Parameters supplied to the attach and detach data disks operation on a Virtual * Machine Scale Sets VM. * @param options The options parameters. */ beginAttachDetachDataDisks(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: AttachDetachDataDisksRequest, options?: VirtualMachineScaleSetVMsAttachDetachDataDisksOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetVMsAttachDetachDataDisksResponse>, VirtualMachineScaleSetVMsAttachDetachDataDisksResponse>>; /** * Attach and detach data disks to/from a virtual machine in a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param parameters Parameters supplied to the attach and detach data disks operation on a Virtual * Machine Scale Sets VM. * @param options The options parameters. */ beginAttachDetachDataDisksAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: AttachDetachDataDisksRequest, options?: VirtualMachineScaleSetVMsAttachDetachDataDisksOptionalParams): Promise<VirtualMachineScaleSetVMsAttachDetachDataDisksResponse>; /** * 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. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginDeallocate(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsDeallocateOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>; /** * 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. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginDeallocateAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsDeallocateOptionalParams): Promise<void>; /** * Gets the status of a virtual machine from a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ getInstanceView(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsGetInstanceViewOptionalParams): Promise<VirtualMachineScaleSetVMsGetInstanceViewResponse>; /** * Performs maintenance on a virtual machine in a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginPerformMaintenance(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>; /** * Performs maintenance on a virtual machine in a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginPerformMaintenanceAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsPerformMaintenanceOptionalParams): Promise<void>; /** * 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. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginPowerOff(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsPowerOffOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>; /** * 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. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginPowerOffAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsPowerOffOptionalParams): Promise<void>; /** * Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers * it back on. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginRedeploy(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsRedeployOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>; /** * Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers * it back on. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginRedeployAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsRedeployOptionalParams): Promise<void>; /** * Reimages (upgrade the operating system) a specific virtual machine in a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginReimage(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsReimageOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>; /** * Reimages (upgrade the operating system) a specific virtual machine in a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginReimageAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsReimageOptionalParams): Promise<void>; /** * 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. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginReimageAll(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsReimageAllOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>; /** * 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. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginReimageAllAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsReimageAllOptionalParams): Promise<void>; /** * Restarts a virtual machine in a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginRestart(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsRestartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>; /** * Restarts a virtual machine in a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginRestartAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsRestartOptionalParams): Promise<void>; /** * The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ retrieveBootDiagnosticsData(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsRetrieveBootDiagnosticsDataOptionalParams): Promise<VirtualMachineScaleSetVMsRetrieveBootDiagnosticsDataResponse>; /** * Run command on a virtual machine in a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param parameters Parameters supplied to the Run command operation. * @param options The options parameters. */ beginRunCommand(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: RunCommandInput, options?: VirtualMachineScaleSetVMsRunCommandOptionalParams): Promise<SimplePollerLike<OperationState<VirtualMachineScaleSetVMsRunCommandResponse>, VirtualMachineScaleSetVMsRunCommandResponse>>; /** * Run command on a virtual machine in a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param parameters Parameters supplied to the Run command operation. * @param options The options parameters. */ beginRunCommandAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, parameters: RunCommandInput, options?: VirtualMachineScaleSetVMsRunCommandOptionalParams): Promise<VirtualMachineScaleSetVMsRunCommandResponse>; /** * The operation to simulate the eviction of spot virtual machine in a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ simulateEviction(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsSimulateEvictionOptionalParams): Promise<void>; /** * Starts a virtual machine in a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginStart(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>; /** * Starts a virtual machine in a VM scale set. * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param vmScaleSetName The name of the VM scale set. * @param instanceId The instance ID of the virtual machine. * @param options The options parameters. */ beginStartAndWait(resourceGroupName: string, vmScaleSetName: string, instanceId: string, options?: VirtualMachineScaleSetVMsStartOptionalParams): Promise<void>; /** * ListNext * @param resourceGroupName The name of the resource group. The name is case insensitive. * @param virtualMachineScaleSetName The name of the VirtualMachineScaleSet * @param nextLink The nextLink from the previous successful call to the List method. * @param options The options parameters. */ private _listNext; } //# sourceMappingURL=virtualMachineScaleSetVMs.d.ts.map