Get Operation Status
The Get Operation Status operation returns the status of the specified operation. After calling an asynchronous operation, you can call Get Operation Status to determine whether the operation has succeeded, failed, or is still in progress.
Request
The Get Operation Status request may be specified as follows. Replace <subscription-id> with the subscription ID, and <request-id> with the request ID that was returned in a response.
Method |
Request URI |
|---|---|
GET |
https://management.core.windows.net/<subscription-id>/operations/<request-id> |
You must make sure that the request that is made to the management service is secure. For additional details, see Authenticating Service Management Requests.
URI Parameters
None.
Request Headers
The following table describes the request headers.
Request Header |
Description |
|---|---|
x-ms-version |
Required. Specifies the version of the operation to use for this request. This header should be set to 2009-10-01 or higher. For more information about versioning headers, see Service Management Versioning. |
Request Body
None.
Response
The response includes an HTTP status code, a set of response headers, and a response body.
Status Code
A successful operation returns status code 200 (OK). For information about status codes, see Service Management Status and Error Codes.
Response Headers
The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
Response Header |
Description |
|---|---|
x-ms-request-id |
A value that uniquely identifies a request made against the management service. |
Response Body
The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is in progress, or has failed. This status is distinct from the HTTP status code returned for the Get Operation Status operation itself.
If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request.
If the asynchronous operation failed, the response body includes the HTTP status code for the failed request, and also includes error information regarding the failure.
<?xml version="1.0" encoding="utf-8"?>
<Operation xmlns="https://schemas.microsoft.com/windowsazure">
<ID>request-id</ID>
<Status>InProgress|Succeeded|Failed</Status>
<!--Response includes HTTP status code only if the operation succeeded or failed -->
<HttpStatusCode>http-status-code-for-asynchronous-operation</HttpStatusCode>
<!--Response includes additional error information only if the operation failed -->
<Error>
<Code>error-code</Code>
<Message>error-message</Message>
</Error>
</Operation>
The following table describes the elements in the response body.
Element name |
Description |
|---|---|
ID |
Specifies the request ID of the asynchronous request. This value is returned in the x-ms-request-id response header of the asynchronous request. |
Status |
Specifies the status of the asynchronous request. Possible values are:
|
HttpStatusCode |
Specifies the HTTP status code for the asynchronous request. |
Code |
Specifies the management service error code returned if the asynchronous request failed. See Service Management Status and Error Codes for information about possible error codes returned by the service. |
Message |
Specifies the management service error message returned if the asynchronous request failed. |
Remarks
Service management operations that require lengthy processing to complete are implemented with an asynchronous pattern. All successful Service Management REST API operation requests return a unique request ID, which can be used to determine the final status of an operation. This is done by polling Get Operation Status with the request ID until the operation has succeeded or failed. An asynchronous service management operation request will return quickly. An error response to the asynchronous operation request indicates that the request did not succeed, and no asynchronous operation is pending. An operation request will return a status code of 202 (Accepted) to indicate that the request has been made successfully and is pending. The Get Operation Status operation will return an error status code and an error response body if the call to Get Operation Status does not succeed, for example, if the request ID does not correspond to an actual service management operation request made against your subscription. A status code of 200 (OK) indicates that the Get Operation Status call has been made successfully, and the status of the operation specified by the request ID parameter is recorded in the response body returned. You must check the response body for the status of the asynchronous operation. The Operation element or the response body contains a Status element value representing the current state of the pending operation, which can be InProgress, Failed, or Succeeded. Continue polling Get Operation Status while the Status element contains InProgress. When the Status element has a value of Succeeded or Failed, the Operation element will also contain an HttpStatusCode element containing the status code for the completed asynchronous operation. If the Status element contains Failed, the Operation element will contain an Error element with Code and Message elements giving further details on the asynchronous operation error.
Example
This example console program creates a new storage account, setting the description, label, and location using the Create Storage Account operation, then polls the Get Operation Status operation with the request ID returned from the Create Storage Account operation until the call has succeeded, failed, or polling has timed out. Finally, it calls Get Storage Account Properties to display the properties for the new storage account. Set the value for the x-ms-version header in the Version string, your subscription identifier in SubscriptionId, your management certificate thumbprint in Thumbprint, and set ServiceName to a unique storage account name to run the sample.
namespace Microsoft.WindowsAzure.ServiceManagementRESTAPI.Samples
{
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net;
using System.Security.Cryptography.X509Certificates;
using System.Threading;
using System.Xml;
using System.Xml.Linq;
public class Program
{
// Set these constants with your values to run the sample.
private const string Version = "2011-10-01";
private const string Thumbprint = "management-certificate-thumbprint";
private const string SubscriptionId = "subscription-identifier";
private const string ServiceName = "unique-storage-account-name";
// This is the common namespace for all Service Management REST API XML data.
private static XNamespace wa = "https://schemas.microsoft.com/windowsazure";
/// <summary>
/// The operation status values from PollGetOperationStatus.
/// </summary>
private enum OperationStatus
{
InProgress,
Failed,
Succeeded,
TimedOut
}
/// <summary>
/// Gets or sets the certificate that matches the Thumbprint value.
/// </summary>
private static X509Certificate2 Certificate { get; set; }
static void Main(string[] args)
{
try
{
Certificate = GetCertificate(Thumbprint);
// Create the new storage account with the following values:
string description = "Description for my example storage account";
string label = "My example storage account label";
string location = "North Central US";
string requestId = CreateStorageAccount(
ServiceName,
description,
label,
null,
location);
Console.WriteLine(
"Called Create Storage Account operation: requestId {0}",
requestId);
// Loop on Get Operation Status for result of storage creation
OperationResult result = PollGetOperationStatus(
requestId,
pollIntervalSeconds: 20,
timeoutSeconds: 180);
switch (result.Status)
{
case OperationStatus.TimedOut:
Console.WriteLine(
"Poll of Get Operation Status timed out: " +
"Operation {0} is still in progress after {1} seconds.",
requestId,
(int)result.RunningTime.TotalSeconds);
break;
case OperationStatus.Failed:
Console.WriteLine(
"Failed: Operation {0} failed after " +
"{1} seconds with status {2} ({3}) - {4}: {5}",
requestId,
(int)result.RunningTime.TotalSeconds,
(int)result.StatusCode,
result.StatusCode,
result.Code,
result.Message);
break;
case OperationStatus.Succeeded:
Console.WriteLine(
"Succeeded: Operation {0} completed " +
"after {1} seconds with status {2} ({3})",
requestId,
(int)result.RunningTime.TotalSeconds,
(int)result.StatusCode,
result.StatusCode);
break;
}
// Display the property values for the new storage account.
// Convert the Label property to a readable value for display.
XElement updatedProperties =
GetStorageAccountProperties(ServiceName);
XElement labelElement = updatedProperties.Descendants(wa + "Label").First();
labelElement.Value = labelElement.Value.FromBase64();
Console.WriteLine(
"New Storage Account Properties for {0}:{1}{2}",
ServiceName,
Environment.NewLine,
updatedProperties.ToString(SaveOptions.OmitDuplicateNamespaces));
}
catch (Exception ex)
{
Console.WriteLine("Exception caught in Main:");
Console.WriteLine(ex.Message);
}
Console.Write("Press any key to continue:");
Console.ReadKey();
}
/// <summary>
/// Calls the Get Storage Account Properties operation in the Service
/// Management REST API for the specified subscription and storage account
/// name and returns the StorageService XML element from the response.
/// </summary>
/// <param name="serviceName">The name of the storage account.</param>
/// <returns>The StorageService XML element from the response.</returns>
private static XElement GetStorageAccountProperties(
string serviceName)
{
string uriFormat = "https://management.core.windows.net/{0}" +
"/services/storageservices/{1}";
Uri uri = new Uri(String.Format(uriFormat, SubscriptionId, serviceName));
XDocument responseBody;
InvokeRequest(uri, "GET", HttpStatusCode.OK, null, out responseBody);
return responseBody.Element(wa + "StorageService");
}
/// <summary>
/// Calls the Create Storage Account operation in the Service Management
/// REST API for the specified subscription, storage account name,
/// description, label, and location or affinity group.
/// </summary>
/// <param name="serviceName">The name of the storage account to update.</param>
/// <param name="description">The new description for the storage account.</param>
/// <param name="label">The new label for the storage account.</param>
/// <param name="affinityGroup">The affinity group name, or null to use a location.</param>
/// <param name="location">The location name, or null to use an affinity group.</param>
/// <returns>The requestId for the operation.</returns>
private static string CreateStorageAccount(
string serviceName,
string description,
string label,
string affinityGroup,
string location)
{
string uriFormat = "https://management.core.windows.net/{0}" +
"/services/storageservices";
Uri uri = new Uri(String.Format(uriFormat, SubscriptionId));
// Location and Affinity Group are mutually exclusive.
// Use the location if it isn't null or empty.
XElement locationOrAffinityGroup = String.IsNullOrEmpty(location) ?
new XElement(wa + "AffinityGroup", affinityGroup) :
new XElement(wa + "Location", location);
// Create the request XML document
XDocument requestBody = new XDocument(
new XDeclaration("1.0", "UTF-8", "no"),
new XElement(
wa + "CreateStorageServiceInput",
new XElement(wa + "ServiceName", serviceName),
new XElement(wa + "Description", description),
new XElement(wa + "Label", label.ToBase64()),
locationOrAffinityGroup));
XDocument responseBody;
return InvokeRequest(
uri, "POST", HttpStatusCode.Accepted, requestBody, out responseBody);
}
/// <summary>
/// Calls the Get Operation Status operation in the Service
/// Management REST API for the specified subscription and requestId
/// and returns the Operation XML element from the response.
/// </summary>
/// <param name="requestId">The requestId of the operation to track.</param>
/// <returns>The Operation XML element from the response.</returns>
private static XElement GetOperationStatus(
string requestId)
{
string uriFormat = "https://management.core.windows.net/{0}" +
"/operations/{1}";
Uri uri = new Uri(String.Format(uriFormat, SubscriptionId, requestId));
XDocument responseBody;
InvokeRequest(uri, "GET", HttpStatusCode.OK, null, out responseBody);
return responseBody.Element(wa + "Operation");
}
/// <summary>
/// The results from PollGetOperationStatus are passed in this struct.
/// </summary>
private struct OperationResult
{
// The status: InProgress, Failed, Succeeded, or TimedOut.
public OperationStatus Status { get; set; }
// The http status code of the requestId operation, if any.
public HttpStatusCode StatusCode { get; set; }
// The approximate running time for PollGetOperationStatus.
public TimeSpan RunningTime { get; set; }
// The error code for the failed operation.
public string Code { get; set; }
// The message for the failed operation.
public string Message { get; set; }
}
/// <summary>
/// Polls Get Operation Status for the operation specified by requestId
/// every pollIntervalSeconds until timeoutSeconds have passed or the
/// operation has returned a Failed or Succeeded status.
/// </summary>
/// <param name="requestId">The requestId of the operation to get status for.</param>
/// <param name="pollIntervalSeconds">The interval between calls to Get Operation Status.</param>
/// <param name="timeoutSeconds">The maximum number of seconds to poll.</param>
/// <returns>An OperationResult structure with status or error information.</returns>
private static OperationResult PollGetOperationStatus(
string requestId,
int pollIntervalSeconds,
int timeoutSeconds)
{
OperationResult result = new OperationResult();
DateTime beginPollTime = DateTime.UtcNow;
TimeSpan pollInterval = new TimeSpan(0, 0, pollIntervalSeconds);
DateTime endPollTime = beginPollTime + new TimeSpan(0, 0, timeoutSeconds);
bool done = false;
while (!done)
{
XElement operation = GetOperationStatus(requestId);
result.RunningTime = DateTime.UtcNow - beginPollTime;
try
{
// Turn the Status string into an OperationStatus value
result.Status = (OperationStatus)Enum.Parse(
typeof(OperationStatus),
operation.Element(wa + "Status").Value);
}
catch (Exception)
{
throw new ApplicationException(string.Format(
"Get Operation Status {0} returned unexpected status: {1}{2}",
requestId,
Environment.NewLine,
operation.ToString(SaveOptions.OmitDuplicateNamespaces)));
}
switch (result.Status)
{
case OperationStatus.InProgress:
Console.WriteLine(
"In progress for {0} seconds",
(int)result.RunningTime.TotalSeconds);
Thread.Sleep((int)pollInterval.TotalMilliseconds);
break;
case OperationStatus.Failed:
result.StatusCode = (HttpStatusCode)Convert.ToInt32(
operation.Element(wa + "HttpStatusCode").Value);
XElement error = operation.Element(wa + "Error");
result.Code = error.Element(wa + "Code").Value;
result.Message = error.Element(wa + "Message").Value;
done = true;
break;
case OperationStatus.Succeeded:
result.StatusCode = (HttpStatusCode)Convert.ToInt32(
operation.Element(wa + "HttpStatusCode").Value);
done = true;
break;
}
if (!done && DateTime.UtcNow > endPollTime)
{
result.Status = OperationStatus.TimedOut;
done = true;
}
}
return result;
}
/// <summary>
/// Gets the certificate matching the thumbprint from the local store.
/// Throws an ArgumentException if a matching certificate is not found.
/// </summary>
/// <param name="thumbprint">The thumbprint of the certificate to find.</param>
/// <returns>The certificate with the specified thumbprint.</returns>
private static X509Certificate2 GetCertificate(string thumbprint)
{
List<StoreLocation> locations = new List<StoreLocation>
{
StoreLocation.CurrentUser,
StoreLocation.LocalMachine
};
foreach (var location in locations)
{
X509Store store = new X509Store("My", location);
try
{
store.Open(OpenFlags.ReadOnly | OpenFlags.OpenExistingOnly);
X509Certificate2Collection certificates = store.Certificates.Find(
X509FindType.FindByThumbprint, thumbprint, false);
if (certificates.Count == 1)
{
return certificates[0];
}
}
finally
{
store.Close();
}
}
throw new ArgumentException(string.Format(
"A Certificate with Thumbprint '{0}' could not be located.",
thumbprint));
}
/// <summary>
/// A helper function to invoke a Service Management REST API operation.
/// Throws an ApplicationException on unexpected status code results.
/// </summary>
/// <param name="uri">The URI of the operation to invoke using a web request.</param>
/// <param name="method">The method of the web request, GET, PUT, POST, or DELETE.</param>
/// <param name="expectedCode">The expected status code.</param>
/// <param name="requestBody">The XML body to send with the web request. Use null to send no request body.</param>
/// <param name="responseBody">The XML body returned by the request, if any.</param>
/// <returns>The requestId returned by the operation.</returns>
private static string InvokeRequest(
Uri uri,
string method,
HttpStatusCode expectedCode,
XDocument requestBody,
out XDocument responseBody)
{
responseBody = null;
string requestId = String.Empty;
HttpWebRequest request = (HttpWebRequest)HttpWebRequest.Create(uri);
request.Method = method;
request.Headers.Add("x-ms-Version", Version);
request.ClientCertificates.Add(Certificate);
request.ContentType = "application/xml";
if (requestBody != null)
{
using (Stream requestStream = request.GetRequestStream())
{
using (StreamWriter streamWriter = new StreamWriter(
requestStream, System.Text.UTF8Encoding.UTF8))
{
requestBody.Save(streamWriter, SaveOptions.DisableFormatting);
}
}
}
HttpWebResponse response;
HttpStatusCode statusCode = HttpStatusCode.Unused;
try
{
response = (HttpWebResponse)request.GetResponse();
}
catch (WebException ex)
{
// GetResponse throws a WebException for 4XX and 5XX status codes
response = (HttpWebResponse)ex.Response;
}
try
{
statusCode = response.StatusCode;
if (response.ContentLength > 0)
{
using (XmlReader reader = XmlReader.Create(response.GetResponseStream()))
{
responseBody = XDocument.Load(reader);
}
}
if (response.Headers != null)
{
requestId = response.Headers["x-ms-request-id"];
}
}
finally
{
response.Close();
}
if (!statusCode.Equals(expectedCode))
{
throw new ApplicationException(string.Format(
"Call to {0} returned an error:{1}Status Code: {2} ({3}):{1}{4}",
uri.ToString(),
Environment.NewLine,
(int)statusCode,
statusCode,
responseBody.ToString(SaveOptions.OmitDuplicateNamespaces)));
}
return requestId;
}
}
/// <summary>
/// Helpful extension methods for converting strings to and from Base-64.
/// </summary>
public static class StringExtensions
{
/// <summary>
/// Converts a UTF-8 string to a Base-64 version of the string.
/// </summary>
/// <param name="s">The string to convert to Base-64.</param>
/// <returns>The Base-64 converted string.</returns>
public static string ToBase64(this string s)
{
byte[] bytes = System.Text.Encoding.UTF8.GetBytes(s);
return Convert.ToBase64String(bytes);
}
/// <summary>
/// Converts a Base-64 encoded string to UTF-8.
/// </summary>
/// <param name="s">The string to convert from Base-64.</param>
/// <returns>The converted UTF-8 string.</returns>
public static string FromBase64(this string s)
{
byte[] bytes = Convert.FromBase64String(s);
return System.Text.Encoding.UTF8.GetString(bytes);
}
}
}
This example program produces console output something like the following when run:
Called Create Storage Account operation: requestId 8ba8bd9cdc50472892a0b3cd3659b297
In progress for 0 seconds
In progress for 20 seconds
In progress for 41 seconds
In progress for 61 seconds
In progress for 82 seconds
In progress for 103 seconds
Succeeded: Operation 8ba8bd9cdc50472892a0b3cd3659b297 completed after 123 seconds with status 200 (OK)
New Storage Account Properties for myexamplestorage1:
<StorageService xmlns="https://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Url>https://management.core.windows.net/01234567-89ab-cdef-0123-456789abcdef/services/storageservices/myexamplestorage1</Url>
<ServiceName>myexamplestorage1</ServiceName>
<StorageServiceProperties>
<Description>Description for my example storage account</Description>
<Location>North Central US</Location>
<Label>My example storage account label</Label>
<Status>Created</Status>
<Endpoints>
<Endpoint>http://myexamplestorage1.blob.core.windows.net/</Endpoint>
<Endpoint>http://myexamplestorage1.queue.core.windows.net/</Endpoint>
<Endpoint>http://myexamplestorage1.table.core.windows.net/</Endpoint>
</Endpoints>
</StorageServiceProperties>
</StorageService>
Press any key to continue: