Partilhar via


Api Diagnostic - Update

Atualizações os detalhes do Diagnóstico de uma API especificada pelo respetivo identificador.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}?api-version=2021-08-01

Parâmetros do URI

Name Em Necessário Tipo Description
apiId
path True

string

Identificador de API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.

diagnosticId
path True

string

Identificador de diagnóstico. Tem de ser exclusivo na instância de serviço do Gestão de API atual.

Padrão Regex: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

O nome do grupo de recursos.

serviceName
path True

string

O nome do serviço Gestão de API.

Padrão Regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.

api-version
query True

string

Versão da API a utilizar com o pedido de cliente.

Cabeçalho do Pedido

Name Necessário Tipo Description
If-Match True

string

ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.

Corpo do Pedido

Name Necessário Tipo Description
properties.loggerId True

string

ID de recurso de um logger de destino.

properties.alwaysLog

AlwaysLog

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

properties.backend

PipelineDiagnosticSettings

Definições de diagnóstico para mensagens HTTP recebidas/enviadas para o Back-end

properties.frontend

PipelineDiagnosticSettings

Definições de diagnóstico para mensagens HTTP recebidas/enviadas para o Gateway.

properties.httpCorrelationProtocol

HttpCorrelationProtocol

Define o protocolo de correlação a utilizar para diagnósticos do Application Insights.

properties.logClientIp

boolean

Registe o ClientIP. A predefinição é falso.

properties.metrics

boolean

Emita métricas personalizadas através da política emit-metric. Aplicável apenas às definições de diagnóstico do Application Insights.

properties.operationNameFormat

OperationNameFormat

O formato do Nome da Operação para telemetrias do Application Insights. A predefinição é Nome.

properties.sampling

SamplingSettings

Definições de amostragem para Diagnóstico.

properties.verbosity

Verbosity

O nível de verbosidade aplicado aos rastreios emitidos pelas políticas de rastreio.

Respostas

Name Tipo Description
200 OK

DiagnosticContract

O diagnóstico foi atualizado com êxito.

Cabeçalhos

ETag: string

Other Status Codes

ErrorResponse

Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

ApiManagementUpdateApiDiagnostic

Pedido de amostra

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/diagnostics/applicationinsights?api-version=2021-08-01


{
  "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
        }
      }
    }
  }
}

Resposta da amostra

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/diagnostics/applicationinsights",
  "type": "Microsoft.ApiManagement/service/apis/diagnostics",
  "name": "applicationinsights",
  "properties": {
    "alwaysLog": "allErrors",
    "httpCorrelationProtocol": "Legacy",
    "logClientIp": true,
    "loggerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest",
    "sampling": {
      "samplingType": "fixed",
      "percentage": 100
    },
    "frontend": {
      "request": {
        "headers": [],
        "body": {
          "bytes": 100
        }
      },
      "response": {
        "headers": [],
        "body": {
          "bytes": 100
        }
      }
    },
    "backend": {
      "request": {
        "headers": [],
        "body": {
          "bytes": 100
        }
      },
      "response": {
        "headers": [],
        "body": {
          "bytes": 100
        }
      }
    }
  }
}

Definições

Name Description
AlwaysLog

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

BodyDiagnosticSettings

Definições de registo de corpo.

DataMasking
DataMaskingEntity
DataMaskingMode

Modo de máscara de dados.

DiagnosticContract

Detalhes de diagnóstico.

ErrorFieldContract

Contrato de Campo de Erro.

ErrorResponse

Resposta do Erro.

HttpCorrelationProtocol

Define o protocolo de correlação a utilizar para diagnósticos do Application Insights.

HttpMessageDiagnostic

Definições de diagnóstico de mensagens http.

OperationNameFormat

O formato do Nome da Operação para telemetrias do Application Insights. A predefinição é Nome.

PipelineDiagnosticSettings

Definições de diagnóstico para mensagens HTTP recebidas/enviadas para o Gateway.

SamplingSettings

Definições de amostragem para Diagnóstico.

SamplingType

Tipo de amostragem.

Verbosity

O nível de verbosidade aplicado aos rastreios emitidos pelas políticas de rastreio.

AlwaysLog

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

Name Tipo Description
allErrors

string

