Share via


WebSiteManagementClient.GetOperationStatusAsync Method

The Get Operation Status operation returns the status of the specified operation. After calling a long-running operation, you can call Get Operation Status to determine whether the operation has succeeded, failed, timed out, or is still in progress. (see https://msdn.microsoft.com/en-us/library/windowsazure/ee460783.aspx for more information)

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

Usage

'Usage
Dim instance As WebSiteManagementClient
Dim webSpaceName As String
Dim siteName As String
Dim operationId As String
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of WebSiteOperationStatusResponse)

returnValue = instance.GetOperationStatusAsync(webSpaceName, siteName, operationId, cancellationToken)

Syntax

'Declaration
<DebuggerStepThroughAttribute> _
Public Function GetOperationStatusAsync ( _
    webSpaceName As String, _
    siteName As String, _
    operationId As String, _
    cancellationToken As CancellationToken _
) As Task(Of WebSiteOperationStatusResponse)
[DebuggerStepThroughAttribute] 
public Task<WebSiteOperationStatusResponse> GetOperationStatusAsync (
    string webSpaceName,
    string siteName,
    string operationId,
    CancellationToken cancellationToken
)
[DebuggerStepThroughAttribute] 
public:
virtual Task<WebSiteOperationStatusResponse^>^ GetOperationStatusAsync (
    String^ webSpaceName, 
    String^ siteName, 
    String^ operationId, 
    CancellationToken cancellationToken
) sealed
/** @attribute DebuggerStepThroughAttribute() */ 
public final Task<WebSiteOperationStatusResponse> GetOperationStatusAsync (
    String webSpaceName, 
    String siteName, 
    String operationId, 
    CancellationToken cancellationToken
)
DebuggerStepThroughAttribute 
public final function GetOperationStatusAsync (
    webSpaceName : String, 
    siteName : String, 
    operationId : String, 
    cancellationToken : CancellationToken
) : Task<WebSiteOperationStatusResponse>

Parameters

  • webSpaceName
    Required. The name of the webspace for the website where the operation was targeted.
  • siteName
    Required. The name of the site where the operation was targeted.
  • operationId
    Required. The operation ID for the operation you wish to track. The operation ID is returned in the ID field in the body of the response for long-running operations.
  • cancellationToken
    Cancellation token.

Return Value

The response body contains the status of the specified long-running operation, indicating whether it has succeeded, is inprogress, has timed out, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the long-running operation failed, the response body includes error information regarding the failure.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012

Target Platforms

See Also

Reference

WebSiteManagementClient Class
WebSiteManagementClient Members
Microsoft.WindowsAzure.Management.WebSites Namespace