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-avant-première
• 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 la propriété

Microsoft.ApiGestion/service/diagnostics

Nom	Descriptif	Valeur
nom	Nom de la ressource	corde Contraintes: Longueur minimale = 1 Longueur maximale = 80 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

BodyDiagnosticSettings

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

DiagnosticContractProperties

Nom	Descriptif	Valeur
toujoursJournal	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.	EchantillonnageParamètres

HttpMessageDiagnostic

Nom	Descriptif	Valeur
corps	Paramètres de journalisation du corps.	BodyDiagnosticSettings
En-têtes	Tableau d’en-têtes HTTP à journaliser.	chaîne de caractères[]

PipelineDiagnosticSettings

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

EchantillonnageParamètres

Nom	Descriptif	Valeur
pourcentage	Taux d’échantillonnage pour l’échantillonnage à taux fixe.	Int Contraintes: Valeur minimale = 0 Valeur maximale = 100
échantillonType	Type d’échantillonnage.	'fixe'

Exemples d’utilisation

Exemples de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants contiennent des exemples Bicep pour le déploiement de ce type de ressource.

Fichier Bicep	Descriptif
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 la propriété

Microsoft.ApiGestion/service/diagnostics

Nom	Descriptif	Valeur
apiVersion	Version de l’API	'2018-06-01-preview'
nom	Nom de la ressource	corde Contraintes: Longueur minimale = 1 Longueur maximale = 80 Modèle = ^[^*#&+:<>?]+$ (obligatoire)
Propriétés	Propriétés du contrat d’entité de diagnostic.	DiagnosticContractProperties
type	Type de ressource	'Microsoft.ApiManagement/service/diagnostics'

BodyDiagnosticSettings

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

DiagnosticContractProperties

Nom	Descriptif	Valeur
toujoursJournal	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.	EchantillonnageParamètres

HttpMessageDiagnostic

Nom	Descriptif	Valeur
corps	Paramètres de journalisation du corps.	BodyDiagnosticSettings
En-têtes	Tableau d’en-têtes HTTP à journaliser.	chaîne de caractères[]

PipelineDiagnosticSettings

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

EchantillonnageParamètres

Nom	Descriptif	Valeur
pourcentage	Taux d’échantillonnage pour l’échantillonnage à taux fixe.	Int Contraintes: Valeur minimale = 0 Valeur maximale = 100
échantillonType	Type d’échantillonnage.	'fixe'

Exemples d’utilisation

Modèles de démarrage rapide Microsoft Azure

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

Modèle	Descriptif
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"
  parent_id = "string"
  body = {
    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 la propriété

Microsoft.ApiGestion/service/diagnostics

Nom	Descriptif	Valeur
nom	Nom de la ressource	corde Contraintes: Longueur minimale = 1 Longueur maximale = 80 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 »

BodyDiagnosticSettings

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

DiagnosticContractProperties

Nom	Descriptif	Valeur
toujoursJournal	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.	EchantillonnageParamètres

HttpMessageDiagnostic

Nom	Descriptif	Valeur
corps	Paramètres de journalisation du corps.	BodyDiagnosticSettings
En-têtes	Tableau d’en-têtes HTTP à journaliser.	chaîne de caractères[]

PipelineDiagnosticSettings

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

EchantillonnageParamètres

Nom	Descriptif	Valeur
pourcentage	Taux d’échantillonnage pour l’échantillonnage à taux fixe.	Int Contraintes: Valeur minimale = 0 Valeur maximale = 100
échantillonType	Type d’échantillonnage.	'fixe'