Get Api Keys - List

Serviço:

Marketplace Catalog

Versão da API:

2023-01-01-preview

Recupera uma lista de chaves de API associadas a uma assinatura selecionada. Observe que essa API está atualmente em um estado de versão prévia e requer a inscrição no recurso de visualização "Acesso Antecipado à Chave de API de Descoberta" usando uma assinatura válida do Azure. Para obter mais informações sobre esse processo, consulte a documentação das APIs do Catálogo do Marketplace aqui

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/keys?api-version=2023-01-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
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.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-tenant-id	True	string	O locatário associado à assinatura.

Respostas

Nome	Tipo	Description
200 OK	ApiKeys	Lista de chaves ativas que pertencem à assinatura.
Other Status Codes	ErrorResponse	Resposta de erro do Microsoft.Marketplace descrevendo por que a operação falhou.

Exemplos

Get_Key

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Marketplace/keys?api-version=2023-01-01-preview

Resposta de exemplo

Código de status:

200

{
  "value": [
    {
      "key": "apiKey1",
      "keyAlias": "alias1"
    },
    {
      "key": "apiKey2",
      "keyAlias": "alias2"
    }
  ],
  "nextLink": null
}

Definições

Nome	Description
ApiKey	Objeto ApiKey que contém a chave e seu alias.
ApiKeys	Lista de objetos ApiKey.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro

ApiKey

Objeto

Objeto ApiKey que contém a chave e seu alias.

Nome	Tipo	Description
key	string	A chave de API a ser usada ao chamar pontos de extremidade de descoberta relevantes.
keyAlias	string	O alias de chave de API.

ApiKeys

Objeto

Lista de objetos ApiKey.

Nome	Tipo	Description
nextLink	string	Próxima página de resultados.
value	ApiKey[]	Objeto ApiKey que contém a chave e seu alias.

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.