Api Diagnostic - Update

Service:

API Management

API-versie:

2021-08-01

Hiermee worden de details van de diagnostische gegevens bijgewerkt voor een API die is opgegeven door de bijbehorende id.

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

URI-parameters

Name	In	Vereist	Type	Description
apiId	path	True	string minLength: 1 maxLength: 80	API-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
diagnosticId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Diagnostische id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
resourceGroupName	path	True	string	De naam van de resourcegroep.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string	Abonnementsreferenties die het Microsoft Azure-abonnement uniek identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match	True	string	ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus van het headerantwoord van de GET-aanvraag of moet * zijn voor een onvoorwaardelijke update.

Aanvraagbody

Name	Vereist	Type	Description
properties.loggerId	True	string	Resource-id van een doellogger.
properties.alwaysLog		AlwaysLog	Hiermee geeft u op welk type instellingen voor het nemen van berichten niet van toepassing moeten zijn.
properties.backend		PipelineDiagnosticSettings	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de back-end
properties.frontend		PipelineDiagnosticSettings	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway.
properties.httpCorrelationProtocol		HttpCorrelationProtocol	Hiermee stelt u het correlatieprotocol in dat moet worden gebruikt voor Application Insights-diagnostische gegevens.
properties.logClientIp		boolean	Registreer de ClientIP. De standaardwaarde is onwaar.
properties.metrics		boolean	Aangepaste metrische gegevens verzenden via het beleid voor metrische gegevens verzenden. Alleen van toepassing op diagnostische instellingen van Application Insights.
properties.operationNameFormat		OperationNameFormat	De indeling van de bewerkingsnaam voor Application Insights-telemetrieën. De standaardwaarde is Naam.
properties.sampling		SamplingSettings	Sampling-instellingen voor Diagnostische gegevens.
properties.verbosity		Verbosity	Het uitgebreidheidsniveau dat wordt toegepast op traceringen die worden verzonden door traceringsbeleid.

Antwoorden

Name	Type	Description
200 OK	DiagnosticContract	Diagnostische gegevens zijn bijgewerkt. Kopteksten ETag: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementUpdateApiDiagnostic

Voorbeeldaanvraag

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/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
        }
      }
    }
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.apimanagement.models.AlwaysLog;
import com.azure.resourcemanager.apimanagement.models.BodyDiagnosticSettings;
import com.azure.resourcemanager.apimanagement.models.DiagnosticContract;
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 Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateApiDiagnostic.json
     */
    /**
     * Sample code: ApiManagementUpdateApiDiagnostic.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateApiDiagnostic(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        DiagnosticContract resource =
            manager
                .apiDiagnostics()
                .getWithResponse("rg1", "apimService1", "echo-api", "applicationinsights", Context.NONE)
                .getValue();
        resource
            .update()
            .withAlwaysLog(AlwaysLog.ALL_ERRORS)
            .withLoggerId("/loggers/applicationinsights")
            .withSampling(new SamplingSettings().withSamplingType(SamplingType.FIXED).withPercentage(50.0))
            .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))))
            .withIfMatch("*")
            .apply();
    }
}

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 azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_update_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="subid",
    )

    response = client.api_diagnostic.update(
        resource_group_name="rg1",
        service_name="apimService1",
        api_id="echo-api",
        diagnostic_id="applicationinsights",
        if_match="*",
        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/2021-08-01/examples/ApiManagementUpdateApiDiagnostic.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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateApiDiagnostic.json
func ExampleAPIDiagnosticClient_Update() {
	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().Update(ctx, "rg1", "apimService1", "echo-api", "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),
			},
		},
	}, 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/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/diagnostics/applicationinsights"),
	// 	Properties: &armapimanagement.DiagnosticContractProperties{
	// 		AlwaysLog: to.Ptr(armapimanagement.AlwaysLogAllErrors),
	// 		Backend: &armapimanagement.PipelineDiagnosticSettings{
	// 			Response: &armapimanagement.HTTPMessageDiagnostic{
	// 				Body: &armapimanagement.BodyDiagnosticSettings{
	// 					Bytes: to.Ptr[int32](100),
	// 				},
	// 				Headers: []*string{
	// 				},
	// 			},
	// 			Request: &armapimanagement.HTTPMessageDiagnostic{
	// 				Body: &armapimanagement.BodyDiagnosticSettings{
	// 					Bytes: to.Ptr[int32](100),
	// 				},
	// 				Headers: []*string{
	// 				},
	// 			},
	// 		},
	// 		Frontend: &armapimanagement.PipelineDiagnosticSettings{
	// 			Response: &armapimanagement.HTTPMessageDiagnostic{
	// 				Body: &armapimanagement.BodyDiagnosticSettings{
	// 					Bytes: to.Ptr[int32](100),
	// 				},
	// 				Headers: []*string{
	// 				},
	// 			},
	// 			Request: &armapimanagement.HTTPMessageDiagnostic{
	// 				Body: &armapimanagement.BodyDiagnosticSettings{
	// 					Bytes: to.Ptr[int32](100),
	// 				},
	// 				Headers: []*string{
	// 				},
	// 			},
	// 		},
	// 		HTTPCorrelationProtocol: to.Ptr(armapimanagement.HTTPCorrelationProtocolLegacy),
	// 		LogClientIP: to.Ptr(true),
	// 		LoggerID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/aisamplingtest"),
	// 		Sampling: &armapimanagement.SamplingSettings{
	// 			Percentage: to.Ptr[float64](100),
	// 			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 Updates the details of the Diagnostic for an API specified by its identifier.
 *
 * @summary Updates the details of the Diagnostic for an API specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateApiDiagnostic.json
 */
