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

• meest recente
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview-
• 2023-03-01-preview-
• 2022-09-01-preview-
• 2022-08-01
• 2022-04-01-preview-
• 2021-12-01-preview-
• 2021-08-01
• 2021-04-01-preview-
• 2021-01-01-preview-
• 2020-12-01
• 2020-06-01-preview-
• 2019-12-01
• 2019-12-01-preview-
• 2019-01-01
• 2018-06-01-preview-
• 2018-01-01
• 2017-03-01

Bicep-resourcedefinitie

Het resourcetype service/diagnostische gegevens kan worden geïmplementeerd met bewerkingen die zijn gericht op:

• Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.ApiManagement/service/diagnostics-resource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

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

Eigenschapswaarden

BodyDiagnosticSettings

Naam	Beschrijving	Waarde
Bytes	Aantal aanvraagbodybytes dat moet worden geregistreerd.	Int Beperkingen: Maximumwaarde = 8192

DataMasking

Naam	Beschrijving	Waarde
Headers	Maskeringsinstellingen voor kopteksten	DataMaskingEntity[]
queryParams	Maskeringsinstellingen voor URL-queryparameters	DataMaskingEntity[]

DataMaskingEntity

Naam	Beschrijving	Waarde
wijze	Modus voor gegevensmaskering.	'Verbergen' 'Masker'
waarde	De naam van een entiteit die moet worden gemaskeerd (bijvoorbeeld een naam van een header of een queryparameter).	snaar

DiagnosticContractProperties

Naam	Beschrijving	Waarde
alwaysLog	Hiermee geeft u op welk type instellingen voor het nemen van berichten niet van toepassing moeten zijn.	'allErrors'
back-end	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de back-end	PipelineDiagnosticSettings
front-end	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway.	PipelineDiagnosticSettings
httpCorrelationProtocol	Hiermee stelt u het correlatieprotocol in dat moet worden gebruikt voor Application Insights-diagnostische gegevens.	'Verouderd' 'Geen' 'W3C'
logClientIp	Registreer de ClientIP. De standaardwaarde is onwaar.	Bool
loggerId	Resource-id van een doellogger.	tekenreeks (vereist)
Statistieken	Aangepaste metrische gegevens verzenden via het beleid voor metrische gegevens verzenden. Alleen van toepassing op diagnostische instellingen van Application Insights.	Bool
operationNameFormat	De indeling van de bewerkingsnaam voor Application Insights-telemetrieën. De standaardwaarde is Naam.	'Naam' 'URL'
monsterneming	Sampling-instellingen voor Diagnostische gegevens.	SamplingSettings
langdradigheid	Het uitgebreidheidsniveau dat wordt toegepast op traceringen die worden verzonden door traceringsbeleid.	'fout' "informatie" 'uitgebreid'

HttpMessageDiagnostic

Naam	Beschrijving	Waarde
lichaam	Instellingen voor logboekregistratie van hoofdteksten.	BodyDiagnosticSettings
dataMasking	Instellingen voor gegevensmaskering.	DataMasking-
Headers	Matrix van HTTP-headers die moeten worden vastgelegd.	tekenreeks[]

Microsoft.ApiManagement/service/diagnostics

