Diagnostic - Update
Обновляет сведения о диагностике, указанной его идентификатором.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}?api-version=2021-08-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
diagnostic
|
path | True |
string minLength: 1maxLength: 80 pattern: ^[^*#&+:<>?]+$ |
Идентификатор диагностики. Должен быть уникальным в текущем экземпляре службы управления API. |
resource
|
path | True |
string |
Имя группы ресурсов. |
service
|
path | True |
string minLength: 1maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ |
Имя службы управления API. |
subscription
|
path | True |
string |
Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы. |
api-version
|
query | True |
string |
Версия API для использования с клиентским запросом. |
Заголовок запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
If-Match | True |
string |
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или оно должно быть * для безусловного обновления. |
Текст запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
properties.loggerId | True |
string |
Идентификатор ресурса целевого средства ведения журнала. |
properties.alwaysLog |
Указывает, какой тип параметров выборки сообщений не должен применяться. |
||
properties.backend |
Параметры диагностики для входящих и исходящих HTTP-сообщений в серверную часть |
||
properties.frontend |
Параметры диагностики для входящих и исходящих HTTP-сообщений в шлюз. |
||
properties.httpCorrelationProtocol |
Задает протокол корреляции, используемый для диагностики Application Insights. |
||
properties.logClientIp |
boolean |
Зайдите в журнал clientIP. Значение по умолчанию — false. |
|
properties.metrics |
boolean |
Выдайте пользовательские метрики с помощью политики выдачи метрик. Применимо только к параметрам диагностики Application Insights. |
|
properties.operationNameFormat |
Формат данных телеметрии Application Insights с именем операции. По умолчанию используется имя. |
||
properties.sampling |
Параметры выборки для диагностики. |
||
properties.verbosity |
Уровень детализации, применяемый к трассировкам, создаваемым политиками трассировки. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Диагностика успешно обновлена Заголовки ETag: string |
|
Other Status Codes |
Ответ на ошибку, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 Azure Active Directory.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
ApiManagementUpdateDiagnostic
Образец запроса
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/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
}
}
}
}
}
Пример ответа
{
"id": "/subscriptions/subid/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/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest",
"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
}
}
}
}
}
Определения
Имя | Описание |
---|---|
Always |
Указывает, какой тип параметров выборки сообщений не должен применяться. |
Body |
Параметры ведения журнала тела. |
Data |
|
Data |
|
Data |
Режим маскирования данных. |
Diagnostic |
Сведения о диагностике. |
Error |
Контракт поля ошибки. |
Error |
Ответ на ошибку. |
Http |
Задает протокол корреляции, используемый для диагностики Application Insights. |
Http |
Параметры диагностики сообщений HTTP. |
Operation |
Формат данных телеметрии Application Insights с именем операции. По умолчанию используется имя. |
Pipeline |
Параметры диагностики для входящих и исходящих HTTP-сообщений в шлюз. |
Sampling |
Параметры выборки для диагностики. |
Sampling |
Тип выборки. |
Verbosity |
Уровень детализации, применяемый к трассировкам, создаваемым политиками трассировки. |
AlwaysLog
Указывает, какой тип параметров выборки сообщений не должен применяться.
Значение | Описание |
---|---|
allErrors |
Всегда регистрируются все ошибочные запросы независимо от параметров выборки. |
BodyDiagnosticSettings
Параметры ведения журнала тела.
Имя | Тип | Описание |
---|---|---|
bytes |
integer (int32) maximum: 8192 |
Количество байтов текста запроса для журнала. |
DataMasking
Имя | Тип | Описание |
---|---|---|
headers |
Параметры маскирования заголовков |
|
queryParams |
Параметры маскирования для параметров запроса URL-адреса |
DataMaskingEntity
Имя | Тип | Описание |
---|---|---|
mode |
Режим маскирования данных. |
|
value |
string |
Имя сущности для маскирования (например, имя заголовка или параметра запроса). |
DataMaskingMode
Режим маскирования данных.
Значение | Описание |
---|---|
Hide |
Скрытие присутствия сущности. |
Mask |
Маскирование значения сущности. |
DiagnosticContract
Сведения о диагностике.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Имя ресурса |
properties.alwaysLog |
Указывает, какой тип параметров выборки сообщений не должен применяться. |
|
properties.backend |
Параметры диагностики для входящих и исходящих HTTP-сообщений в серверную часть |
|
properties.frontend |
Параметры диагностики для входящих и исходящих HTTP-сообщений в шлюз. |
|
properties.httpCorrelationProtocol |
Задает протокол корреляции, используемый для диагностики Application Insights. |
|
properties.logClientIp |
boolean |
Зайдите в журнал clientIP. Значение по умолчанию — false. |
properties.loggerId |
string |
Идентификатор ресурса целевого средства ведения журнала. |
properties.metrics |
boolean |
Выдайте пользовательские метрики с помощью политики выдачи метрик. Применимо только к параметрам диагностики Application Insights. |
properties.operationNameFormat |
Формат данных телеметрии Application Insights с именем операции. По умолчанию используется имя. |
|
properties.sampling |
Параметры выборки для диагностики. |
|
properties.verbosity |
Уровень детализации, применяемый к трассировкам, создаваемым политиками трассировки. |
|
type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
ErrorFieldContract
Контракт поля ошибки.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки уровня свойств. |
message |
string |
Удобочитаемое пользователем представление ошибки уровня свойств. |
target |
string |
Имя свойства. |
ErrorResponse
Ответ на ошибку.
Имя | Тип | Описание |
---|---|---|
error.code |
string |
Код ошибки, определенный службой. Этот код служит вложенным состоянием для кода ошибки HTTP, указанного в ответе. |
error.details |
Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки. |
|
error.message |
string |
Читаемое человеком представление ошибки. |
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
Параметры диагностики сообщений HTTP.
Имя | Тип | Описание |
---|---|---|
body |
Параметры ведения журнала тела. |
|
dataMasking |
Параметры маскирования данных. |
|
headers |
string[] |
Массив заголовков HTTP в журнал. |
OperationNameFormat
Формат данных телеметрии Application Insights с именем операции. По умолчанию используется имя.
Значение | Описание |
---|---|
Name |
API_NAME; rev=API_REVISION — OPERATION_NAME |
Url |
URL-адрес HTTP_VERB |
PipelineDiagnosticSettings
Параметры диагностики для входящих и исходящих HTTP-сообщений в шлюз.
Имя | Тип | Описание |
---|---|---|
request |
Параметры диагностики для запроса. |
|
response |
Параметры диагностики для ответа. |
SamplingSettings
Параметры выборки для диагностики.
Имя | Тип | Описание |
---|---|---|
percentage |
number (double) minimum: 0maximum: 100 |
Частота выборки для выборки фиксированной частоты. |
samplingType |
Тип выборки. |
SamplingType
Тип выборки.
Значение | Описание |
---|---|
fixed |
Выборка фиксированной частоты. |
Verbosity
Уровень детализации, применяемый к трассировкам, создаваемым политиками трассировки.
Значение | Описание |
---|---|
error |
Только трассировки с параметром "серьезность" с параметром error будут отправлены в средство ведения журнала, подключенного к этому экземпляру диагностики. |
information |
Трассировки со значением "серьезность", равные "сведения" и "ошибка", будут отправлены средству ведения журнала, подключенному к этому экземпляру диагностики. |
verbose |
Все трассировки, создаваемые политиками трассировки, будут отправлены средству ведения журнала, подключенному к этому экземпляру диагностики. |