Diagnostic - Create Or Update

Hizmet:: API Management

API Sürümü:: 2024-05-01

Yeni bir Tanılama oluşturur veya var olan bir tanılamayı güncelleştirir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
diagnosticId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Tanılama tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management hizmetinin adı.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
If-Match		string	Varlığın ETag'i. Varlık oluştururken gerekli değildir, ancak varlığı güncelleştirirken gereklidir.

İstek Gövdesi

Name	Gerekli	Tür	Description
properties.loggerId	True	string	Hedef günlükçü kaynak kimliği.
properties.alwaysLog		AlwaysLog	Ne tür ileti örnekleme ayarlarının uygulanmaması gerektiğini belirtir.
properties.backend		PipelineDiagnosticSettings	Arka uçtan gelen/giden HTTP iletileri için tanılama ayarları
properties.frontend		PipelineDiagnosticSettings	Ağ geçidine gelen/giden HTTP iletileri için tanılama ayarları.
properties.httpCorrelationProtocol		HttpCorrelationProtocol	Application Insights tanılaması için kullanılacak bağıntı protokollerini ayarlar.
properties.logClientIp		boolean	ClientIP'yi günlüğe kaydetme. Varsayılan değer false'tur.
properties.metrics		boolean	Yayma ölçümü ilkesi aracılığıyla özel ölçümler yayma. Yalnızca Application Insights tanılama ayarları için geçerlidir.
properties.operationNameFormat		OperationNameFormat	Application Insights telemetrileri için İşlem Adı biçimi. Varsayılan Ad'dır.
properties.sampling		SamplingSettings	Tanılama için örnekleme ayarları.
properties.verbosity		Verbosity	İzleme ilkeleri tarafından yayılan izlemelere uygulanan ayrıntı düzeyi.

Yanıtlar

Name	Tür	Description
200 OK	DiagnosticContract	Tanılama başarıyla güncelleştirildi Üst Bilgiler ETag: string
201 Created	DiagnosticContract	Tanılama başarıyla oluşturuldu. Üst Bilgiler ETag: string
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Name

Tür

Description

200 OK

DiagnosticContract

Tanılama başarıyla güncelleştirildi

Üst Bilgiler

ETag: string

201 Created

DiagnosticContract

Tanılama başarıyla oluşturuldu.

Üst Bilgiler

ETag: string

Other Status Codes

ErrorResponse

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementCreateDiagnostic

Örnek isteği

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights?api-version=2024-05-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
        }
      }
    }
  }
}

Örnek yanıt

Durum kodu:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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
        }
      }
    }
  }
}

Durum kodu:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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
        }
      }
    }
  }
}

Tanımlar

Name	Description
AlwaysLog	Ne tür ileti örnekleme ayarlarının uygulanmaması gerektiğini belirtir.
BodyDiagnosticSettings	Gövde günlüğü ayarları.
DataMasking
DataMaskingEntity
DataMaskingMode	Veri maskeleme modu.
DiagnosticContract	Tanılama ayrıntıları.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
HttpCorrelationProtocol	Application Insights tanılaması için kullanılacak bağıntı protokollerini ayarlar.
HttpMessageDiagnostic	Http iletisi tanılama ayarları.
OperationNameFormat	Application Insights telemetrileri için İşlem Adı biçimi. Varsayılan Ad'dır.
PipelineDiagnosticSettings	Ağ geçidine gelen/giden HTTP iletileri için tanılama ayarları.
SamplingSettings	Tanılama için örnekleme ayarları.
SamplingType	Örnekleme türü.
Verbosity	İzleme ilkeleri tarafından yayılan izlemelere uygulanan ayrıntı düzeyi.

AlwaysLog

Listeleme

Ne tür ileti örnekleme ayarlarının uygulanmaması gerektiğini belirtir.

Değer	Description
allErrors	Örnekleme ayarlarından bağımsız olarak her zaman tüm hatalı istekleri günlüğe kaydeder.

BodyDiagnosticSettings

Object

Gövde günlüğü ayarları.

Name	Tür	Description
bytes	integer (int32) maximum: 8192	Günlüğe kaydedilecek istek gövdesi bayt sayısı.

DataMasking

Object

Name	Tür	Description
headers	DataMaskingEntity[]	Üst bilgiler için maskeleme ayarları
queryParams	DataMaskingEntity[]	Url sorgu parametreleri için maskeleme ayarları

DataMaskingEntity

Object

