Gateway - List Keys
Recupera claves de puerta de enlace.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listKeys?api-version=2024-05-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
gateway
|
path | True |
string minLength: 1maxLength: 80 |
Identificador de entidad de puerta de enlace. Debe ser único en la instancia actual del servicio API Management. No debe tener el valor "administrado". |
resource
|
path | True |
string minLength: 1maxLength: 90 |
Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas. |
service
|
path | True |
string minLength: 1maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ |
Nombre del servicio API Management. |
subscription
|
path | True |
string (uuid) |
Identificador de la suscripción de destino. El valor debe ser un UUID. |
api-version
|
query | True |
string minLength: 1 |
Versión de la API que se va a usar para esta operación. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
El cuerpo de la respuesta contiene las claves de puerta de enlace especificadas. Encabezados ETag: string |
|
Other Status Codes |
Respuesta de error que describe por qué se produjo un error en la operación. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
user_impersonation | suplantar la cuenta de usuario |
Ejemplos
ApiManagementGatewayListKeys
Solicitud de ejemplo
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/listKeys?api-version=2024-05-01
Respuesta de muestra
{
"primary": "primary_key_value",
"secondary": "secondary_key_value"
}
Definiciones
Nombre | Description |
---|---|
Error |
Información adicional sobre el error de administración de recursos. |
Error |
Detalle del error. |
Error |
Respuesta de error |
Gateway |
Claves de autenticación de puerta de enlace. |
ErrorAdditionalInfo
Información adicional sobre el error de administración de recursos.
Nombre | Tipo | Description |
---|---|---|
info |
object |
Información adicional. |
type |
string |
Tipo de información adicional. |
ErrorDetail
Detalle del error.
Nombre | Tipo | Description |
---|---|---|
additionalInfo |
Información adicional del error. |
|
code |
string |
Código de error. |
details |
Detalles del error. |
|
message |
string |
Mensaje de error. |
target |
string |
Destino del error. |
ErrorResponse
Respuesta de error
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de error. |
GatewayKeysContract
Claves de autenticación de puerta de enlace.
Nombre | Tipo | Description |
---|---|---|
primary |
string |
Clave de puerta de enlace principal. |
secondary |
string |
Clave de puerta de enlace secundaria. |