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

Asynchronously shuts down the specified Virtual Machine.

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

Syntax

Task<OperationStatusResponse> ShutdownAsync(
    string serviceName,
    string deploymentName,
    string virtualMachineName,
    VirtualMachineShutdownParameters parameters,
    CancellationToken cancellationToken
)

Task<OperationStatusResponse^>^ ShutdownAsync(
    String^ serviceName,
    String^ deploymentName,
    String^ virtualMachineName,
    VirtualMachineShutdownParameters^ parameters,
    CancellationToken cancellationToken
)

abstract ShutdownAsync : 
        serviceName:string *
        deploymentName:string *
        virtualMachineName:string *
        parameters:VirtualMachineShutdownParameters *
        cancellationToken:CancellationToken -> Task<OperationStatusResponse>

Function ShutdownAsync (
    serviceName As String,
    deploymentName As String,
    virtualMachineName As String,
    parameters As VirtualMachineShutdownParameters,
    cancellationToken As CancellationToken
) As Task(Of OperationStatusResponse)

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<OperationStatusResponse>

The T:Microsoft.WindowsAzure.Management.Compute.Models.ComputeOperationStatusResponse object that contains the status of the operation.

Remarks

If the asynchronous operation succeeds, the response includes the HTTP status code for the successful request. If the asynchronous operation failed, the response includes the HTTP status code for the failed request, and also includes error information about the failure.

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