Microsoft.ApiManagement-Dienst/Diagnose 2024-05-01

• neueste
• 2024-06-01-Preview-
• 2024-05-01
• 2023-09-01-Preview-
• 2023-05-01-Preview-
• 2023-03-01-Preview-
• 2022-09-01-Preview-
• 2022-08-01
• 2022-04-01-Vorschau-
• 2021-12-01-Preview-
• 2021-08-01
• 2021-04-01-preview
• 2021-01-01-Preview-
• 2020-12-01
• 2020-06-01-Preview-
• 2019-12-01
• 2019-12-01-Preview-
• 2019-01-01
• 2018-06-01-Preview-
• 2018-01-01
• 2017-03-01

Bicep-Ressourcendefinition

Der Ressourcentyp "Dienst/Diagnose" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

• Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/diagnostics-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.ApiManagement/service/diagnostics@2024-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    alwaysLog: 'string'
    backend: {
      request: {
        body: {
          bytes: int
        }
        dataMasking: {
          headers: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
          queryParams: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
        }
        headers: [
          'string'
        ]
      }
      response: {
        body: {
          bytes: int
        }
        dataMasking: {
          headers: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
          queryParams: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
        }
        headers: [
          'string'
        ]
      }
    }
    frontend: {
      request: {
        body: {
          bytes: int
        }
        dataMasking: {
          headers: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
          queryParams: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
        }
        headers: [
          'string'
        ]
      }
      response: {
        body: {
          bytes: int
        }
        dataMasking: {
          headers: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
          queryParams: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
        }
        headers: [
          'string'
        ]
      }
    }
    httpCorrelationProtocol: 'string'
    logClientIp: bool
    loggerId: 'string'
    metrics: bool
    operationNameFormat: 'string'
    sampling: {
      percentage: int
      samplingType: 'string'
    }
    verbosity: 'string'
  }
}

Eigenschaftswerte

BodyDiagnosticSettings

Name	Beschreibung	Wert
Bytes	Anzahl der zu protokollierenden Anforderungstextbytes.	Int Zwänge: Maximalwert = 8192

DataMasking

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

DataMaskingEntity

Name	Beschreibung	Wert
Modus	Datenformatierungsmodus.	"Ausblenden" "Maske"
Wert	Der Name einer zu maskierenden Entität (z. B. ein Name eines Headers oder eines Abfrageparameters).	Schnur

DiagnosticContractProperties

Name	Beschreibung	Wert
alwaysLog	Gibt an, welche Art von Nachrichten-Samplingeinstellungen nicht angewendet werden sollen.	"allErrors"
Back-End	Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten im Back-End	PipelineDiagnosticSettings
Frontend	Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten an das Gateway.	PipelineDiagnosticSettings
httpCorrelationProtocol	Legt das Korrelationsprotokoll fest, das für die Application Insights-Diagnose verwendet werden soll.	'Legacy' 'None' "W3C"
logClientIp	Protokollieren Sie clientIP. Der Standardwert ist "false".	Bool
loggerId	Ressourcen-ID eines Zielprotokollierers.	Zeichenfolge (erforderlich)
Metrik	Geben Sie benutzerdefinierte Metriken über die Emit-metrische Richtlinie aus. Gilt nur für Die Diagnoseeinstellungen von Application Insights.	Bool
operationNameFormat	Das Format des Vorgangsnamens für Application Insights-Telemetriedaten. Der Standardwert ist Name.	'Name' 'URL'
Probenahme	Samplingeinstellungen für Diagnose.	SamplingSettings
Wortfülle	Die Ausführlichkeitsebene, die auf Ablaufverfolgungen angewendet wird, die von Ablaufverfolgungsrichtlinien ausgegeben werden.	'error' "Informationen" "ausführlich"

HttpMessageDiagnostic

Name	Beschreibung	Wert
Körper	Einstellungen für die Textkörperprotokollierung.	BodyDiagnosticSettings
dataMasking	Datenformatierungseinstellungen.	DataMasking-
Header	Array von HTTP-Headern, die protokolliert werden sollen.	string[]

