Compartilhar via

Subscription - List Secrets

Serviço:
API Management
Versão da API:
2024-05-01

Obtém as chaves de assinatura 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 URI

Nome Em Obrigatório Tipo Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName
 path True

string

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

O nome do serviço de Gerenciamento de API.
sid
 path True

string

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

Identificador de entidade de assinatura. A entidade representa a associação entre um usuário e um produto no Gerenciamento de API.
subscriptionId
 path True

string (uuid)

A ID da assinatura de destino. O valor deve ser uma UUID.
api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

SubscriptionKeysContract

O corpo da resposta contém chaves de assinatura.

Cabeçalhos

ETag: string
Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

ApiManagementSubscriptionListSecrets

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
200 
{
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>"
}

Definições

Nome Description
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
SubscriptionKeysContract

Chaves de assinatura.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

SubscriptionKeysContract

Objeto

Chaves de assinatura.

Nome Tipo Description
primaryKey

string

minLength: 1
maxLength: 256

Chave primária da assinatura.
secondaryKey

string

minLength: 1
maxLength: 256

Chave secundária da assinatura.