你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Api Diagnostic - Create Or Update

服务:: API Management

API 版本:: 2024-05-01

为 API 创建新的诊断或更新现有诊断。

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

URI 参数

名称	在	必需	类型	说明
apiId	path	True	string minLength: 1 maxLength: 80	API 标识符。当前 API 管理服务实例中必须是唯一的。
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)	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求头

名称	必需	类型	说明
If-Match		string	实体的 ETag。创建实体时不需要，但在更新实体时是必需的。

请求正文

名称	必需	类型	说明
properties.loggerId	True	string	目标记录器的资源 ID。
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

诊断已成功更新。

标头

ETag: string

201 Created

DiagnosticContract

已成功创建诊断。

标头

ETag: string

Other Status Codes

描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ApiManagementCreateApiDiagnostic

示例请求

PUT 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

{
  "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
        }
      }
    }
  }
}


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 ApiDiagnostic CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementCreateApiDiagnostic.json
     */
    /**
     * Sample code: ApiManagementCreateApiDiagnostic.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementCreateApiDiagnostic(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apiDiagnostics().define("applicationinsights")
            .withExistingApi("rg1", "apimService1", "57d1f7558aa04f15146d9d8a").withAlwaysLog(AlwaysLog.ALL_ERRORS)
            .withLoggerId("/loggers/applicationinsights")
            .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))))
            .create();
    }
}

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

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_api_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="00000000-0000-0000-0000-000000000000",
    )

    response = client.api_diagnostic.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        api_id="57d1f7558aa04f15146d9d8a",
        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/applicationinsights",
                "sampling": {"percentage": 50, "samplingType": "fixed"},
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateApiDiagnostic.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

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateApiDiagnostic.json
func ExampleAPIDiagnosticClient_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.NewAPIDiagnosticClient().CreateOrUpdate(ctx, "rg1", "apimService1", "57d1f7558aa04f15146d9d8a", "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/applicationinsights"),
			Sampling: &armapimanagement.SamplingSettings{
				Percentage:   to.Ptr[float64](50),
				SamplingType: to.Ptr(armapimanagement.SamplingTypeFixed),
			},
		},
	}, &armapimanagement.APIDiagnosticClientCreateOrUpdateOptions{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/apis/diagnostics"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/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

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

/**
 * This sample demonstrates how to Creates a new Diagnostic for an API or updates an existing one.
 *
 * @summary Creates a new Diagnostic for an API or updates an existing one.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateApiDiagnostic.json
 */
async function apiManagementCreateApiDiagnostic() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const apiId = "57d1f7558aa04f15146d9d8a";
  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/applicationinsights",
    sampling: { percentage: 50, samplingType: "fixed" },
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiDiagnostic.createOrUpdate(
    resourceGroupName,
    serviceName,
    apiId,
    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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateApiDiagnostic.json
// this example is just showing the usage of "ApiDiagnostic_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiResource created on azure
// for more information of creating ApiResource, please refer to the document of ApiResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string apiId = "57d1f7558aa04f15146d9d8a";
ResourceIdentifier apiResourceId = ApiResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, apiId);
ApiResource api = client.GetApiResource(apiResourceId);

// get the collection of this ApiDiagnosticResource
ApiDiagnosticCollection collection = api.GetApiDiagnostics();

// invoke the operation
string diagnosticId = "applicationinsights";
DiagnosticContractData data = new DiagnosticContractData
{
    AlwaysLog = AlwaysLog.AllErrors,
    LoggerId = "/loggers/applicationinsights",
    Sampling = new SamplingSettings
    {
        SamplingType = SamplingType.Fixed,
        Percentage = 50,
    },
    Frontend = new PipelineDiagnosticSettings
    {
        Request = new HttpMessageDiagnostic
        {
            Headers = { "Content-type" },
            BodyBytes = 512,
        },
        Response = new HttpMessageDiagnostic
        {
            Headers = { "Content-type" },
            BodyBytes = 512,
        },
    },
    Backend = new PipelineDiagnosticSettings
    {
        Request = new HttpMessageDiagnostic
        {
            Headers = { "Content-type" },
            BodyBytes = 512,
        },
        Response = new HttpMessageDiagnostic
        {
            Headers = { "Content-type" },
            BodyBytes = 512,
        },
    },
};
ArmOperation<ApiDiagnosticResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, diagnosticId, data);
ApiDiagnosticResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DiagnosticContractData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

示例响应

状态代码:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights",
  "type": "Microsoft.ApiManagement/service/apis/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
        }
      }
    }
  }
}

状态代码:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights",
  "type": "Microsoft.ApiManagement/service/apis/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	诊断详细信息。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
HttpCorrelationProtocol	设置要用于 Application Insights 诊断的相关协议。
HttpMessageDiagnostic	Http 消息诊断设置。
OperationNameFormat	Application Insights 遥测的作名称的格式。默认值为 Name。
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

枚举

数据掩码模式。

值	说明
Mask	屏蔽实体的值。
Hide	隐藏实体的存在。

DiagnosticContract

Object

诊断详细信息。

名称	类型	说明
id	string	资源的完全限定资源 ID。示例 - /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	目标记录器的资源 ID。
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”

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 诊断的相关协议。

值	说明
None	不要读取和注入相关标头。
Legacy	使用请求关联数据注入 Request-Id 和 Request-Context 标头。请参阅 https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md。
W3C	注入跟踪上下文标头。请参阅 https://w3c.github.io/trace-context。

HttpMessageDiagnostic

Object

Http 消息诊断设置。

名称	类型	说明
body	BodyDiagnosticSettings	正文日志记录设置。
dataMasking	DataMasking	数据掩码设置。
headers	string[]	要记录的 HTTP 标头数组。

OperationNameFormat

枚举

Application Insights 遥测的作名称的格式。默认值为 Name。

值	说明
Name	API_NAME;rev=API_REVISION - OPERATION_NAME
Url	HTTP_VERB网址

PipelineDiagnosticSettings

Object

传入/传出 HTTP 消息到网关的诊断设置。

名称	类型	说明
request	HttpMessageDiagnostic	请求的诊断设置。
response	HttpMessageDiagnostic	响应的诊断设置。

SamplingSettings

Object

诊断的采样设置。

名称	类型	说明
percentage	number (double) minimum: 0 maximum: 100	固定速率采样的采样率。
samplingType	SamplingType	采样类型。

SamplingType

枚举

采样类型。

值	说明
fixed	固定速率采样。

Verbosity

枚举

应用于跟踪策略发出的跟踪的详细级别。

值	说明
verbose	跟踪策略发出的所有跟踪都将发送到附加到此诊断实例的记录器。
information	将“严重性”设置为“信息”和“错误”的跟踪将发送到附加到此诊断实例的记录器。
error	只有“严重性”设置为“error”的跟踪才会发送到附加到此诊断实例的记录器。