async function apiManagementUpdateApiDiagnostic() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const apiId = "echo-api";
  const diagnosticId = "applicationinsights";
  const ifMatch = "*";
  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.update(
    resourceGroupName,
    serviceName,
    apiId,
    diagnosticId,
    ifMatch,
    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

dotnet

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

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateApiDiagnostic.json
// this example is just showing the usage of "ApiDiagnostic_Update" 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://learn.microsoft.com/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 ApiDiagnosticResource created on azure
// for more information of creating ApiDiagnosticResource, please refer to the document of ApiDiagnosticResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string apiId = "echo-api";
string diagnosticId = "applicationinsights";
ResourceIdentifier apiDiagnosticResourceId = ApiDiagnosticResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, apiId, diagnosticId);
ApiDiagnosticResource apiDiagnostic = client.GetApiDiagnosticResource(apiDiagnosticResourceId);

// invoke the operation
ETag ifMatch = new ETag("*");
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,
        },
    },
};
ApiDiagnosticResource result = await apiDiagnostic.UpdateAsync(ifMatch, data);

// 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

Voorbeeldrespons

Statuscode:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/diagnostics/applicationinsights",
  "type": "Microsoft.ApiManagement/service/apis/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": 100
    },
    "frontend": {
      "request": {
        "headers": [],
        "body": {
          "bytes": 100
        }
      },
      "response": {
        "headers": [],
        "body": {
          "bytes": 100
        }
      }
    },
    "backend": {
      "request": {
        "headers": [],
        "body": {
          "bytes": 100
        }
      },
      "response": {
        "headers": [],
        "body": {
          "bytes": 100
        }
      }
    }
  }
}

Definities

Name	Description
AlwaysLog	Hiermee geeft u op welk type instellingen voor het nemen van berichten niet van toepassing moeten zijn.
BodyDiagnosticSettings	Instellingen voor logboekregistratie van hoofdteksten.
DataMasking
DataMaskingEntity
DataMaskingMode	Modus voor gegevensmaskering.
DiagnosticContract	Diagnostische gegevens.
ErrorFieldContract	Foutveldcontract.
ErrorResponse	Foutreactie.
HttpCorrelationProtocol	Hiermee stelt u het correlatieprotocol in dat moet worden gebruikt voor Application Insights-diagnostische gegevens.
HttpMessageDiagnostic	Diagnostische instellingen voor HTTP-berichten.
OperationNameFormat	De indeling van de bewerkingsnaam voor Application Insights-telemetrieën. De standaardwaarde is Naam.
PipelineDiagnosticSettings	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway.
SamplingSettings	Sampling-instellingen voor Diagnostische gegevens.
SamplingType	Steekproeftype.
Verbosity	Het uitgebreidheidsniveau dat wordt toegepast op traceringen die worden verzonden door traceringsbeleid.

AlwaysLog

Inventarisatie

Hiermee geeft u op welk type instellingen voor het nemen van berichten niet van toepassing moeten zijn.

Waarde	Description
allErrors	Registreer altijd alle onjuiste aanvragen, ongeacht de sampling-instellingen.

BodyDiagnosticSettings

Object

Instellingen voor logboekregistratie van hoofdteksten.

Name	Type	Description
bytes	integer (int32) maximum: 8192	Aantal aanvraagbodybytes dat moet worden geregistreerd.

DataMasking

Object

Name	Type	Description
headers	DataMaskingEntity[]	Maskeringsinstellingen voor kopteksten
queryParams	DataMaskingEntity[]	Maskeringsinstellingen voor URL-queryparameters

