Diagnostic - Update

Referens

Tjänst:: API Management

API-version:: 2024-05-01

Uppdaterar informationen om diagnostiken som anges av dess identifierare.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
diagnosticId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Diagnostikidentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Namnet på API Management-tjänsten.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
If-Match	True	string	ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.

Begärandetext

Name	Obligatorisk	Typ	Description
properties.loggerId	True	string	Resurs-ID för en målloggare.
properties.alwaysLog		AlwaysLog	Anger vilken typ av meddelandesamplingsinställningar som inte ska tillämpas.
properties.backend		PipelineDiagnosticSettings	Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till serverdelen
properties.frontend		PipelineDiagnosticSettings	Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till gatewayen.
properties.httpCorrelationProtocol		HttpCorrelationProtocol	Anger korrelationsprotokoll som ska användas för Application Insights-diagnostik.
properties.logClientIp		boolean	Logga ClientIP. Standardvärdet är falskt.
properties.metrics		boolean	Generera anpassade mått via principen för utsända mått. Gäller endast diagnostikinställningar för Application Insights.
properties.operationNameFormat		OperationNameFormat	Formatet för åtgärdsnamnet för Application Insights-telemetrier. Standardvärdet är Namn.
properties.sampling		SamplingSettings	Samplingsinställningar för diagnostik.
properties.verbosity		Verbosity	Den verbositetsnivå som tillämpas på spårningar som genereras av spårningsprinciper.

Svar

Name	Typ	Description
200 OK	DiagnosticContract	Diagnostiken har uppdaterats Sidhuvuden ETag: string
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Name

Typ

Description

200 OK

DiagnosticContract

Diagnostiken har uppdaterats

Sidhuvuden

ETag: string

Other Status Codes

ErrorResponse

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

ApiManagementUpdateDiagnostic

Exempelbegäran

HTTP

PATCH 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/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
        }
      }
    }
  }
}

Exempelsvar

Statuskod:: 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",
    "httpCorrelationProtocol": "Legacy",
    "logClientIp": true,
    "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/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
        }
      }
    }
  }
}

Definitioner

Name	Description
AlwaysLog	Anger vilken typ av meddelandesamplingsinställningar som inte ska tillämpas.
BodyDiagnosticSettings	Inställningar för kroppsloggning.
DataMasking
DataMaskingEntity
DataMaskingMode	Datamaskeringsläge.
DiagnosticContract	Diagnostikinformation.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
HttpCorrelationProtocol	Anger korrelationsprotokoll som ska användas för Application Insights-diagnostik.
HttpMessageDiagnostic	Diagnostikinställningar för http-meddelande.
OperationNameFormat	Formatet för åtgärdsnamnet för Application Insights-telemetrier. Standardvärdet är Namn.
PipelineDiagnosticSettings	Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till gatewayen.
SamplingSettings	Samplingsinställningar för diagnostik.
SamplingType	Samplingstyp.
Verbosity	Den verbositetsnivå som tillämpas på spårningar som genereras av spårningsprinciper.

AlwaysLog

Uppräkning

Anger vilken typ av meddelandesamplingsinställningar som inte ska tillämpas.

Värde	Description
allErrors	Logga alltid alla felaktiga begäranden oavsett samplingsinställningar.

BodyDiagnosticSettings

Objekt

Inställningar för kroppsloggning.

Name	Typ	Description
bytes	integer (int32) maximum: 8192	Antal begärandetextbyte som ska loggas.

DataMasking

Objekt

Name	Typ	Description
headers	DataMaskingEntity[]	Maskeringsinställningar för rubriker
queryParams	DataMaskingEntity[]	Maskeringsinställningar för URL-frågeparametrar

DataMaskingEntity

Objekt

Name	Typ	Description
mode	DataMaskingMode	Datamaskeringsläge.
value	string	Namnet på en entitet som ska maskeras (t.ex. ett namn på en rubrik eller en frågeparameter).

DataMaskingMode

Uppräkning

Datamaskeringsläge.

Värde	Description
Hide	Dölj förekomsten av en entitet.
Mask	Maskera värdet för en entitet.

DiagnosticContract

Objekt

Diagnostikinformation.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties.alwaysLog	AlwaysLog	Anger vilken typ av meddelandesamplingsinställningar som inte ska tillämpas.
properties.backend	PipelineDiagnosticSettings	Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till serverdelen
properties.frontend	PipelineDiagnosticSettings	Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till gatewayen.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Anger korrelationsprotokoll som ska användas för Application Insights-diagnostik.
properties.logClientIp	boolean	Logga ClientIP. Standardvärdet är falskt.
properties.loggerId	string	Resurs-ID för en målloggare.
properties.metrics	boolean	Generera anpassade mått via principen för utsända mått. Gäller endast diagnostikinställningar för Application Insights.
properties.operationNameFormat	OperationNameFormat	Formatet för åtgärdsnamnet för Application Insights-telemetrier. Standardvärdet är Namn.
properties.sampling	SamplingSettings	Samplingsinställningar för diagnostik.
properties.verbosity	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"

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

HttpCorrelationProtocol

Uppräkning

Anger korrelationsprotokoll som ska användas för Application Insights-diagnostik.

Värde	Description
Legacy	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	Läs inte och mata inte in korrelationshuvuden.
W3C	Mata in spårningskontextrubriker. Se https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Objekt

Diagnostikinställningar för http-meddelande.

Name	Typ	Description
body	BodyDiagnosticSettings	Inställningar för kroppsloggning.
dataMasking	DataMasking	Inställningar för datamaskering.
headers	string[]	Matris med HTTP-huvuden som ska loggas.

OperationNameFormat

Uppräkning

Formatet för åtgärdsnamnet för Application Insights-telemetrier. Standardvärdet är Namn.

Värde	Description
Name	API_NAME; rev=API_REVISION – OPERATION_NAME
Url	HTTP_VERB URL

PipelineDiagnosticSettings

Objekt

Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till gatewayen.

Name	Typ	Description
request	HttpMessageDiagnostic	Diagnostikinställningar för begäran.
response	HttpMessageDiagnostic	Diagnostikinställningar för svar.

SamplingSettings

Objekt

Samplingsinställningar för diagnostik.

Name	Typ	Description
percentage	number (double) minimum: 0 maximum: 100	Samplingshastighet för fast sampling.
samplingType	SamplingType	Samplingstyp.

SamplingType

Uppräkning

Samplingstyp.

Värde	Description
fixed	Sampling med fast hastighet.

Verbosity

Uppräkning

Den verbositetsnivå som tillämpas på spårningar som genereras av spårningsprinciper.

Värde	Description
error	Endast spårningar med allvarlighetsgrad inställd på "fel" skickas till den loggare som är kopplad till den här diagnostikinstansen.
information	Spårningar med allvarlighetsgrad inställd på "information" och "fel" skickas till den loggare som är kopplad till den här diagnostikinstansen.
verbose	Alla spårningar som genereras av spårningsprinciper skickas till den loggning som är kopplad till den här diagnostikinstansen.

Dela via

Diagnostic - Update

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

ApiManagementUpdateDiagnostic

Exempelbegäran

Exempelsvar

Definitioner

AlwaysLog

BodyDiagnosticSettings

DataMasking

DataMaskingEntity

DataMaskingMode

DiagnosticContract

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HttpCorrelationProtocol

HttpMessageDiagnostic

OperationNameFormat

PipelineDiagnosticSettings

SamplingSettings

SamplingType

Verbosity

Ytterligare resurser