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 參數

名稱	位於	必要	類型	Description
gatewayId	path	True	string minLength: 1 maxLength: 80	閘道實體標識碼。 目前 API 管理服務實例中必須是唯一的。 不得有值 '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 管理服務的名稱。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

要求本文

名稱	必要	類型	Description
apiId	True	string (arm-id)	API 的完整資源識別碼。
purposes	True	GatewayListDebugCredentialsContractPurpose[]	偵錯認證的用途。
credentialsExpireAfter		string (duration)	ISO8601格式的認證到期。 認證的最大持續時間為 PT1H。 未指定 屬性時，會使用它們值 PT1H。

回應

名稱	類型	Description
200 OK	GatewayDebugCredentialsContract	回應本文包含要用於網關的偵錯認證。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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=="
}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
GatewayDebugCredentialsContract	閘道偵錯認證。
GatewayListDebugCredentialsContract	列出偵錯認證屬性。
GatewayListDebugCredentialsContractPurpose	偵錯認證的用途。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

GatewayDebugCredentialsContract

Object

閘道偵錯認證。

名稱	類型	Description
token	string	閘道偵錯令牌。

GatewayListDebugCredentialsContract

Object

列出偵錯認證屬性。

名稱	類型	Description
apiId	string (arm-id)	API 的完整資源識別碼。
credentialsExpireAfter	string (duration)	ISO8601格式的認證到期。 認證的最大持續時間為 PT1H。 未指定 屬性時，會使用它們值 PT1H。
purposes	GatewayListDebugCredentialsContractPurpose[]	偵錯認證的用途。

GatewayListDebugCredentialsContractPurpose

列舉型別

偵錯認證的用途。

值	Description
tracing	追蹤目的。