Api Diagnostic - Get

Referência

Serviço:: API Management

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

Obtém os detalhes do Diagnóstico para uma API especificada por seu identificador.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
apiId	path	True	string minLength: 1 maxLength: 80	Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
diagnosticId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificador de diagnóstico. Deve ser exclusivo na instância atual 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.

Respostas

Nome	Tipo	Description
200 OK	DiagnosticContract	O corpo da resposta contém a entidade de diagnóstico especificada. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Nome

Tipo

Description

200 OK

DiagnosticContract

O corpo da resposta contém a entidade de diagnóstico especificada.

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

ApiManagementGetApiDiagnostic

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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/00000000-0000-0000-0000-000000000000/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

Nome	Description
AlwaysLog	Especifica que tipo de configurações de amostragem de mensagens não devem ser aplicadas.
BodyDiagnosticSettings	Configurações de registro em log do corpo.
DataMasking
DataMaskingEntity
DataMaskingMode	Modo de mascaramento de dados.
DiagnosticContract	Detalhes do diagnóstico.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
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 verbosidade aplicado a rastreamentos emitidos por políticas de rastreamento.

AlwaysLog

Enumeração

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

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

BodyDiagnosticSettings

Objeto

Configurações de registro em log do corpo.

Nome	Tipo	Description
bytes	integer (int32) maximum: 8192	Número de bytes do corpo da solicitação a serem registrados em log.

DataMasking

Objeto

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

DataMaskingEntity

Objeto

Nome	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

Objeto

Detalhes do diagnóstico.

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.alwaysLog	AlwaysLog	Especifica que tipo de configurações de amostragem de mensagens 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 em log. O padrão é false.
properties.loggerId	string	ID de recurso de um agente de destino.
properties.metrics	boolean	Emita métricas personalizadas por meio da política de métrica de emissão. Aplicável somente à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 verbosidade aplicado a rastreamentos emitidos por políticas de rastreamento.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

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.

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 Request-Id e Request-Context com dados de correlação de solicitação. Consulte https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
None	Não leia e injete cabeçalhos de correlação.
W3C	Injetar cabeçalhos de contexto de rastreamento. Consulte https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Objeto

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

Nome	Tipo	Description
body	BodyDiagnosticSettings	Configurações de registro em log do corpo.
dataMasking	DataMasking	Configurações de mascaramento de dados.
headers	string[]	Matriz de cabeçalhos HTTP a serem registrados em log.

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

Objeto

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

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

SamplingSettings

Objeto

Configurações de amostragem para Diagnóstico.

Nome	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 verbosidade aplicado a rastreamentos emitidos por políticas de rastreamento.

Valor	Description
error	Somente rastreamentos com 'severidade' definido como 'error' serão enviados para o agente anexado a essa instância de diagnóstico.
information	Rastreamentos com 'severidade' definido como 'informações' e 'erro' serão enviados para o agente anexado a essa instância de diagnóstico.
verbose	Todos os rastreamentos emitidos pelas políticas de rastreamento serão enviados ao agente anexado a essa instância de diagnóstico.

Compartilhar via

Api Diagnostic - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

ApiManagementGetApiDiagnostic

Solicitação de exemplo

Resposta de exemplo

Definições

AlwaysLog

BodyDiagnosticSettings

DataMasking

DataMaskingEntity

DataMaskingMode

DiagnosticContract

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HttpCorrelationProtocol

HttpMessageDiagnostic

OperationNameFormat

PipelineDiagnosticSettings

SamplingSettings

SamplingType

Verbosity

Recursos adicionais