Diagnostic - Create Or Update

Service:

API Management

API Version:

2022-08-01

Создает новую диагностику или обновляет существующую.

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

Параметры URI

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

Заголовок запроса

Имя	Обязательно	Тип	Описание
If-Match		string	ETag сущности. Не требуется при создании сущности, но требуется при обновлении сущности.

Текст запроса

Имя	Обязательно	Тип	Описание
properties.loggerId	True	string	Идентификатор ресурса целевого средства ведения журнала.
properties.alwaysLog		AlwaysLog	Указывает, к какому типу параметров выборки сообщений не следует применять.
properties.backend		PipelineDiagnosticSettings	Параметры диагностики входящих и исходящих HTTP-сообщений в серверную часть
properties.frontend		PipelineDiagnosticSettings	Параметры диагностики входящих и исходящих HTTP-сообщений в шлюз.
properties.httpCorrelationProtocol		HttpCorrelationProtocol	Задает протокол корреляции, используемый для диагностика Application Insights.
properties.logClientIp		boolean	Зайдите в журнал ClientIP. Значение по умолчанию — false.
properties.metrics		boolean	Создание пользовательских метрик с помощью политики отправки метрик. Применимо только к параметрам диагностики Application Insights.
properties.operationNameFormat		OperationNameFormat	Формат имени операции для телеметрии Application Insights. Значение по умолчанию — Name.
properties.sampling		SamplingSettings	Параметры выборки для диагностики.
properties.verbosity		Verbosity	Уровень детализации, применяемый к трассировкам, создаваемым политиками трассировки.

Ответы

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

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

azure_auth

Поток OAuth2 в Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Примеры

ApiManagementCreateDiagnostic

Sample Request

HTTP

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

{
  "properties": {
    "alwaysLog": "allErrors",
    "loggerId": "/loggers/azuremonitor",
    "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
        }
      }
    }
  }
}

Java

import com.azure.resourcemanager.apimanagement.fluent.models.DiagnosticContractInner;
import com.azure.resourcemanager.apimanagement.models.AlwaysLog;
import com.azure.resourcemanager.apimanagement.models.BodyDiagnosticSettings;
import com.azure.resourcemanager.apimanagement.models.HttpMessageDiagnostic;
import com.azure.resourcemanager.apimanagement.models.PipelineDiagnosticSettings;
import com.azure.resourcemanager.apimanagement.models.SamplingSettings;
import com.azure.resourcemanager.apimanagement.models.SamplingType;
import java.util.Arrays;

