Partager via

Service Microsoft.ApiManagement/apis/diagnostics 2019-01-01

  • Article

Définition de ressource Bicep

Le type de ressource service/apis/diagnostics peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.ApiManagement/service/apis/diagnostics, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ApiManagement/service/apis/diagnostics@2019-01-01' = {
  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'
        ]
      }
    }
    httpCorrelationProtocol: 'string'
    loggerId: 'string'
    sampling: {
      percentage: int
      samplingType: 'string'
    }
    verbosity: 'string'
  }
}

Valeurs de propriété

BodyDiagnosticSettings

Nom Description Valeur
Octets Nombre d’octets du corps de la demande à consigner. Int

Contraintes:
Valeur maximale = 8192

DiagnosticContractProperties

Nom Description Valeur
alwaysLog Spécifie le type de paramètres d’échantillonnage des messages qui ne doivent pas s’appliquer. 'allErrors'
back-end Paramètres de diagnostic pour les messages HTTP entrants/sortants vers le serveur principal PipelineDiagnosticSettings
enableHttpCorrelationHeaders Indique s’il faut traiter les en-têtes de corrélation entrants dans le service Gestion des API. Applicable uniquement aux diagnostics Application Insights. La valeur par défaut est true. Bool
frontend Paramètres de diagnostic pour les messages HTTP entrants/sortants vers la passerelle. PipelineDiagnosticSettings
httpCorrelationProtocol Définit le protocole de corrélation à utiliser pour les diagnostics Application Insights. 'Legacy'
'None'
'W3C'
loggerId ID de ressource d’un enregistreur d’événements cible. chaîne (obligatoire)
échantillonnage Paramètres d’échantillonnage pour diagnostic. SamplingSettings
verbosité Niveau de détail appliqué aux traces émises par les stratégies de trace. 'error'
'information'
'verbose'

HttpMessageDiagnostic

Nom Description Valeur
corps Paramètres de journalisation du corps. BodyDiagnosticSettings
En-têtes Tableau d’en-têtes HTTP à journaliser. string[]

Microsoft.ApiManagement/service/apis/diagnostics

Nom Description Valeur
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
Modèle = ^[^*#&+:<>?]+$ (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : service/apis
Propriétés Propriétés du contrat d’entité de diagnostic. DiagnosticContractProperties

PipelineDiagnosticSettings

Nom Description Valeur
demander Paramètres de diagnostic pour la demande. HttpMessageDiagnostic
réponse Paramètres de diagnostic pour la réponse. HttpMessageDiagnostic

SamplingSettings

Nom Description Valeur
pourcentage Taux d’échantillonnage pour l’échantillonnage à taux fixe. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 100
samplingType Type d’échantillonnage. 'fixe'

Définition de ressource de modèle ARM

Le type de ressource service/apis/diagnostics peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.ApiManagement/service/apis/diagnostics, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.ApiManagement/service/apis/diagnostics",
  "apiVersion": "2019-01-01",
  "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" ]
      }
    },
    "httpCorrelationProtocol": "string",
    "loggerId": "string",
    "sampling": {
      "percentage": "int",
      "samplingType": "string"
    },
    "verbosity": "string"
  }
}

Valeurs de propriété

BodyDiagnosticSettings

Nom Description Valeur
Octets Nombre d’octets du corps de la demande à consigner. Int

Contraintes:
Valeur maximale = 8192

DiagnosticContractProperties

Nom Description Valeur
alwaysLog Spécifie le type de paramètres d’échantillonnage des messages qui ne doivent pas s’appliquer. 'allErrors'
back-end Paramètres de diagnostic pour les messages HTTP entrants/sortants vers le serveur principal PipelineDiagnosticSettings
enableHttpCorrelationHeaders Indique s’il faut traiter les en-têtes de corrélation entrants dans le service Gestion des API. Applicable uniquement aux diagnostics Application Insights. La valeur par défaut est true. Bool
frontend Paramètres de diagnostic pour les messages HTTP entrants/sortants vers la passerelle. PipelineDiagnosticSettings
httpCorrelationProtocol Définit le protocole de corrélation à utiliser pour les diagnostics Application Insights. 'Legacy'
'None'
'W3C'
loggerId ID de ressource d’un enregistreur d’événements cible. chaîne (obligatoire)
échantillonnage Paramètres d’échantillonnage pour diagnostic. SamplingSettings
verbosité Niveau de détail appliqué aux traces émises par les stratégies de trace. 'error'
'information'
'verbose'

