Compartir a través de


Gateway - List Keys

Recupera las claves de la puerta de enlace.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
gatewayId
path True

string

Identificador de entidad de puerta de enlace. Debe ser único en la instancia de servicio de API Management actual. No debe tener el valor "administrado".

resourceGroupName
path True

string

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serviceName
path True

string

Nombre del servicio API Management.

Patrón de Regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Identificador de la suscripción de destino.

api-version
query True

string

Versión de API que se usará para la operación.

Respuestas

Nombre Tipo Description
200 OK

GatewayKeysContract

El cuerpo de la respuesta contiene las claves de puerta de enlace especificadas.

Encabezados

ETag: string

Other Status Codes

ErrorResponse

Respuesta de error que describe el motivo del error de 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 suplantación de su cuenta de usuario

Ejemplos

ApiManagementGatewayListKeys

Solicitud de ejemplo

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/listKeys?api-version=2022-08-01

Respuesta de muestra

{
  "primary": "primary_key_value",
  "secondary": "secondary_key_value"
}

Definiciones

Nombre Description
ErrorFieldContract

Contrato de campo de error.

ErrorResponse

Respuesta de error.

GatewayKeysContract

Claves de autenticación de puerta de enlace.

ErrorFieldContract

Contrato de campo de error.

Nombre Tipo Description
code

string

Código de error de nivel de propiedad.

message

string

Representación legible del error de nivel de propiedad.

target

string

Nombre de propiedad.

ErrorResponse

Respuesta de error.

Nombre Tipo Description
error.code

string

Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.

error.details

ErrorFieldContract[]

La lista de campos no válidos que se envían en la solicitud, en caso de error de validación.

error.message

string

Representación legible del 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.