Services - List Test Keys

サービスのテスト キーを一覧表示します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/listTestKeys?api-version=2023-12-01

URI パラメーター

名前 / 必須 説明
resourceGroupName
path True

string

リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

serviceName
path True

string

サービス リソースの名前。

正規表現パターン: ^[a-z][a-z0-9-]*[a-z0-9]$

subscriptionId
path True

string

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

api-version
query True

string

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

応答

名前 説明
200 OK

TestKeys

正常終了しました。 応答では、テスト キーについて説明します。

Other Status Codes

CloudError

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

Services_ListTestKeys

要求のサンプル

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/listTestKeys?api-version=2023-12-01

応答のサンプル

{
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>",
  "primaryTestEndpoint": "<primaryTestEndpoint>",
  "secondaryTestEndpoint": "<secondaryTestEndpoint>",
  "enabled": true
}

定義

名前 説明
CloudError

サービスからのエラー応答。

CloudErrorBody

サービスからのエラー応答。

TestKeys

テスト キーのペイロード

CloudError

サービスからのエラー応答。

名前 説明
error

CloudErrorBody

サービスからのエラー応答。

CloudErrorBody

サービスからのエラー応答。

名前 説明
code

string

エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。

details

CloudErrorBody[]

エラーに関するその他の詳細の一覧。

message

string

ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。

target

string

特定のエラーのターゲット。 たとえば、エラーが発生したプロパティの名前です。

TestKeys

テスト キーのペイロード

名前 説明
enabled

boolean

テスト エンドポイント機能が有効になっているかどうかを示します

primaryKey

string

Primary key (プライマリ キー)

primaryTestEndpoint

string

プライマリ テスト エンドポイント

secondaryKey

string

セカンダリ キー

secondaryTestEndpoint

string

セカンダリ テスト エンドポイント