Azure の使用量分析情報をすべて取得する
適用対象: パートナー センター | 21Vianet が運営するパートナー センター | Microsoft Cloud for US Government のパートナー センター
顧客のすべての Azure 使用状況分析情報を取得する方法。
前提条件
- パートナー センターの認証に関するページで説明している資格情報。 このシナリオでは、ユーザー資格情報のみを使用した認証がサポートされています。
REST 要求
要求の構文
認証方法 | 要求 URI |
---|---|
GET | {baseURL}/partner/v1/analytics/usage/azure HTTP/1.1 |
URI パラメーター
パラメーター | Type | 説明 |
---|---|---|
top | string | 要求で返すデータの行数です。 最大値および指定しない場合の既定値は 10000 です。 クエリにこれを上回る行がある場合は、応答本文に次リンクが含まれ、そのリンクを使ってデータの次のページを要求できます。 |
skip | int | クエリでスキップする行数です。 大きなデータ セットを操作するには、このパラメーターを使用します。 たとえば、 top=10000 and skip=0 は最初の 1,0000 行のデータを取得し、 top=10000 and skip=10000 次の 1,0000 行のデータを取得します。 |
filter | string | 要求の filter パラメーターには、応答内の行をフィルター処理する 1 つまたは複数のステートメントが含まれます。 各ステートメントには、 または ne 演算子に関連付eq けられているフィールドと値が含まれており、 ステートメントは または or を使用してand 組み合わせることができます。 次の文字列を指定できます。customerTenantId customerName subscriptionId subscriptionName usageDate resourceLocation meterCategory meterSubcategory meterUnit 例: .../usage/azure?filter=meterCategory eq 'Data Management' 例: .../usage/azure?filter=meterCategory eq 'Data Management' or (usageDate le cast('2018-01-01', Edm.DateTimeOffset) and usageDate le cast('2018-04-01', Edm.DateTimeOffset)) |
aggregationLevel | string | 集計データを取得する時間範囲を指定します。 、、または month のいずれかの文字列day week を指定できます。 指定しない場合、既定値は day です。パラメーターは aggregationLevel 、 なしで groupby はサポートされていません。 パラメーターは aggregationLevel 、 に存在するすべての日付フィールドに groupby 適用されます。 |
orderby | string | 各インストールの結果データ値の順序を指定するステートメントです。 構文は ...&orderby=field [order],field [order],... です。 パラメーターには field 、次のいずれかの文字列を指定できます。customerTenantId customerName subscriptionId subscriptionName usageDate resourceLocation meterCategory meterSubcategory meterUnit order パラメーターは省略可能で、 または desc を使用して、各フィールドの昇順または降順を指定できますasc 。 既定値は、asc です。例: ...&orderby=meterCategory,meterUnit |
groupby | string | 指定したフィールドのみにデータ集計を適用するステートメントです。 次のフィールドを指定できます。customerTenantId customerName subscriptionId subscriptionName usageDate resourceLocation meterCategory meterSubcategory meterUnit 返されるデータ行には、 パラメーターと Quantity で groupby 指定されたフィールドが含まれます。パラメーターは groupby 、 パラメーターと共に aggregationLevel 使用できます。例: ...&groupby=meterCategory,meterUnit |
要求ヘッダー
詳細については、「パートナー センター REST ヘッダー」を参照してください。
[要求本文]
なし。
要求の例
GET https://api.partnercenter.microsoft.com/partner/v1/analytics/usage/azure HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
Content-Type: application/json
Content-Length: 0
REST 応答
成功した場合、応答本文には Azure 使用状況 リソースのコレクションが含まれます。
応答の成功とエラーのコード
各応答には、成功または失敗を示す HTTP ステータス コードと、追加のデバッグ情報が付属しています。 このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワーク トレース ツールを使用します。 完全な一覧については、エラー コードに関するページを参照してください。
応答の例
{
"customerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"customerName": "A",
"subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
"subscriptionName": "AZURE PURCHSE SAMPLE APP",
"usageDate": "2018-05-27T00:00:00",
"resourceLocation": "useast",
"meterCategory": "Data Management",
"meterSubcategory": "None",
"meterUnit": "10,000s",
"quantity": 20
}