Get Api Keys - List

サービス:

Marketplace Catalog

API バージョン:

2023-01-01-preview

選択したサブスクリプションに関連付けられている API キーの一覧を取得します。 この API は現在プレビュー状態であり、有効な Azure サブスクリプションを使用して "Discovery Api Key Early Access" プレビュー機能にサインアップする必要があることに注意してください。 このプロセスの詳細については、の Marketplace カタログ API ドキュメントを参照してください

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/keys?api-version=2023-01-01-preview

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
x-ms-client-tenant-id	True	string	サブスクリプションに関連付けられているテナント。

応答

名前	型	説明
200 OK	ApiKeys	サブスクリプションに属するアクティブなキーの一覧。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明する Microsoft.Marketplace エラー応答。

例

Get_Key

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Marketplace/keys?api-version=2023-01-01-preview

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "key": "apiKey1",
      "keyAlias": "alias1"
    },
    {
      "key": "apiKey2",
      "keyAlias": "alias2"
    }
  ],
  "nextLink": null
}

定義

名前	説明
ApiKey	キーとそのエイリアスの両方を含む ApiKey オブジェクト。
ApiKeys	ApiKey オブジェクトの一覧。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答

ApiKey

Object

キーとそのエイリアスの両方を含む ApiKey オブジェクト。

名前	型	説明
key	string	関連する探索エンドポイントを呼び出すときに使用する API キー。
keyAlias	string	API キーのエイリアス。

ApiKeys

Object

ApiKey オブジェクトの一覧。

名前	型	説明
nextLink	string	結果の次のページ。
value	ApiKey[]	キーとそのエイリアスの両方を含む ApiKey オブジェクト。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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