Gateway - List Debug Credentials

リファレンス

Service:: API Management

API Version:: 2023-05-01-preview

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

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

URI パラメーター

名前	/	必須	型	説明
gatewayId	path	True	string	ゲートウェイエンティティ識別子。現在のAPI Management サービスインスタンスで一意である必要があります。値 'managed' を持つ必要があります
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 uuid	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

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

応答

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

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

例

ApiManagementGatewayListDebugCredentials

Sample Request

HTTP

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

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

Sample Response

Status code:: 200

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

定義

名前	説明
ErrorFieldContract	エラーフィールドコントラクト。
ErrorResponse	エラー応答。
GatewayDebugCredentialsContract	ゲートウェイデバッグ資格情報。
GatewayListDebugCredentialsContract	デバッグ資格情報のプロパティを一覧表示します。
GatewayListDebugCredentialsContractPurpose	資格情報のデバッグの目的。

ErrorFieldContract

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

名前	型	説明
code	string	プロパティレベルのエラーコード。
message	string	プロパティレベルエラーの人間が判読できる表現。
target	string	プロパティ名。

ErrorResponse

エラー応答。

名前	型	説明
error.code	string	サービスによって定義されたエラーコード。このコードは、応答に指定された HTTP エラーコードのサブステータスとして機能します。
error.details	ErrorFieldContract[]	検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message	string	人が判読できるエラーの表現。

GatewayDebugCredentialsContract

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

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

GatewayListDebugCredentialsContract

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

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

GatewayListDebugCredentialsContractPurpose

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

名前	型	説明
tracing	string	トレースの目的。

Share via