Microsoft.ApiManagement service/diagnostics 2023-05-01-preview

Artikel
01/18/2024

Bicep-resursdefinition

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

Resursgrupper – Se kommandon för resursgruppsdistribution

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

Resursformat

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

resource symbolicname 'Microsoft.ApiManagement/service/diagnostics@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    alwaysLog: 'allErrors'
    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: 'fixed'
    }
    verbosity: 'string'
  }
}

Egenskapsvärden

tjänst/diagnostik

Name	Beskrivning	Värde
name	Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep.	sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt.
parent	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 överordnad resurs.	Symboliskt namn för resurs av typen: tjänst
properties	Egenskaper för diagnostikentitetskontrakt.	DiagnosticContractProperties

DiagnosticContractProperties

Name	Beskrivning	Värde
alwaysLog	Anger vilken typ av meddelandesamplingsinställningar som inte ska tillämpas.	"allErrors"
backend	Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till serverdelen	PipelineDiagnosticSettings
Frontend	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 false.	boolesk
loggerId	Resurs-ID för en målloggare.	sträng (krävs)
metrics	Generera anpassade mått via principen för avsändande mått. Gäller endast för diagnostikinställningar för Application Insights.	boolesk
operationNameFormat	Formatet för åtgärdsnamnet för Application Insights-telemetri. Standardvärdet är Namn.	"Namn" "Url"
Provtagning	Samplingsinställningar för Diagnostik.	SamplingSettings
verbosity	Den verbositetsnivå som tillämpas på spårningar som genereras av spårningsprinciper.	"fel" "information" "utförlig"

PipelineDiagnosticSettings

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

HttpMessageDiagnostic

Name	Beskrivning	Värde
body	Inställningar för kroppsloggning.	BodyDiagnosticSettings
dataMaskering	Inställningar för datamaskering.	Datamaskering
Headers	Matris med HTTP-huvuden som ska loggas.	string[]

BodyDiagnosticSettings

Name	Beskrivning	Värde
Byte	Antal byte för begärandetext som ska loggas.	int

Datamaskering

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

DataMaskingEntity

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

SamplingSettings

Name	Beskrivning	Värde
percentage	Samplingsfrekvens för fast sampling.	int
samplingType	Samplingstyp.	"fast"

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall	Description
Skapa API Management i internt virtuellt nätverk 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.
Application Gateway med interna API Management och webbappar	Application Gateway att dirigera Internettrafik till ett virtuellt nätverk (internt läge) API Management instans som betjänar ett webb-API som finns i en Azure-webbapp.

Resursdefinition för ARM-mall

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

Resursgrupper – Se kommandon för resursgruppsdistribution

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

Resursformat

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

{
  "type": "Microsoft.ApiManagement/service/diagnostics",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "alwaysLog": "allErrors",
    "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": "fixed"
    },
    "verbosity": "string"
  }
}

Egenskapsvärden

tjänst/diagnostik

Name	Beskrivning	Värde
typ	Resurstypen	"Microsoft.ApiManagement/service/diagnostics"
apiVersion	Resurs-API-versionen	"2023-05-01-preview"
name	Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.	sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt.
properties	Egenskaper för diagnostikentitetskontrakt.	DiagnosticContractProperties

DiagnosticContractProperties

Name	Beskrivning	Värde
alwaysLog	Anger vilken typ av meddelandesamplingsinställningar som inte ska tillämpas.	"allErrors"
backend	Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till serverdelen	PipelineDiagnosticSettings
Frontend	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 false.	boolesk
loggerId	Resurs-ID för en målloggare.	sträng (krävs)
metrics	Generera anpassade mått via principen för avsändande mått. Gäller endast för diagnostikinställningar för Application Insights.	boolesk
operationNameFormat	Formatet för åtgärdsnamnet för Application Insights-telemetri. Standardvärdet är Namn.	"Namn" "Url"
Provtagning	Samplingsinställningar för Diagnostik.	SamplingSettings
verbosity	Den verbositetsnivå som tillämpas på spårningar som genereras av spårningsprinciper.	"fel" "information" "utförlig"

PipelineDiagnosticSettings

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

HttpMessageDiagnostic

