Subscription - List

リファレンス

サービス:: API Management

API バージョン:: 2024-05-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions?api-version=2024-05-01

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前では大文字と小文字が区別されません。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management サービスの名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する 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) minimum: 0	スキップするレコードの数。
$top	query		integer (int32) minimum: 1	返されるレコードの数。

応答

名前	型	説明
200 OK	SubscriptionCollection	指定した API Management サービスインスタンスのサブスクリプションエンティティのコレクション。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

ApiManagementListSubscriptions

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions?api-version=2024-05-01

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5600b59475ff190048070001",
      "type": "Microsoft.ApiManagement/service/subscriptions",
      "name": "5600b59475ff190048070001",
      "properties": {
        "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
        "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060001",
        "state": "active",
        "createdDate": "2015-09-22T01:57:40.3Z"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/56eaed3dbaf08b06e46d27fe",
      "type": "Microsoft.ApiManagement/service/subscriptions",
      "name": "56eaed3dbaf08b06e46d27fe",
      "properties": {
        "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd",
        "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/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/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8",
      "type": "Microsoft.ApiManagement/service/subscriptions",
      "name": "5931a769d8d14f0ad8ce13b8",
      "properties": {
        "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
        "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
        "displayName": "Unlimited",
        "state": "submitted",
        "createdDate": "2017-06-02T17:59:06.223Z"
      }
    }
  ],
  "count": 3,
  "nextLink": ""
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
SubscriptionCollection	ページサブスクリプションの一覧表現。
SubscriptionContract	サブスクリプションの詳細。
SubscriptionState	サブスクリプションの状態。可能な状態はアクティブです。サブスクリプションがアクティブで、中断されています。サブスクリプションはブロックされ、サブスクライバーは製品の API を呼び出すことができません。送信済み - サブスクリプション要求は開発者によって行われましたが、まだ承認または拒否されていません。* 拒否されました。サブスクリプション要求は管理者によって拒否されました。* 取り消されました。サブスクリプションは開発者または管理者によって取り消されました。 * 期限切れ – サブスクリプションは有効期限に達し、非アクティブ化されました。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

SubscriptionCollection

Object

ページサブスクリプションの一覧表現。

名前	型	説明
count	integer (int64)	すべてのページの合計レコード数。
nextLink	string	次のページリンク (ある場合)。
value	SubscriptionContract[]	ページ値。

SubscriptionContract

Object

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

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.allowTracing	boolean	トレースが有効になっているかどうかを判断します
properties.createdDate	string (date-time)	サブスクリプションの作成日。日付は、ISO 8601 標準で指定された `yyyy-MM-ddTHH:mm:ssZ` 形式に準拠しています。
properties.displayName	string minLength: 0 maxLength: 100	サブスクリプションの名前。サブスクリプションに名前がない場合は null。
properties.endDate	string (date-time)	サブスクリプションが取り消されたか期限切れになった日付。この設定は監査のみを目的としており、サブスクリプションは自動的に取り消されません。サブスクリプションのライフサイクルは、`state` プロパティを使用して管理できます。日付は、ISO 8601 標準で指定された `yyyy-MM-ddTHH:mm:ssZ` 形式に準拠しています。
properties.expirationDate	string (date-time)	サブスクリプションの有効期限。この設定は監査のみを目的としており、サブスクリプションの有効期限が自動的に切れるわけではありません。サブスクリプションのライフサイクルは、`state` プロパティを使用して管理できます。日付は、ISO 8601 標準で指定された `yyyy-MM-ddTHH:mm:ssZ` 形式に準拠しています。
properties.notificationDate	string (date-time)	今後のサブスクリプション有効期限の通知日。日付は、ISO 8601 標準で指定された `yyyy-MM-ddTHH:mm:ssZ` 形式に準拠しています。
properties.ownerId	string	サブスクリプション所有者のユーザーリソース識別子。値は、/users/{userId} 形式の有効な相対 URL です。{userId} はユーザー識別子です。
properties.primaryKey	string minLength: 1 maxLength: 256	サブスクリプションの主キー。このプロパティは'GET' 操作では入力されません。値を取得するには、'/listSecrets' POST 要求を使用します。
properties.scope	string	/products/{productId} や /apis、/apis/{apiId} などのスコープ。
properties.secondaryKey	string minLength: 1 maxLength: 256	サブスクリプションのセカンダリキー。このプロパティは'GET' 操作では入力されません。値を取得するには、'/listSecrets' POST 要求を使用します。
properties.startDate	string (date-time)	サブスクリプションのアクティブ化日。この設定は監査のみを目的としており、サブスクリプションは自動的にアクティブ化されません。サブスクリプションのライフサイクルは、`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
cancelled
expired
rejected
submitted
suspended

次の方法で共有

Subscription - List

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

ApiManagementListSubscriptions

要求のサンプル

応答のサンプル

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SubscriptionCollection

SubscriptionContract

SubscriptionState

その他のリソース