Compartilhar via


Diagnostic - List By Service

Lista todos os diagnósticos da instância do serviço de Gerenciamento de API.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName
path True

string

O nome do serviço Gerenciamento de API.

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

subscriptionId
path True

string

A ID da assinatura de destino.

api-version
query True

string

A versão da API a ser usada para esta operação.

$filter
query

string

| Campo | Uso | Operadores com suporte | Funções com suporte |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |

$skip
query

integer

int32

Número de registros a serem ignorados.

$top
query

integer

int32

Número de registros a serem retornados.

Respostas

Nome Tipo Description
200 OK

DiagnosticCollection

Resposta de resultado paginada de diagnóstico.

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

ApiManagementListDiagnostics

Solicitação de exemplo

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics?api-version=2022-08-01

Resposta de exemplo

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

Definições

Nome Description
AlwaysLog

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

BodyDiagnosticSettings

Configurações de registro em log de corpo.

DataMasking
DataMaskingEntity
DataMaskingMode

Modo de mascaramento de dados.

DiagnosticCollection

Representação de lista de diagnóstico paginado.

DiagnosticContract

Detalhes do diagnóstico.

ErrorFieldContract

Contrato de campo de erro.

ErrorResponse

Resposta de erro.

HttpCorrelationProtocol

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

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

AlwaysLog

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

Nome Tipo Description
allErrors

string

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

BodyDiagnosticSettings

Configurações de registro em log de corpo.

Nome Tipo Description
bytes

integer

Número de bytes do corpo da solicitação a serem registrados.

DataMasking

Nome Tipo Description
headers

DataMaskingEntity[]

Configurações de mascaramento para cabeçalhos

queryParams

DataMaskingEntity[]

Configurações de mascaramento para parâmetros de consulta url

DataMaskingEntity

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

Modo de mascaramento de dados.

Nome Tipo Description
Hide

string

Ocultar a presença de uma entidade.

Mask

string

Mascarar o valor de uma entidade.

DiagnosticCollection

Representação de lista de diagnóstico paginado.

Nome Tipo Description
count

integer

Número total de contagem de registros em todas as páginas.

nextLink

string

Próximo link da página, se houver.

value

DiagnosticContract[]

Valores de página.

DiagnosticContract

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 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 Application Insights diagnóstico.

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

type

string

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

ErrorFieldContract

Contrato de campo de erro.

Nome Tipo Description
code

string

Código de erro no nível da propriedade.

message

string

Representação legível por humanos do erro no nível da propriedade.

target

string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Nome Tipo Description
error.code

string

Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.

error.details

ErrorFieldContract[]

A lista de campos inválidos enviados na solicitação, em caso de erro de validação.

error.message

string

Representação legível ao olho humano do erro.

HttpCorrelationProtocol

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

Nome Tipo Description
Legacy

string

Injete cabeçalhos de 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

string

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

W3C

string

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

HttpMessageDiagnostic

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

Nome Tipo Description
body

BodyDiagnosticSettings

Configurações de registro em log de corpo.

dataMasking

DataMasking

Configurações de mascaramento de dados.

headers

string[]

Matriz de cabeçalhos HTTP para registrar.

OperationNameFormat

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

Nome Tipo Description
Name

string

API_NAME; rev=API_REVISION - OPERATION_NAME

Url

string

HTTP_VERB URL

PipelineDiagnosticSettings

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

Configurações de amostragem para Diagnóstico.

Nome Tipo Description
percentage

number

Taxa de amostragem para amostragem de taxa fixa.

samplingType

SamplingType

Tipo de amostragem.

SamplingType

Tipo de amostragem.

Nome Tipo Description
fixed

string

Amostragem de taxa fixa.

Verbosity

O nível de detalhamento aplicado a rastreamentos emitidos por políticas de rastreamento.

Nome Tipo Description
error

string

Somente rastreamentos com 'severidade' definido como 'error' serão enviados para o agente anexado a essa instância de diagnóstico.

information

string

Rastreamentos com 'severidade' definido como 'information' e 'error' serão enviados para o agente anexado a essa instância de diagnóstico.

verbose

string

Todos os rastreamentos emitidos pelas políticas de rastreamento serão enviados ao agente anexado a essa instância de diagnóstico.