Name	Beskrivning	Värde
body	Inställningar för kroppsloggning.	BodyDiagnosticSettings
dataMaskering	Inställningar för datamaskering.	Datamaskering
Headers	Matris med HTTP-huvuden som ska loggas.	string[]

BodyDiagnosticSettings

Name	Beskrivning	Värde
Byte	Antal byte för begärandetext som ska loggas.	int

Datamaskering

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

DataMaskingEntity

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

SamplingSettings

Name	Beskrivning	Värde
percentage	Samplingsfrekvens för fast sampling.	int
samplingType	Samplingstyp.	"fast"

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall	Description
Skapa API Management i internt virtuellt nätverk 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.
Application Gateway med interna API Management och webbappar	Application Gateway att dirigera Internettrafik till ett virtuellt nätverk (internt läge) API Management instans som betjänar ett webb-API som finns i en Azure-webbapp.

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 Resurs för Microsoft.ApiManagement/service/diagnostics lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/diagnostics@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      alwaysLog = "allErrors"
      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 = "fixed"
      }
      verbosity = "string"
    }
  })
}

Egenskapsvärden

tjänst/diagnostik

Name	Beskrivning	Värde
typ	Resurstypen	"Microsoft.ApiManagement/service/diagnostics@2023-05-01-preview"
name	Resursnamnet	sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt.
parent_id	ID:t för resursen som är överordnad för den här resursen.	ID för resurs av typen: tjänst
properties	Egenskaper för diagnostikentitetskontrakt.	DiagnosticContractProperties

DiagnosticContractProperties

Name	Beskrivning	Värde
alwaysLog	Anger vilken typ av meddelandesamplingsinställningar som inte ska tillämpas.	"allErrors"
backend	Diagnostikinställningar för inkommande/utgående HTTP-meddelanden till serverdelen	PipelineDiagnosticSettings
Frontend	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 false.	boolesk
loggerId	Resurs-ID för en målloggare.	sträng (krävs)
metrics	Generera anpassade mått via principen för utsända mått. Gäller endast för diagnostikinställningar för Application Insights.	boolesk
operationNameFormat	Formatet för åtgärdsnamnet för Application Insights-telemetrier. Standard är Namn.	"Namn" "Url"
Provtagning	Samplingsinställningar för diagnostik.	SamplingSettings
verbosity	Den verbositetsnivå som tillämpas på spårningar som genereras av spårningsprinciper.	"fel" "information" "utförlig"

PipelineDiagnosticSettings

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

HttpMessageDiagnostic

Name	Beskrivning	Värde
body	Inställningar för kroppsloggning.	BodyDiagnosticSettings
dataMaskering	Inställningar för datamaskering.	Datamaskering
Headers	Matris med HTTP-huvuden som ska loggas.	string[]

BodyDiagnosticSettings

Name	Beskrivning	Värde
Byte	Antal begärandetextbyte som ska loggas.	int

Datamaskering

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

DataMaskingEntity

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

SamplingSettings

Name	Beskrivning	Värde
percentage	Samplingshastighet för fast sampling.	int
samplingType	Samplingstyp.	"fast"

Dela via

Microsoft.ApiManagement service/diagnostics 2023-05-01-preview

Bicep-resursdefinition

Resursformat

Egenskapsvärden

tjänst/diagnostik

DiagnosticContractProperties

PipelineDiagnosticSettings

HttpMessageDiagnostic

BodyDiagnosticSettings

Datamaskering

DataMaskingEntity

SamplingSettings

Snabbstartsmallar

Resursdefinition för ARM-mall

Resursformat

Egenskapsvärden

tjänst/diagnostik

DiagnosticContractProperties

PipelineDiagnosticSettings

HttpMessageDiagnostic

BodyDiagnosticSettings

Datamaskering

DataMaskingEntity

SamplingSettings

Snabbstartsmallar

Resursdefinition för Terraform (AzAPI-provider)

Resursformat

Egenskapsvärden

tjänst/diagnostik

DiagnosticContractProperties

PipelineDiagnosticSettings

HttpMessageDiagnostic

BodyDiagnosticSettings

Datamaskering

DataMaskingEntity

SamplingSettings

Ytterligare resurser