Služba Microsoft.ApiManagement / diagnostika 2020-12-01

Článek
12/21/2024

nejnovější
2024-06-01-preview
2024-05-01
2023-09-01-preview
2023-05-01-preview
1. 3. 2023 ve verzi Preview
2022-09-01-preview
2022-08-01
2022-04-01-preview
12. 12. 2021 ve verzi Preview
2021-08-01
2021-04-01-preview
2021-01-01-preview
12. 12. 2020
2020-06-01-preview
12. 12. 2019
12. 12. 2019
1. 1. 2019
06. 6. 2018 ve verzi Preview
1. 1. 2018
03.03.2017

Definice prostředku Bicep

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

skupiny prostředků – viz příkazy nasazení 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/diagnostics, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.ApiManagement/service/diagnostics@2020-12-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/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žby
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"

Ukázky rychlého startu

Následující ukázky rychlého startu nasadí tento typ prostředku.

Soubor Bicep	Popis
Application Gateway s interní službou API Management a webovou aplikací	Služba Application Gateway směruje internetový provoz do instance služby API Management (interní režim), která obsluhuje webové rozhraní API hostované ve webové aplikaci Azure.
vytvoření služby API Management v interní virtuální síti s služby App Gateway	Tato šablona ukazuje, jak vytvořit instanci služby Azure API Management v privátní síti chráněné službou Azure Application Gateway.

Definice prostředku šablony ARM

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

skupiny prostředků – viz příkazy nasazení 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/diagnostics, přidejte do šablony následující KÓD JSON.

{
  "type": "Microsoft.ApiManagement/service/diagnostics",
  "apiVersion": "2020-12-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/diagnostics

Jméno	Popis	Hodnota
apiVersion	Verze rozhraní API	'2020-12-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/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"

Šablony pro rychlý start

Následující šablony pro rychlý start nasazují tento typ prostředku.

Šablona	Popis
Application Gateway s interní službou API Management a webovou aplikací nasazení	Služba Application Gateway směruje internetový provoz do instance služby API Management (interní režim), která obsluhuje webové rozhraní API hostované ve webové aplikaci Azure.
vytvoření služby API Management v interní virtuální síti s služby App Gateway nasazení	Tato šablona ukazuje, jak vytvořit instanci služby Azure API Management v privátní síti chráněné službou Azure Application Gateway.

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku služby/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/diagnostics, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/diagnostics@2020-12-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/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žby
vlastnosti	Vlastnosti kontraktu diagnostických entit	DiagnosticContractProperties
typ	Typ prostředku	Microsoft.ApiManagement/service/diagnostics@2020-12-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"

Sdílet prostřednictvím

Služba Microsoft.ApiManagement / diagnostika 2020-12-01

Definice prostředku Bicep

Formát prostředku

Hodnoty vlastností

BodyDiagnosticSettings

DataMasking

DataMaskingEntity

DiagnosticContractProperties

HttpMessageDiagnostic

Microsoft.ApiManagement/service/diagnostics

PipelineDiagnosticSettings

SamplingSettings

Ukázky rychlého startu

Definice prostředku šablony ARM

Formát prostředku

Hodnoty vlastností

BodyDiagnosticSettings

DataMasking

DataMaskingEntity

DiagnosticContractProperties

HttpMessageDiagnostic

Microsoft.ApiManagement/service/diagnostics

PipelineDiagnosticSettings

SamplingSettings

Šablony pro rychlý start

Definice prostředku Terraformu (poskytovatel AzAPI)

Formát prostředku

Hodnoty vlastností

BodyDiagnosticSettings

DataMasking

DataMaskingEntity

DiagnosticContractProperties

HttpMessageDiagnostic

Microsoft.ApiManagement/service/diagnostics

PipelineDiagnosticSettings

SamplingSettings

Váš názor

Další materiály