Admin Keys - Get
Obtém as chaves de API de administração primárias e secundárias para o serviço de pesquisa especificado.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/listAdminKeys?api-version=2023-11-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
O nome do grupo de recursos dentro da assinatura atual. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal. |
search
|
path | True |
string |
O nome do serviço de pesquisa associado ao grupo de recursos especificado. |
subscription
|
path | True |
string |
O identificador exclusivo de uma assinatura do Microsoft Azure. Você pode obter esse valor da API de Resource Manager do Azure, das ferramentas de linha de comando ou do portal. |
api-version
|
query | True |
string |
A versão da API a ser usada para cada solicitação. |
Cabeçalho da solicitação
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
x-ms-client-request-id |
string uuid |
Um valor de GUID gerado pelo cliente que identifica esta solicitação. Se especificado, isso será incluído nas informações de resposta como uma maneira de acompanhar a solicitação. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
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 do plano de dados ou um SDK do Azure 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 upload, modificação ou exclusão de dados em seus índices. |
|
Other Status Codes |
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
Microsoft Entra ID fluxo de autorização OAuth2.
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
SearchGetAdminKeys
Solicitação de exemplo
Resposta de exemplo
{
"primaryKey": "<your primary admin API key>",
"secondaryKey": "<your secondary admin API key>"
}
Definições
Nome | Description |
---|---|
Admin |
Resposta que contém as chaves de API de administração primárias e secundárias para um determinado serviço de pesquisa. |
Cloud |
Contém informações sobre um erro de API. |
Cloud |
Descreve um erro de API específico com um código de erro e uma mensagem. |
AdminKeyResult
Resposta que contém as chaves de API de administração primárias e secundárias para um determinado serviço de pesquisa.
Nome | Tipo | Description |
---|---|---|
primaryKey |
string |
A chave de API do administrador primário do serviço de pesquisa. |
secondaryKey |
string |
A chave de API de administração secundária do serviço de pesquisa. |
CloudError
Contém informações sobre um erro de API.
Nome | Tipo | Description |
---|---|---|
error |
Descreve um erro de API específico com um código de erro e uma mensagem. |
CloudErrorBody
Descreve um erro de API específico com um código de erro e uma mensagem.
Nome | Tipo | Description |
---|---|---|
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 |
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). |