Freigeben über

Microsoft.ApiManagement service/apis/diagnostics 2019-01-01

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp "service/apis/diagnostics" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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

Ressourcenformat

Um eine Microsoft.ApiManagement/service/apis/diagnostics-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.ApiManagement/service/apis/diagnostics@2019-01-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    alwaysLog: 'string'
    backend: {
      request: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
      response: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
    }
    enableHttpCorrelationHeaders: bool
    frontend: {
      request: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
      response: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
    }
    httpCorrelationProtocol: 'string'
    loggerId: 'string'
    sampling: {
      percentage: int
      samplingType: 'string'
    }
    verbosity: 'string'
  }
}

Eigenschaftswerte

BodyDiagnosticSettings

Name Beschreibung Wert
Bytes Anzahl der zu protokollierenden Anforderungstextbytes. Int

Zwänge:
Maximalwert = 8192

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
enableHttpCorrelationHeaders Gibt an, ob Korrelationsheader verarbeitet werden sollen, die an den API-Verwaltungsdienst kommen. Gilt nur für die Application Insights-Diagnose. Der Standardwert ist true. Bool
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"
loggerId Ressourcen-ID eines Zielprotokollierers. Zeichenfolge (erforderlich)
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
Header Array von HTTP-Headern, die protokolliert werden sollen. string[]

Microsoft.ApiManagement/service/apis/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 vom Typ: Dienst/APIs
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"

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "service/apis/diagnostics" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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

Ressourcenformat

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

{
  "type": "Microsoft.ApiManagement/service/apis/diagnostics",
  "apiVersion": "2019-01-01",
  "name": "string",
  "properties": {
    "alwaysLog": "string",
    "backend": {
      "request": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      },
      "response": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      }
    },
    "enableHttpCorrelationHeaders": "bool",
    "frontend": {
      "request": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      },
      "response": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      }
    },
    "httpCorrelationProtocol": "string",
    "loggerId": "string",
    "sampling": {
      "percentage": "int",
      "samplingType": "string"
    },
    "verbosity": "string"
  }
}

Eigenschaftswerte

BodyDiagnosticSettings

Name Beschreibung Wert
Bytes Anzahl der zu protokollierenden Anforderungstextbytes. Int

Zwänge:
Maximalwert = 8192

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
enableHttpCorrelationHeaders Gibt an, ob Korrelationsheader verarbeitet werden sollen, die an den API-Verwaltungsdienst kommen. Gilt nur für die Application Insights-Diagnose. Der Standardwert ist true. Bool
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"
loggerId Ressourcen-ID eines Zielprotokollierers. Zeichenfolge (erforderlich)
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
Header Array von HTTP-Headern, die protokolliert werden sollen. string[]

Microsoft.ApiManagement/service/apis/diagnostics

Name Beschreibung Wert
apiVersion Die API-Version '2019-01-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/apis/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"

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "service/apis/diagnostics" 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/apis/diagnostics-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/diagnostics@2019-01-01"
  name = "string"
  body = jsonencode({
    properties = {
      alwaysLog = "string"
      backend = {
        request = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
        response = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
      }
      enableHttpCorrelationHeaders = bool
      frontend = {
        request = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
        response = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
      }
      httpCorrelationProtocol = "string"
      loggerId = "string"
      sampling = {
        percentage = int
        samplingType = "string"
      }
      verbosity = "string"
    }
  })
}

Eigenschaftswerte

BodyDiagnosticSettings

Name Beschreibung Wert
Bytes Anzahl der zu protokollierenden Anforderungstextbytes. Int

Zwänge:
Maximalwert = 8192

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
enableHttpCorrelationHeaders Gibt an, ob Korrelationsheader verarbeitet werden sollen, die an den API-Verwaltungsdienst kommen. Gilt nur für die Application Insights-Diagnose. Der Standardwert ist true. Bool
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"
loggerId Ressourcen-ID eines Zielprotokollierers. Zeichenfolge (erforderlich)
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
Header Array von HTTP-Headern, die protokolliert werden sollen. string[]

Microsoft.ApiManagement/service/apis/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/APIs
Eigenschaften Eigenschaften des Diagnoseentitätsvertrags. DiagnosticContractProperties-
Art Der Ressourcentyp "Microsoft.ApiManagement/service/apis/diagnostics@2019-01-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"