Gateway - List Keys
Obtém chaves de gateway.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/listKeys?api-version=2022-08-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
gateway
|
path | True |
string |
Identificador de entidade de gateway. Tem de ser exclusivo na instância de serviço de Gestão de API atual. Não é possível 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. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
O corpo da resposta contém as chaves de Gateway especificadas. Headers ETag: string |
|
Other Status Codes |
Resposta de erro que descreve a razão 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
ApiManagementGatewayListKeys
Sample Request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/listKeys?api-version=2022-08-01
Sample Response
{
"primary": "primary_key_value",
"secondary": "secondary_key_value"
}
Definições
Name | Description |
---|---|
Error |
Contrato de campo de erro. |
Error |
Resposta a Erros. |
Gateway |
Chaves de autenticação do gateway. |
ErrorFieldContract
Contrato de campo de erro.
Name | Tipo | Description |
---|---|---|
code |
string |
Código de erro ao nível da propriedade. |
message |
string |
Representação legível por humanos do erro ao nível da propriedade. |
target |
string |
Nome da propriedade. |
ErrorResponse
Resposta a Erros.
Name | Tipo | Description |
---|---|---|
error.code |
string |
Código de erro definido pelo serviço. Este código serve como um sub-estado para o código de erro HTTP especificado na resposta. |
error.details |
A lista de campos inválidos enviados a pedido, em caso de erro de validação. |
|
error.message |
string |
Representação legível por humanos do erro. |
GatewayKeysContract
Chaves de autenticação do gateway.
Name | Tipo | Description |
---|---|---|
primary |
string |
Chave de gateway principal. |
secondary |
string |
Chave de gateway secundária. |