Service Microsoft.ApiManagement/diagnostics 2022-09-01-preview

• La plus récente
• 2023-05-01-preview
• Préversion du 01/03/2023
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview

Définition de ressource Bicep

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

• Groupes de ressources - Voir commandes de déploiement de groupe de ressources

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

Format des ressources

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

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

Valeurs de propriétés

service/diagnostics

Nom	Description	Valeur
name	Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.	string (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique.
parent	Dans Bicep, vous pouvez spécifier la ressource parente pour 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
properties	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'
Serveur principal	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	Journalisez le ClientIP. La valeur par défaut est false.	bool
loggerId	ID de ressource d’un enregistreur d’événements cible.	string (obligatoire)
Mesures	É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 suivi.	'error' 'information' 'verbose'

PipelineDiagnosticSettings

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

HttpMessageDiagnostic

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

BodyDiagnosticSettings

Nom	Description	Valeur
octets	Nombre d’octets du corps de la demande à journaliser.	int

DataMasking

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

DataMaskingEntity

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

SamplingSettings

Nom	Description	Valeur
percentage	Taux d’échantillonnage pour l’échantillonnage à taux fixe.	int
samplingType	Type d’échantillonnage.	'fixed'

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 des Gestion des API dans un réseau virtuel interne avec App Gateway	Ce modèle montre comment créer un instance de Gestion des API Azure sur un réseau privé protégé par Azure Application Gateway.
Application Gateway avec l’Gestion des API interne et l’application web	Application Gateway le routage du trafic Internet vers un réseau virtuel (mode interne) Gestion des API instance qui dessert une API web hébergée dans une application web Azure.

Définition de ressources de modèle ARM

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

• Groupes de ressources - Voir commandes de déploiement de groupe de ressources

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

Format des ressources

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

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

Valeurs de propriétés

service/diagnostics

Nom	Description	Valeur
type	Type de ressource	« Microsoft.ApiManagement/service/diagnostics »
apiVersion	Version de l’API de ressource	'2022-09-01-preview'
name	Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.	string (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique.
properties	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'
Serveur principal	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	Consignez le ClientIP. La valeur par défaut est false.	bool
loggerId	ID de ressource d’un enregistreur d’événements cible.	chaîne (obligatoire)
Mesures	Émettre des métriques personnalisées via une stratégie de métrique d’émission. Applicable uniquement aux paramètres de diagnostic Application Insights.	bool
operationNameFormat	Format du nom de l’opération pour les télémetries 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 suivi.	'error' 'information' 'détaillé'

PipelineDiagnosticSettings

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

HttpMessageDiagnostic

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

BodyDiagnosticSettings

Nom	Description	Valeur
octets	Nombre d’octets du corps de la requête à consigner.	int

DataMasking

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

DataMaskingEntity

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

SamplingSettings

Nom	Description	Valeur
percentage	Taux d’échantillonnage pour l’échantillonnage à taux fixe.	int
samplingType	Type d’échantillonnage.	'fixed'

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 des Gestion des API dans un réseau virtuel interne avec App Gateway	Ce modèle montre comment créer un instance d’Azure Gestion des API sur un réseau privé protégé par Azure Application Gateway.
Application Gateway avec Gestion des API interne et Web App	Application Gateway le routage du trafic Internet vers un réseau virtuel (mode interne) Gestion des API instance qui traite une API web hébergée dans une application web Azure.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource 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 des ressources

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

Valeurs de propriétés

service/diagnostics

Nom	Description	Valeur
type	Type de ressource	« Microsoft.ApiManagement/service/diagnostics@2022-09-01-preview »
name	Nom de la ressource	string (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique.
parent_id	ID de la ressource qui est le parent de cette ressource.	ID de ressource de type : service
properties	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 »
Serveur principal	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é » "None" « W3C »
logClientIp	Journalisez le ClientIP. La valeur par défaut est false.	bool
loggerId	ID de ressource d’un enregistreur d’événements cible.	string (obligatoire)
Mesures	É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 suivi.	« erreur » « information » « verbose »

PipelineDiagnosticSettings

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

HttpMessageDiagnostic

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

BodyDiagnosticSettings

Nom	Description	Valeur
octets	Nombre d’octets du corps de la demande à journaliser.	int

DataMasking

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

DataMaskingEntity

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

SamplingSettings

Nom	Description	Valeur
percentage	Taux d’échantillonnage pour l’échantillonnage à taux fixe.	int
samplingType	Type d’échantillonnage.	« fixe »