Naam	Beschrijving	Waarde
naam	De resourcenaam	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 Patroon = ^[^*#&+:<>?]+$ (vereist)
ouder	In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd. Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie.	Symbolische naam voor resource van het type: service
Eigenschappen	Contracteigenschappen voor diagnostische entiteiten.	DiagnosticContractProperties-

PipelineDiagnosticSettings

Naam	Beschrijving	Waarde
verzoek	Diagnostische instellingen voor aanvraag.	HttpMessageDiagnostic-
antwoord	Diagnostische instellingen voor antwoord.	HttpMessageDiagnostic-

SamplingSettings

Naam	Beschrijving	Waarde
percentage	De steekproeffrequentie voor steekproeven met vaste frequentie.	Int Beperkingen: Minimumwaarde = 0 Maximumwaarde = 100
samplingType	Steekproeftype.	'vast'

Quickstart-voorbeelden

In de volgende quickstartvoorbeelden wordt dit resourcetype geïmplementeerd.

Bicep-bestand	Beschrijving
Application Gateway met interne API Management en Web App	Application Gateway: internetverkeer routeren naar een API Management-exemplaar van een virtueel netwerk (interne modus) dat een web-API services die wordt gehost in een Azure-web-app.
API Management maken in intern VNet met App Gateway-	Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt op een particulier netwerk dat wordt beveiligd door Azure Application Gateway.

Resourcedefinitie van ARM-sjabloon

Het resourcetype service/diagnostische gegevens kan worden geïmplementeerd met bewerkingen die zijn gericht op:

• Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.ApiManagement/service/diagnostics-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

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

Eigenschapswaarden

BodyDiagnosticSettings

Naam	Beschrijving	Waarde
Bytes	Aantal aanvraagbodybytes dat moet worden geregistreerd.	Int Beperkingen: Maximumwaarde = 8192

DataMasking

Naam	Beschrijving	Waarde
Headers	Maskeringsinstellingen voor kopteksten	DataMaskingEntity[]
queryParams	Maskeringsinstellingen voor URL-queryparameters	DataMaskingEntity[]

DataMaskingEntity

Naam	Beschrijving	Waarde
wijze	Modus voor gegevensmaskering.	'Verbergen' 'Masker'
waarde	De naam van een entiteit die moet worden gemaskeerd (bijvoorbeeld een naam van een header of een queryparameter).	snaar

DiagnosticContractProperties

Naam	Beschrijving	Waarde
alwaysLog	Hiermee geeft u op welk type instellingen voor het nemen van berichten niet van toepassing moeten zijn.	'allErrors'
back-end	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de back-end	PipelineDiagnosticSettings
front-end	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway.	PipelineDiagnosticSettings
httpCorrelationProtocol	Hiermee stelt u het correlatieprotocol in dat moet worden gebruikt voor Application Insights-diagnostische gegevens.	'Verouderd' 'Geen' 'W3C'
logClientIp	Registreer de ClientIP. De standaardwaarde is onwaar.	Bool
loggerId	Resource-id van een doellogger.	tekenreeks (vereist)
Statistieken	Aangepaste metrische gegevens verzenden via het beleid voor metrische gegevens verzenden. Alleen van toepassing op diagnostische instellingen van Application Insights.	Bool
operationNameFormat	De indeling van de bewerkingsnaam voor Application Insights-telemetrieën. De standaardwaarde is Naam.	'Naam' 'URL'
monsterneming	Sampling-instellingen voor Diagnostische gegevens.	SamplingSettings
langdradigheid	Het uitgebreidheidsniveau dat wordt toegepast op traceringen die worden verzonden door traceringsbeleid.	'fout' "informatie" 'uitgebreid'

HttpMessageDiagnostic

Naam	Beschrijving	Waarde
lichaam	Instellingen voor logboekregistratie van hoofdteksten.	BodyDiagnosticSettings
dataMasking	Instellingen voor gegevensmaskering.	DataMasking-
Headers	Matrix van HTTP-headers die moeten worden vastgelegd.	tekenreeks[]

Microsoft.ApiManagement/service/diagnostics

Naam	Beschrijving	Waarde
apiVersion	De API-versie	'2022-04-01-preview'
naam	De resourcenaam	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 Patroon = ^[^*#&+:<>?]+$ (vereist)
Eigenschappen	Contracteigenschappen voor diagnostische entiteiten.	DiagnosticContractProperties-
type	Het resourcetype	'Microsoft.ApiManagement/service/diagnostics'

PipelineDiagnosticSettings

Naam	Beschrijving	Waarde
verzoek	Diagnostische instellingen voor aanvraag.	HttpMessageDiagnostic-
antwoord	Diagnostische instellingen voor antwoord.	HttpMessageDiagnostic-

SamplingSettings

Naam	Beschrijving	Waarde
percentage	De steekproeffrequentie voor steekproeven met vaste frequentie.	Int Beperkingen: Minimumwaarde = 0 Maximumwaarde = 100
samplingType	Steekproeftype.	'vast'

Quickstart-sjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Sjabloon	Beschrijving
Application Gateway met interne API Management en Web App	Application Gateway: internetverkeer routeren naar een API Management-exemplaar van een virtueel netwerk (interne modus) dat een web-API services die wordt gehost in een Azure-web-app.
API Management maken in intern VNet met App Gateway-	Deze sjabloon laat zien hoe u een exemplaar van Azure API Management maakt op een particulier netwerk dat wordt beveiligd door Azure Application Gateway.

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype service/diagnostische gegevens kan worden geïmplementeerd met bewerkingen die zijn gericht op:

• resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.ApiManagement/service/diagnostics-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

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

Eigenschapswaarden

BodyDiagnosticSettings

Naam	Beschrijving	Waarde
Bytes	Aantal aanvraagbodybytes dat moet worden geregistreerd.	Int Beperkingen: Maximumwaarde = 8192

DataMasking

Naam	Beschrijving	Waarde
Headers	Maskeringsinstellingen voor kopteksten	DataMaskingEntity[]
queryParams	Maskeringsinstellingen voor URL-queryparameters	DataMaskingEntity[]

DataMaskingEntity

Naam	Beschrijving	Waarde
wijze	Modus voor gegevensmaskering.	'Verbergen' 'Masker'
waarde	De naam van een entiteit die moet worden gemaskeerd (bijvoorbeeld een naam van een header of een queryparameter).	snaar

DiagnosticContractProperties

Naam	Beschrijving	Waarde
alwaysLog	Hiermee geeft u op welk type instellingen voor het nemen van berichten niet van toepassing moeten zijn.	'allErrors'
back-end	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de back-end	PipelineDiagnosticSettings
front-end	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway.	PipelineDiagnosticSettings
httpCorrelationProtocol	Hiermee stelt u het correlatieprotocol in dat moet worden gebruikt voor Application Insights-diagnostische gegevens.	'Verouderd' 'Geen' 'W3C'
logClientIp	Registreer de ClientIP. De standaardwaarde is onwaar.	Bool
loggerId	Resource-id van een doellogger.	tekenreeks (vereist)
Statistieken	Aangepaste metrische gegevens verzenden via het beleid voor metrische gegevens verzenden. Alleen van toepassing op diagnostische instellingen van Application Insights.	Bool
operationNameFormat	De indeling van de bewerkingsnaam voor Application Insights-telemetrieën. De standaardwaarde is Naam.	'Naam' 'URL'
monsterneming	Sampling-instellingen voor Diagnostische gegevens.	SamplingSettings
langdradigheid	Het uitgebreidheidsniveau dat wordt toegepast op traceringen die worden verzonden door traceringsbeleid.	'fout' "informatie" 'uitgebreid'

HttpMessageDiagnostic

Naam	Beschrijving	Waarde
lichaam	Instellingen voor logboekregistratie van hoofdteksten.	BodyDiagnosticSettings
dataMasking	Instellingen voor gegevensmaskering.	DataMasking-
Headers	Matrix van HTTP-headers die moeten worden vastgelegd.	tekenreeks[]

Microsoft.ApiManagement/service/diagnostics

Naam	Beschrijving	Waarde
naam	De resourcenaam	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 1 Patroon = ^[^*#&+:<>?]+$ (vereist)
parent_id	De id van de resource die het bovenliggende item voor deze resource is.	Id voor resource van het type: service-
Eigenschappen	Contracteigenschappen voor diagnostische entiteiten.	DiagnosticContractProperties-
type	Het resourcetype	"Microsoft.ApiManagement/service/diagnostics@2022-04-01-preview"

PipelineDiagnosticSettings

Naam	Beschrijving	Waarde
verzoek	Diagnostische instellingen voor aanvraag.	HttpMessageDiagnostic-
antwoord	Diagnostische instellingen voor antwoord.	HttpMessageDiagnostic-

SamplingSettings

Naam	Beschrijving	Waarde
percentage	De steekproeffrequentie voor steekproeven met vaste frequentie.	Int Beperkingen: Minimumwaarde = 0 Maximumwaarde = 100
samplingType	Steekproeftype.	'vast'