Diagnostic - Get

Ссылка

Служба:: API Management

Версия API:: 2024-05-01

Возвращает сведения о диагностике, указанной его идентификатором.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
diagnosticId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Идентификатор диагностики. Должен быть уникальным в текущем экземпляре службы управления API.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Имя службы управления API.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	DiagnosticContract	Текст ответа содержит указанную сущность диагностики. Заголовки ETag: string
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Имя

Тип

Описание

200 OK

DiagnosticContract

Текст ответа содержит указанную сущность диагностики.

Заголовки

ETag: string

Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ApiManagementGetDiagnostic

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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",
    "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
        }
      }
    }
  }
}

Определения

Имя	Описание
AlwaysLog	Указывает, какой тип параметров выборки сообщений не должен применяться.
BodyDiagnosticSettings	Параметры ведения журнала тела.
DataMasking
DataMaskingEntity
DataMaskingMode	Режим маскирования данных.
DiagnosticContract	Сведения о диагностике.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
HttpCorrelationProtocol	Задает протокол корреляции, используемый для диагностики Application Insights.
HttpMessageDiagnostic	Параметры диагностики сообщений HTTP.
OperationNameFormat	Формат данных телеметрии Application Insights с именем операции. По умолчанию используется имя.
PipelineDiagnosticSettings	Параметры диагностики для входящих и исходящих HTTP-сообщений в шлюз.
SamplingSettings	Параметры выборки для диагностики.
SamplingType	Тип выборки.
Verbosity	Уровень детализации, применяемый к трассировкам, создаваемым политиками трассировки.

AlwaysLog

Перечисление

Указывает, какой тип параметров выборки сообщений не должен применяться.

Значение	Описание
allErrors	Всегда регистрируются все ошибочные запросы независимо от параметров выборки.

BodyDiagnosticSettings

Object

Параметры ведения журнала тела.

Имя	Тип	Описание
bytes	integer (int32) maximum: 8192	Количество байтов текста запроса для журнала.

DataMasking

Object

Имя	Тип	Описание
headers	DataMaskingEntity[]	Параметры маскирования заголовков
queryParams	DataMaskingEntity[]	Параметры маскирования для параметров запроса URL-адреса

DataMaskingEntity

Object

Имя	Тип	Описание
mode	DataMaskingMode	Режим маскирования данных.
value	string	Имя сущности для маскирования (например, имя заголовка или параметра запроса).

DataMaskingMode

Перечисление

Режим маскирования данных.

Значение	Описание
Hide	Скрытие присутствия сущности.
Mask	Маскирование значения сущности.

DiagnosticContract

Object

Сведения о диагностике.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.alwaysLog	AlwaysLog	Указывает, какой тип параметров выборки сообщений не должен применяться.
properties.backend	PipelineDiagnosticSettings	Параметры диагностики для входящих и исходящих HTTP-сообщений в серверную часть
properties.frontend	PipelineDiagnosticSettings	Параметры диагностики для входящих и исходящих HTTP-сообщений в шлюз.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Задает протокол корреляции, используемый для диагностики Application Insights.
properties.logClientIp	boolean	Зайдите в журнал clientIP. Значение по умолчанию — false.
properties.loggerId	string	Идентификатор ресурса целевого средства ведения журнала.
properties.metrics	boolean	Выдайте пользовательские метрики с помощью политики выдачи метрик. Применимо только к параметрам диагностики Application Insights.
properties.operationNameFormat	OperationNameFormat	Формат данных телеметрии Application Insights с именем операции. По умолчанию используется имя.
properties.sampling	SamplingSettings	Параметры выборки для диагностики.
properties.verbosity	Verbosity	Уровень детализации, применяемый к трассировкам, создаваемым политиками трассировки.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

HttpCorrelationProtocol

Перечисление

Задает протокол корреляции, используемый для диагностики Application Insights.

Значение	Описание
Legacy	Внедрение заголовков Request-Id и Request-Context с данными корреляции запросов. См. https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
None	Не считывайте и не внедряйте заголовки корреляции.
W3C	Внедрение заголовков контекста трассировки. См. https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Object

Параметры диагностики сообщений HTTP.

Имя	Тип	Описание
body	BodyDiagnosticSettings	Параметры ведения журнала тела.
dataMasking	DataMasking	Параметры маскирования данных.
headers	string[]	Массив заголовков HTTP в журнал.

OperationNameFormat

Перечисление

Формат данных телеметрии Application Insights с именем операции. По умолчанию используется имя.

Значение	Описание
Name	API_NAME; rev=API_REVISION — OPERATION_NAME
Url	URL-адрес HTTP_VERB

PipelineDiagnosticSettings

Object

Параметры диагностики для входящих и исходящих HTTP-сообщений в шлюз.

Имя	Тип	Описание
request	HttpMessageDiagnostic	Параметры диагностики для запроса.
response	HttpMessageDiagnostic	Параметры диагностики для ответа.

SamplingSettings

Object

Параметры выборки для диагностики.

Имя	Тип	Описание
percentage	number (double) minimum: 0 maximum: 100	Частота выборки для выборки фиксированной частоты.
samplingType	SamplingType	Тип выборки.

SamplingType

Перечисление

Тип выборки.

Значение	Описание
fixed	Выборка фиксированной частоты.

Verbosity

Перечисление

Уровень детализации, применяемый к трассировкам, создаваемым политиками трассировки.

Значение	Описание
error	Только трассировки с параметром "серьезность" с параметром error будут отправлены в средство ведения журнала, подключенного к этому экземпляру диагностики.
information	Трассировки со значением "серьезность", равные "сведения" и "ошибка", будут отправлены средству ведения журнала, подключенному к этому экземпляру диагностики.
verbose	Все трассировки, создаваемые политиками трассировки, будут отправлены средству ведения журнала, подключенному к этому экземпляру диагностики.

Поделиться через

Diagnostic - Get

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

ApiManagementGetDiagnostic

Образец запроса

Пример ответа

Определения

AlwaysLog

BodyDiagnosticSettings

DataMasking

DataMaskingEntity

DataMaskingMode

DiagnosticContract

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HttpCorrelationProtocol

HttpMessageDiagnostic

OperationNameFormat

PipelineDiagnosticSettings

SamplingSettings

SamplingType

Verbosity

Дополнительные ресурсы