次の方法で共有

Product - List By Service

  • リファレンス
サービス:
API Management
API バージョン:
2022-08-01

指定されたサービス インスタンスにおける製品のコレクションを一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products?api-version=2022-08-01
省略可能なパラメーターを含む: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products?$filter={$filter}&$top={$top}&$skip={$skip}&expandGroups={expandGroups}&tags={tags}&api-version=2022-08-01

URI パラメーター

名前 / 必須 型 説明
resourceGroupName
 path True

string

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

string

API Management サービスの名前。

正規表現パターン: ^[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 |
|description |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|terms |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|state |filter |eq | |
|groups |expand | | |
$skip
 query

integer

int32

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

integer

int32

返されるレコードの数。
expandGroups
 query

boolean

true に設定すると、応答には製品を表示できるグループの配列が含まれます。 既定値は false です。
tags
 query

string

特定のタグの一部である製品。

応答

名前 型 説明
200 OK

ProductCollection

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

ErrorResponse

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

例

ApiManagementListProducts

要求のサンプル

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

応答のサンプル

状態コード:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/kjoshiarmtemplateCert1",
      "type": "Microsoft.ApiManagement/service/products",
      "name": "kjoshiarmtemplateCert1",
      "properties": {
        "displayName": "Dev",
        "description": "Development Product",
        "subscriptionRequired": false,
        "state": "published"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter",
      "type": "Microsoft.ApiManagement/service/products",
      "name": "starter",
      "properties": {
        "displayName": "Starter",
        "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.",
        "terms": "",
        "subscriptionRequired": true,
        "approvalRequired": false,
        "subscriptionsLimit": 1,
        "state": "published"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited",
      "type": "Microsoft.ApiManagement/service/products",
      "name": "unlimited",
      "properties": {
        "displayName": "Unlimited",
        "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.",
        "subscriptionRequired": true,
        "approvalRequired": true,
        "subscriptionsLimit": 1,
        "state": "published"
      }
    }
  ],
  "count": 3,
  "nextLink": ""
}

定義

名前 説明
ErrorFieldContract

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

エラー応答。
ProductCollection

Paged Products リストの表現。
ProductContract

製品の詳細。
ProductState

製品が公開されているかどうか。 公開された製品は、開発者ポータルのユーザーが検出できます。 公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態はPublished ではありません。

ErrorFieldContract

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

名前 型 説明
code

string

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

string

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

string

プロパティ名。

ErrorResponse

エラー応答。

名前 型 説明
error.code

string

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

ErrorFieldContract[]

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

string

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

ProductCollection

Paged Products リストの表現。

名前 型 説明
count

integer

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

string

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

ProductContract[]

ページ値。

ProductContract

製品の詳細。

名前 型 説明
id

string

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

string

リソースの名前
properties.approvalRequired

boolean

サブスクリプションの承認が必要かどうか。 false の場合、新しいサブスクリプションが自動的に承認され、開発者はサブスクライブ直後に製品の API を呼び出すことができます。 true の場合、管理者は、開発者が製品の API を使用する前に、サブスクリプションを手動で承認する必要があります。 subscriptionRequired プロパティが存在し、値が false の場合にのみ存在できます。
properties.description

string

製品の説明。 HTML 書式設定タグを含めることができます。
properties.displayName

string

製品名。
properties.state

ProductState

製品が公開されているかどうか。 公開された製品は、開発者ポータルのユーザーが検出できます。 公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態はPublished ではありません。
properties.subscriptionRequired

boolean

この製品に含まれる API にアクセスするために製品サブスクリプションが必要かどうか。 true の場合、製品は "protected" と呼ばれ、製品に含まれる API への要求が成功するには有効なサブスクリプション キーが必要です。 false の場合、製品は "オープン" と呼ばれ、製品に含まれる API への要求はサブスクリプション キーなしで行うことができます。 新しい製品を作成するときにプロパティを省略すると、値は true と見なされます。
properties.subscriptionsLimit

integer

ユーザーがこの製品に対して同時に持ち込むことができるサブスクリプションの数かどうか。 ユーザーサブスクリプションごとに無制限を許可するには、null または省略に設定します。 subscriptionRequired プロパティが存在し、値が false の場合にのみ存在できます。
properties.terms

string

製品の使用条件。 製品をサブスクライブしようとする開発者に提示される条件です。開発者は、サブスクリプション プロセスを完了する前にこれらの条件に同意する必要があります。
type

string

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

ProductState

製品が公開されているかどうか。 公開された製品は、開発者ポータルのユーザーが検出できます。 公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態はPublished ではありません。

名前 型 説明
notPublished

string

published

string