Gateway - Update

Serviço:

API Management

Versão da API:

2024-05-01

Atualiza os detalhes do gateway especificado por seu identificador.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}?api-version=2024-05-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
gatewayId	path	True	string minLength: 1 maxLength: 80	Identificador de entidade de gateway. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Não deve ter o valor 'gerenciado'
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do serviço de Gerenciamento de API.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
If-Match	True	string	ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

Corpo da solicitação

Nome	Tipo	Description
properties.description	string maxLength: 1000	Descrição do gateway
properties.locationData	ResourceLocationDataContract	Local do gateway.

Respostas

Nome	Tipo	Description
200 OK	GatewayContract	Os detalhes do Gateway foram atualizados com êxito. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

ApiManagementUpdateGateway

Solicitação de exemplo

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1?api-version=2024-05-01


{
  "properties": {
    "description": "my gateway 1",
    "locationData": {
      "name": "my location"
    }
  }
}

Resposta de exemplo

Código de status:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1",
  "type": "Microsoft.ApiManagement/service/gateways",
  "name": "a1",
  "properties": {
    "description": "my gateway 1",
    "locationData": {
      "name": "my location"
    }
  }
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GatewayContract	Detalhes do gateway.
ResourceLocationDataContract	Propriedades de dados do local do recurso.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

GatewayContract

Objeto

Detalhes do gateway.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.description	string maxLength: 1000	Descrição do gateway
properties.locationData	ResourceLocationDataContract	Local do gateway.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ResourceLocationDataContract

Objeto

Propriedades de dados do local do recurso.

Nome	Tipo	Description
city	string maxLength: 256	A cidade ou localidade em que o recurso está localizado.
countryOrRegion	string maxLength: 256	O país ou a região em que o recurso está localizado.
district	string maxLength: 256	O distrito, o estado ou a província onde o recurso está localizado.
name	string maxLength: 256	Um nome canônico para a localização geográfica ou física.