List Subscription Operations

  • Article

 

The List Subscription Operations operation returns a list of create, update, and delete operations that were performed on a subscription during the specified timeframe.

Request

The List Subscription Operations request may be specified as follows. Replace <subscription-id> with the subscription ID.

Method

Request URI

GET

https://management.core.windows.net/<subscription-id>/operations

URI Parameters

URI Parameter

Description

StartTime=<start-of-timeframe>

Required. The start of the timeframe to begin listing subscription operations in UTC format. This parameter and the EndTime parameter indicate the timeframe to retrieve subscription operations. This parameter cannot indicate a start date of more than 90 days in the past.

If you specify a time for this parameter, you must include the literal string “T” before the time, which indicates the start of the time element. Also, you must include the literal string “Z” after the time element, which indicates that the time is in UTC format. For example, a start time of March 1st, 2011 at 4:30PM would be expressed as follows: StartTime=2011-03-01T16:30:00Z

You can use the following time formats:

  • StartTime=[4DigitYear]-[2DigitMonth]-[2DigitDay]

    Example: StartTime=2011-03-01

  • StartTime=[4DigitYear]-[2DigitMonth]-[2DigitDay]T[2DigitHour]:[2DigitMinute]:2DigitSecond]Z

    Example: StartTime=2011-03-01T16:30:00Z

  • StartTime=[4DigitYear]-[2DigitMonth]-[2DigitDay]T[2DigitMinute]:[2DigitSecond].[7DigitsOfPrecision]Z

    Example: StartTime=2011-03-01T16:30:00.0005000Z

EndTime=<end-of-timeframe>

Required. The end of the timeframe to begin listing subscription operations in UTC format. This parameter and the StartTime parameter indicate the timeframe to retrieve subscription operations.

If you specify a time for this parameter, you must include the literal string “T” before the time, which indicates the start of the time element. Also, you must include the literal string “Z” after the time element, which indicates that the time is in UTC format. For example, an end time of March 7st, 2011 at 4:30PM would be expressed as follows: EndTime=2011-03-07T16:30:00Z

You can use the following time formats:

  • EndTime=[4DigitYear]-[2DigitMonth]-[2DigitDay]

    Example: EndTime=2011-03-07

  • EndTime=[4DigitYear]-[2DigitMonth]-[2DigitDay]T[2DigitHour]:[2DigitMinute]:2DigitSecond]Z

    Example: EndTime=2011-03-07T16:30:00Z

  • EndTime=[4DigitYear]-[2DigitMonth]-[2DigitDay]T[2DigitMinute]:[2DigitSecond].[7DigitsOfPrecision]Z

    Example: EndTime=2011-03-07T16:30:00.0005000Z

ObjectIdFilter=<object-url>

Optional. Returns subscription operations only for the specified object type and object ID. This parameter must be set equal to the URL value for performing an HTTP GET on the object. If no object is specified, a filter is not applied. Applicable object types and examples are included below. Replace sample values such as <subscription-id> with your own values.

Object Type

Object URL for Filter

Subscription

ObjectIdFilter=/<subscription-id>

Cloud Service

ObjectIdFilter=/<subscription-id>/services/hostedservices/<cloud-service-name>

Storage Service

ObjectIdFilter=/<subscription-id>/services/storageservices/<storage-service-name>

Affinity Group

ObjectIdFilter=/<subscription-id>/affinitygroups/<affinity-group-name>

Deployment

ObjectIdFilter=/<subscription-id>/services/hostedservices/<cloud-service-name>/deployments/<deployment-name>

Role Instance

ObjectIdFilter=/<subscription-id>/services/hostedservices/<cloud-service-name>/deployments/<deployment-name>/roleinstances/<role-instance-name>

Machine Image

ObjectIdFilter=/<subscription-id>/machineimages/<machine-image-name>

OperationResultFilter=<Succeeded|Failed|InProgress>

Optional. Returns subscription operations only for the specified result status, either Succeeded, Failed, or InProgress. This filter can be combined with the ObjectIdFilter to select subscription operations for an object with a specific result status. If no result status is specified, a filter is not applied. For example, the following request URI snippet returns all successful operations for a storage service:

ObjectIdFilter=/<subscription-id>/services/storageservices/<storage-service-name>&OperationResultFilter=Succeeded

ContinuationToken=<opaque-continuation-token>

Optional. When there are too many operations to list, such as when the requested timeframe is very large, the response includes an incomplete list and a token that can be used to return the rest of the list. Subsequent requests must include this parameter to continue listing operations from where the last response left off. If no token is specified, a filter is not applied and the response will begin at the specified StartTime.

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 2011-02-25 or higher.

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).

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers.

Response Header

Description

x-ms-request-id

A value that uniquely identifies a request made against the management service.

Response Body

The format of the response body is as follows:

<?xml version="1.0" encoding="utf-8"?>
<SubscriptionOperationCollection xmlns="https://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <SubscriptionOperations>
    <SubscriptionOperation>
      <OperationId>subscription-operation-id</OperationId>
      <OperationObjectId>subscription-object-id</OperationObjectId>
      <OperationName>subscription-operation-name</OperationName>
      <OperationParameters">
        <OperationParameter>
          <a:Name>operation-parameter-name</a:Name>
          <a:Value>value-of-parameter</a:Value>
        </OperationParameter>
      </OperationParameters>
      <OperationCaller>
        <UsedServiceManagementApi>true</UsedServiceManagementApi>
        <SubscriptionCertificateThumbprint>subscription-certificate-thumbprint</SubscriptionCertificateThumbprint>
        <ClientIP>client-ip-address</ClientIP>
      </OperationCaller>
      <OperationStatus>operation-status</OperationStatus>
      <OperationStartedTime>operation-start-time</OperationStartedTime>
      <OperationCompletedTime>operation-completed-time</OperationCompletedTime>
    </SubscriptionOperation>
  </SubscriptionOperations>
<ContinuationToken>continuation-token-value</ContinuationToken>
</SubscriptionOperationCollection>

The following table describes the elements in the response body.

Element name

Description

Subscription Operations

Specifies the list of operations that have been performed on the subscription during the specified timeframe.

Continuation Token

Specifies the string that can be used to return the rest of the list. Subsequent requests must include this parameter to continue listing operations from where the last response left off. This element exists only if the complete list of subscription operations was not returned.

Subscription Operation

Specifies a single operation that has been performed on the subscription during the specified timeframe.

Operation ID

Specifies the globally unique identifier (GUID) of the operation.

Operation Object ID

Specifies the target object for the operation. This value is equal to the URL for performing an HTTP GET on the object, and corresponds to the same values for the ObjectIdFilter in the request.

Operation Name

Specifies the name of the performed operation. Possible values are:

  • ActivateDomainName

  • AddCertificates

  • AddSubscriptionCertificate

  • ChangeDeploymentConfiguration

  • ChangeDeploymentConfigurationBySlot

  • CommitImageUpload

  • CreateAffinityGroup

  • CreateDeployment

  • CreateDeploymentBySlot

  • CreateHostedService

  • CreateStorageService

  • DeleteAffinityGroup

  • DeleteCertificate

  • DeleteDeployment

  • DeleteHostedService

  • DeleteImage

  • DeleteStorageService

  • PrepareImageUpload

  • RebootDeploymentRoleInstance

  • RebootDeploymentRoleInstanceBySlot

  • ReimageDeploymentRoleInstance

  • ReimageDeploymentRoleInstanceBySlot

  • RegenerateStorageServiceKeys

  • RegisterDomainName

  • RemoveSubscriptionCertificate

  • RollbackDeploymentUpdateOrUpgrade

  • SetImageProperties

  • SetParentImage

  • SwapDeployment

  • UnregisterDomainName

  • UpdateAffinityGroup

  • UpdateDeploymentStatus

  • UpdateDeploymentStatusBySlot

  • UpdateHostedService

  • UpdateStorageService

  • UpdateStorageService

  • UpgradeDeployment

  • UpgradeDeploymentBySlot

  • WalkUpgradeDomain

  • WalkUpgradeDomainBySlot

Operation Parameters

Specifies the collection of parameters for the performed operation.

Operation Parameter

Specifies a single parameter for the performed operation.

Name

Specifies the name of the parameter.

Value

Specifies the value of the parameter. The value can be represented as a string or an XML document, depending on the subscription operation that was performed.

OperationCaller

Specifies a collection of attributes that identifies the source of the operation.

UsedServiceManagementApi

Indicates whether the operation was initiated by using the Service Management API. False if it was initiated by another source.

UserEmailAddress

Specifies the email associated with the Windows Live ID of the user who initiated the operation. This element is returned only if UsedServiceManagementApi is false.

ClientIP

Specifies the IP address of the client computer that initiated the operation. This element is returned only if UsedServiceManagementApi is true.

SubscriptionCertificateThumbprint

Specifies the thumbprint of the subscription certificate used to initiate the operation.

Operation Status

Specifies an object that contains information on the current status of the operation. The object returned has the following XML format:

<OperationStatus><ID>339c6c13-1f81-412f-9bc6-00e9c5876695</ID><Status>Succeeded</Status><HttpStatusCode>200</HttpStatusCode></OperationStatus>

Possible values of the Status element, which holds the operation status, are:

  • Succeeded

  • Failed

  • InProgress

OperationStartedTime

Specifies the time that the operation started to execute. The format of the time is:

[4DigitYear]-[2DigitMonth]-[2DigitDay]T[2DigitHour]:[2DigitMinute]:2DigitSecond]Z

Example: 2011-05-11T16:15:26Z

Specifies the OperationStartedTime element is only available using version 2011-06-01 or higher.

OperationCompletedTime

Specifies the time that the operation finished executing. This element is not present if the operation is still in progress. The format of the time is:

[4DigitYear]-[2DigitMonth]-[2DigitDay]T[2DigitHour]:[2DigitMinute]:2DigitSecond]Z

Example: 2011-05-11T16:15:32Z

The OperationCompletedTime element is only available using version 2011-06-01 or higher.