Registe sempre todos os pedidos erróneos, independentemente das definições de amostragem.

BodyDiagnosticSettings

Definições de registo de corpo.

Name Tipo Description
bytes

integer

Número de bytes do corpo do pedido a registar.

DataMasking

Name Tipo Description
headers

DataMaskingEntity[]

Definições de máscara para cabeçalhos

queryParams

DataMaskingEntity[]

Definições de máscara para parâmetros de consulta url

DataMaskingEntity

Name Tipo Description
mode

DataMaskingMode

Modo de máscara de dados.

value

string

O nome de uma entidade a mascarar (por exemplo, um nome de um cabeçalho ou um parâmetro de consulta).

DataMaskingMode

Modo de máscara de dados.

Name Tipo Description
Hide

string

Ocultar a presença de uma entidade.

Mask

string

Mascarar o valor de uma entidade.

DiagnosticContract

Detalhes de diagnóstico.

Name Tipo Description
id

string

ID de recurso completamente 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 definições de amostragem não devem ser aplicadas.

properties.backend

PipelineDiagnosticSettings

Definições de diagnóstico para mensagens HTTP recebidas/enviadas para o Back-end

properties.frontend

PipelineDiagnosticSettings

Definições de diagnóstico para mensagens HTTP recebidas/enviadas para o Gateway.

properties.httpCorrelationProtocol

HttpCorrelationProtocol

Define o protocolo de correlação a utilizar para diagnósticos do Application Insights.

properties.logClientIp

boolean

Registe o ClientIP. A predefinição é falso.

properties.loggerId

string

ID de recurso de um logger de destino.

properties.metrics

boolean

Emita métricas personalizadas através da política emit-metric. Aplicável apenas às definições de diagnóstico do Application Insights.

properties.operationNameFormat

OperationNameFormat

O formato do Nome da Operação para telemetrias do Application Insights. A predefinição é Nome.

properties.sampling

SamplingSettings

Definições de amostragem para Diagnóstico.

properties.verbosity

Verbosity

O nível de verbosidade aplicado aos rastreios emitidos pelas políticas de rastreio.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

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

ErrorFieldContract[]

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.

HttpCorrelationProtocol

Define o protocolo de correlação a utilizar para diagnósticos do Application Insights.

Name Tipo Description
Legacy

string

Injete cabeçalhos de Request-Id e Request-Context com dados de correlação de pedidos. Consulte https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.

None

string

Não leia nem injete cabeçalhos de correlação.

W3C

string

Injetar cabeçalhos de Contexto de Rastreio. Consulte https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Definições de diagnóstico de mensagens http.

Name Tipo Description
body

BodyDiagnosticSettings

Definições de registo de corpo.

dataMasking

DataMasking

Definições de mascaramento de dados.

headers

string[]

Matriz de Cabeçalhos HTTP a registar.

OperationNameFormat

O formato do Nome da Operação para telemetrias do Application Insights. A predefinição é Nome.

Name Tipo Description
Name

string

API_NAME; rev=API_REVISION - OPERATION_NAME

Url

string

HTTP_VERB URL

PipelineDiagnosticSettings

Definições de diagnóstico para mensagens HTTP recebidas/enviadas para o Gateway.

Name Tipo Description
request

HttpMessageDiagnostic

Definições de diagnóstico do pedido.

response

HttpMessageDiagnostic

Definições de diagnóstico para resposta.

SamplingSettings

Definições de amostragem para Diagnóstico.

Name Tipo Description
percentage

number

Taxa de amostragem da amostragem de taxa fixa.

samplingType

SamplingType

Tipo de amostragem.

SamplingType

Tipo de amostragem.

Name Tipo Description
fixed

string

Amostragem de taxa fixa.

Verbosity

O nível de verbosidade aplicado aos rastreios emitidos pelas políticas de rastreio.

Name Tipo Description
error

string

Apenas os rastreios com "gravidade" definido como "erro" serão enviados para o logger anexado a esta instância de diagnóstico.

information

string

Os rastreios com "gravidade" definidos como "informações" e "erro" serão enviados para o logger anexado a esta instância de diagnóstico.

verbose

string

Todos os rastreios emitidos pelas políticas de rastreio serão enviados para o logger anexado a esta instância de diagnóstico.