/** Samples for Diagnostic CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateDiagnostic.json
     */
    /**
     * Sample code: ApiManagementCreateDiagnostic.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateDiagnostic(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .diagnostics()
            .createOrUpdateWithResponse(
                "rg1",
                "apimService1",
                "applicationinsights",
                new DiagnosticContractInner()
                    .withAlwaysLog(AlwaysLog.ALL_ERRORS)
                    .withLoggerId("/loggers/azuremonitor")
                    .withSampling(new SamplingSettings().withSamplingType(SamplingType.FIXED).withPercentage(50.0D))
                    .withFrontend(
                        new PipelineDiagnosticSettings()
                            .withRequest(
                                new HttpMessageDiagnostic()
                                    .withHeaders(Arrays.asList("Content-type"))
                                    .withBody(new BodyDiagnosticSettings().withBytes(512)))
                            .withResponse(
                                new HttpMessageDiagnostic()
                                    .withHeaders(Arrays.asList("Content-type"))
                                    .withBody(new BodyDiagnosticSettings().withBytes(512))))
                    .withBackend(
                        new PipelineDiagnosticSettings()
                            .withRequest(
                                new HttpMessageDiagnostic()
                                    .withHeaders(Arrays.asList("Content-type"))
                                    .withBody(new BodyDiagnosticSettings().withBytes(512)))
                            .withResponse(
                                new HttpMessageDiagnostic()
                                    .withHeaders(Arrays.asList("Content-type"))
                                    .withBody(new BodyDiagnosticSettings().withBytes(512)))),
                null,
                com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_create_diagnostic.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.diagnostic.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        diagnostic_id="applicationinsights",
        parameters={
            "properties": {
                "alwaysLog": "allErrors",
                "backend": {
                    "request": {"body": {"bytes": 512}, "headers": ["Content-type"]},
                    "response": {"body": {"bytes": 512}, "headers": ["Content-type"]},
                },
                "frontend": {
                    "request": {"body": {"bytes": 512}, "headers": ["Content-type"]},
                    "response": {"body": {"bytes": 512}, "headers": ["Content-type"]},
                },
                "loggerId": "/loggers/azuremonitor",
                "sampling": {"percentage": 50, "samplingType": "fixed"},
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateDiagnostic.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateDiagnostic.json
func ExampleDiagnosticClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDiagnosticClient().CreateOrUpdate(ctx, "rg1", "apimService1", "applicationinsights", armapimanagement.DiagnosticContract{
		Properties: &armapimanagement.DiagnosticContractProperties{
			AlwaysLog: to.Ptr(armapimanagement.AlwaysLogAllErrors),
			Backend: &armapimanagement.PipelineDiagnosticSettings{
				Response: &armapimanagement.HTTPMessageDiagnostic{
					Body: &armapimanagement.BodyDiagnosticSettings{
						Bytes: to.Ptr[int32](512),
					},
					Headers: []*string{
						to.Ptr("Content-type")},
				},
				Request: &armapimanagement.HTTPMessageDiagnostic{
					Body: &armapimanagement.BodyDiagnosticSettings{
						Bytes: to.Ptr[int32](512),
					},
					Headers: []*string{
						to.Ptr("Content-type")},
				},
			},
			Frontend: &armapimanagement.PipelineDiagnosticSettings{
				Response: &armapimanagement.HTTPMessageDiagnostic{
					Body: &armapimanagement.BodyDiagnosticSettings{
						Bytes: to.Ptr[int32](512),
					},
					Headers: []*string{
						to.Ptr("Content-type")},
				},
				Request: &armapimanagement.HTTPMessageDiagnostic{
					Body: &armapimanagement.BodyDiagnosticSettings{
						Bytes: to.Ptr[int32](512),
					},
					Headers: []*string{
						to.Ptr("Content-type")},
				},
			},
			LoggerID: to.Ptr("/loggers/azuremonitor"),
			Sampling: &armapimanagement.SamplingSettings{
				Percentage:   to.Ptr[float64](50),
				SamplingType: to.Ptr(armapimanagement.SamplingTypeFixed),
			},
		},
	}, &armapimanagement.DiagnosticClientCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DiagnosticContract = armapimanagement.DiagnosticContract{
	// 	Name: to.Ptr("applicationinsights"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/diagnostics"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights"),
	// 	Properties: &armapimanagement.DiagnosticContractProperties{
	// 		AlwaysLog: to.Ptr(armapimanagement.AlwaysLogAllErrors),
	// 		Backend: &armapimanagement.PipelineDiagnosticSettings{
	// 			Response: &armapimanagement.HTTPMessageDiagnostic{
	// 				Body: &armapimanagement.BodyDiagnosticSettings{
	// 					Bytes: to.Ptr[int32](512),
	// 				},
	// 				Headers: []*string{
	// 					to.Ptr("Content-type")},
	// 				},
	// 				Request: &armapimanagement.HTTPMessageDiagnostic{
	// 					Body: &armapimanagement.BodyDiagnosticSettings{
	// 						Bytes: to.Ptr[int32](512),
	// 					},
	// 					Headers: []*string{
	// 						to.Ptr("Content-type")},
	// 					},
	// 				},
	// 				Frontend: &armapimanagement.PipelineDiagnosticSettings{
	// 					Response: &armapimanagement.HTTPMessageDiagnostic{
	// 						Body: &armapimanagement.BodyDiagnosticSettings{
	// 							Bytes: to.Ptr[int32](512),
	// 						},
	// 						Headers: []*string{
	// 							to.Ptr("Content-type")},
	// 						},
	// 						Request: &armapimanagement.HTTPMessageDiagnostic{
	// 							Body: &armapimanagement.BodyDiagnosticSettings{
	// 								Bytes: to.Ptr[int32](512),
	// 							},
	// 							Headers: []*string{
	// 								to.Ptr("Content-type")},
	// 							},
	// 						},
	// 						LoggerID: to.Ptr("/loggers/applicationinsights"),
	// 						Sampling: &armapimanagement.SamplingSettings{
	// 							Percentage: to.Ptr[float64](50),
	// 							SamplingType: to.Ptr(armapimanagement.SamplingTypeFixed),
	// 						},
	// 					},
	// 				}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates a new Diagnostic or updates an existing one.
 *
 * @summary Creates a new Diagnostic or updates an existing one.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateDiagnostic.json
 */
