Gateway - List Debug Credentials

サービス:

API Management

API バージョン:

2024-05-01

ゲートウェイの新しいデバッグ資格情報を作成します。

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

URI パラメーター

名前	/	必須	型	説明
gatewayId	path	True	string minLength: 1 maxLength: 80	ゲートウェイ エンティティ識別子。 現在の API Management サービス インスタンスで一意である必要があります。 値 'managed' を持つ必要があります
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 バージョン。

要求本文

名前	必須	型	説明
apiId	True	string (arm-id)	API の完全なリソース ID。
purposes	True	GatewayListDebugCredentialsContractPurpose[]	デバッグ資格情報の目的。
credentialsExpireAfter		string (duration)	資格情報の有効期限 (ISO8601形式)。 資格情報の最大期間は PT1H です。 プロパティが指定されていない場合は、値 PT1H が使用されます。

応答

名前	型	説明
200 OK	GatewayDebugCredentialsContract	応答本文には、ゲートウェイで使用するデバッグ資格情報が含まれています。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

例

ApiManagementGatewayListDebugCredentials

要求のサンプル

HTTP

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

{
  "credentialsExpireAfter": "PT1H",
  "apiId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1",
  "purposes": [
    "tracing"
  ]
}

応答のサンプル

状態コード:

200

{
  "token": "p=tracing&aid=a1&ex=20230504000000&sn=ZdfxSJoCsOJE0/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/8LchGl7gu/Q=="
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
GatewayDebugCredentialsContract	ゲートウェイ デバッグ資格情報。
GatewayListDebugCredentialsContract	デバッグ資格情報のプロパティを一覧表示します。
GatewayListDebugCredentialsContractPurpose	デバッグ資格情報の目的。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

GatewayDebugCredentialsContract

Object

ゲートウェイ デバッグ資格情報。

名前	型	説明
token	string	ゲートウェイ デバッグ トークン。

GatewayListDebugCredentialsContract

Object

デバッグ資格情報のプロパティを一覧表示します。

名前	型	説明
apiId	string (arm-id)	API の完全なリソース ID。
credentialsExpireAfter	string (duration)	資格情報の有効期限 (ISO8601形式)。 資格情報の最大期間は PT1H です。 プロパティが指定されていない場合は、値 PT1H が使用されます。
purposes	GatewayListDebugCredentialsContractPurpose[]	デバッグ資格情報の目的。

GatewayListDebugCredentialsContractPurpose

列挙

デバッグ資格情報の目的。

値	説明
tracing	トレースの目的。