Diagnostic - Update
Updates de details van de diagnose die is opgegeven door de id.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}?api-version=2021-08-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
diagnostic
|
path | True |
string |
Diagnostische id. Moet uniek zijn in het huidige API Management service-exemplaar. Regex-patroon: |
resource
|
path | True |
string |
De naam van de resourcegroep. |
service
|
path | True |
string |
De naam van de API Management service. Regex-patroon: |
subscription
|
path | True |
string |
Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep. |
api-version
|
query | True |
string |
Versie van de API die moet worden gebruikt met de clientaanvraag. |
Aanvraagkoptekst
Name | Vereist | Type | Description |
---|---|---|---|
If-Match | True |
string |
ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit de headerreactie van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update. |
Aanvraagbody
Name | Vereist | Type | Description |
---|---|---|---|
properties.loggerId | True |
string |
Resource-id van een doellogboekregistratie. |
properties.alwaysLog |
Hiermee geeft u op voor welk type berichten sampling-instellingen niet van toepassing moeten zijn. |
||
properties.backend |
Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de back-end |
||
properties.frontend |
Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway. |
||
properties.httpCorrelationProtocol |
Hiermee stelt u het correlatieprotocol in dat moet worden gebruikt voor diagnostische gegevens van Application Insights. |
||
properties.logClientIp |
boolean |
Registreer de ClientIP. De standaardinstelling is onwaar. |
|
properties.metrics |
boolean |
Aangepaste metrische gegevens verzenden via beleid voor metrische gegevens verzenden. Alleen van toepassing op diagnostische instellingen van Application Insights. |
|
properties.operationNameFormat |
De indeling van de bewerkingsnaam voor Application Insights-telemetrieën. De standaardwaarde is Naam. |
||
properties.sampling |
Sampling-instellingen voor Diagnostische gegevens. |
||
properties.verbosity |
Het uitgebreidheidsniveau dat wordt toegepast op traceringen die worden verzonden door traceringsbeleid. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
Diagnostische gegevens zijn bijgewerkt Kopteksten ETag: string |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom.
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
ApiManagementUpdateDiagnostic
Voorbeeldaanvraag
PATCH 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/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
}
}
}
}
}
Voorbeeldrespons
{
"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
}
}
}
}
}
Definities
Name | Description |
---|---|
Always |
Hiermee geeft u op voor welk type berichten sampling-instellingen niet van toepassing moeten zijn. |
Body |
Instellingen voor logboekregistratie van hoofdteksten. |
Data |
|
Data |
|
Data |
Gegevensmaskeringsmodus. |
Diagnostic |
Diagnostische gegevens. |
Error |
Fout veldcontract. |
Error |
Foutreactie. |
Http |
Hiermee stelt u het correlatieprotocol in dat moet worden gebruikt voor diagnostische gegevens van Application Insights. |
Http |
Diagnostische instellingen voor HTTP-berichten. |
Operation |
De indeling van de bewerkingsnaam voor Application Insights-telemetrieën. De standaardwaarde is Naam. |
Pipeline |
Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway. |
Sampling |
Sampling-instellingen voor Diagnostische gegevens. |
Sampling |
Steekproeftype. |
Verbosity |
Het uitgebreidheidsniveau dat wordt toegepast op traceringen die worden verzonden door traceringsbeleid. |
AlwaysLog
Hiermee geeft u op voor welk type berichten sampling-instellingen niet van toepassing moeten zijn.
Name | Type | Description |
---|---|---|
allErrors |
string |
Registreer altijd alle onjuiste aanvragen, ongeacht de steekproefinstellingen. |
BodyDiagnosticSettings
Instellingen voor logboekregistratie van hoofdteksten.
Name | Type | Description |
---|---|---|
bytes |
integer |
Aantal aanvraaghoofdtekstbytes dat moet worden geregistreerd. |
DataMasking
Name | Type | Description |
---|---|---|
headers |
Maskeringsinstellingen voor headers |
|
queryParams |
Maskeringsinstellingen voor URL-queryparameters |
DataMaskingEntity
Name | Type | Description |
---|---|---|
mode |
Gegevensmaskeringsmodus. |
|
value |
string |
De naam van een entiteit die moet worden gemaskeerd (bijvoorbeeld een naam van een header of een queryparameter). |
DataMaskingMode
Gegevensmaskeringsmodus.
Name | Type | Description |
---|---|---|
Hide |
string |
De aanwezigheid van een entiteit verbergen. |
Mask |
string |
Masker de waarde van een entiteit. |
DiagnosticContract
Diagnostische gegevens.
Name | Type | Description |
---|---|---|
id |
string |
Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
De naam van de resource |
properties.alwaysLog |
Hiermee geeft u op voor welk type berichten sampling-instellingen niet van toepassing moeten zijn. |
|
properties.backend |
Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de back-end |
|
properties.frontend |
Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway. |
|
properties.httpCorrelationProtocol |
Hiermee stelt u het correlatieprotocol in dat moet worden gebruikt voor diagnostische gegevens van Application Insights. |
|
properties.logClientIp |
boolean |
Registreer de ClientIP. De standaardinstelling is onwaar. |
properties.loggerId |
string |
Resource-id van een doellogboekregistratie. |
properties.metrics |
boolean |
Aangepaste metrische gegevens verzenden via beleid voor metrische gegevens verzenden. Alleen van toepassing op diagnostische instellingen van Application Insights. |
properties.operationNameFormat |
De indeling van de bewerkingsnaam voor Application Insights-telemetrieën. De standaardwaarde is Naam. |
|
properties.sampling |
Sampling-instellingen voor Diagnostische gegevens. |
|
properties.verbosity |
Het uitgebreidheidsniveau dat wordt toegepast op traceringen die worden verzonden door traceringsbeleid. |
|
type |
string |
Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' |
ErrorFieldContract
Fout veldcontract.
Name | Type | Description |
---|---|---|
code |
string |
Foutcode op eigenschapsniveau. |
message |
string |
Door mensen leesbare weergave van fout op eigenschapsniveau. |
target |
string |
Naam van eigenschap. |
ErrorResponse
Foutreactie.
Name | Type | Description |
---|---|---|
error.code |
string |
Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord. |
error.details |
De lijst met ongeldige velden verzenden in aanvraag, in geval van een validatiefout. |
|
error.message |
string |
Door mensen leesbare weergave van de fout. |
HttpCorrelationProtocol
Hiermee stelt u het correlatieprotocol in dat moet worden gebruikt voor diagnostische gegevens van Application Insights.
Name | Type | Description |
---|---|---|
Legacy |
string |
Injecteer Request-Id en Request-Context headers met aanvraagcorrelatiegegevens. Zie https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md. |
None |
string |
Lees en injecteer geen correlatieheaders. |
W3C |
string |
Headers voor traceringscontext injecteren. Zie https://w3c.github.io/trace-context. |
HttpMessageDiagnostic
Diagnostische instellingen voor HTTP-berichten.
Name | Type | Description |
---|---|---|
body |
Instellingen voor logboekregistratie van hoofdteksten. |
|
dataMasking |
Instellingen voor gegevensmaskering. |
|
headers |
string[] |
Matrix van HTTP-headers om te registreren. |
OperationNameFormat
De indeling van de bewerkingsnaam voor Application Insights-telemetrieën. De standaardwaarde is Naam.
Name | Type | Description |
---|---|---|
Name |
string |
API_NAME; rev=API_REVISION - OPERATION_NAME |
Url |
string |
HTTP_VERB URL |
PipelineDiagnosticSettings
Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway.
Name | Type | Description |
---|---|---|
request |
Diagnostische instellingen voor aanvraag. |
|
response |
Diagnostische instellingen voor antwoord. |
SamplingSettings
Sampling-instellingen voor Diagnostische gegevens.
Name | Type | Description |
---|---|---|
percentage |
number |
Frequentie van steekproeven voor steekproeven met vaste frequentie. |
samplingType |
Steekproeftype. |
SamplingType
Steekproeftype.
Name | Type | Description |
---|---|---|
fixed |
string |
Steekproeven met vaste frequentie. |
Verbosity
Het uitgebreidheidsniveau dat wordt toegepast op traceringen die worden verzonden door traceringsbeleid.
Name | Type | Description |
---|---|---|
error |
string |
Alleen traceringen met 'ernst' die zijn ingesteld op 'fout' worden verzonden naar de logboekregistratie die is gekoppeld aan dit diagnostische exemplaar. |
information |
string |
Traceringen met 'ernst' ingesteld op 'informatie' en 'fout' worden verzonden naar de logger die is gekoppeld aan dit diagnostische exemplaar. |
verbose |
string |
Alle traceringen die door traceringsbeleid worden verzonden, worden verzonden naar de logboekregistratie die is gekoppeld aan dit diagnostische exemplaar. |