Microsoft.ApiManagement/service/diagnostics

Name	Beschreibung	Wert
Name	Der Ressourcenname	Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[^*#&+:<>?]+$ (erforderlich)
Elternteil	In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.	Symbolischer Name für Ressource des Typs: Dienst-
Eigenschaften	Eigenschaften des Diagnoseentitätsvertrags.	DiagnosticContractProperties-

PipelineDiagnosticSettings

Name	Beschreibung	Wert
bitten	Diagnoseeinstellungen für die Anforderung.	HttpMessageDiagnostic-
Antwort	Diagnoseeinstellungen für die Antwort.	HttpMessageDiagnostic-

SamplingSettings

Name	Beschreibung	Wert
Prozentsatz	Abtastrate für stichprobenfreie Stichproben.	Int Zwänge: Min.-Wert = 0 Max. Wert = 100
samplingType	Samplingtyp.	"behoben"

Schnellstartbeispiele

Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.

Bicep-Datei	Beschreibung
Anwendungsgateway mit interner API-Verwaltung und Web App-	Das Anwendungsgateway routingt Internetdatenverkehr an eine API-Verwaltungsinstanz für virtuelle Netzwerke (interner Modus), die eine in einer Azure Web App gehostete Web-API verwendet.
Erstellen der API-Verwaltung im internen VNet mit App-Gateway-	Diese Vorlage veranschaulicht, wie Sie eine Instanz von Azure API Management in einem privaten Netzwerk erstellen, das durch Azure Application Gateway geschützt ist.

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "Dienst/Diagnose" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

• Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/diagnostics-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.ApiManagement/service/diagnostics",
  "apiVersion": "2024-05-01",
  "name": "string",
  "properties": {
    "alwaysLog": "string",
    "backend": {
      "request": {
        "body": {
          "bytes": "int"
        },
        "dataMasking": {
          "headers": [
            {
              "mode": "string",
              "value": "string"
            }
          ],
          "queryParams": [
            {
              "mode": "string",
              "value": "string"
            }
          ]
        },
        "headers": [ "string" ]
      },
      "response": {
        "body": {
          "bytes": "int"
        },
        "dataMasking": {
          "headers": [
            {
              "mode": "string",
              "value": "string"
            }
          ],
          "queryParams": [
            {
              "mode": "string",
              "value": "string"
            }
          ]
        },
        "headers": [ "string" ]
      }
    },
    "frontend": {
      "request": {
        "body": {
          "bytes": "int"
        },
        "dataMasking": {
          "headers": [
            {
              "mode": "string",
              "value": "string"
            }
          ],
          "queryParams": [
            {
              "mode": "string",
              "value": "string"
            }
          ]
        },
        "headers": [ "string" ]
      },
      "response": {
        "body": {
          "bytes": "int"
        },
        "dataMasking": {
          "headers": [
            {
              "mode": "string",
              "value": "string"
            }
          ],
          "queryParams": [
            {
              "mode": "string",
              "value": "string"
            }
          ]
        },
        "headers": [ "string" ]
      }
    },
    "httpCorrelationProtocol": "string",
    "logClientIp": "bool",
    "loggerId": "string",
    "metrics": "bool",
    "operationNameFormat": "string",
    "sampling": {
      "percentage": "int",
      "samplingType": "string"
    },
    "verbosity": "string"
  }
}

Eigenschaftswerte

BodyDiagnosticSettings

Name	Beschreibung	Wert
Bytes	Anzahl der zu protokollierenden Anforderungstextbytes.	Int Zwänge: Maximalwert = 8192

DataMasking

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

DataMaskingEntity

Name	Beschreibung	Wert
Modus	Datenformatierungsmodus.	"Ausblenden" "Maske"
Wert	Der Name einer zu maskierenden Entität (z. B. ein Name eines Headers oder eines Abfrageparameters).	Schnur

DiagnosticContractProperties

