Sdílet prostřednictvím

Služba Microsoft.ApiManagement/ workspaces/apis/diagnostics 2024-05-01

  • Článek

Definice prostředku Bicep

Typ prostředku služby, pracovního prostoru/ apis/diagnostiky je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/workspaces/apis/diagnostics, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.ApiManagement/service/workspaces/apis/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'
  }
}

Hodnoty vlastností

BodyDiagnosticSettings

Jméno Popis Hodnota
byty Počet bajtů textu požadavku, které se mají protokolovat. Int

Omezení:
Maximální hodnota = 8192

DataMasking

Jméno Popis Hodnota
hlavičky Nastavení maskování pro záhlaví DataMaskingEntity[]
queryParams Nastavení maskování pro parametry dotazu adresy URL DataMaskingEntity[]

DataMaskingEntity

Jméno Popis Hodnota
režim Režim maskování dat Skrýt
Maska
hodnota Název entity, která se má maskovat (např. název hlavičky nebo parametru dotazu). řetězec

DiagnosticContractProperties

Jméno Popis Hodnota
alwaysLog Určuje, jaký typ nastavení vzorkování zpráv se nemá použít. AllErrors
back-end Nastavení diagnostiky příchozích a odchozích zpráv HTTP do back-endu PipelineDiagnosticSettings
front-end Nastavení diagnostiky příchozích a odchozích zpráv HTTP pro bránu PipelineDiagnosticSettings
httpCorrelationProtocol Nastaví protokol korelace, který se použije pro diagnostiku Application Insights. Starší verze
None (Žádný)
W3C
logClientIp Protokolujte clientIP. Výchozí hodnota je false. Bool
loggerId ID prostředku cílového protokolovacího nástroje string (povinné)
metrika Generování vlastních metrik prostřednictvím zásad metrik generování Platí jenom pro nastavení diagnostiky Application Insights. Bool
operationNameFormat Formát názvu operace pro telemetrie Application Insights Výchozí hodnota je Název. Jméno
Adresa URL
vzorkování Nastavení vzorkování pro diagnostiku nastavení vzorkování
mnohomluvnost Úroveň podrobností použitá pro trasování vygenerované zásadami trasování. Chyba
"informace"
Slovesné

HttpMessageDiagnostic

Jméno Popis Hodnota
tělo Nastavení protokolování textu. BodyDiagnosticSettings
dataMasking Nastavení maskování dat DataMasking
hlavičky Pole hlaviček HTTP, které se mají protokolovat. string[]

Microsoft.ApiManagement/service/workspaces/apis/diagnostics

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
Model = ^[^*#&+:<>?]+$ (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.		 Symbolický název prostředku typu: služba, pracovní prostory/
vlastnosti Vlastnosti kontraktu diagnostických entit DiagnosticContractProperties

PipelineDiagnosticSettings

Jméno Popis Hodnota
prosba Nastavení diagnostiky pro požadavek HttpMessageDiagnostic
odpověď Nastavení diagnostiky pro odpověď HttpMessageDiagnostic

SamplingSettings

Jméno Popis Hodnota
procento Míra vzorkování pro vzorkování s pevnou rychlostí Int

Omezení:
Minimální hodnota = 0
Maximální hodnota = 100
samplingType Typ vzorkování "Opraveno"

Definice prostředku šablony ARM

Typ prostředku služby, pracovního prostoru/ apis/diagnostiky je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/workspaces/apis/diagnostics, přidejte do šablony následující JSON.

{
  "type": "Microsoft.ApiManagement/service/workspaces/apis/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"
  }
}

Hodnoty vlastností

BodyDiagnosticSettings

Jméno Popis Hodnota
byty Počet bajtů textu požadavku, které se mají protokolovat. Int

Omezení:
Maximální hodnota = 8192

DataMasking

Jméno Popis Hodnota
hlavičky Nastavení maskování pro záhlaví DataMaskingEntity[]
queryParams Nastavení maskování pro parametry dotazu adresy URL DataMaskingEntity[]

DataMaskingEntity

Jméno Popis Hodnota
režim Režim maskování dat Skrýt
Maska
hodnota Název entity, která se má maskovat (např. název hlavičky nebo parametru dotazu). řetězec

DiagnosticContractProperties

Jméno Popis Hodnota
alwaysLog Určuje, jaký typ nastavení vzorkování zpráv se nemá použít. AllErrors
back-end Nastavení diagnostiky příchozích a odchozích zpráv HTTP do back-endu PipelineDiagnosticSettings
front-end Nastavení diagnostiky příchozích a odchozích zpráv HTTP pro bránu PipelineDiagnosticSettings
httpCorrelationProtocol Nastaví protokol korelace, který se použije pro diagnostiku Application Insights. Starší verze
None (Žádný)
W3C
logClientIp Protokolujte clientIP. Výchozí hodnota je false. Bool
loggerId ID prostředku cílového protokolovacího nástroje string (povinné)
metrika Generování vlastních metrik prostřednictvím zásad metrik generování Platí jenom pro nastavení diagnostiky Application Insights. Bool
operationNameFormat Formát názvu operace pro telemetrie Application Insights Výchozí hodnota je Název. Jméno
Adresa URL
vzorkování Nastavení vzorkování pro diagnostiku nastavení vzorkování
mnohomluvnost Úroveň podrobností použitá pro trasování vygenerované zásadami trasování. Chyba
"informace"
Slovesné

