Service Microsoft.ApiManagement/diagnostics 2022-08-01

Article
07/24/2024

Définition de ressource Bicep

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

groupes de ressources - Consultez commandes de déploiement de 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/diagnostics, ajoutez le bicep suivant à votre modèle.

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

Valeurs de propriété

service/diagnostics

Nom	Description	Valeur
nom	Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans Bicep.	chaîne (obligatoire) Limite de caractères : 1 à 80 Caractères valides : Alphanumériques et traits d’union. Commencez par la lettre et terminez par alphanumérique.
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
Propriétés	Propriétés du contrat d’entité de diagnostic.	DiagnosticContractProperties

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
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'
logClientIp	Journaliser Le ClientIP. La valeur par défaut est false.	Bool
loggerId	ID de ressource d’un enregistreur d’événements cible.	chaîne (obligatoire)
métrique	Émettre des métriques personnalisées via une stratégie d’émission de métriques. Applicable uniquement aux paramètres de diagnostic Application Insights.	Bool
operationNameFormat	Format du nom de l’opération pour les télémétries Application Insights. La valeur par défaut est Name.	'Name' 'Url'
é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'

PipelineDiagnosticSettings

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

HttpMessageDiagnostic

Nom	Description	Valeur
corps	Paramètres de journalisation du corps.	BodyDiagnosticSettings
dataMasking	Paramètres de masquage des données.	DataMasking
En-têtes	Tableau d’en-têtes HTTP à journaliser.	string[]

BodyDiagnosticSettings

Nom	Description	Valeur
Octets	Nombre d’octets du corps de la demande à consigner.	Int Contraintes: Valeur maximale = 8192

DataMasking

Nom	Description	Valeur
En-têtes	Paramètres de masquage des en-têtes	DataMaskingEntity[]
queryParams	Paramètres de masquage des paramètres de requête d’URL	DataMaskingEntity[]

DataMaskingEntity

Nom	Description	Valeur
mode	Mode de masquage des données.	'Masquer' 'Mask'
valeur	Nom d’une entité à masquer (par exemple, un nom d’en-tête ou un paramètre de requête).	corde

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'

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
Créer une gestion des API dans un réseau virtuel interne avec app Gateway	Ce modèle montre comment créer une instance de Gestion des API Azure sur un réseau privé protégé par Azure Application Gateway.
Application Gateway avec gestion des API internes et d’application web	Application Gateway achemine le trafic Internet vers une instance de gestion des API de réseau virtuel (mode interne) qui services une API web hébergée dans une application web Azure.

Définition de ressource de modèle ARM

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

groupes de ressources - Consultez commandes de déploiement de 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/diagnostics, ajoutez le code JSON suivant à votre modèle.

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

Valeurs de propriété

service/diagnostics

Nom	Description	Valeur
type	Type de ressource	'Microsoft.ApiManagement/service/diagnostics'
apiVersion	Version de l’API de ressource	'2022-08-01'
nom	Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans modèles ARM JSON.	chaîne (obligatoire) Limite de caractères : 1 à 80 Caractères valides : Alphanumériques et traits d’union. Commencez par la lettre et terminez par alphanumérique.
Propriétés	Propriétés du contrat d’entité de diagnostic.	DiagnosticContractProperties

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
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'
logClientIp	Journaliser Le ClientIP. La valeur par défaut est false.	Bool
loggerId	ID de ressource d’un enregistreur d’événements cible.	chaîne (obligatoire)
métrique	Émettre des métriques personnalisées via une stratégie d’émission de métriques. Applicable uniquement aux paramètres de diagnostic Application Insights.	Bool
operationNameFormat	Format du nom de l’opération pour les télémétries Application Insights. La valeur par défaut est Name.	'Name' 'Url'
é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'

PipelineDiagnosticSettings

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

HttpMessageDiagnostic

Nom	Description	Valeur
corps	Paramètres de journalisation du corps.	BodyDiagnosticSettings
dataMasking	Paramètres de masquage des données.	DataMasking
En-têtes	Tableau d’en-têtes HTTP à journaliser.	string[]

BodyDiagnosticSettings

