Diagnostic - Create Or Update

Service:

API Management

API Version:

2021-08-01

Membuat Diagnostik baru atau memperbarui yang sudah ada.

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

Parameter URI

Name	In	Required	Type	Description
diagnosticId	path	True	string	Pengidentifikasi diagnostik. Harus unik dalam instans layanan API Management saat ini. Regex pattern: ^[^*#&+:<>?]+$
resourceGroupName	path	True	string	Nama grup sumber daya.
serviceName	path	True	string	Nama layanan API Management. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan klien.

Header Permintaan

Name	Required	Type	Description
If-Match		string	ETag Entitas. Tidak diperlukan saat membuat entitas, tetapi diperlukan saat memperbarui entitas.

Isi Permintaan

Name	Required	Type	Description
properties.loggerId	True	string	Id Sumber Daya dari pencatat target.
properties.alwaysLog		AlwaysLog	Menentukan jenis pengaturan pengambilan sampel pesan apa yang tidak boleh diterapkan.
properties.backend		PipelineDiagnosticSettings	Pengaturan diagnostik untuk pesan HTTP masuk/keluar ke Backend
properties.frontend		PipelineDiagnosticSettings	Pengaturan diagnostik untuk pesan HTTP masuk/keluar ke Gateway.
properties.httpCorrelationProtocol		HttpCorrelationProtocol	Mengatur protokol korelasi yang akan digunakan untuk diagnostik Insights Aplikasi.
properties.logClientIp		boolean	Catat ClientIP. Defaultnya adalah false.
properties.operationNameFormat		OperationNameFormat	Format telemetri Insights Nama Operasi untuk Aplikasi. Defaultnya adalah Nama.
properties.sampling		SamplingSettings	Pengaturan pengambilan sampel untuk Diagnostik.
properties.verbosity		Verbosity	Tingkat verbositas yang diterapkan pada jejak yang dipancarkan oleh kebijakan pelacakan.

Respons

Name	Type	Description
200 OK	DiagnosticContract	Diagnostik berhasil diperbarui Headers ETag: string
201 Created	DiagnosticContract	Diagnostik berhasil dibuat. Headers ETag: string
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

ApiManagementCreateDiagnostic

Sample Request

HTTP

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

{
  "properties": {
    "alwaysLog": "allErrors",
    "loggerId": "/loggers/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.core.util.Context;
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/2021-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.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)))),
                null,
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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/tree/main/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-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()
	client, err := armapimanagement.NewDiagnosticClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.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)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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

Definisi

AlwaysLog	Menentukan jenis pengaturan pengambilan sampel pesan apa yang tidak boleh diterapkan.
BodyDiagnosticSettings	Pengaturan pengelogan isi.
DataMasking
DataMaskingEntity
DataMaskingMode	Mode masking data.
DiagnosticContract	Detail diagnostik.
ErrorFieldContract	Kontrak Bidang Kesalahan.
ErrorResponse	Respons Kesalahan.
HttpCorrelationProtocol	Mengatur protokol korelasi yang akan digunakan untuk diagnostik Insights Aplikasi.
HttpMessageDiagnostic	Pengaturan diagnostik pesan http.
OperationNameFormat	Format telemetri Insights Nama Operasi untuk Aplikasi. Defaultnya adalah Nama.
PipelineDiagnosticSettings	Pengaturan diagnostik untuk pesan HTTP masuk/keluar ke Gateway.
SamplingSettings	Pengaturan pengambilan sampel untuk Diagnostik.
SamplingType	Jenis pengambilan sampel.
Verbosity	Tingkat verbositas yang diterapkan pada jejak yang dipancarkan oleh kebijakan pelacakan.

AlwaysLog

Menentukan jenis pengaturan pengambilan sampel pesan apa yang tidak boleh diterapkan.

Name	Type	Description
allErrors	string	Selalu catat semua permintaan yang salah terlepas dari pengaturan pengambilan sampel.

BodyDiagnosticSettings

Pengaturan pengelogan isi.

Name	Type	Description
bytes	integer	Jumlah byte isi permintaan untuk dicatat.

DataMasking

Name	Type	Description
headers	DataMaskingEntity[]	Pengaturan masking untuk header
queryParams	DataMaskingEntity[]	Pengaturan masking untuk parameter kueri Url

