Admin Keys - Regenerate
Regenera a chave de API de administração primária ou secundária. Só pode regenerar uma chave de cada vez.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/regenerateAdminKey/{keyKind}?api-version=2023-11-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
key
|
path | True |
Especifica a chave a regenerar. Os valores válidos incluem "primário" e "secundário". |
|
resource
|
path | True |
string |
O nome do grupo de recursos na subscrição atual. Pode obter este valor a partir da API do Azure Resource Manager ou 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 subscrição do Microsoft Azure. Pode obter este valor a partir da API Resource Manager do Azure, das ferramentas de linha de comandos ou do portal. |
api-version
|
query | True |
string |
A versão da API a utilizar para cada pedido. |
Cabeçalho do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
x-ms-client-request-id |
string uuid |
Um valor GUID gerado pelo cliente que identifica este pedido. Se for especificado, isto será incluído nas informações de resposta como forma de controlar o pedido. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
A chave de administração especificada foi regenerada com êxito. Ambas as chaves de administração estão incluídas na resposta, incluindo a chave recém-regenerada. |
|
Other Status Codes |
HTTP 404 (Não Encontrado): não foi possível localizar a subscrição, o grupo de recursos ou o serviço de pesquisa. HTTP 409 (Conflito): a subscrição especificada está desativada. |
Segurança
azure_auth
Microsoft Entra ID fluxo de autorização OAuth2.
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
user_impersonation | representar a sua conta de utilizador |
Exemplos
SearchRegenerateAdminKey
Pedido de amostra
Resposta da amostra
{
"primaryKey": "<your primary admin API key>",
"secondaryKey": "<your secondary admin API key>"
}
Definições
Name | Description |
---|---|
Admin |
Especifica a chave a regenerar. Os valores válidos incluem "primário" e "secundário". |
Admin |
Resposta que contém as chaves de API de administração primária e secundária para um determinado serviço de pesquisa. |
Cloud |
Contém informações sobre um erro de API. |
Cloud |
Descreve um erro específico da API com um código de erro e uma mensagem. |
AdminKeyKind
Especifica a chave a regenerar. Os valores válidos incluem "primário" e "secundário".
Name | Tipo | Description |
---|---|---|
primary |
string |
A chave de API primária do serviço de pesquisa. |
secondary |
string |
A chave de API secundária do serviço de pesquisa. |
AdminKeyResult
Resposta que contém as chaves de API de administração primária e secundária para um determinado serviço de pesquisa.
Name | Tipo | Description |
---|---|---|
primaryKey |
string |
A chave de API de administrador principal 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.
Name | Tipo | Description |
---|---|---|
error |
Descreve um erro específico da API com um código de erro e uma mensagem. |
CloudErrorBody
Descreve um erro específico da API com um código de erro e uma mensagem.
Name | 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 estado HTTP. Pode ser utilizado para processar programaticamente casos de erro específicos. |
details |
Contém erros aninhados relacionados com este erro. |
|
message |
string |
Uma mensagem que descreve o erro em detalhe e fornece informações de depuração. |
target |
string |
O destino do erro específico (por exemplo, o nome da propriedade em erro). |