Service Microsoft.ApiManagement/diagnostics 2018-06-01-preview

• dernière
• 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

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

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
loggerId	ID de ressource d’un enregistreur d’événements cible.	chaîne (obligatoire)
échantillonnage	Paramètres d’échantillonnage pour diagnostic.	SamplingSettings

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

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep	Description
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.
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.

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

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
loggerId	ID de ressource d’un enregistreur d’événements cible.	chaîne (obligatoire)
échantillonnage	Paramètres d’échantillonnage pour diagnostic.	SamplingSettings

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/diagnostics

Nom	Description	Valeur
apiVersion	Version de l’API	'2018-06-01-preview'
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/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'

Modèles de démarrage rapide

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

Modèle	Description
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.
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.

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

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
loggerId	ID de ressource d’un enregistreur d’événements cible.	chaîne (obligatoire)
échantillonnage	Paramètres d’échantillonnage pour diagnostic.	SamplingSettings

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/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 : de service
Propriétés	Propriétés du contrat d’entité de diagnostic.	DiagnosticContractProperties
type	Type de ressource	« Microsoft.ApiManagement/service/diagnostics@2018-06-01-preview »

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'