DataMaskingEntity

Object

Name	Type	Description
mode	DataMaskingMode	Modus voor gegevensmaskering.
value	string	De naam van een entiteit die moet worden gemaskeerd (bijvoorbeeld een naam van een header of een queryparameter).

DataMaskingMode

Inventarisatie

Modus voor gegevensmaskering.

Waarde	Description
Hide	De aanwezigheid van een entiteit verbergen.
Mask	Masker de waarde van een entiteit.

DiagnosticContract

Object

Diagnostische gegevens.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.alwaysLog	AlwaysLog	Hiermee geeft u op welk type instellingen voor het nemen van berichten niet van toepassing moeten zijn.
properties.backend	PipelineDiagnosticSettings	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de back-end
properties.frontend	PipelineDiagnosticSettings	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Hiermee stelt u het correlatieprotocol in dat moet worden gebruikt voor Application Insights-diagnostische gegevens.
properties.logClientIp	boolean	Registreer de ClientIP. De standaardwaarde is onwaar.
properties.loggerId	string	Resource-id van een doellogger.
properties.metrics	boolean	Aangepaste metrische gegevens verzenden via het beleid voor metrische gegevens verzenden. Alleen van toepassing op diagnostische instellingen van Application Insights.
properties.operationNameFormat	OperationNameFormat	De indeling van de bewerkingsnaam voor Application Insights-telemetrieën. De standaardwaarde is Naam.
properties.sampling	SamplingSettings	Sampling-instellingen voor Diagnostische gegevens.
properties.verbosity	Verbosity	Het uitgebreidheidsniveau dat wordt toegepast op traceringen die worden verzonden door traceringsbeleid.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ErrorFieldContract

Object

Foutveldcontract.

Name	Type	Description
code	string	Foutcode op eigenschapsniveau.
message	string	Leesbare weergave van fout op eigenschapsniveau.
target	string	Eigenschapsnaam.

ErrorResponse

Object

Foutreactie.

Name	Type	Description
error.code	string	Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.
error.details	ErrorFieldContract[]	De lijst met ongeldige velden die in de aanvraag worden verzonden, in het geval van een validatiefout.
error.message	string	Leesbare weergave van de fout.

HttpCorrelationProtocol

Inventarisatie

Hiermee stelt u het correlatieprotocol in dat moet worden gebruikt voor Application Insights-diagnostische gegevens.

Waarde	Description
Legacy	Injecteer Request-Id en Request-Context headers met aanvraagcorrelatiegegevens. Zie https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
None	Lees en injecteer correlatieheaders niet.
W3C	Traceringscontextheaders injecteren. Zie https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Object

Diagnostische instellingen voor HTTP-berichten.

Name	Type	Description
body	BodyDiagnosticSettings	Instellingen voor logboekregistratie van hoofdteksten.
dataMasking	DataMasking	Instellingen voor gegevensmaskering.
headers	string[]	Matrix van HTTP-headers die moeten worden vastgelegd.

OperationNameFormat

Inventarisatie

De indeling van de bewerkingsnaam voor Application Insights-telemetrieën. De standaardwaarde is Naam.

Waarde	Description
Name	API_NAME; rev=API_REVISION - OPERATION_NAME
Url	HTTP_VERB URL

PipelineDiagnosticSettings

Object

Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway.

Name	Type	Description
request	HttpMessageDiagnostic	Diagnostische instellingen voor aanvraag.
response	HttpMessageDiagnostic	Diagnostische instellingen voor antwoord.

SamplingSettings

Object

Sampling-instellingen voor Diagnostische gegevens.

Name	Type	Description
percentage	number (double) minimum: 0 maximum: 100	De steekproeffrequentie voor steekproeven met vaste frequentie.
samplingType	SamplingType	Steekproeftype.

SamplingType

Inventarisatie

Steekproeftype.

Waarde	Description
fixed	Steekproeven met vaste snelheid.

Verbosity

Inventarisatie

Het uitgebreidheidsniveau dat wordt toegepast op traceringen die worden verzonden door traceringsbeleid.

Waarde	Description
error	Alleen traceringen waarvoor ernst is ingesteld op 'fout' worden verzonden naar de logger die is gekoppeld aan dit diagnostische exemplaar.
information	Traceringen met 'ernst' ingesteld op 'informatie' en 'fout' worden verzonden naar de logger die is gekoppeld aan dit diagnostische exemplaar.
verbose	Alle traceringen die door traceringsbeleid worden verzonden, worden verzonden naar de logger die is gekoppeld aan dit diagnostische exemplaar.