Workspace Diagnostic - Update

Referenz

Dienst:: API Management

API-Version:: 2024-05-01

Aktualisiert die Details der durch den Bezeichner angegebenen Diagnose.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
diagnosticId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Diagnosebezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match	True	string	ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.

Anforderungstext

Name	Typ	Beschreibung
properties.alwaysLog	AlwaysLog	Gibt an, welche Art von Nachrichten-Samplingeinstellungen nicht angewendet werden sollen.
properties.backend	PipelineDiagnosticSettings	Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten im Back-End
properties.frontend	PipelineDiagnosticSettings	Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten an das Gateway.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Legt das Korrelationsprotokoll fest, das für die Application Insights-Diagnose verwendet werden soll.
properties.logClientIp	boolean	Protokollieren Sie clientIP. Der Standardwert ist "false".
properties.loggerId	string	Ressourcen-ID eines Zielprotokollierers.
properties.metrics	boolean	Geben Sie benutzerdefinierte Metriken über die Emit-metrische Richtlinie aus. Gilt nur für Die Diagnoseeinstellungen von Application Insights.
properties.operationNameFormat	OperationNameFormat	Das Format des Vorgangsnamens für Application Insights-Telemetriedaten. Der Standardwert ist Name.
properties.sampling	SamplingSettings	Samplingeinstellungen für Diagnose.
properties.verbosity	Verbosity	Die Ausführlichkeitsebene, die auf Ablaufverfolgungen angewendet wird, die von Ablaufverfolgungsrichtlinien ausgegeben werden.

Antworten

Name	Typ	Beschreibung
200 OK	DiagnosticContract	Diagnose erfolgreich aktualisiert Header ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Name

Typ

Beschreibung

200 OK

DiagnosticContract

Diagnose erfolgreich aktualisiert

Header

ETag: string

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementUpdateWorkspaceDiagnostic

Beispielanforderung

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights?api-version=2024-05-01


{
  "properties": {
    "alwaysLog": "allErrors",
    "loggerId": "/workspaces/wks1/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
        }
      }
    }
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/diagnostics/applicationinsights",
  "type": "Microsoft.ApiManagement/service/workspaces/diagnostics",
  "name": "applicationinsights",
  "properties": {
    "alwaysLog": "allErrors",
    "httpCorrelationProtocol": "Legacy",
    "logClientIp": true,
    "loggerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/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
        }
      }
    }
  }
}

Definitionen

Name	Beschreibung
AlwaysLog	Gibt an, welche Art von Nachrichten-Samplingeinstellungen nicht angewendet werden sollen.
BodyDiagnosticSettings	Einstellungen für die Textkörperprotokollierung.
DataMasking
DataMaskingEntity
DataMaskingMode	Datenformatierungsmodus.
DiagnosticContract	Diagnosedetails.
DiagnosticUpdateContract	Diagnosedetails.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
HttpCorrelationProtocol	Legt das Korrelationsprotokoll fest, das für die Application Insights-Diagnose verwendet werden soll.
HttpMessageDiagnostic	Http-Nachrichtendiagnoseeinstellungen.
OperationNameFormat	Das Format des Vorgangsnamens für Application Insights-Telemetriedaten. Der Standardwert ist Name.
PipelineDiagnosticSettings	Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten an das Gateway.
SamplingSettings	Samplingeinstellungen für Diagnose.
SamplingType	Samplingtyp.
Verbosity	Die Ausführlichkeitsebene, die auf Ablaufverfolgungen angewendet wird, die von Ablaufverfolgungsrichtlinien ausgegeben werden.

AlwaysLog

Enumeration

Gibt an, welche Art von Nachrichten-Samplingeinstellungen nicht angewendet werden sollen.

Wert	Beschreibung
allErrors	Protokollieren Sie immer alle fehlerhaften Anforderungen unabhängig von den Samplingeinstellungen.

BodyDiagnosticSettings

Objekt

Einstellungen für die Textkörperprotokollierung.

Name	Typ	Beschreibung
bytes	integer (int32) maximum: 8192	Anzahl der zu protokollierenden Anforderungstextbytes.

DataMasking

Objekt

Name	Typ	Beschreibung
headers	DataMaskingEntity[]	Maskieren von Einstellungen für Kopfzeilen
queryParams	DataMaskingEntity[]	Maskierungseinstellungen für URL-Abfrageparameter

DataMaskingEntity

Objekt

Name	Typ	Beschreibung
mode	DataMaskingMode	Datenformatierungsmodus.
value	string	Der Name einer zu maskierenden Entität (z. B. ein Name eines Headers oder eines Abfrageparameters).

DataMaskingMode

Enumeration

Datenformatierungsmodus.

Wert	Beschreibung
Hide	Ausblenden des Vorhandenseins einer Entität.
Mask	Masken Sie den Wert einer Entität.

DiagnosticContract

Objekt

