Microsoft.ApiManagement-service/apis/diagnostics 2018-06-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/apis/diagnostics 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 Resource microsoft.ApiManagement/service/apis/diagnostics wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.ApiManagement/service/apis/diagnostics@2018-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    alwaysLog: 'string'
    backend: {
      request: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
      response: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
    }
    enableHttpCorrelationHeaders: bool
    frontend: {
      request: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
      response: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
    }
    loggerId: 'string'
    sampling: {
      percentage: int
      samplingType: 'string'
    }
  }
}

Eigenschapswaarden

BodyDiagnosticSettings

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

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
enableHttpCorrelationHeaders	Of correlatieheaders naar Api Management Service moeten worden verwerkt. Alleen van toepassing op Diagnostische gegevens van Application Insights. De standaardwaarde is waar.	Bool
front-end	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway.	PipelineDiagnosticSettings
loggerId	Resource-id van een doellogger.	tekenreeks (vereist)
monsterneming	Sampling-instellingen voor Diagnostische gegevens.	SamplingSettings

HttpMessageDiagnostic

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

Microsoft.ApiManagement/service/apis/diagnostics

Naam	Beschrijving	Waarde
naam	De resourcenaam	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 80 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/api's
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'

Resourcedefinitie van ARM-sjabloon

Het resourcetype service/apis/diagnostics 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 Resource microsoft.ApiManagement/service/apis/diagnostics wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.ApiManagement/service/apis/diagnostics",
  "apiVersion": "2018-06-01-preview",
  "name": "string",
  "properties": {
    "alwaysLog": "string",
    "backend": {
      "request": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      },
      "response": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      }
    },
    "enableHttpCorrelationHeaders": "bool",
    "frontend": {
      "request": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      },
      "response": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      }
    },
    "loggerId": "string",
    "sampling": {
      "percentage": "int",
      "samplingType": "string"
    }
  }
}

Eigenschapswaarden

BodyDiagnosticSettings

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

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
enableHttpCorrelationHeaders	Of correlatieheaders naar Api Management Service moeten worden verwerkt. Alleen van toepassing op Diagnostische gegevens van Application Insights. De standaardwaarde is waar.	Bool
front-end	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway.	PipelineDiagnosticSettings
loggerId	Resource-id van een doellogger.	tekenreeks (vereist)
monsterneming	Sampling-instellingen voor Diagnostische gegevens.	SamplingSettings

HttpMessageDiagnostic

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

Microsoft.ApiManagement/service/apis/diagnostics

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

Gebruiksvoorbeelden

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype service/apis/diagnostics 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 Resource microsoft.ApiManagement/service/apis/diagnostics wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/diagnostics@2018-06-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      alwaysLog = "string"
      backend = {
        request = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
        response = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
      }
      enableHttpCorrelationHeaders = bool
      frontend = {
        request = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
        response = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
      }
      loggerId = "string"
      sampling = {
        percentage = int
        samplingType = "string"
      }
    }
  })
}

Eigenschapswaarden

BodyDiagnosticSettings

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

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
enableHttpCorrelationHeaders	Of correlatieheaders naar Api Management Service moeten worden verwerkt. Alleen van toepassing op Diagnostische gegevens van Application Insights. De standaardwaarde is waar.	Bool
front-end	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway.	PipelineDiagnosticSettings
loggerId	Resource-id van een doellogger.	tekenreeks (vereist)
monsterneming	Sampling-instellingen voor Diagnostische gegevens.	SamplingSettings

HttpMessageDiagnostic

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

Microsoft.ApiManagement/service/apis/diagnostics

Naam	Beschrijving	Waarde
naam	De resourcenaam	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 80 Patroon = ^[^*#&+:<>?]+$ (vereist)
parent_id	De id van de resource die het bovenliggende item voor deze resource is.	Id voor resource van het type: service/API's
Eigenschappen	Contracteigenschappen voor diagnostische entiteiten.	DiagnosticContractProperties-
type	Het resourcetype	"Microsoft.ApiManagement/service/apis/diagnostics@2018-06-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'