Gateway - List Debug Credentials

Odwołanie

Usługa:: API Management

Wersja interfejsu API:: 2023-09-01-preview

Utwórz nowe poświadczenia debugowania dla bramy.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
gatewayId	path	True	string	Identyfikator jednostki bramy. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nie może mieć wartości "zarządzanej"
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
serviceName	path	True	string	Nazwa usługi API Management. Wzorzec wyrażenia regularnego: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string uuid	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
apiId	True	string	Pełny identyfikator zasobu interfejsu API.
purposes	True	GatewayListDebugCredentialsContractPurpose[]	Cele debugowania poświadczeń.
credentialsExpireAfter		string	Wygaśnięcie poświadczeń w formacie ISO8601. Maksymalny czas trwania poświadczeń to PT1H. Gdy właściwość nie jest określona, jest używana wartość PT1H.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GatewayDebugCredentialsContract	Treść odpowiedzi zawiera poświadczenia debugowania do użycia w bramie.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
GatewayDebugCredentialsContract	Poświadczenia debugowania bramy.
GatewayListDebugCredentialsContract	Wyświetlanie listy właściwości poświadczeń debugowania.
GatewayListDebugCredentialsContractPurpose	Cele debugowania poświadczeń.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.

GatewayDebugCredentialsContract

Poświadczenia debugowania bramy.

Nazwa	Typ	Opis
token	string	Token debugowania bramy.

GatewayListDebugCredentialsContract

Wyświetlanie listy właściwości poświadczeń debugowania.

Nazwa	Typ	Opis
apiId	string	Pełny identyfikator zasobu interfejsu API.
credentialsExpireAfter	string	Wygaśnięcie poświadczeń w formacie ISO8601. Maksymalny czas trwania poświadczeń to PT1H. Gdy właściwość nie jest określona, jest używana wartość PT1H.
purposes	GatewayListDebugCredentialsContractPurpose[]	Cele debugowania poświadczeń.

GatewayListDebugCredentialsContractPurpose

Cele debugowania poświadczeń.

Nazwa	Typ	Opis
tracing	string	Cel śledzenia.

Udostępnij za pośrednictwem