async function apiManagementCreateDiagnostic() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const diagnosticId = "applicationinsights";
  const parameters = {
    alwaysLog: "allErrors",
    backend: {
      response: { body: { bytes: 512 }, headers: ["Content-type"] },
      request: { body: { bytes: 512 }, headers: ["Content-type"] },
    },
    frontend: {
      response: { body: { bytes: 512 }, headers: ["Content-type"] },
      request: { body: { bytes: 512 }, headers: ["Content-type"] },
    },
    loggerId: "/loggers/azuremonitor",
    sampling: { percentage: 50, samplingType: "fixed" },
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.diagnostic.createOrUpdate(
    resourceGroupName,
    serviceName,
    diagnosticId,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights",
  "type": "Microsoft.ApiManagement/service/diagnostics",
  "name": "applicationinsights",
  "properties": {
    "alwaysLog": "allErrors",
    "loggerId": "/loggers/azuremonitor",
    "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
        }
      }
    }
  }
}

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights",
  "type": "Microsoft.ApiManagement/service/diagnostics",
  "name": "applicationinsights",
  "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
        }
      }
    }
  }
}

Определения

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

AlwaysLog

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

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

BodyDiagnosticSettings

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

Имя	Тип	Описание
bytes	integer	Число байтов текста запроса для записи в журнал.

DataMasking

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

DataMaskingEntity

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

DataMaskingMode

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

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

DiagnosticContract

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

Имя	Тип	Описание
id	string	Полный идентификатор ресурса. Например: /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. Значение по умолчанию — Name.
properties.sampling	SamplingSettings	Параметры выборки для диагностики.
properties.verbosity	Verbosity	Уровень детализации, применяемый к трассировкам, создаваемым политиками трассировки.
type	string	Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

ErrorFieldContract

Контракт поля ошибки.

Имя	Тип	Описание
code	string	Код ошибки уровня свойства.
message	string	Удобочитаемое представление ошибки на уровне свойств.
target	string	Имя свойства.

ErrorResponse

Ответ об ошибке.

Имя	Тип	Описание
error.code	string	Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе.
error.details	ErrorFieldContract[]	Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки.
error.message	string	Читаемое представление ошибки.

HttpCorrelationProtocol

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

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

HttpMessageDiagnostic

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

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

OperationNameFormat

Формат имени операции для телеметрии Application Insights. Значение по умолчанию — Name.

Имя	Тип	Описание
Name	string	API_NAME; rev=API_REVISION — OPERATION_NAME
Url	string	URL-адрес HTTP_VERB

PipelineDiagnosticSettings

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

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

SamplingSettings

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

Имя	Тип	Описание
percentage	number	Частота выборки для выборки с фиксированной частотой.
samplingType	SamplingType	Тип выборки.

SamplingType

Тип выборки.

Имя	Тип	Описание
fixed	string	Выборка с фиксированной частотой.

Verbosity

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

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