Gateway - List Debug Credentials

Referensi

Service:: API Management

API Version:: 2023-05-01-preview

Buat kredensial debug baru untuk gateway.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
gatewayId	path	True	string	Pengidentifikasi entitas gateway. Harus unik dalam instans layanan API Management saat ini. Tidak boleh memiliki nilai 'terkelola'
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
serviceName	path	True	string	Nama layanan API Management. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string uuid	ID langganan target. Nilainya harus UUID.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
apiId	True	string	Id sumber daya lengkap API.
purposes	True	GatewayListDebugCredentialsContractPurpose[]	Tujuan kredensial debug.
credentialsExpireAfter		string	Kedaluwarsa kredensial dalam format ISO8601. Durasi maksimum kredensial adalah PT1H. Ketika properti tidak ditentukan, nilainya PT1H digunakan.

Respons

Nama	Jenis	Deskripsi
200 OK	GatewayDebugCredentialsContract	Isi respons berisi kredensial debug untuk digunakan di gateway.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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=="
}

Definisi

Nama	Deskripsi
ErrorFieldContract	Kontrak Bidang Kesalahan.
ErrorResponse	Respons Kesalahan.
GatewayDebugCredentialsContract	Info masuk debug gateway.
GatewayListDebugCredentialsContract	Mencantumkan properti kredensial debug.
GatewayListDebugCredentialsContractPurpose	Tujuan kredensial debug.

ErrorFieldContract

Kontrak Bidang Kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan tingkat properti.
message	string	Representasi kesalahan tingkat properti yang dapat dibaca manusia.
target	string	Nama properti.

ErrorResponse

Respons Kesalahan.

Nama	Jenis	Deskripsi
error.code	string	Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.
error.details	ErrorFieldContract[]	Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.
error.message	string	Representasi kesalahan yang dapat dibaca manusia.

GatewayDebugCredentialsContract

Info masuk debug gateway.

Nama	Jenis	Deskripsi
token	string	Token debug gateway.

GatewayListDebugCredentialsContract

Mencantumkan properti kredensial debug.

Nama	Jenis	Deskripsi
apiId	string	Id sumber daya lengkap API.
credentialsExpireAfter	string	Kedaluwarsa kredensial dalam format ISO8601. Durasi maksimum kredensial adalah PT1H. Ketika properti tidak ditentukan, nilainya PT1H digunakan.
purposes	GatewayListDebugCredentialsContractPurpose[]	Tujuan kredensial debug.

GatewayListDebugCredentialsContractPurpose

Tujuan kredensial debug.

Nama	Jenis	Deskripsi
tracing	string	Tujuan pelacakan.

Bagikan melalui