HttpMessageDiagnostic

Jméno Popis Hodnota
tělo Nastavení protokolování textu. BodyDiagnosticSettings
dataMasking Nastavení maskování dat DataMasking
hlavičky Pole hlaviček HTTP, které se mají protokolovat. string[]

Microsoft.ApiManagement/service/workspaces/apis/diagnostics

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2024-05-01'
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
Model = ^[^*#&+:<>?]+$ (povinné)
vlastnosti Vlastnosti kontraktu diagnostických entit DiagnosticContractProperties
typ Typ prostředku Microsoft.ApiManagement/service/workspaces/apis/diagnostics

PipelineDiagnosticSettings

Jméno Popis Hodnota
prosba Nastavení diagnostiky pro požadavek HttpMessageDiagnostic
odpověď Nastavení diagnostiky pro odpověď HttpMessageDiagnostic

SamplingSettings

Jméno Popis Hodnota
procento Míra vzorkování pro vzorkování s pevnou rychlostí Int

Omezení:
Minimální hodnota = 0
Maximální hodnota = 100
samplingType Typ vzorkování "Opraveno"

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku služby, pracovního prostoru/ apis/diagnostiky je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/workspaces/apis/diagnostics, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/workspaces/apis/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"
    }
  })
}

Hodnoty vlastností

BodyDiagnosticSettings

Jméno Popis Hodnota
byty Počet bajtů textu požadavku, které se mají protokolovat. Int

Omezení:
Maximální hodnota = 8192

DataMasking

Jméno Popis Hodnota
hlavičky Nastavení maskování pro záhlaví DataMaskingEntity[]
queryParams Nastavení maskování pro parametry dotazu adresy URL DataMaskingEntity[]

DataMaskingEntity

Jméno Popis Hodnota
režim Režim maskování dat Skrýt
Maska
hodnota Název entity, která se má maskovat (např. název hlavičky nebo parametru dotazu). řetězec

DiagnosticContractProperties

Jméno Popis Hodnota
alwaysLog Určuje, jaký typ nastavení vzorkování zpráv se nemá použít. AllErrors
back-end Nastavení diagnostiky příchozích a odchozích zpráv HTTP do back-endu PipelineDiagnosticSettings
front-end Nastavení diagnostiky příchozích a odchozích zpráv HTTP pro bránu PipelineDiagnosticSettings
httpCorrelationProtocol Nastaví protokol korelace, který se použije pro diagnostiku Application Insights. Starší verze
None (Žádný)
W3C
logClientIp Protokolujte clientIP. Výchozí hodnota je false. Bool
loggerId ID prostředku cílového protokolovacího nástroje string (povinné)
metrika Generování vlastních metrik prostřednictvím zásad metrik generování Platí jenom pro nastavení diagnostiky Application Insights. Bool
operationNameFormat Formát názvu operace pro telemetrie Application Insights Výchozí hodnota je Název. Jméno
Adresa URL
vzorkování Nastavení vzorkování pro diagnostiku nastavení vzorkování
mnohomluvnost Úroveň podrobností použitá pro trasování vygenerované zásadami trasování. Chyba
"informace"
Slovesné

HttpMessageDiagnostic

Jméno Popis Hodnota
tělo Nastavení protokolování textu. BodyDiagnosticSettings
dataMasking Nastavení maskování dat DataMasking
hlavičky Pole hlaviček HTTP, které se mají protokolovat. string[]

Microsoft.ApiManagement/service/workspaces/apis/diagnostics

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
Model = ^[^*#&+:<>?]+$ (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: služba, pracovní prostory/ rozhraní API
vlastnosti Vlastnosti kontraktu diagnostických entit DiagnosticContractProperties
typ Typ prostředku Microsoft.ApiManagement/service/workspaces/apis/diagnostics@2024-05-01

PipelineDiagnosticSettings

Jméno Popis Hodnota
prosba Nastavení diagnostiky pro požadavek HttpMessageDiagnostic
odpověď Nastavení diagnostiky pro odpověď HttpMessageDiagnostic

SamplingSettings

Jméno Popis Hodnota
procento Míra vzorkování pro vzorkování s pevnou rychlostí Int

Omezení:
Minimální hodnota = 0
Maximální hodnota = 100
samplingType Typ vzorkování "Opraveno"