Diagnosedetails.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.alwaysLog	AlwaysLog	Gibt an, welche Art von Nachrichten-Samplingeinstellungen nicht angewendet werden sollen.
properties.backend	PipelineDiagnosticSettings	Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten im Back-End
properties.frontend	PipelineDiagnosticSettings	Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten an das Gateway.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Legt das Korrelationsprotokoll fest, das für die Application Insights-Diagnose verwendet werden soll.
properties.logClientIp	boolean	Protokollieren Sie clientIP. Der Standardwert ist "false".
properties.loggerId	string	Ressourcen-ID eines Zielprotokollierers.
properties.metrics	boolean	Geben Sie benutzerdefinierte Metriken über die Emit-metrische Richtlinie aus. Gilt nur für Die Diagnoseeinstellungen von Application Insights.
properties.operationNameFormat	OperationNameFormat	Das Format des Vorgangsnamens für Application Insights-Telemetriedaten. Der Standardwert ist Name.
properties.sampling	SamplingSettings	Samplingeinstellungen für Diagnose.
properties.verbosity	Verbosity	Die Ausführlichkeitsebene, die auf Ablaufverfolgungen angewendet wird, die von Ablaufverfolgungsrichtlinien ausgegeben werden.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

DiagnosticUpdateContract

Objekt

Diagnosedetails.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.alwaysLog	AlwaysLog	Gibt an, welche Art von Nachrichten-Samplingeinstellungen nicht angewendet werden sollen.
properties.backend	PipelineDiagnosticSettings	Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten im Back-End
properties.frontend	PipelineDiagnosticSettings	Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten an das Gateway.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Legt das Korrelationsprotokoll fest, das für die Application Insights-Diagnose verwendet werden soll.
properties.logClientIp	boolean	Protokollieren Sie clientIP. Der Standardwert ist "false".
properties.loggerId	string	Ressourcen-ID eines Zielprotokollierers.
properties.metrics	boolean	Geben Sie benutzerdefinierte Metriken über die Emit-metrische Richtlinie aus. Gilt nur für Die Diagnoseeinstellungen von Application Insights.
properties.operationNameFormat	OperationNameFormat	Das Format des Vorgangsnamens für Application Insights-Telemetriedaten. Der Standardwert ist Name.
properties.sampling	SamplingSettings	Samplingeinstellungen für Diagnose.
properties.verbosity	Verbosity	Die Ausführlichkeitsebene, die auf Ablaufverfolgungen angewendet wird, die von Ablaufverfolgungsrichtlinien ausgegeben werden.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

HttpCorrelationProtocol

Enumeration

Legt das Korrelationsprotokoll fest, das für die Application Insights-Diagnose verwendet werden soll.

Wert	Beschreibung
Legacy	Fügen Sie Request-Id kopfzeilen und Request-Context kopfzeilen mit Anforderungskorrelationsdaten ein. Siehe https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
None	Keine Korrelationsheader lesen und einfügen.
W3C	Einfügen von Ablaufverfolgungskontextheadern. Siehe https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Objekt

Http-Nachrichtendiagnoseeinstellungen.

Name	Typ	Beschreibung
body	BodyDiagnosticSettings	Einstellungen für die Textkörperprotokollierung.
dataMasking	DataMasking	Datenformatierungseinstellungen.
headers	string[]	Array von HTTP-Headern, die protokolliert werden sollen.

OperationNameFormat

Enumeration

Das Format des Vorgangsnamens für Application Insights-Telemetriedaten. Der Standardwert ist Name.

Wert	Beschreibung
Name	API_NAME; rev=API_REVISION - OPERATION_NAME
Url	HTTP_VERB-URL

PipelineDiagnosticSettings

Objekt

Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten an das Gateway.

Name	Typ	Beschreibung
request	HttpMessageDiagnostic	Diagnoseeinstellungen für die Anforderung.
response	HttpMessageDiagnostic	Diagnoseeinstellungen für die Antwort.

SamplingSettings

Objekt

Samplingeinstellungen für Diagnose.

Name	Typ	Beschreibung
percentage	number (double) minimum: 0 maximum: 100	Abtastrate für stichprobenfreie Stichproben.
samplingType	SamplingType	Samplingtyp.

SamplingType

Enumeration

Samplingtyp.

Wert	Beschreibung
fixed	Sampling mit fester Rate.

Verbosity

Enumeration

Die Ausführlichkeitsebene, die auf Ablaufverfolgungen angewendet wird, die von Ablaufverfolgungsrichtlinien ausgegeben werden.

Wert	Beschreibung
error	Nur Ablaufverfolgungen, deren Schweregrad auf "Fehler" festgelegt ist, werden an den Logger gesendet, der an diese Diagnoseinstanz angefügt ist.
information	Ablaufverfolgungen, deren Schweregrad auf "Informationen" und "Fehler" festgelegt ist, werden an den an diese Diagnoseinstanz angefügten Logger gesendet.
verbose	Alle von Ablaufverfolgungsrichtlinien ausgegebenen Ablaufverfolgungen werden an den Logger gesendet, der an diese Diagnoseinstanz angefügt ist.

Freigeben über

Workspace Diagnostic - Update

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ApiManagementUpdateWorkspaceDiagnostic

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AlwaysLog

BodyDiagnosticSettings

DataMasking

DataMaskingEntity

DataMaskingMode

DiagnosticContract

DiagnosticUpdateContract

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HttpCorrelationProtocol

HttpMessageDiagnostic

OperationNameFormat

PipelineDiagnosticSettings

SamplingSettings

SamplingType

Verbosity

Zusätzliche Ressourcen