Logger - Update

Serviço:

API Management

Versão da API:

2024-05-01

Atualiza um agente existente.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
loggerId	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identificador do agente. Deve ser exclusivo na instância do serviço de Gerenciamento de API.
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.credentials	object	Credenciais do agente.
properties.description	string	Descrição do agente.
properties.isBuffered	boolean	Se os registros são armazenados em buffer no agente antes da publicação. O padrão é considerado verdadeiro.
properties.loggerType	LoggerType	Tipo de agente.

Respostas

Nome	Tipo	Description
200 OK	LoggerContract	O agente existente foi atualizado 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

ApiManagementUpdateLogger

Solicitação de exemplo

HTTP

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


{
  "properties": {
    "loggerType": "azureEventHub",
    "description": "updating description"
  }
}

Resposta de exemplo

Código de status:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1",
  "type": "Microsoft.ApiManagement/service/loggers",
  "name": "eh1",
  "properties": {
    "loggerType": "azureEventHub",
    "description": "updating description",
    "credentials": {
      "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}"
    },
    "isBuffered": true
  }
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
LoggerContract	Detalhes do agente.
LoggerType	Tipo de agente.
LoggerUpdateContract	Contrato de atualização do agente.

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.

LoggerContract

Objeto

Detalhes do agente.

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.credentials	object	O nome e a cadeia de conexão SendRule do hub de eventos do agente do azureEventHub. Chave de instrumentação para o agente applicationInsights.
properties.description	string maxLength: 256	Descrição do agente.
properties.isBuffered	boolean	Se os registros são armazenados em buffer no agente antes da publicação. O padrão é considerado verdadeiro.
properties.loggerType	LoggerType	Tipo de agente.
properties.resourceId	string	ID de recurso do Azure de um destino de log (recurso do Hub de Eventos do Azure ou recurso do Azure Application Insights).
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

LoggerType

Enumeração

Tipo de agente.

Valor	Description
applicationInsights	Azure Application Insights como destino de log.
azureEventHub	Hub de Eventos do Azure como destino de log.
azureMonitor	Azure Monitor

LoggerUpdateContract

Objeto

Contrato de atualização do agente.

Nome	Tipo	Description
properties.credentials	object	Credenciais do agente.
properties.description	string	Descrição do agente.
properties.isBuffered	boolean	Se os registros são armazenados em buffer no agente antes da publicação. O padrão é considerado verdadeiro.
properties.loggerType	LoggerType	Tipo de agente.