Gateway - List Debug Credentials

Hizmet:

API Management

API Sürümü:

2024-05-01

Ağ geçidi için yeni hata ayıklama kimlik bilgileri oluşturun.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
gatewayId	path	True	string minLength: 1 maxLength: 80	Ağ geçidi varlık tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. 'Yönetilen' değerine sahip olmamalıdır
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management hizmetinin adı.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
apiId	True	string (arm-id)	Bir API'nin tam kaynak kimliği.
purposes	True	GatewayListDebugCredentialsContractPurpose[]	Kimlik bilgilerinin hatalarını ayıklamanın amaçları.
credentialsExpireAfter		string (duration)	Kimlik bilgilerinin süresi ISO8601 biçimde sona erer. Kimlik bilgilerinin maksimum süresi PT1H'dir. Özellik belirtilmediğinde, PT1H değeri kullanılır.

Yanıtlar

Name	Tür	Description
200 OK	GatewayDebugCredentialsContract	Yanıt gövdesi, ağ geçidinde kullanılacak hata ayıklama kimlik bilgilerini içerir.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementGatewayListDebugCredentials

Örnek isteği

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

Örnek yanıt

Durum kodu:

200

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

Tanımlar

Name	Description
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
GatewayDebugCredentialsContract	Ağ geçidi hata ayıklama kimlik bilgileri.
GatewayListDebugCredentialsContract	Hata ayıklama kimlik bilgileri özelliklerini listeleyin.
GatewayListDebugCredentialsContractPurpose	Kimlik bilgilerinin hatalarını ayıklamanın amaçları.

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

GatewayDebugCredentialsContract

Object

Ağ geçidi hata ayıklama kimlik bilgileri.

Name	Tür	Description
token	string	Ağ geçidi hata ayıklama belirteci.

GatewayListDebugCredentialsContract

Object

Hata ayıklama kimlik bilgileri özelliklerini listeleyin.

Name	Tür	Description
apiId	string (arm-id)	Bir API'nin tam kaynak kimliği.
credentialsExpireAfter	string (duration)	Kimlik bilgilerinin süresi ISO8601 biçimde sona erer. Kimlik bilgilerinin maksimum süresi PT1H'dir. Özellik belirtilmediğinde, PT1H değeri kullanılır.
purposes	GatewayListDebugCredentialsContractPurpose[]	Kimlik bilgilerinin hatalarını ayıklamanın amaçları.

GatewayListDebugCredentialsContractPurpose

Listeleme

Kimlik bilgilerinin hatalarını ayıklamanın amaçları.

Değer	Description
tracing	İzleme amacı.