Gateway - List Debug Credentials

Reference

Service:: API Management

API Version:: 2023-05-01-preview

Vytvořte nové přihlašovací údaje ladění pro bránu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
gatewayId	path	True	string	Identifikátor entity brány. Musí být jedinečný v aktuální instanci služby API Management. Nesmí mít hodnotu managed.
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
serviceName	path	True	string	Název služby API Management. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string uuid	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
apiId	True	string	Úplné ID prostředku rozhraní API
purposes	True	GatewayListDebugCredentialsContractPurpose[]	Účely ladění přihlašovacích údajů
credentialsExpireAfter		string	Vypršení platnosti přihlašovacích údajů ve formátu ISO8601. Maximální doba trvání přihlašovacích údajů je PT1H. Pokud není vlastnost zadána, použije se hodnota PT1H.

Odpovědi

Name	Typ	Description
200 OK	GatewayDebugCredentialsContract	Tělo odpovědi obsahuje přihlašovací údaje pro ladění, které se mají použít v bráně.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Definice

Name	Description
ErrorFieldContract	Chybový kontrakt pole.
ErrorResponse	Odpověď na chybu.
GatewayDebugCredentialsContract	Přihlašovací údaje pro ladění brány.
GatewayListDebugCredentialsContract	Vypíše vlastnosti přihlašovacích údajů pro ladění.
GatewayListDebugCredentialsContractPurpose	Účely ladění přihlašovacích údajů

ErrorFieldContract

Chybový kontrakt pole.

Name	Typ	Description
code	string	Kód chyby na úrovni vlastnosti.
message	string	Pro člověka čitelná reprezentace chyby na úrovni vlastností.
target	string	Název vlastnosti.

ErrorResponse

Odpověď na chybu.

Name	Typ	Description
error.code	string	Kód chyby definovaný službou. Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.
error.details	ErrorFieldContract[]	Seznam neplatných polí se odešle v požadavku v případě chyby ověření.
error.message	string	Pro člověka čitelná reprezentace chyby.

GatewayDebugCredentialsContract

Přihlašovací údaje pro ladění brány.

Name	Typ	Description
token	string	Token ladění brány.

GatewayListDebugCredentialsContract

Vypíše vlastnosti přihlašovacích údajů pro ladění.

Name	Typ	Description
apiId	string	Úplné ID prostředku rozhraní API
credentialsExpireAfter	string	Vypršení platnosti přihlašovacích údajů ve formátu ISO8601. Maximální doba trvání přihlašovacích údajů je PT1H. Pokud není vlastnost zadána, použije se hodnota PT1H.
purposes	GatewayListDebugCredentialsContractPurpose[]	Účely ladění přihlašovacích údajů

GatewayListDebugCredentialsContractPurpose

Účely ladění přihlašovacích údajů

Name	Typ	Description
tracing	string	Účel trasování.

Share via