Dela via

Microsoft.ApiManagement service/diagnostics 2022-04-01-preview

  • Artikel

Bicep-resursdefinition

Resurstypen tjänst/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/diagnostics-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.ApiManagement/service/diagnostics@2022-04-01-preview' = {
  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'
  }
}

Egenskapsvärden

BodyDiagnosticSettings

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

Begränsningar:
Maxvärde = 8192

Datamaskering

Namn Beskrivning Värde
Headers Maskeringsinställningar för rubriker DataMaskingEntity[]
queryParams Maskeringsinställningar för URL-frågeparametrar DataMaskingEntity[]

DataMaskingEntity

Namn Beskrivning Värde
läge Datamaskeringsläge. "Dölj"
"Maskera"
värde Namnet på en entitet som ska maskeras (t.ex. ett namn på en rubrik eller en frågeparameter). sträng

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
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"
logClientIp Logga ClientIP. Standardvärdet är falskt. Bool
loggerId Resurs-ID för en målloggare. sträng (krävs)
metrik Generera anpassade mått via principen för utsända mått. Gäller endast diagnostikinställningar för Application Insights. Bool
operationNameFormat Formatet för åtgärdsnamnet för Application Insights-telemetrier. Standardvärdet är Namn. Namn
"Url"
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
dataMaskering Inställningar för datamaskering. DataMasking
Headers Matris med HTTP-huvuden som ska loggas. string[]

Microsoft.ApiManagement/service/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: tjänst
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"

Snabbstartsexempel

Följande snabbstartsexempel distribuerar den här resurstypen.

Bicep-fil Beskrivning
Application Gateway med intern API Management och Web App Application Gateway dirigerar Internettrafik till en API Management-instans för virtuellt nätverk (internt läge) som servar ett webb-API som finns i en Azure-webbapp.
Skapa API Management i internt VNet med App Gateway Den här mallen visar hur du skapar en instans av Azure API Management i ett privat nätverk som skyddas av Azure Application Gateway.

Resursdefinition för ARM-mall

Resurstypen tjänst/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/diagnostics-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.ApiManagement/service/diagnostics",
  "apiVersion": "2022-04-01-preview",
  "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"
  }
}

Egenskapsvärden

BodyDiagnosticSettings

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

Begränsningar:
Maxvärde = 8192

Datamaskering

Namn Beskrivning Värde
Headers Maskeringsinställningar för rubriker DataMaskingEntity[]
queryParams Maskeringsinställningar för URL-frågeparametrar DataMaskingEntity[]

DataMaskingEntity

Namn Beskrivning Värde
läge Datamaskeringsläge. "Dölj"
"Maskera"
värde Namnet på en entitet som ska maskeras (t.ex. ett namn på en rubrik eller en frågeparameter). sträng

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
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"
logClientIp Logga ClientIP. Standardvärdet är falskt. Bool
loggerId Resurs-ID för en målloggare. sträng (krävs)
metrik Generera anpassade mått via principen för utsända mått. Gäller endast diagnostikinställningar för Application Insights. Bool
operationNameFormat Formatet för åtgärdsnamnet för Application Insights-telemetrier. Standardvärdet är Namn. Namn
"Url"
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
dataMaskering Inställningar för datamaskering. DataMasking
Headers Matris med HTTP-huvuden som ska loggas. string[]

Microsoft.ApiManagement/service/diagnostics

Namn Beskrivning Värde
apiVersion API-versionen "2022-04-01-preview"
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/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"

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Beskrivning
Application Gateway med intern API Management och Web App

Distribuera till Azure 		Application Gateway dirigerar Internettrafik till en API Management-instans för virtuellt nätverk (internt läge) som servar ett webb-API som finns i en Azure-webbapp.
Skapa API Management i internt VNet med App Gateway

Distribuera till Azure 		Den här mallen visar hur du skapar en instans av Azure API Management i ett privat nätverk som skyddas av Azure Application Gateway.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen tjänst/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/diagnostics-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/diagnostics@2022-04-01-preview"
  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"
    }
  })
}

Egenskapsvärden

BodyDiagnosticSettings

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

Begränsningar:
Maxvärde = 8192

Datamaskering

Namn Beskrivning Värde
Headers Maskeringsinställningar för rubriker DataMaskingEntity[]
queryParams Maskeringsinställningar för URL-frågeparametrar DataMaskingEntity[]

DataMaskingEntity

Namn Beskrivning Värde
läge Datamaskeringsläge. "Dölj"
"Maskera"
värde Namnet på en entitet som ska maskeras (t.ex. ett namn på en rubrik eller en frågeparameter). sträng

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
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"
logClientIp Logga ClientIP. Standardvärdet är falskt. Bool
loggerId Resurs-ID för en målloggare. sträng (krävs)
metrik Generera anpassade mått via principen för utsända mått. Gäller endast diagnostikinställningar för Application Insights. Bool
operationNameFormat Formatet för åtgärdsnamnet för Application Insights-telemetrier. Standardvärdet är Namn. Namn
"Url"
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
dataMaskering Inställningar för datamaskering. DataMasking
Headers Matris med HTTP-huvuden som ska loggas. string[]

Microsoft.ApiManagement/service/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: tjänst
Egenskaper Egenskaper för diagnostikentitetskontrakt. DiagnosticContractProperties
typ Resurstypen "Microsoft.ApiManagement/service/diagnostics@2022-04-01-preview"

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"