Product Subscriptions - List

指定された製品に対するサブスクリプションのコレクションを一覧表示します。

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

URI パラメーター

Name In Required Type Description
productId
path True
  • string

製品識別子。 現在の API Management サービス インスタンスで一意である必要があります。

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

サブスクリプションを一意に識別するサブスクリプション資格情報Microsoft Azure。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

api-version
query True
  • string

クライアント要求で使用する API のバージョン。

$filter
query
  • string

|フィールド |使用状況|サポートされている演算子の|サポートされている関数|
|-------------|-------------|-------------|-------------|
|name |フィルター |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|displayName |フィルター |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|stateComment |フィルター |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswithwith |
|ownerId |フィルター |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|scope |フィルター |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|userId |フィルター |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswithwith |
|productId |フィルター |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|state |フィルター |eq | |
|ユーザー || | |展開

$skip
query
  • integer
int32

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

$top
query
  • integer
int32

返されるレコードの数。

応答

Name Type Description
200 OK

サブスクリプション エンティティのコレクションを一覧表示します。

Other Status Codes

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

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryします。

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

ApiManagementListProductSubscriptions

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/subscriptions/5600b57e7e8880006a070002",
      "type": "Microsoft.ApiManagement/service/products/subscriptions",
      "name": "5600b57e7e8880006a070002",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002",
        "state": "active",
        "createdDate": "2015-09-22T01:57:18.723Z"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

定義

ErrorFieldContract

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

ErrorResponse

エラー応答。

SubscriptionCollection

Paged Subscriptions list representation.

SubscriptionContract

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

SubscriptionState

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

ErrorFieldContract

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

Name Type Description
code
  • string

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

message
  • string

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

target
  • string

プロパティ名。

ErrorResponse

エラー応答。

Name Type Description
error.code
  • string

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

error.details

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

error.message
  • string

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

SubscriptionCollection

Paged Subscriptions list representation.

Name Type Description
count
  • integer

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

nextLink
  • string

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

value

ページ値。

SubscriptionContract

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

Name Type Description
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/{apiId} などのスコープ。

properties.secondaryKey
  • string

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

properties.startDate
  • string

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

properties.state

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

properties.stateComment
  • string

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

type
  • string

リソースの型。 "Microsoft.Compute/virtualMachines" や "Microsoft" など。Storage/storageAccounts"

SubscriptionState

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

Name Type Description
active
  • string
cancelled
  • string
expired
  • string
rejected
  • string
submitted
  • string
suspended
  • string