DataMaskingEntity

Name	Type	Description
mode	DataMaskingMode	Mode masking data.
value	string	Nama entitas yang akan disamarkan (misalnya nama header atau parameter kueri).

DataMaskingMode

Mode masking data.

Name	Type	Description
Hide	string	Menyembunyikan kehadiran entitas.
Mask	string	Menutupi nilai entitas.

DiagnosticContract

Detail diagnostik.

Name	Type	Description
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya.
properties.alwaysLog	AlwaysLog	Menentukan jenis pengaturan pengambilan sampel pesan apa yang tidak boleh diterapkan.
properties.backend	PipelineDiagnosticSettings	Pengaturan diagnostik untuk pesan HTTP masuk/keluar ke Backend
properties.frontend	PipelineDiagnosticSettings	Pengaturan diagnostik untuk pesan HTTP masuk/keluar ke Gateway.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Mengatur protokol korelasi yang akan digunakan untuk diagnostik Insights Aplikasi.
properties.logClientIp	boolean	Catat ClientIP. Defaultnya adalah false.
properties.loggerId	string	Id Sumber Daya dari pencatat target.
properties.operationNameFormat	OperationNameFormat	Format telemetri Insights Nama Operasi untuk Aplikasi. Defaultnya adalah Nama.
properties.sampling	SamplingSettings	Pengaturan pengambilan sampel untuk Diagnostik.
properties.verbosity	Verbosity	Tingkat verbositas yang diterapkan pada jejak yang dipancarkan oleh kebijakan pelacakan.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft. Storage/storageAccounts"

ErrorFieldContract

Kontrak Bidang Kesalahan.

Name	Type	Description
code	string	Kode kesalahan tingkat properti.
message	string	Representasi kesalahan tingkat properti yang dapat dibaca manusia.
target	string	Nama properti.

ErrorResponse

Respons Kesalahan.

Name	Type	Description
error.code	string	Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.
error.details	ErrorFieldContract[]	Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.
error.message	string	Representasi kesalahan yang dapat dibaca manusia.

HttpCorrelationProtocol

Mengatur protokol korelasi yang akan digunakan untuk diagnostik Insights Aplikasi.

Name	Type	Description
Legacy	string	Masukkan header Request-Id dan Request-Context dengan data korelasi permintaan. Lihat https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
None	string	Jangan membaca dan menyuntikkan header korelasi.
W3C	string	Suntikkan header Konteks Pelacakan. Lihat https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Pengaturan diagnostik pesan http.

Name	Type	Description
body	BodyDiagnosticSettings	Pengaturan pengelogan isi.
dataMasking	DataMasking	Pengaturan masking data.
headers	string[]	Array Header HTTP untuk dicatat.

OperationNameFormat

Format telemetri Insights Nama Operasi untuk Aplikasi. Defaultnya adalah Nama.

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

PipelineDiagnosticSettings

Pengaturan diagnostik untuk pesan HTTP masuk/keluar ke Gateway.

Name	Type	Description
request	HttpMessageDiagnostic	Pengaturan diagnostik untuk permintaan.
response	HttpMessageDiagnostic	Pengaturan diagnostik untuk respons.

SamplingSettings

Pengaturan pengambilan sampel untuk Diagnostik.

Name	Type	Description
percentage	number	Tingkat pengambilan sampel untuk pengambilan sampel laju tetap.
samplingType	SamplingType	Jenis pengambilan sampel.

SamplingType

Jenis pengambilan sampel.

Name	Type	Description
fixed	string	Pengambilan sampel laju tetap.

Verbosity

Tingkat verbositas yang diterapkan pada jejak yang dipancarkan oleh kebijakan pelacakan.

Name	Type	Description
error	string	Hanya jejak dengan 'tingkat keparahan' yang diatur ke 'kesalahan' yang akan dikirim ke pencatat yang dilampirkan ke instans diagnostik ini.
information	string	Jejak dengan 'tingkat keparahan' yang diatur ke 'informasi' dan 'kesalahan' akan dikirim ke pencatat yang dilampirkan ke instans diagnostik ini.
verbose	string	Semua jejak yang dipancarkan oleh kebijakan pelacakan akan dikirim ke pencatat yang dilampirkan ke instans diagnostik ini.