Compartir a través de

Subscription - List Secrets

Servicio:
API Management
Versión de la API:
2024-05-01

Obtiene las claves de suscripción especificadas.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Nombre del servicio API Management.
sid
 path True

string

maxLength: 256
pattern: ^[^*#&+:<>?]+$

Identificador de entidad de suscripción. La entidad representa la asociación entre un usuario y un producto en API Management.
subscriptionId
 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

SubscriptionKeysContract

El cuerpo de la respuesta contiene claves de suscripción.

Encabezados

ETag: string
Other Status Codes

ErrorResponse

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

ApiManagementSubscriptionListSecrets

Solicitud de ejemplo

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/5931a769d8d14f0ad8ce13b8/listSecrets?api-version=2024-05-01

Respuesta de muestra

status code:
200 
{
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>"
}

Definiciones

Nombre Description
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.
ErrorDetail

Detalle del error.
ErrorResponse

Respuesta de error
SubscriptionKeysContract

Claves de suscripción.

ErrorAdditionalInfo

Object

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

Object

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorDetail[]

Detalles del error.
message

string

Mensaje de error.
target

string

Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

SubscriptionKeysContract

Object

Claves de suscripción.

Nombre Tipo Description
primaryKey

string

minLength: 1
maxLength: 256

Clave principal de suscripción.
secondaryKey

string

minLength: 1
maxLength: 256

Clave secundaria de suscripción.