Diagnostic - Create Or Update

Referência

Serviço:: API Management

Versão da API:: 2024-05-01

Cria um novo Diagnóstico ou atualiza um existente.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
diagnosticId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificador de diagnóstico. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
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 um UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
If-Match		string	ETag da Entidade. Não é necessário ao criar uma entidade, mas é necessário ao atualizar uma entidade.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.loggerId	True	string	ID do recurso de um registrador de destino.
properties.alwaysLog		AlwaysLog	Especifica para que tipo de mensagens as configurações de amostragem não devem ser aplicadas.
properties.backend		PipelineDiagnosticSettings	Configurações de diagnóstico para mensagens HTTP de entrada/saída para o back-end
properties.frontend		PipelineDiagnosticSettings	Configurações de diagnóstico para mensagens HTTP de entrada/saída para o Gateway.
properties.httpCorrelationProtocol		HttpCorrelationProtocol	Define o protocolo de correlação a ser usado para o diagnóstico do Application Insights.
properties.logClientIp		boolean	Registre o ClientIP. O padrão é false.
properties.metrics		boolean	Emita métricas personalizadas por meio da política de métricas de emissão. Aplicável apenas às configurações de diagnóstico do Application Insights.
properties.operationNameFormat		OperationNameFormat	O formato do nome da operação para telemetrias do Application Insights. O padrão é Nome.
properties.sampling		SamplingSettings	Configurações de amostragem para diagnóstico.
properties.verbosity		Verbosity	O nível de detalhamento aplicado aos traços emitidos pelas políticas de rastreamento.

Respostas

Name	Tipo	Description
200 OK	DiagnosticContract	Diagnóstico atualizado com êxito Cabeçalhos ETag: string
201 Created	DiagnosticContract	O diagnóstico foi criado com êxito. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Name

Tipo

Description

200 OK

DiagnosticContract

Diagnóstico atualizado com êxito

Cabeçalhos

ETag: string

201 Created

DiagnosticContract

O diagnóstico foi criado com êxito.

Cabeçalhos

ETag: string

Other Status Codes

ErrorResponse

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

ApiManagementCreateDiagnostic

Pedido de amostra

HTTP

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

{
  "properties": {
    "alwaysLog": "allErrors",
    "loggerId": "/loggers/azuremonitor",
    "sampling": {
      "samplingType": "fixed",
      "percentage": 50
    },
    "frontend": {
      "request": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      },
      "response": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      }
    },
    "backend": {
      "request": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      },
      "response": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      }
    }
  }
}

Resposta da amostra

Código de estado:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights",
  "type": "Microsoft.ApiManagement/service/diagnostics",
  "name": "applicationinsights",
  "properties": {
    "alwaysLog": "allErrors",
    "loggerId": "/loggers/azuremonitor",
    "sampling": {
      "samplingType": "fixed",
      "percentage": 50
    },
    "frontend": {
      "request": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      },
      "response": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      }
    },
    "backend": {
      "request": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      },
      "response": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      }
    }
  }
}

Código de estado:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights",
  "type": "Microsoft.ApiManagement/service/diagnostics",
  "name": "applicationinsights",
  "properties": {
    "alwaysLog": "allErrors",
    "loggerId": "/loggers/applicationinsights",
    "sampling": {
      "samplingType": "fixed",
      "percentage": 50
    },
    "frontend": {
      "request": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      },
      "response": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      }
    },
    "backend": {
      "request": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      },
      "response": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      }
    }
  }
}

Definições

Name	Description
AlwaysLog	Especifica para que tipo de mensagens as configurações de amostragem não devem ser aplicadas.
BodyDiagnosticSettings	Configurações de registro do corpo.
DataMasking
DataMaskingEntity
DataMaskingMode	Modo de mascaramento de dados.
DiagnosticContract	Detalhes do diagnóstico.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
HttpCorrelationProtocol	Define o protocolo de correlação a ser usado para o diagnóstico do Application Insights.
HttpMessageDiagnostic	Configurações de diagnóstico de mensagem HTTP.
OperationNameFormat	O formato do nome da operação para telemetrias do Application Insights. O padrão é Nome.
PipelineDiagnosticSettings	Configurações de diagnóstico para mensagens HTTP de entrada/saída para o Gateway.
SamplingSettings	Configurações de amostragem para diagnóstico.
SamplingType	Tipo de amostragem.
Verbosity	O nível de detalhamento aplicado aos traços emitidos pelas políticas de rastreamento.

AlwaysLog

Enumeração

Especifica para que tipo de mensagens as configurações de amostragem não devem ser aplicadas.

Valor	Description
allErrors	Sempre registre todas as solicitações erradas, independentemente das configurações de amostragem.

BodyDiagnosticSettings

