Subscription - List

  • リファレンス
Service:
API Management
API Version:
2022-08-01

API Management サービス インスタンスのすべてのサブスクリプションを一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions?api-version=2022-08-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

URI パラメーター

名前 / 必須 型 説明
resourceGroupName
 path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。
serviceName
 path True

string

API Management サービスの名前。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

ターゲット サブスクリプションの ID。
api-version
 query True

string

この操作に使用する API バージョン。
$filter
 query

string

|フィールド |使用法 |サポートされている演算子 |サポートされている関数 |
|-------------|-------------|-------------|-------------|
|name |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|displayName |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|stateComment |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|ownerId |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|scope |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|userId |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|productId |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|state |filter |eq | |
|user |expand | | |
$skip
 query

integer

int32

スキップするレコードの数。
$top
 query

integer

int32

返されるレコードの数。

応答

名前 型 説明
200 OK

SubscriptionCollection

指定したAPI Management サービス インスタンスの Subscription エンティティのコレクション。
Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

例

ApiManagementListSubscriptions

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions?api-version=2022-08-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5600b59475ff190048070001",
      "type": "Microsoft.ApiManagement/service/subscriptions",
      "name": "5600b59475ff190048070001",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060001",
        "state": "active",
        "createdDate": "2015-09-22T01:57:40.3Z"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/56eaed3dbaf08b06e46d27fe",
      "type": "Microsoft.ApiManagement/service/subscriptions",
      "name": "56eaed3dbaf08b06e46d27fe",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060001",
        "displayName": "Starter",
        "state": "active",
        "createdDate": "2016-03-17T17:45:33.837Z",
        "startDate": "2016-03-17T00:00:00Z",
        "expirationDate": "2016-04-01T00:00:00Z",
        "notificationDate": "2016-03-20T00:00:00Z"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8",
      "type": "Microsoft.ApiManagement/service/subscriptions",
      "name": "5931a769d8d14f0ad8ce13b8",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
        "displayName": "Unlimited",
        "state": "submitted",
        "createdDate": "2017-06-02T17:59:06.223Z"
      }
    }
  ],
  "count": 3,
  "nextLink": ""
}

定義

名前 説明
ErrorFieldContract

エラー フィールド コントラクト。
ErrorResponse

エラー応答。
SubscriptionCollection

Paged Subscriptions list representation.
SubscriptionContract

サブスクリプションの詳細。
SubscriptionState

サブスクリプションの状態。 可能な状態は * アクティブです。 サブスクリプションがアクティブで、 * 中断 – サブスクリプションがブロックされ、サブスクライバーは製品の API を呼び出すことができません。送信済み - サブスクリプション要求は開発者によって行われましたが、まだ承認または拒否されていません。* 拒否されました。 サブスクリプション要求は管理者によって拒否されました。* 取り消されました。サブスクリプションは開発者または管理者によってキャンセルされました * 有効期限切れ – サブスクリプションが有効期限に達し、非アクティブ化されました。

ErrorFieldContract

エラー フィールド コントラクト。

名前 型 説明
code

string

プロパティ レベルのエラー コード。
message

string

プロパティ レベルエラーの人間が判読できる表現。
target

string

プロパティ名。

ErrorResponse

エラー応答。

名前 型 説明
error.code

string

サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。
error.details

ErrorFieldContract[]

検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message

string

人が判読できるエラーの表現。

SubscriptionCollection

Paged Subscriptions list representation.

名前 型 説明
count

integer

すべてのページの合計レコード数。
nextLink

string

次のページリンク (存在する場合)。
value

SubscriptionContract[]

ページ値。

SubscriptionContract

サブスクリプションの詳細。

名前 型 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

リソースの名前
properties.allowTracing

boolean

トレースが有効になっているかどうかを判断します
properties.createdDate

string

サブスクリプションの作成日。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。
properties.displayName

string

サブスクリプションの名前。サブスクリプションに名前がない場合は null。
properties.endDate

string

サブスクリプションが取り消されたか期限切れになった日付。 この設定は監査のみを目的としており、サブスクリプションは自動的に取り消されません。 サブスクリプションのライフサイクルは、 プロパティを使用 state して管理できます。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。
properties.expirationDate

string

サブスクリプションの有効期限。 この設定は監査のみを目的としており、サブスクリプションの有効期限は自動的には切れていません。 サブスクリプションのライフサイクルは、 プロパティを使用 state して管理できます。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。
properties.notificationDate

string

今後のサブスクリプションの有効期限の通知日。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。
properties.ownerId

string

サブスクリプション所有者のユーザー リソース識別子。 値は、/users/{userId} 形式の有効な相対 URL です。{userId} はユーザー識別子です。
properties.primaryKey

string

サブスクリプションの主キー。 このプロパティは、'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。
properties.scope

string

/products/{productId} や /apis または /apis/{apiId} などのスコープ。
properties.secondaryKey

string

サブスクリプションのセカンダリ キー。 このプロパティは、'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。
properties.startDate

string

サブスクリプションのアクティブ化日。 この設定は監査のみを目的としており、サブスクリプションは自動的にアクティブ化されません。 サブスクリプションのライフサイクルは、 プロパティを使用 state して管理できます。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。
properties.state

SubscriptionState

サブスクリプションの状態。 可能な状態は * アクティブです。 サブスクリプションがアクティブで、 * 中断 – サブスクリプションがブロックされ、サブスクライバーは製品の API を呼び出すことができません。送信済み - サブスクリプション要求は開発者によって行われましたが、まだ承認または拒否されていません。* 拒否されました。 サブスクリプション要求は管理者によって拒否されました。* 取り消されました。サブスクリプションは開発者または管理者によってキャンセルされました * 有効期限切れ – サブスクリプションが有効期限に達し、非アクティブ化されました。
properties.stateComment

string

状態が 'rejected' に変更されたときに管理者によって追加されるオプションのサブスクリプション コメント。
type

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

SubscriptionState

サブスクリプションの状態。 可能な状態は * アクティブです。 サブスクリプションがアクティブで、 * 中断 – サブスクリプションがブロックされ、サブスクライバーは製品の API を呼び出すことができません。送信済み - サブスクリプション要求は開発者によって行われましたが、まだ承認または拒否されていません。* 拒否されました。 サブスクリプション要求は管理者によって拒否されました。* 取り消されました。サブスクリプションは開発者または管理者によってキャンセルされました * 有効期限切れ – サブスクリプションが有効期限に達し、非アクティブ化されました。

名前 型 説明
active

string

cancelled

string

expired

string

rejected

string

submitted

string

suspended

string