Name	Beschreibung	Wert
alwaysLog	Gibt an, welche Art von Nachrichten-Samplingeinstellungen nicht angewendet werden sollen.	"allErrors"
Back-End	Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten im Back-End	PipelineDiagnosticSettings
Frontend	Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten an das Gateway.	PipelineDiagnosticSettings
httpCorrelationProtocol	Legt das Korrelationsprotokoll fest, das für die Application Insights-Diagnose verwendet werden soll.	'Legacy' 'None' "W3C"
logClientIp	Protokollieren Sie clientIP. Der Standardwert ist "false".	Bool
loggerId	Ressourcen-ID eines Zielprotokollierers.	Zeichenfolge (erforderlich)
Metrik	Geben Sie benutzerdefinierte Metriken über die Emit-metrische Richtlinie aus. Gilt nur für Die Diagnoseeinstellungen von Application Insights.	Bool
operationNameFormat	Das Format des Vorgangsnamens für Application Insights-Telemetriedaten. Der Standardwert ist Name.	'Name' 'URL'
Probenahme	Samplingeinstellungen für Diagnose.	SamplingSettings
Wortfülle	Die Ausführlichkeitsebene, die auf Ablaufverfolgungen angewendet wird, die von Ablaufverfolgungsrichtlinien ausgegeben werden.	'error' "Informationen" "ausführlich"

HttpMessageDiagnostic

Name	Beschreibung	Wert
Körper	Einstellungen für die Textkörperprotokollierung.	BodyDiagnosticSettings
dataMasking	Datenformatierungseinstellungen.	DataMasking-
Header	Array von HTTP-Headern, die protokolliert werden sollen.	string[]

Microsoft.ApiManagement/service/diagnostics

Name	Beschreibung	Wert
apiVersion	Die API-Version	'2024-05-01'
Name	Der Ressourcenname	Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[^*#&+:<>?]+$ (erforderlich)
Eigenschaften	Eigenschaften des Diagnoseentitätsvertrags.	DiagnosticContractProperties-
Art	Der Ressourcentyp	"Microsoft.ApiManagement/service/diagnostics"

PipelineDiagnosticSettings

Name	Beschreibung	Wert
bitten	Diagnoseeinstellungen für die Anforderung.	HttpMessageDiagnostic-
Antwort	Diagnoseeinstellungen für die Antwort.	HttpMessageDiagnostic-

SamplingSettings

Name	Beschreibung	Wert
Prozentsatz	Abtastrate für stichprobenfreie Stichproben.	Int Zwänge: Min.-Wert = 0 Max. Wert = 100
samplingType	Samplingtyp.	"behoben"

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone	Beschreibung
Anwendungsgateway mit interner API-Verwaltung und Web App-	Das Anwendungsgateway routingt Internetdatenverkehr an eine API-Verwaltungsinstanz für virtuelle Netzwerke (interner Modus), die eine in einer Azure Web App gehostete Web-API verwendet.
Erstellen der API-Verwaltung im internen VNet mit App-Gateway-	Diese Vorlage veranschaulicht, wie Sie eine Instanz von Azure API Management in einem privaten Netzwerk erstellen, das durch Azure Application Gateway geschützt ist.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "Dienst/Diagnose" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

• Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/diagnostics-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/diagnostics@2024-05-01"
  name = "string"
  body = jsonencode({
    properties = {
      alwaysLog = "string"
      backend = {
        request = {
          body = {
            bytes = int
          }
          dataMasking = {
            headers = [
              {
                mode = "string"
                value = "string"
              }
            ]
            queryParams = [
              {
                mode = "string"
                value = "string"
              }
            ]
          }
          headers = [
            "string"
          ]
        }
        response = {
          body = {
            bytes = int
          }
          dataMasking = {
            headers = [
              {
                mode = "string"
                value = "string"
              }
            ]
            queryParams = [
              {
                mode = "string"
                value = "string"
              }
            ]
          }
          headers = [
            "string"
          ]
        }
      }
      frontend = {
        request = {
          body = {
            bytes = int
          }
          dataMasking = {
            headers = [
              {
                mode = "string"
                value = "string"
              }
            ]
            queryParams = [
              {
                mode = "string"
                value = "string"
              }
            ]
          }
          headers = [
            "string"
          ]
        }
        response = {
          body = {
            bytes = int
          }
          dataMasking = {
            headers = [
              {
                mode = "string"
                value = "string"
              }
            ]
            queryParams = [
              {
                mode = "string"
                value = "string"
              }
            ]
          }
          headers = [
            "string"
          ]
        }
      }
      httpCorrelationProtocol = "string"
      logClientIp = bool
      loggerId = "string"
      metrics = bool
      operationNameFormat = "string"
      sampling = {
        percentage = int
        samplingType = "string"
      }
      verbosity = "string"
    }
  })
}

