Diagnostic - Create Or Update
Létrehoz egy új diagnosztikát, vagy frissít egy meglévőt.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}?api-version=2022-08-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
diagnostic
|
path | True |
string |
Diagnosztikai azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. Regex pattern: |
resource
|
path | True |
string |
Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket. |
service
|
path | True |
string |
A API Management szolgáltatás neve. Regex pattern: |
subscription
|
path | True |
string |
A cél-előfizetés azonosítója. |
api-version
|
query | True |
string |
A művelethez használandó API-verzió. |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
If-Match |
string |
Az entitás ETagje. Entitás létrehozásakor nem kötelező, de az entitások frissítésekor kötelező. |
Kérelem törzse
Name | Kötelező | Típus | Description |
---|---|---|---|
properties.loggerId | True |
string |
A célnaplózó erőforrás-azonosítója. |
properties.alwaysLog |
Meghatározza, hogy milyen típusú üzenetek mintavételezési beállításai nem alkalmazhatók. |
||
properties.backend |
A háttérrendszerbe bejövő/kimenő HTTP-üzenetek diagnosztikai beállításai |
||
properties.frontend |
Diagnosztikai beállítások az átjáróba bejövő/kimenő HTTP-üzenetekhez. |
||
properties.httpCorrelationProtocol |
Beállítja az Application Insights diagnosztikához használandó korrelációs protokollt. |
||
properties.logClientIp |
boolean |
Naplózza a ClientIP-t. Az alapértelmezett érték a false (hamis). |
|
properties.metrics |
boolean |
Egyéni metrikák kibocsátása emit-metric szabályzattal. Csak az Application Insights diagnosztikai beállításaira vonatkozik. |
|
properties.operationNameFormat |
Az Application Insights-telemetriák műveletnevének formátuma. Az alapértelmezett érték a Név. |
||
properties.sampling |
Mintavételezési beállítások a diagnosztika számára. |
||
properties.verbosity |
A nyomkövetési szabályzatok által kibocsátott nyomkövetésekre alkalmazott részletességi szint. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A diagnosztika frissítése sikerült Headers ETag: string |
|
201 Created |
A diagnosztika létrehozása sikerült. Headers ETag: string |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. |
Biztonság
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 | felhasználói fiók megszemélyesítése |
Példák
ApiManagementCreateDiagnostic
Sample Request
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
}
}
}
}
}
Sample Response
{
"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
}
}
}
}
}
{
"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
}
}
}
}
}
Definíciók
Name | Description |
---|---|
Always |
Meghatározza, hogy milyen típusú üzenetek mintavételezési beállításai nem alkalmazhatók. |
Body |
Törzsnaplózási beállítások. |
Data |
|
Data |
|
Data |
Adatmaszkolás mód. |
Diagnostic |
Diagnosztikai adatok. |
Error |
Hibamező-szerződés. |
Error |
Hibaválasz. |
Http |
Beállítja az Application Insights diagnosztikához használandó korrelációs protokollt. |
Http |
HTTP-üzenet diagnosztikai beállításai. |
Operation |
Az Application Insights-telemetriák műveletnevének formátuma. Az alapértelmezett érték a Név. |
Pipeline |
Diagnosztikai beállítások az átjáróba bejövő/kimenő HTTP-üzenetekhez. |
Sampling |
Mintavételezési beállítások a diagnosztika számára. |
Sampling |
Mintavételezés típusa. |
Verbosity |
A nyomkövetési szabályzatok által kibocsátott nyomkövetésekre alkalmazott részletességi szint. |
AlwaysLog
Meghatározza, hogy milyen típusú üzenetek mintavételezési beállításai nem alkalmazhatók.
Name | Típus | Description |
---|---|---|
allErrors |
string |
A mintavételezési beállításoktól függetlenül mindig naplózza az összes hibás kérést. |
BodyDiagnosticSettings
Törzsnaplózási beállítások.
Name | Típus | Description |
---|---|---|
bytes |
integer |
A naplózandó kérelemtörzs bájtjainak száma. |
DataMasking
Name | Típus | Description |
---|---|---|
headers |
Fejlécek maszkolásának beállításai |
|
queryParams |
Az URL-lekérdezés paramétereinek maszkolási beállításai |
DataMaskingEntity
Name | Típus | Description |
---|---|---|
mode |
Adatmaszkolás mód. |
|
value |
string |
A maszkolandó entitás neve (például egy fejléc vagy egy lekérdezési paraméter neve). |
DataMaskingMode
Adatmaszkolás mód.
Name | Típus | Description |
---|---|---|
Hide |
string |
Entitás jelenlétének elrejtése. |
Mask |
string |
Egy entitás értékének maszkolása. |
DiagnosticContract
Diagnosztikai adatok.
Name | Típus | Description |
---|---|---|
id |
string |
Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Az erőforrás neve |
properties.alwaysLog |
Meghatározza, hogy milyen típusú üzenetek mintavételezési beállításai nem alkalmazhatók. |
|
properties.backend |
A háttérrendszerbe bejövő/kimenő HTTP-üzenetek diagnosztikai beállításai |
|
properties.frontend |
Diagnosztikai beállítások az átjáróba bejövő/kimenő HTTP-üzenetekhez. |
|
properties.httpCorrelationProtocol |
Beállítja az Application Insights diagnosztikához használandó korrelációs protokollt. |
|
properties.logClientIp |
boolean |
Naplózza a ClientIP-t. Az alapértelmezett érték a false (hamis). |
properties.loggerId |
string |
A célnaplózó erőforrás-azonosítója. |
properties.metrics |
boolean |
Egyéni metrikák kibocsátása emit-metric szabályzattal. Csak az Application Insights diagnosztikai beállításaira vonatkozik. |
properties.operationNameFormat |
Az Application Insights-telemetriák műveletnevének formátuma. Az alapértelmezett érték a Név. |
|
properties.sampling |
Mintavételezési beállítások a diagnosztika számára. |
|
properties.verbosity |
A nyomkövetési szabályzatok által kibocsátott nyomkövetésekre alkalmazott részletességi szint. |
|
type |
string |
Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts" |
ErrorFieldContract
Hibamező-szerződés.
Name | Típus | Description |
---|---|---|
code |
string |
Tulajdonságszintű hibakód. |
message |
string |
A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása. |
target |
string |
Tulajdonság neve. |
ErrorResponse
Hibaválasz.
Name | Típus | Description |
---|---|---|
error.code |
string |
Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál. |
error.details |
Érvényesítési hiba esetén a kérelemben küldött érvénytelen mezők listája. |
|
error.message |
string |
A hiba emberi olvasásra alkalmas ábrázolása. |
HttpCorrelationProtocol
Beállítja az Application Insights diagnosztikához használandó korrelációs protokollt.
Name | Típus | Description |
---|---|---|
Legacy |
string |
Szúrja be Request-Id és Request-Context fejléceket a kérés korrelációs adataival. Lásd: https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. |
None |
string |
Ne olvassa be és szúrja be a korrelációs fejléceket. |
W3C |
string |
Nyomkövetési környezet fejléceinek beszúrása. Lásd: https://w3c.github.io/trace-context. |
HttpMessageDiagnostic
HTTP-üzenet diagnosztikai beállításai.
Name | Típus | Description |
---|---|---|
body |
Törzsnaplózási beállítások. |
|
dataMasking |
Adatmaszkolás beállításai. |
|
headers |
string[] |
A naplózandó HTTP-fejlécek tömbje. |
OperationNameFormat
Az Application Insights-telemetriák műveletnevének formátuma. Az alapértelmezett érték a Név.
Name | Típus | Description |
---|---|---|
Name |
string |
API_NAME; rev=API_REVISION – OPERATION_NAME |
Url |
string |
HTTP_VERB URL-cím |
PipelineDiagnosticSettings
Diagnosztikai beállítások az átjáróba bejövő/kimenő HTTP-üzenetekhez.
Name | Típus | Description |
---|---|---|
request |
A kérés diagnosztikai beállításai. |
|
response |
Diagnosztikai beállítások a válaszhoz. |
SamplingSettings
Mintavételezési beállítások a diagnosztika számára.
Name | Típus | Description |
---|---|---|
percentage |
number |
Rögzített gyakoriságú mintavételezés mintavételezési sebessége. |
samplingType |
Mintavételezés típusa. |
SamplingType
Mintavételezés típusa.
Name | Típus | Description |
---|---|---|
fixed |
string |
Rögzített gyakoriságú mintavételezés. |
Verbosity
A nyomkövetési szabályzatok által kibocsátott nyomkövetésekre alkalmazott részletességi szint.
Name | Típus | Description |
---|---|---|
error |
string |
A diagnosztikai példányhoz csatolt naplózónak csak a súlyosságú, "hiba" értékű nyomkövetések lesznek elküldve. |
information |
string |
A súlyosságú nyomkövetések "információ" és "hiba" értékre vannak állítva a diagnosztikai példányhoz csatolt naplózónak. |
verbose |
string |
A nyomkövetési szabályzatok által kibocsátott összes nyomkövetés el lesz küldve a diagnosztikai példányhoz csatolt naplózónak. |