Dela via

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

  • Artikel

Bicep-resursdefinition

Resurstypen tjänst/apis/diagnostik kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/apis/diagnostics-resurs lägger du till följande Bicep i mallen.

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'
  }
}

Egenskapsvärden

BodyDiagnosticSettings

Namn Beskrivning Värde
Byte Antal begärandetextbyte som ska loggas. Int

Begränsningar:
Maxvärde = 8192

DiagnosticContractProperties

Namn Beskrivning Värde
alwaysLog Anger vilken typ av meddelandesamplingsinställningar som inte ska tillämpas. "allErrors"
serverdel Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till serverdelen PipelineDiagnosticSettings
enableHttpCorrelationHeaders Om korrelationsrubriker ska bearbetas som kommer till Api Management Service. Gäller endast för Application Insights-diagnostik. Standardvärdet är sant. Bool
klientdel Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till gatewayen. PipelineDiagnosticSettings
httpCorrelationProtocol Anger korrelationsprotokoll som ska användas för Application Insights-diagnostik. "Äldre"
"Ingen"
"W3C"
loggerId Resurs-ID för en målloggare. sträng (krävs)
provtagning Samplingsinställningar för diagnostik. SamplingSettings
Informationsnivån Den verbositetsnivå som tillämpas på spårningar som genereras av spårningsprinciper. "fel"
"information"
"utförligt"

HttpMessageDiagnostic

Namn Beskrivning Värde
kropp Inställningar för kroppsloggning. BodyDiagnosticSettings
Headers Matris med HTTP-huvuden som ska loggas. string[]

Microsoft.ApiManagement/service/apis/diagnostics

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1
Mönster = ^[^*#&+:<>?]+$ (krävs)
förälder I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför den överordnade resursen.		 Symboliskt namn för resurs av typen: service/apis
Egenskaper Egenskaper för diagnostikentitetskontrakt. DiagnosticContractProperties

PipelineDiagnosticSettings

Namn Beskrivning Värde
begäran Diagnostikinställningar för begäran. HttpMessageDiagnostic
svar Diagnostikinställningar för svar. HttpMessageDiagnostic

SamplingSettings

Namn Beskrivning Värde
procent Samplingshastighet för fast sampling. Int

Begränsningar:
Minsta värde = 0
Maxvärde = 100
samplingType Samplingstyp. "fast"

Resursdefinition för ARM-mall

Resurstypen tjänst/apis/diagnostik kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/apis/diagnostics-resurs lägger du till följande JSON i mallen.

{
  "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"
  }
}

Egenskapsvärden

BodyDiagnosticSettings

Namn Beskrivning Värde
Byte Antal begärandetextbyte som ska loggas. Int

Begränsningar:
Maxvärde = 8192

DiagnosticContractProperties

Namn Beskrivning Värde
alwaysLog Anger vilken typ av meddelandesamplingsinställningar som inte ska tillämpas. "allErrors"
serverdel Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till serverdelen PipelineDiagnosticSettings
enableHttpCorrelationHeaders Om korrelationsrubriker ska bearbetas som kommer till Api Management Service. Gäller endast för Application Insights-diagnostik. Standardvärdet är sant. Bool
klientdel Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till gatewayen. PipelineDiagnosticSettings
httpCorrelationProtocol Anger korrelationsprotokoll som ska användas för Application Insights-diagnostik. "Äldre"
"Ingen"
"W3C"
loggerId Resurs-ID för en målloggare. sträng (krävs)
provtagning Samplingsinställningar för diagnostik. SamplingSettings
Informationsnivån Den verbositetsnivå som tillämpas på spårningar som genereras av spårningsprinciper. "fel"
"information"
"utförligt"

HttpMessageDiagnostic

Namn Beskrivning Värde
kropp Inställningar för kroppsloggning. BodyDiagnosticSettings
Headers Matris med HTTP-huvuden som ska loggas. string[]

Microsoft.ApiManagement/service/apis/diagnostics

Namn Beskrivning Värde
apiVersion API-versionen '2019-01-01'
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1
Mönster = ^[^*#&+:<>?]+$ (krävs)
Egenskaper Egenskaper för diagnostikentitetskontrakt. DiagnosticContractProperties
typ Resurstypen "Microsoft.ApiManagement/service/apis/diagnostics"

PipelineDiagnosticSettings

Namn Beskrivning Värde
begäran Diagnostikinställningar för begäran. HttpMessageDiagnostic
svar Diagnostikinställningar för svar. HttpMessageDiagnostic

SamplingSettings

Namn Beskrivning Värde
procent Samplingshastighet för fast sampling. Int

Begränsningar:
Minsta värde = 0
Maxvärde = 100
samplingType Samplingstyp. "fast"

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen tjänst/apis/diagnostik kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/apis/diagnostics-resurs lägger du till följande Terraform i mallen.

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"
    }
  })
}

Egenskapsvärden

BodyDiagnosticSettings

Namn Beskrivning Värde
Byte Antal begärandetextbyte som ska loggas. Int

Begränsningar:
Maxvärde = 8192

DiagnosticContractProperties

Namn Beskrivning Värde
alwaysLog Anger vilken typ av meddelandesamplingsinställningar som inte ska tillämpas. "allErrors"
serverdel Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till serverdelen PipelineDiagnosticSettings
enableHttpCorrelationHeaders Om korrelationsrubriker ska bearbetas som kommer till Api Management Service. Gäller endast för Application Insights-diagnostik. Standardvärdet är sant. Bool
klientdel Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till gatewayen. PipelineDiagnosticSettings
httpCorrelationProtocol Anger korrelationsprotokoll som ska användas för Application Insights-diagnostik. "Äldre"
"Ingen"
"W3C"
loggerId Resurs-ID för en målloggare. sträng (krävs)
provtagning Samplingsinställningar för diagnostik. SamplingSettings
Informationsnivån Den verbositetsnivå som tillämpas på spårningar som genereras av spårningsprinciper. "fel"
"information"
"utförligt"

HttpMessageDiagnostic

Namn Beskrivning Värde
kropp Inställningar för kroppsloggning. BodyDiagnosticSettings
Headers Matris med HTTP-huvuden som ska loggas. string[]

Microsoft.ApiManagement/service/apis/diagnostics

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1
Mönster = ^[^*#&+:<>?]+$ (krävs)
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: service/apis
Egenskaper Egenskaper för diagnostikentitetskontrakt. DiagnosticContractProperties
typ Resurstypen "Microsoft.ApiManagement/service/apis/diagnostics@2019-01-01"

PipelineDiagnosticSettings

Namn Beskrivning Värde
begäran Diagnostikinställningar för begäran. HttpMessageDiagnostic
svar Diagnostikinställningar för svar. HttpMessageDiagnostic

SamplingSettings

Namn Beskrivning Värde
procent Samplingshastighet för fast sampling. Int

Begränsningar:
Minsta värde = 0
Maxvärde = 100
samplingType Samplingstyp. "fast"