Diagnostic - Create Or Update

Service:

API Management

API Version:

2022-08-01

Skapar en ny diagnostik eller uppdaterar en befintlig.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
diagnosticId	path	True	string	Diagnostikidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Regex pattern: ^[^*#&+:<>?]+$
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName	path	True	string	Namnet på API Management-tjänsten. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
If-Match		string	ETag för entiteten. Krävs inte när du skapar en entitet, men krävs vid uppdatering av en entitet.

Begärandetext

Name	Obligatorisk	Typ	Description
properties.loggerId	True	string	Resurs-ID för en målloggare.
properties.alwaysLog		AlwaysLog	Anger vilken typ av meddelandesamplingsinställningar som inte ska tillämpas.
properties.backend		PipelineDiagnosticSettings	Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till serverdelen
properties.frontend		PipelineDiagnosticSettings	Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till gatewayen.
properties.httpCorrelationProtocol		HttpCorrelationProtocol	Anger korrelationsprotokoll som ska användas för Application Insights-diagnostik.
properties.logClientIp		boolean	Logga ClientIP. Standardvärdet är false.
properties.metrics		boolean	Generera anpassade mått via principen för avsändande mått. Gäller endast för diagnostikinställningar för Application Insights.
properties.operationNameFormat		OperationNameFormat	Formatet för åtgärdsnamnet för Application Insights-telemetri. Standardvärdet är Namn.
properties.sampling		SamplingSettings	Samplingsinställningar för Diagnostik.
properties.verbosity		Verbosity	Den verbositetsnivå som tillämpas på spårningar som genereras av spårningsprinciper.

Svar

Name	Typ	Description
200 OK	DiagnosticContract	Diagnostiken har uppdaterats Headers ETag: string
201 Created	DiagnosticContract	Diagnostiken har skapats. Headers ETag: string
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
AlwaysLog	Anger vilken typ av meddelandesamplingsinställningar som inte ska tillämpas.
BodyDiagnosticSettings	Inställningar för kroppsloggning.
DataMasking
DataMaskingEntity
DataMaskingMode	Datamaskeringsläge.
DiagnosticContract	Diagnostikinformation.
ErrorFieldContract	Fel fältkontrakt.
ErrorResponse	Felsvar.
HttpCorrelationProtocol	Anger korrelationsprotokoll som ska användas för Application Insights-diagnostik.
HttpMessageDiagnostic	Diagnostikinställningar för HTTP-meddelande.
OperationNameFormat	Formatet för åtgärdsnamnet för Application Insights-telemetri. Standardvärdet är Namn.
PipelineDiagnosticSettings	Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till gatewayen.
SamplingSettings	Samplingsinställningar för Diagnostik.
SamplingType	Samplingstyp.
Verbosity	Den verbositetsnivå som tillämpas på spårningar som genereras av spårningsprinciper.

AlwaysLog

Anger vilken typ av meddelandesamplingsinställningar som inte ska tillämpas.

Name	Typ	Description
allErrors	string	Logga alltid alla felaktiga begäranden oavsett samplingsinställningar.

BodyDiagnosticSettings

Inställningar för kroppsloggning.

Name	Typ	Description
bytes	integer	Antal byte för begärandetext som ska loggas.

DataMasking

Name	Typ	Description
headers	DataMaskingEntity[]	Maskeringsinställningar för rubriker
queryParams	DataMaskingEntity[]	Maskeringsinställningar för URL-frågeparametrar

DataMaskingEntity

Name	Typ	Description
mode	DataMaskingMode	Datamaskeringsläge.
value	string	Namnet på en entitet som ska maskeras (t.ex. ett namn på en rubrik eller en frågeparameter).

DataMaskingMode

Datamaskeringsläge.

Name	Typ	Description
Hide	string	Dölj förekomsten av en entitet.
Mask	string	Maskera värdet för en entitet.

DiagnosticContract

Diagnostikinformation.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties.alwaysLog	AlwaysLog	Anger vilken typ av meddelandesamplingsinställningar som inte ska tillämpas.
properties.backend	PipelineDiagnosticSettings	Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till serverdelen
properties.frontend	PipelineDiagnosticSettings	Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till gatewayen.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Anger korrelationsprotokoll som ska användas för Application Insights-diagnostik.
properties.logClientIp	boolean	Logga ClientIP. Standardvärdet är false.
properties.loggerId	string	Resurs-ID för en målloggare.
properties.metrics	boolean	Generera anpassade mått via principen för avsändande mått. Gäller endast för diagnostikinställningar för Application Insights.
properties.operationNameFormat	OperationNameFormat	Formatet för åtgärdsnamnet för Application Insights-telemetri. Standardvärdet är Namn.
properties.sampling	SamplingSettings	Samplingsinställningar för Diagnostik.
properties.verbosity	Verbosity	Den verbositetsnivå som tillämpas på spårningar som genereras av spårningsprinciper.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ErrorFieldContract

Fel fältkontrakt.

Name	Typ	Description
code	string	Felkod på egenskapsnivå.
message	string	Mänsklig läsbar representation av fel på egenskapsnivå.
target	string	Egenskapsnamn.

ErrorResponse

Felsvar.

Name	Typ	Description
error.code	string	Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.
error.details	ErrorFieldContract[]	Listan över ogiltiga fält som skickas i begäran, vid valideringsfel.
error.message	string	Mänsklig läsbar representation av felet.

HttpCorrelationProtocol

Anger korrelationsprotokoll som ska användas för Application Insights-diagnostik.

Name	Typ	Description
Legacy	string	Mata in Request-Id- och Request-Context-huvuden med korrelationsdata för begäran. Se https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
None	string	Läs inte och mata inte in korrelationsrubriker.
W3C	string	Infoga kontextrubriker för spårning. Se https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Diagnostikinställningar för HTTP-meddelande.

Name	Typ	Description
body	BodyDiagnosticSettings	Inställningar för kroppsloggning.
dataMasking	DataMasking	Inställningar för datamaskering.
headers	string[]	Matris med HTTP-huvuden som ska loggas.

OperationNameFormat

Formatet för åtgärdsnamnet för Application Insights-telemetri. Standardvärdet är Namn.

Name	Typ	Description
Name	string	API_NAME; rev=API_REVISION – OPERATION_NAME
Url	string	HTTP_VERB URL

PipelineDiagnosticSettings

Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till gatewayen.

Name	Typ	Description
request	HttpMessageDiagnostic	Diagnostikinställningar för begäran.
response	HttpMessageDiagnostic	Diagnostikinställningar för svar.

SamplingSettings

Samplingsinställningar för Diagnostik.

Name	Typ	Description
percentage	number	Samplingsfrekvens för fast sampling.
samplingType	SamplingType	Samplingstyp.

SamplingType

Samplingstyp.

Name	Typ	Description
fixed	string	Sampling med fast hastighet.

Verbosity

Den verbositetsnivå som tillämpas på spårningar som genereras av spårningsprinciper.

Name	Typ	Description
error	string	Endast spårningar med "allvarlighetsgrad" som "fel" skickas till loggaren som är kopplad till den här diagnostikinstansen.
information	string	Spårningar med "allvarlighetsgrad" inställt på "information" och "fel" skickas till loggaren som är kopplad till den här diagnostikinstansen.
verbose	string	Alla spårningar som genereras av spårningsprinciper skickas till loggaren som är kopplad till den här diagnostikinstansen.