Name	Tür	Description
mode	DataMaskingMode	Veri maskeleme modu.
value	string	Maskeleneceği varlığın adı (örneğin, üst bilgi adı veya sorgu parametresi).

DataMaskingMode

Listeleme

Veri maskeleme modu.

Değer	Description
Mask	Bir varlığın değerini maskeler.
Hide	Bir varlığın varlığını gizleyin.

DiagnosticContract

Object

Tanılama ayrıntıları.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Örn - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties.alwaysLog	AlwaysLog	Ne tür ileti örnekleme ayarlarının uygulanmaması gerektiğini belirtir.
properties.backend	PipelineDiagnosticSettings	Arka uçtan gelen/giden HTTP iletileri için tanılama ayarları
properties.frontend	PipelineDiagnosticSettings	Ağ geçidine gelen/giden HTTP iletileri için tanılama ayarları.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Application Insights tanılaması için kullanılacak bağıntı protokollerini ayarlar.
properties.logClientIp	boolean	ClientIP'yi günlüğe kaydetme. Varsayılan değer false'tur.
properties.loggerId	string	Hedef günlükçü kaynak kimliği.
properties.metrics	boolean	Yayma ölçümü ilkesi aracılığıyla özel ölçümler yayma. Yalnızca Application Insights tanılama ayarları için geçerlidir.
properties.operationNameFormat	OperationNameFormat	Application Insights telemetrileri için İşlem Adı biçimi. Varsayılan Ad'dır.
properties.sampling	SamplingSettings	Tanılama için örnekleme ayarları.
properties.verbosity	Verbosity	İzleme ilkeleri tarafından yayılan izlemelere uygulanan ayrıntı düzeyi.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

HttpCorrelationProtocol

Listeleme

Application Insights tanılaması için kullanılacak bağıntı protokollerini ayarlar.

Değer	Description
None	Bağıntı üst bilgilerini okumayın ve eklemeyin.
Legacy	İstek bağıntı verileriyle Request-Id ve Request-Context üst bilgileri ekleyin. Bkz. https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
W3C	İzleme Bağlamı üst bilgilerini ekleme. Bkz. https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Object

Http iletisi tanılama ayarları.

Name	Tür	Description
body	BodyDiagnosticSettings	Gövde günlüğü ayarları.
dataMasking	DataMasking	Veri maskeleme ayarları.
headers	string[]	Günlüğe kaydedilecek HTTP Üst Bilgileri dizisi.

OperationNameFormat

Listeleme

Application Insights telemetrileri için İşlem Adı biçimi. Varsayılan Ad'dır.

Değer	Description
Name	API_NAME; rev=API_REVISION - OPERATION_NAME
Url	HTTP_VERB URL'si

PipelineDiagnosticSettings

Object

Ağ geçidine gelen/giden HTTP iletileri için tanılama ayarları.

Name	Tür	Description
request	HttpMessageDiagnostic	İstek için tanılama ayarları.
response	HttpMessageDiagnostic	Yanıt için tanılama ayarları.

SamplingSettings

Object

Tanılama için örnekleme ayarları.

Name	Tür	Description
percentage	number (double) minimum: 0 maximum: 100	Sabit oranlı örnekleme için örnekleme oranı.
samplingType	SamplingType	Örnekleme türü.

SamplingType

Listeleme

Örnekleme türü.

Değer	Description
fixed	Sabit oranlı örnekleme.

Verbosity

Listeleme

İzleme ilkeleri tarafından yayılan izlemelere uygulanan ayrıntı düzeyi.

Değer	Description
verbose	İzleme ilkeleri tarafından yayılan tüm izlemeler, bu tanılama örneğine ekli günlükçüye gönderilir.
information	'Önem derecesi' 'information' ve 'error' olarak ayarlanmış izlemeler bu tanılama örneğine ekli günlükçüye gönderilir.
error	Bu tanılama örneğine bağlı günlükçüye yalnızca 'önem derecesi' 'error' olarak ayarlanmış izlemeler gönderilir.

Aracılığıyla paylaş

Diagnostic - Create Or Update

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

ApiManagementCreateDiagnostic

Örnek isteği

Örnek yanıt

Tanımlar

AlwaysLog

BodyDiagnosticSettings

DataMasking

DataMaskingEntity

DataMaskingMode

DiagnosticContract

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HttpCorrelationProtocol

HttpMessageDiagnostic

OperationNameFormat

PipelineDiagnosticSettings

SamplingSettings

SamplingType

Verbosity