Eigenschaftswerte

BodyDiagnosticSettings

Name	Beschreibung	Wert
Bytes	Anzahl der zu protokollierenden Anforderungstextbytes.	Int Zwänge: Maximalwert = 8192

DataMasking

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

DataMaskingEntity

Name	Beschreibung	Wert
Modus	Datenformatierungsmodus.	"Ausblenden" "Maske"
Wert	Der Name einer zu maskierenden Entität (z. B. ein Name eines Headers oder eines Abfrageparameters).	Schnur

DiagnosticContractProperties

Name	Beschreibung	Wert
alwaysLog	Gibt an, welche Art von Nachrichten-Samplingeinstellungen nicht angewendet werden sollen.	"allErrors"
Back-End	Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten im Back-End	PipelineDiagnosticSettings
Frontend	Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten an das Gateway.	PipelineDiagnosticSettings
httpCorrelationProtocol	Legt das Korrelationsprotokoll fest, das für die Application Insights-Diagnose verwendet werden soll.	'Legacy' 'None' "W3C"
logClientIp	Protokollieren Sie clientIP. Der Standardwert ist "false".	Bool
loggerId	Ressourcen-ID eines Zielprotokollierers.	Zeichenfolge (erforderlich)
Metrik	Geben Sie benutzerdefinierte Metriken über die Emit-metrische Richtlinie aus. Gilt nur für Die Diagnoseeinstellungen von Application Insights.	Bool
operationNameFormat	Das Format des Vorgangsnamens für Application Insights-Telemetriedaten. Der Standardwert ist Name.	'Name' 'URL'
Probenahme	Samplingeinstellungen für Diagnose.	SamplingSettings
Wortfülle	Die Ausführlichkeitsebene, die auf Ablaufverfolgungen angewendet wird, die von Ablaufverfolgungsrichtlinien ausgegeben werden.	'error' "Informationen" "ausführlich"

HttpMessageDiagnostic

Name	Beschreibung	Wert
Körper	Einstellungen für die Textkörperprotokollierung.	BodyDiagnosticSettings
dataMasking	Datenformatierungseinstellungen.	DataMasking-
Header	Array von HTTP-Headern, die protokolliert werden sollen.	string[]

Microsoft.ApiManagement/service/diagnostics

Name	Beschreibung	Wert
Name	Der Ressourcenname	Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[^*#&+:<>?]+$ (erforderlich)
parent_id	Die ID der Ressource, die das übergeordnete Element für diese Ressource ist.	ID für Ressource des Typs: Dienst-
Eigenschaften	Eigenschaften des Diagnoseentitätsvertrags.	DiagnosticContractProperties-
Art	Der Ressourcentyp	"Microsoft.ApiManagement/service/diagnostics@2024-05-01"

PipelineDiagnosticSettings

Name	Beschreibung	Wert
bitten	Diagnoseeinstellungen für die Anforderung.	HttpMessageDiagnostic-
Antwort	Diagnoseeinstellungen für die Antwort.	HttpMessageDiagnostic-

SamplingSettings

Name	Beschreibung	Wert
Prozentsatz	Abtastrate für stichprobenfreie Stichproben.	Int Zwänge: Min.-Wert = 0 Max. Wert = 100
samplingType	Samplingtyp.	"behoben"