エクスポート (0) 印刷
すべて展開

List Subscription Operations

更新日: 2014年5月

List Subscription Operations 操作は、指定した期間に実行されたサブスクリプションの作成、更新、および削除操作の一覧を返します。

List Subscription Operations要求は、次のように指定できます。<subscription-id> をサブスクリプション ID に置き換えます。

 

メソッド 要求 URI

GET

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

管理サービスに対して行われる要求をセキュリティで保護する必要があります。詳細については、「サービス管理要求の認証」を参照してください。

 

URI パラメーター 説明

StartTime=<start-of-timeframe>

必須。サブスクリプション一覧を作成する期間の開始時刻 (UTC 形式)。このパラメーターと EndTime パラメーターは、サブスクリプション操作を取得する期間を示します。このパラメーターに 90 日より前の開始日を指定することはできません。

このパラメーターに対して時刻を指定する場合は、時刻要素の開始を示すリテラル文字列 "T" を時刻の前に含める必要があります。また、時刻が UTC 形式であることを示すリテラル文字列 "Z" を時刻要素の後に含める必要もあります。たとえば、開始時刻が 2011 年 3 月 1 日の午後 4:30 の場合の表記は次のとおりです。StartTime=2011-03-01T16:30:00Z

次の時間形式を使用できます。

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

    例:StartTime=2011-03-01

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

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

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

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

EndTime=<end-of-timeframe>

必須。サブスクリプション一覧を作成する期間の終了時刻 (UTC 形式)。このパラメーターと StartTime パラメーターは、サブスクリプション操作を取得する期間を示します。

このパラメーターに対して時刻を指定する場合は、時刻要素の開始を示すリテラル文字列 "T" を時刻の前に含める必要があります。また、時刻が UTC 形式であることを示すリテラル文字列 "Z" を時刻要素の後に含める必要もあります。たとえば、終了時刻が 2011 年 3 月 7 日の午後 4:30 の場合の表記は次のとおりです。EndTime=2011-03-07T16:30:00Z

次の時間形式を使用できます。

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

    例:EndTime=2011-03-07

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

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

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

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

ObjectIdFilter=<object-url>

省略可能。指定したオブジェクトの種類とオブジェクト ID のみのサブスクリプション操作を返します。このパラメーターは、オブジェクトに対して HTTP GET を実行するための URL 値と同じ値に設定する必要があります。オブジェクトを指定しない場合、フィルターは適用されません。適用できるオブジェクトの種類と例を以下に示します。<subscription-id> などのサンプル値は固有の値に置き換えます。

 

オブジェクトの種類

フィルター用のオブジェクト URL

Subscription

ObjectIdFilter=/<subscription-id>

クラウド サービス

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

ストレージ サービス

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

アフィニティ グループ

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

デプロイ

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

ロール インスタンス

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

マシン イメージ

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

OperationResultFilter=<Succeeded|Failed|InProgress>

省略可能。指定した結果ステータス (SucceededFailed、または InProgress) のみのサブスクリプション操作を返します。このフィルターを ObjectIdFilter と組み合わせて、指定した結果ステータスに該当するオブジェクトのサブスクリプション操作を選択できます。結果ステータスを指定しない場合、フィルターは適用されません。たとえば、次の要求 URI のスニペットは、ストレージ サービスに対する成功したすべての操作を返します。

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

ContinuationToken=<opaque-continuation-token>

省略可能。要求した期間がきわめて長い場合などで、取得した操作が多すぎる場合、応答には不完全なリストと、リストの残りを取得するために使用できるトークンが含まれます。最後の応答の終わりから操作一覧の取得を続けるには、以降の要求にこのパラメーターを含める必要があります。トークンを指定しない場合、フィルターは適用されず、応答は指定した StartTime から開始します。

要求ヘッダーの説明を次の表に示します。

 

要求ヘッダー 説明

x-ms-version

必須。この要求に使用する操作のバージョンを指定します。このヘッダーは、2011/02/25 以上のバージョンに設定する必要があります。バージョン管理ヘッダーの詳細については、「サービス管理のバージョン管理」を参照してください。