Object

Configurações de registro do corpo.

Name	Tipo	Description
bytes	integer (int32) maximum: 8192	Número de bytes do corpo da solicitação para registrar.

DataMasking

Object

Name	Tipo	Description
headers	DataMaskingEntity[]	Configurações de mascaramento para cabeçalhos
queryParams	DataMaskingEntity[]	Configurações de mascaramento para parâmetros de consulta Url

DataMaskingEntity

Object

Name	Tipo	Description
mode	DataMaskingMode	Modo de mascaramento de dados.
value	string	O nome de uma entidade a ser mascarada (por exemplo, um nome de um cabeçalho ou um parâmetro de consulta).

DataMaskingMode

Enumeração

Modo de mascaramento de dados.

Valor	Description
Hide	Ocultar a presença de uma entidade.
Mask	Mascarar o valor de uma entidade.

DiagnosticContract

Object

Detalhes do diagnóstico.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.alwaysLog	AlwaysLog	Especifica para que tipo de mensagens as configurações de amostragem não devem ser aplicadas.
properties.backend	PipelineDiagnosticSettings	Configurações de diagnóstico para mensagens HTTP de entrada/saída para o back-end
properties.frontend	PipelineDiagnosticSettings	Configurações de diagnóstico para mensagens HTTP de entrada/saída para o Gateway.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Define o protocolo de correlação a ser usado para o diagnóstico do Application Insights.
properties.logClientIp	boolean	Registre o ClientIP. O padrão é false.
properties.loggerId	string	ID do recurso de um registrador de destino.
properties.metrics	boolean	Emita métricas personalizadas por meio da política de métricas de emissão. Aplicável apenas às configurações de diagnóstico do Application Insights.
properties.operationNameFormat	OperationNameFormat	O formato do nome da operação para telemetrias do Application Insights. O padrão é Nome.
properties.sampling	SamplingSettings	Configurações de amostragem para diagnóstico.
properties.verbosity	Verbosity	O nível de detalhamento aplicado aos traços emitidos pelas políticas de rastreamento.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

HttpCorrelationProtocol

Enumeração

Define o protocolo de correlação a ser usado para o diagnóstico do Application Insights.

Valor	Description
Legacy	Injete cabeçalhos de Request-Id e Request-Context com dados de correlação de solicitação. Ver https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
None	Não leia nem injete cabeçalhos de correlação.
W3C	Injete cabeçalhos de contexto de rastreamento. Ver https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Object

Configurações de diagnóstico de mensagem HTTP.

Name	Tipo	Description
body	BodyDiagnosticSettings	Configurações de registro do corpo.
dataMasking	DataMasking	Configurações de mascaramento de dados.
headers	string[]	Matriz de cabeçalhos HTTP para registrar.

OperationNameFormat

Enumeração

O formato do nome da operação para telemetrias do Application Insights. O padrão é Nome.

Valor	Description
Name	API_NAME; rev=API_REVISION - OPERATION_NAME
Url	HTTP_VERB URL

PipelineDiagnosticSettings

Object

Configurações de diagnóstico para mensagens HTTP de entrada/saída para o Gateway.

Name	Tipo	Description
request	HttpMessageDiagnostic	Configurações de diagnóstico para solicitação.
response	HttpMessageDiagnostic	Configurações de diagnóstico para resposta.

SamplingSettings

Object

Configurações de amostragem para diagnóstico.

Name	Tipo	Description
percentage	number (double) minimum: 0 maximum: 100	Taxa de amostragem para amostragem de taxa fixa.
samplingType	SamplingType	Tipo de amostragem.

SamplingType

Enumeração

Tipo de amostragem.

Valor	Description
fixed	Amostragem de taxa fixa.

Verbosity

Enumeração

O nível de detalhamento aplicado aos traços emitidos pelas políticas de rastreamento.

Valor	Description
error	Somente rastreamentos com 'gravidade' definida como 'erro' serão enviados para o registrador anexado a essa instância de diagnóstico.
information	Rastreamentos com 'gravidade' definida como 'informação' e 'erro' serão enviados para o registrador anexado a esta instância de diagnóstico.
verbose	Todos os rastreamentos emitidos pelas políticas de rastreamento serão enviados para o registrador anexado a essa instância de diagnóstico.

Partilhar via

Diagnostic - Create Or Update

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

ApiManagementCreateDiagnostic

Pedido de amostra

Resposta da amostra

Definições

AlwaysLog

BodyDiagnosticSettings

DataMasking

DataMaskingEntity

DataMaskingMode

DiagnosticContract

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HttpCorrelationProtocol

HttpMessageDiagnostic

OperationNameFormat

PipelineDiagnosticSettings

SamplingSettings

SamplingType

Verbosity

Recursos adicionais