Nom	Description	Valeur
Octets	Nombre d’octets du corps de la demande à consigner.	Int Contraintes: Valeur maximale = 8192

DataMasking

Nom	Description	Valeur
En-têtes	Paramètres de masquage des en-têtes	DataMaskingEntity[]
queryParams	Paramètres de masquage des paramètres de requête d’URL	DataMaskingEntity[]

DataMaskingEntity

Nom	Description	Valeur
mode	Mode de masquage des données.	'Masquer' 'Mask'
valeur	Nom d’une entité à masquer (par exemple, un nom d’en-tête ou un paramètre de requête).	corde

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'

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
Créer une gestion des API dans un réseau virtuel interne avec app Gateway	Ce modèle montre comment créer une instance de Gestion des API Azure sur un réseau privé protégé par Azure Application Gateway.
Application Gateway avec gestion des API internes et d’application web	Application Gateway achemine le trafic Internet vers une instance de gestion des API de réseau virtuel (mode interne) qui services une API web hébergée dans une application web Azure.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource de service/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/diagnostics, ajoutez le terraform suivant à votre modèle.

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

Valeurs de propriété

service/diagnostics

Nom	Description	Valeur
type	Type de ressource	« Microsoft.ApiManagement/service/diagnostics@2022-08-01 »
nom	Nom de la ressource	chaîne (obligatoire) Limite de caractères : 1 à 80 Caractères valides : Alphanumériques et traits d’union. Commencez par la lettre et terminez par alphanumérique.
parent_id	ID de la ressource qui est le parent de cette ressource.	ID de ressource de type : de service
Propriétés	Propriétés du contrat d’entité de diagnostic.	DiagnosticContractProperties

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
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.	« Hérité » « Aucun » « W3C »
logClientIp	Journaliser Le ClientIP. La valeur par défaut est false.	Bool
loggerId	ID de ressource d’un enregistreur d’événements cible.	chaîne (obligatoire)
métrique	Émettre des métriques personnalisées via une stratégie d’émission de métriques. Applicable uniquement aux paramètres de diagnostic Application Insights.	Bool
operationNameFormat	Format du nom de l’opération pour les télémétries Application Insights. La valeur par défaut est Name.	« Name » « Url »
échantillonnage	Paramètres d’échantillonnage pour diagnostic.	SamplingSettings
verbosité	Niveau de détail appliqué aux traces émises par les stratégies de trace.	« erreur » « information » « détaillé »

PipelineDiagnosticSettings

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

HttpMessageDiagnostic

Nom	Description	Valeur
corps	Paramètres de journalisation du corps.	BodyDiagnosticSettings
dataMasking	Paramètres de masquage des données.	DataMasking
En-têtes	Tableau d’en-têtes HTTP à journaliser.	string[]

BodyDiagnosticSettings

Nom	Description	Valeur
Octets	Nombre d’octets du corps de la demande à consigner.	Int Contraintes: Valeur maximale = 8192

DataMasking

Nom	Description	Valeur
En-têtes	Paramètres de masquage des en-têtes	DataMaskingEntity[]
queryParams	Paramètres de masquage des paramètres de requête d’URL	DataMaskingEntity[]

DataMaskingEntity

Nom	Description	Valeur
mode	Mode de masquage des données.	« Masquer » « Mask »
valeur	Nom d’une entité à masquer (par exemple, un nom d’en-tête ou un paramètre de requête).	corde

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 »

Partager via

Service Microsoft.ApiManagement/diagnostics 2022-08-01

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

service/diagnostics

DiagnosticContractProperties

PipelineDiagnosticSettings

HttpMessageDiagnostic

BodyDiagnosticSettings

DataMasking

DataMaskingEntity

SamplingSettings

Modèles de démarrage rapide

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

service/diagnostics

DiagnosticContractProperties

PipelineDiagnosticSettings

HttpMessageDiagnostic

BodyDiagnosticSettings

DataMasking

DataMaskingEntity

SamplingSettings

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

service/diagnostics

DiagnosticContractProperties

PipelineDiagnosticSettings

HttpMessageDiagnostic

BodyDiagnosticSettings

DataMasking

DataMaskingEntity

SamplingSettings

Commentaires

Ressources supplémentaires