Diagnostic - Create Or Update
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 |
---|---|---|---|---|
diagnostic
|
path | True |
string |
Diagnostikidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Reguljärt uttrycksmönster: |
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
service
|
path | True |
string |
Namnet på API Management-tjänsten. Reguljärt uttrycksmönster: |
subscription
|
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 |
Anger vilken typ av meddelandesamplingsinställningar som inte ska tillämpas. |
||
properties.backend |
Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till serverdelen |
||
properties.frontend |
Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till gatewayen. |
||
properties.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 |
Formatet för åtgärdsnamnet för Application Insights-telemetri. Standardvärdet är Namn. |
||
properties.sampling |
Samplingsinställningar för Diagnostik. |
||
properties.verbosity |
Den verbositetsnivå som tillämpas på spårningar som genereras av spårningsprinciper. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Diagnostiken har uppdaterats Sidhuvuden ETag: string |
|
201 Created |
Diagnostiken har skapats. Sidhuvuden ETag: string |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
user_impersonation | personifiera ditt användarkonto |
Exempel
ApiManagementCreateDiagnostic
Exempelbegäran
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
}
}
}
}
}
Exempelsvar
{
"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
}
}
}
}
}
Definitioner
Name | Description |
---|---|
Always |
Anger vilken typ av meddelandesamplingsinställningar som inte ska tillämpas. |
Body |
Inställningar för kroppsloggning. |
Data |
|
Data |
|
Data |
Datamaskeringsläge. |
Diagnostic |
Diagnostikinformation. |
Error |
Fel fältkontrakt. |
Error |
Felsvar. |
Http |
Anger korrelationsprotokoll som ska användas för Application Insights-diagnostik. |
Http |
Diagnostikinställningar för HTTP-meddelande. |
Operation |
Formatet för åtgärdsnamnet för Application Insights-telemetri. Standardvärdet är Namn. |
Pipeline |
Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till gatewayen. |
Sampling |
Samplingsinställningar för Diagnostik. |
Sampling |
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 |
Maskeringsinställningar för rubriker |
|
queryParams |
Maskeringsinställningar för URL-frågeparametrar |
DataMaskingEntity
Name | Typ | Description |
---|---|---|
mode |
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 |
Anger vilken typ av meddelandesamplingsinställningar som inte ska tillämpas. |
|
properties.backend |
Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till serverdelen |
|
properties.frontend |
Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till gatewayen. |
|
properties.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 |
Formatet för åtgärdsnamnet för Application Insights-telemetri. Standardvärdet är Namn. |
|
properties.sampling |
Samplingsinställningar för Diagnostik. |
|
properties.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 |
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 |
Inställningar för kroppsloggning. |
|
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 |
Diagnostikinställningar för begäran. |
|
response |
Diagnostikinställningar för svar. |
SamplingSettings
Samplingsinställningar för Diagnostik.
Name | Typ | Description |
---|---|---|
percentage |
number |
Samplingsfrekvens för fast sampling. |
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. |