IVirtualMachineOperations.BeginShutdownAsync Method (String, String, String, VirtualMachineShutdownParameters, CancellationToken)

Asynchronously initiates a shutdown of the specified Virtual Machine.

Namespace:   Microsoft.WindowsAzure.Management.Compute
Assembly:  Microsoft.WindowsAzure.Management.Compute (in Microsoft.WindowsAzure.Management.Compute.dll)

Syntax

Task<AzureOperationResponse> BeginShutdownAsync(
    string serviceName,
    string deploymentName,
    string virtualMachineName,
    VirtualMachineShutdownParameters parameters,
    CancellationToken cancellationToken
)

Task<AzureOperationResponse^>^ BeginShutdownAsync(
    String^ serviceName,
    String^ deploymentName,
    String^ virtualMachineName,
    VirtualMachineShutdownParameters^ parameters,
    CancellationToken cancellationToken
)

abstract BeginShutdownAsync : 
        serviceName:string *
        deploymentName:string *
        virtualMachineName:string *
        parameters:VirtualMachineShutdownParameters *
        cancellationToken:CancellationToken -> Task<AzureOperationResponse>

Function BeginShutdownAsync (
    serviceName As String,
    deploymentName As String,
    virtualMachineName As String,
    parameters As VirtualMachineShutdownParameters,
    cancellationToken As CancellationToken
) As Task(Of AzureOperationResponse)

Parameters

• serviceName
  Type: System.String

  The name of the cloud service that contains the Virtual Machine.

• deploymentName
  Type: System.String

  The name of the deployment.

• virtualMachineName
  Type: System.String

  The name of the Virtual Machine that should be shut down.

• parameters
  Type: Microsoft.WindowsAzure.Management.Compute.Models.VirtualMachineShutdownParameters

  The VirtualMachineShutdownParameters object that contains the parameters that are used to shut down the Virtual Machine.

• cancellationToken
  Type: System.Threading.CancellationToken

  The cancellation token.

Return Value

Type: System.Threading.Tasks.Task<AzureOperationResponse>

An OperationResponse object that includes an HTTP status code and request ID.

Remarks

For more information about shutting down a Virtual Machine, see the following resources:

• Shutdown Role

• Stop-AzureVM

See Also

IVirtualMachineOperations Interface
Microsoft.WindowsAzure.Management.Compute Namespace

Return to top