Gateway - Regenerate Key
Regenera a chave de gateway especificada ao invalidar todos os tokens criados com a mesma.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/regenerateKey?api-version=2022-08-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
gateway
|
path | True |
string |
Identificador de entidade do gateway. Tem de ser exclusivo na instância de serviço do Gestão de API atual. Não pode ter o valor "gerido" |
resource
|
path | True |
string |
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas. |
service
|
path | True |
string |
O nome do serviço Gestão de API. Regex pattern: |
subscription
|
path | True |
string |
O ID da subscrição de destino. |
api-version
|
query | True |
string |
A versão da API a utilizar para esta operação. |
Corpo do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
keyType | True |
A Chave a ser regenerada. |
Respostas
Name | Tipo | Description |
---|---|---|
204 No Content |
Chave regenerada com êxito |
|
Other Status Codes |
Resposta de erro que descreve o motivo pela qual a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | representar a sua conta de utilizador |
Exemplos
ApiManagementGatewayRegenerateKey
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gwId/regenerateKey?api-version=2022-08-01
{
"keyType": "primary"
}
Sample Response
Definições
Name | Description |
---|---|
Error |
Contrato de Campo de Erro. |
Error |
Resposta do Erro. |
Gateway |
Propriedades do contrato de pedido de regeneração de chaves de gateway. |
Key |
A Chave a ser regenerada. |
ErrorFieldContract
Contrato de Campo de Erro.
Name | Tipo | Description |
---|---|---|
code |
string |
Código de erro de nível de propriedade. |
message |
string |
Representação legível por humanos do erro ao nível da propriedade. |
target |
string |
Nome da propriedade. |
ErrorResponse
Resposta do Erro.
Name | Tipo | Description |
---|---|---|
error.code |
string |
Código de erro definido pelo serviço. Este código serve como um subestado para o código de erro HTTP especificado na resposta. |
error.details |
A lista de campos inválidos enviados no pedido, em caso de erro de validação. |
|
error.message |
string |
Representação legível por humanos do erro. |
GatewayKeyRegenerationRequestContract
Propriedades do contrato de pedido de regeneração de chaves de gateway.
Name | Tipo | Description |
---|---|---|
keyType |
A Chave a ser regenerada. |
KeyType
A Chave a ser regenerada.
Name | Tipo | Description |
---|---|---|
primary |
string |
|
secondary |
string |