ありません。

応答には、HTTP 状態コード、一連の応答ヘッダー、および応答本文が含まれています。

操作が正常に終了すると、ステータス コード 200 (OK) が返されます。ステータス コードの詳細については、「サービス管理のステータス コードとエラー コード」を参照してください。

この操作の応答には、次のヘッダーが含まれています。応答に追加の標準 HTTP ヘッダーが含まれる場合もあります。標準ヘッダーはすべて、HTTP/1.1 プロトコル仕様に準拠しています。

 

応答ヘッダー 説明

x-ms-request-id

管理サービスに対して行われた要求を一意に識別する値。

応答本文の形式は次のとおりです。


<?xml version="1.0" encoding="utf-8"?>
<SubscriptionOperationCollection xmlns="http://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 xmlns:a="http://schemas.datacontract.org/2004/07/Microsoft.Samples.WindowsAzure.ServiceManagement">
        <OperationParameter>
          <a:Name>operation-parameter-name</a:Name>
          <a:Value><?xml version="1.0" encoding="utf-16"?>
            <z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:d1p1="http://schemas.microsoft.com/windowsazure" i:type="d1p1:<type-body>" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
              …xml body…
            </z:anyType>
          </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>

応答本文の要素を次の表に示します。

 

要素名 説明

サブスクリプションの操作 (一覧)

指定した期間に実行されたサブスクリプション操作の一覧を指定します。

継続トークン

一覧の残りを取得するために使用できる文字列を指定します。最後の応答の終わりから操作一覧の取得を続けるには、以降の要求にこのパラメーターを含める必要があります。この要素は、サブスクリプション操作の一覧の全体が返されなかった場合にのみ存在します。

サブスクリプションの操作 (単一)

指定した期間にサブスクリプションに対して実行された単一の操作を指定します。

操作 ID

操作のグローバル一意識別子 (GUID) を指定します。

操作のオブジェクト ID

操作の対象になるオブジェクトを指定します。この値はオブジェクトに対して HTTP GET を実行する URL と等しく、要求内の ObjectIdFilter の同じ値に対応します。

操作名

実行された操作の名前を指定します。次の値をとります。

  • 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

操作パラメーター (複数)

実行された操作のパラメーターのコレクションを指定します。

操作パラメーター (単一)

実行された操作の単一のパラメーターを指定します。

名前

パラメーターの名前を指定します。

パラメーターの値を指定します。値は、実行されたサブスクリプション操作に応じて文字列または XML ドキュメント形式で表すことができます。

OperationCaller

操作元を識別する属性のコレクションを指定します。

UsedServiceManagementApi

操作がサービス管理 API を使用して開始されたかどうかを示します。別の操作元 (Management Portalなど) によって開始された場合は false です。

UserEmailAddress

Management Portalから操作を開始したユーザーの Windows Live ID に関連付けられた電子メールを指定します。この要素は UsedServiceManagementApifalse の場合にのみ返されます。

ClientIP

操作を開始したクライアント コンピューターの IP アドレスを指定します。この要素は UsedServiceManagementApitrue の場合にのみ返されます。

SubscriptionCertificateThumbprint

操作の開始に使用されたサブスクリプション証明書のサムプリントを指定します。

操作の状態

操作の現在のステータスに関する情報が含まれるオブジェクトを指定します。オブジェクトは次の XML 形式で返されます。

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

操作ステータスが保持される Status 要素に指定できる値は次のとおりです。

  • Succeeded

  • Failed

  • InProgress

OperationStartedTime

操作の実行が開始された時刻を指定します。時刻の形式は次のとおりです。

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

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

noteメモ
OperationStartedTime 要素は、バージョン 2011-06-01 以上を使用している場合にのみ使用できます。

OperationCompletedTime

操作の実行が終了した時刻を指定します。この要素は、操作が実行中の場合はありません。時刻の形式は次のとおりです。

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

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

noteメモ
OperationCompletedTime 要素は、バージョン 2011-06-01 以上を使用している場合にのみ使用できます。

表示:
© 2014 Microsoft