HttpMessageDiagnostic

Nom Description Valeur
corps Paramètres de journalisation du corps. BodyDiagnosticSettings
En-têtes Tableau d’en-têtes HTTP à journaliser. string[]

Microsoft.ApiManagement/service/apis/diagnostics

Nom Description Valeur
apiVersion Version de l’API '2019-01-01'
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
Modèle = ^[^*#&+:<>?]+$ (obligatoire)
Propriétés Propriétés du contrat d’entité de diagnostic. DiagnosticContractProperties
type Type de ressource 'Microsoft.ApiManagement/service/apis/diagnostics'

PipelineDiagnosticSettings

Nom Description Valeur
demander Paramètres de diagnostic pour la demande. HttpMessageDiagnostic
réponse Paramètres de diagnostic pour la réponse. HttpMessageDiagnostic

SamplingSettings

Nom Description Valeur
pourcentage Taux d’échantillonnage pour l’échantillonnage à taux fixe. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 100
samplingType Type d’échantillonnage. 'fixe'

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource service/apis/diagnostics peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.ApiManagement/service/apis/diagnostics, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/diagnostics@2019-01-01"
  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"
          ]
        }
      }
      httpCorrelationProtocol = "string"
      loggerId = "string"
      sampling = {
        percentage = int
        samplingType = "string"
      }
      verbosity = "string"
    }
  })
}

Valeurs de propriété

BodyDiagnosticSettings

Nom Description Valeur
Octets Nombre d’octets du corps de la demande à consigner. Int

Contraintes:
Valeur maximale = 8192

DiagnosticContractProperties

Nom Description Valeur
alwaysLog Spécifie le type de paramètres d’échantillonnage des messages qui ne doivent pas s’appliquer. 'allErrors'
back-end Paramètres de diagnostic pour les messages HTTP entrants/sortants vers le serveur principal PipelineDiagnosticSettings
enableHttpCorrelationHeaders Indique s’il faut traiter les en-têtes de corrélation entrants dans le service Gestion des API. Applicable uniquement aux diagnostics Application Insights. La valeur par défaut est true. Bool
frontend Paramètres de diagnostic pour les messages HTTP entrants/sortants vers la passerelle. PipelineDiagnosticSettings
httpCorrelationProtocol Définit le protocole de corrélation à utiliser pour les diagnostics Application Insights. 'Legacy'
'None'
'W3C'
loggerId ID de ressource d’un enregistreur d’événements cible. chaîne (obligatoire)
échantillonnage Paramètres d’échantillonnage pour diagnostic. SamplingSettings
verbosité Niveau de détail appliqué aux traces émises par les stratégies de trace. 'error'
'information'
'verbose'

HttpMessageDiagnostic

Nom Description Valeur
corps Paramètres de journalisation du corps. BodyDiagnosticSettings
En-têtes Tableau d’en-têtes HTTP à journaliser. string[]

Microsoft.ApiManagement/service/apis/diagnostics

Nom Description Valeur
nom Nom de la ressource corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
Modèle = ^[^*#&+:<>?]+$ (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : service/apis
Propriétés Propriétés du contrat d’entité de diagnostic. DiagnosticContractProperties
type Type de ressource « Microsoft.ApiManagement/service/apis/diagnostics@2019-01-01 »

PipelineDiagnosticSettings

Nom Description Valeur
demander Paramètres de diagnostic pour la demande. HttpMessageDiagnostic
réponse Paramètres de diagnostic pour la réponse. HttpMessageDiagnostic

SamplingSettings

Nom Description Valeur
pourcentage Taux d’échantillonnage pour l’échantillonnage à taux fixe. Int

Contraintes:
Valeur minimale = 0
Valeur maximale = 100
samplingType Type d’échantillonnage. 'fixe'