Partilhar 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 do URI

Name Em Necessá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 da entidade de subscrição. 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 um UUID.
api-version
 query True

string

minLength: 1

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

Respostas

Name 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 descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

ApiManagementSubscriptionListSecrets

Pedido de amostra

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 da amostra

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

Definições

Name Description
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
SubscriptionKeysContract

Chaves de subscrição.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
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

Object

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

SubscriptionKeysContract

Object

Chaves de subscrição.

Name Tipo Description
primaryKey

string

minLength: 1
maxLength: 256

Chave primária da subscrição.
secondaryKey

string

minLength: 1
maxLength: 256

Chave secundária de subscrição.