Admin Keys - Get

Serviço:: Search Management

Versão da API:: 2024-03-01-preview

Obtém as chaves de API de administração primária e secundária para o serviço Azure AI Search especificado.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys?api-version=2024-03-01-preview

Parâmetros do URI

Name	Em	Obrigatório	Tipo	Descrição
resourceGroupName	path	True	string	O nome do grupo de recursos dentro da assinatura atual. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	O nome do serviço Azure AI Search associado ao grupo de recursos especificado.
subscriptionId	path	True	string	O identificador exclusivo de uma assinatura do Microsoft Azure. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
api-version	query	True	string	A versão da API a ser usada para cada solicitação.

Cabeçalho do Pedido

Name	Obrigatório	Tipo	Descrição
x-ms-client-request-id		string (uuid)	Um valor GUID gerado pelo cliente que identifica essa solicitação. Se especificado, isso será incluído nas informações de resposta como uma forma de rastrear a solicitação.

Respostas

Name	Tipo	Descrição
200 OK	AdminKeyResult	As chaves de administrador foram recuperadas com êxito e estão na resposta. Você pode usar a chave primária ou secundária como o valor do parâmetro 'api-key' na API REST ou SDK do serviço Azure AI Search para executar quaisquer operações em seu serviço de pesquisa, incluindo operações privilegiadas. As operações privilegiadas incluem o gerenciamento de recursos como índices e fontes de dados, bem como o upload, modificação ou exclusão de dados em seus índices.
Other Status Codes	CloudError	HTTP 404 (Não encontrado): Não foi possível encontrar a assinatura, o grupo de recursos ou o serviço de pesquisa. HTTP 409 (Conflito): A assinatura especificada está desabilitada.

Segurança

azure_auth

Especifica um fluxo de concessão implícito, conforme suportado na plataforma Microsoft Identity.

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

Âmbitos

Name	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

SearchGetAdminKeys

Pedido de amostra

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/listAdminKeys?api-version=2024-03-01-preview

Resposta da amostra

Código de estado:: 200

{
  "primaryKey": "<your primary admin API key>",
  "secondaryKey": "<your secondary admin API key>"
}

Definições

Name	Descrição
AdminKeyResult	Resposta que contém as chaves de API de administração primária e secundária para um determinado serviço Azure AI Search.
CloudError	Contém informações sobre um erro de API.
CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.

AdminKeyResult

Object

Resposta que contém as chaves de API de administração primária e secundária para um determinado serviço Azure AI Search.

Name	Tipo	Descrição
primaryKey	string	A chave de API de administração primária do serviço de pesquisa.
secondaryKey	string	A chave de API de administração secundária do serviço de pesquisa.

CloudError

Object

Contém informações sobre um erro de API.

Name	Tipo	Descrição
error	CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
message	string	Uma breve descrição do erro que sugere o que deu errado (para obter detalhes/informações de depuração, consulte a propriedade 'error.message').

CloudErrorBody

Object

Descreve um erro de API específico com um código de erro e uma mensagem.

Name	Tipo	Descrição
code	string	Um código de erro que descreve a condição de erro com mais precisão do que um código de status HTTP. Pode ser usado para lidar programaticamente com casos de erro específicos.
details	CloudErrorBody[]	Contém erros aninhados relacionados a esse erro.
message	string	Uma mensagem que descreve o erro em detalhes e fornece informações de depuração.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).