Diagnostic - Update
Tanımlayıcısı tarafından belirtilen Tanılama ayrıntılarını Güncelleştirmeler.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}?api-version=2022-08-01
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
diagnostic
|
path | True |
string |
Tanılama tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Normal ifade deseni: |
resource
|
path | True |
string |
Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir. |
service
|
path | True |
string |
API Management hizmetinin adı. Normal ifade deseni: |
subscription
|
path | True |
string |
Hedef aboneliğin kimliği. |
api-version
|
query | True |
string |
Bu işlem için kullanılacak API sürümü. |
İstek Başlığı
Name | Gerekli | Tür | Description |
---|---|---|---|
If-Match | True |
string |
Varlığın ETag'i. ETag, GET isteğinin üst bilgi yanıtından geçerli varlık durumuyla eşleşmeli veya koşulsuz güncelleştirme için * olmalıdır. |
İstek Gövdesi
Name | Gerekli | Tür | Description |
---|---|---|---|
properties.loggerId | True |
string |
Hedef günlükçü kaynak kimliği. |
properties.alwaysLog |
Ne tür iletiler örnekleme ayarlarının uygulanmaması gerektiğini belirtir. |
||
properties.backend |
Arka uçtan gelen/giden HTTP iletileri için tanılama ayarları |
||
properties.frontend |
Ağ geçidine gelen/giden HTTP iletileri için tanılama ayarları. |
||
properties.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 |
Emit-metric ilkesi aracılığıyla özel ölçümleri yayma. Yalnızca Application Insights tanılama ayarları için geçerlidir. |
|
properties.operationNameFormat |
Application Insights telemetrileri için İşlem Adı biçimi. Varsayılan Ad'dır. |
||
properties.sampling |
Tanılama için örnekleme ayarları. |
||
properties.verbosity |
İzleme ilkeleri tarafından yayılan izlemelere uygulanan ayrıntı düzeyi. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Tanılama başarıyla güncelleştirildi Üst Bilgiler ETag: string |
|
Other Status Codes |
İşlemin neden başarısız olduğunu açıklayan hata yanıtı. |
Güvenlik
azure_auth
Azure Active Directory OAuth2 Flow.
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
ApiManagementUpdateDiagnostic
Örnek isteği
PATCH 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/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
}
}
}
}
}
Örnek yanıt
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights",
"type": "Microsoft.ApiManagement/service/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": 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 |
---|---|
Always |
Ne tür iletiler örnekleme ayarlarının uygulanmaması gerektiğini belirtir. |
Body |
Gövde günlüğü ayarları. |
Data |
|
Data |
|
Data |
Veri maskeleme modu. |
Diagnostic |
Tanılama ayrıntıları. |
Error |
Hata Alanı sözleşmesi. |
Error |
Hata Yanıtı. |
Http |
Application Insights tanılaması için kullanılacak bağıntı protokollerini ayarlar. |
Http |
Http iletisi tanılama ayarları. |
Operation |
Application Insights telemetrileri için İşlem Adı biçimi. Varsayılan Ad'dır. |
Pipeline |
Ağ geçidine gelen/giden HTTP iletileri için tanılama ayarları. |
Sampling |
Tanılama için örnekleme ayarları. |
Sampling |
Örnekleme türü. |
Verbosity |
İzleme ilkeleri tarafından yayılan izlemelere uygulanan ayrıntı düzeyi. |
AlwaysLog
Ne tür iletiler örnekleme ayarlarının uygulanmaması gerektiğini belirtir.
Name | Tür | Description |
---|---|---|
allErrors |
string |
Örnekleme ayarlarından bağımsız olarak her zaman tüm hatalı istekleri günlüğe kaydeder. |
BodyDiagnosticSettings
Gövde günlüğü ayarları.
Name | Tür | Description |
---|---|---|
bytes |
integer |
Günlüğe kaydedilecek istek gövdesi bayt sayısı. |
DataMasking
Name | Tür | Description |
---|---|---|
headers |
Üst bilgiler için maskeleme ayarları |
|
queryParams |
Url sorgu parametreleri için maskeleme ayarları |
DataMaskingEntity
Name | Tür | Description |
---|---|---|
mode |
Veri maskeleme modu. |
|
value |
string |
Maskeleneceği varlığın adı (örneğin, bir üst bilgi veya sorgu parametresinin adı). |
DataMaskingMode
Veri maskeleme modu.
Name | Tür | Description |
---|---|---|
Hide |
string |
Varlığın varlığını gizleme. |
Mask |
string |
Bir varlığın değerini maskeler. |
DiagnosticContract
Tanılama ayrıntıları.
Name | Tür | Description |
---|---|---|
id |
string |
Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Kaynağın adı |
properties.alwaysLog |
Ne tür iletiler örnekleme ayarlarının uygulanmaması gerektiğini belirtir. |
|
properties.backend |
Arka uçtan gelen/giden HTTP iletileri için tanılama ayarları |
|
properties.frontend |
Ağ geçidine gelen/giden HTTP iletileri için tanılama ayarları. |
|
properties.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 |
Emit-metric ilkesi aracılığıyla özel ölçümleri yayma. Yalnızca Application Insights tanılama ayarları için geçerlidir. |
properties.operationNameFormat |
Application Insights telemetrileri için İşlem Adı biçimi. Varsayılan Ad'dır. |
|
properties.sampling |
Tanılama için örnekleme ayarları. |
|
properties.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" |
ErrorFieldContract
Hata Alanı sözleşmesi.
Name | Tür | Description |
---|---|---|
code |
string |
Özellik düzeyi hata kodu. |
message |
string |
Özellik düzeyi hatanın insan tarafından okunabilir gösterimi. |
target |
string |
Özellik adı. |
ErrorResponse
Hata Yanıtı.
Name | Tür | Description |
---|---|---|
error.code |
string |
Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür. |
error.details |
Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi. |
|
error.message |
string |
Hatanın insan tarafından okunabilir gösterimi. |
HttpCorrelationProtocol
Application Insights tanılaması için kullanılacak bağıntı protokollerini ayarlar.
Name | Tür | Description |
---|---|---|
Legacy |
string |
İstek bağıntı verileriyle Request-Id ve Request-Context üst bilgilerini ekleyin. Bkz. https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. |
None |
string |
Bağıntı üst bilgilerini okumayın ve eklemeyin. |
W3C |
string |
İzleme Bağlamı üst bilgilerini ekleme. Bkz. https://w3c.github.io/trace-context. |
HttpMessageDiagnostic
Http iletisi tanılama ayarları.
Name | Tür | Description |
---|---|---|
body |
Gövde günlüğü ayarları. |
|
dataMasking |
Veri maskeleme ayarları. |
|
headers |
string[] |
Günlüğe kaydedilecek HTTP Üst Bilgileri dizisi. |
OperationNameFormat
Application Insights telemetrileri için İşlem Adı biçimi. Varsayılan Ad'dır.
Name | Tür | Description |
---|---|---|
Name |
string |
API_NAME; rev=API_REVISION - OPERATION_NAME |
Url |
string |
HTTP_VERB URL'si |
PipelineDiagnosticSettings
Ağ geçidine gelen/giden HTTP iletileri için tanılama ayarları.
Name | Tür | Description |
---|---|---|
request |
İstek için tanılama ayarları. |
|
response |
Yanıt için tanılama ayarları. |
SamplingSettings
Tanılama için örnekleme ayarları.
Name | Tür | Description |
---|---|---|
percentage |
number |
Sabit hızlı örnekleme için örnekleme oranı. |
samplingType |
Örnekleme türü. |
SamplingType
Örnekleme türü.
Name | Tür | Description |
---|---|---|
fixed |
string |
Sabit hızlı örnekleme. |
Verbosity
İzleme ilkeleri tarafından yayılan izlemelere uygulanan ayrıntı düzeyi.
Name | Tür | Description |
---|---|---|
error |
string |
Yalnızca 'önem derecesi' 'error' olarak ayarlanmış izlemeler bu tanılama örneğine bağlı günlükçüye gönderilir. |
information |
string |
'Önem derecesi' 'information' ve 'error' olarak ayarlanmış izlemeler, bu tanılama örneğine bağlı günlükçüye gönderilir. |
verbose |
string |
İzleme ilkeleri tarafından yayılan tüm izlemeler bu tanılama örneğine bağlı günlükçüye gönderilir. |