Compartilhar via


Admin Keys - Regenerate

Regenera a chave de API de administração primária ou secundária. Você 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 de URI

Nome Em Obrigatório Tipo Description
keyKind
path True

AdminKeyKind

Especifica qual chave deve ser regenerada. Os valores válidos incluem 'primary' e 'secondary'.

resourceGroupName
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.

searchServiceName
path True

string

O nome do serviço de pesquisa 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 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

AdminKeyResult

A chave de administrador especificada foi regenerada com êxito. Ambas as chaves de administrador são incluídas na resposta, incluindo a chave recém-regenerada.

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

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

SearchRegenerateAdminKey

Solicitação de exemplo

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/regenerateAdminKey/primary?api-version=2023-11-01

Resposta de exemplo

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

Definições

Nome Description
AdminKeyKind

Especifica qual chave deve ser regenerada. Os valores válidos incluem 'primary' e 'secondary'.

AdminKeyResult

Resposta que contém as chaves de API de administração primárias e secundárias para um determinado serviço de pesquisa.

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.

AdminKeyKind

Especifica qual chave deve ser regenerada. Os valores válidos incluem 'primary' e 'secondary'.

Nome Tipo Description
primary

string

A chave de API primária para o serviço de pesquisa.

secondary

string

A chave de API secundária para o serviço de pesquisa.

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

CloudErrorBody

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

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).