Partager via

Service Microsoft.ApiManagement/enregistreurs d’événements 2024-05-01

  • Article

Définition de ressource Bicep

Le type de ressource service/enregistreurs d’événements 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/loggers, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ApiManagement/service/loggers@2024-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    credentials: {
      {customized property}: 'string'
    }
    description: 'string'
    isBuffered: bool
    loggerType: 'string'
    resourceId: 'string'
  }
}

Valeurs de propriété

LoggerContractProperties

Nom Description Valeur
Pouvoirs Nom et chaîne de connexion SendRule du hub d’événements pour l’enregistreur d’événements AzureEventHub.
Clé d’instrumentation pour l’enregistreur d’événements ApplicationInsights.		 LoggerContractPropertiesCredentials
description Description de l’enregistreur d’événements. corde

Contraintes:
Longueur maximale =
isBuffered Indique si les enregistrements sont mis en mémoire tampon dans l’enregistreur d’événements avant la publication. La valeur par défaut est supposée être true. Bool
loggerType Type d’enregistreur d’événements. 'applicationInsights'
'azureEventHub'
'azureMonitor' (obligatoire)
resourceId ID de ressource Azure d’une cible de journal (ressource Azure Event Hub ou ressource Azure Application Insights). corde

LoggerContractPropertiesCredentials

Nom Description Valeur

Microsoft.ApiManagement/service/enregistreurs d’événements

Nom Description Valeur
nom Nom de la ressource corde

Contraintes:
Longueur maximale =
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é d’enregistreur d’événements. LoggerContractProperties

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.
Analyse de l’API Moesif et de monétisation Le modèle journalisera les appels d’API de Gestion des API Azure à l’analytique des API Moesif et à la plateforme de monétisation

Définition de ressource de modèle ARM

Le type de ressource service/enregistreurs d’événements 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/loggers, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.ApiManagement/service/loggers",
  "apiVersion": "2024-05-01",
  "name": "string",
  "properties": {
    "credentials": {
      "{customized property}": "string"
    },
    "description": "string",
    "isBuffered": "bool",
    "loggerType": "string",
    "resourceId": "string"
  }
}

Valeurs de propriété

LoggerContractProperties

Nom Description Valeur
Pouvoirs Nom et chaîne de connexion SendRule du hub d’événements pour l’enregistreur d’événements AzureEventHub.
Clé d’instrumentation pour l’enregistreur d’événements ApplicationInsights.		 LoggerContractPropertiesCredentials
description Description de l’enregistreur d’événements. corde

Contraintes:
Longueur maximale =
isBuffered Indique si les enregistrements sont mis en mémoire tampon dans l’enregistreur d’événements avant la publication. La valeur par défaut est supposée être true. Bool
loggerType Type d’enregistreur d’événements. 'applicationInsights'
'azureEventHub'
'azureMonitor' (obligatoire)
resourceId ID de ressource Azure d’une cible de journal (ressource Azure Event Hub ou ressource Azure Application Insights). corde

LoggerContractPropertiesCredentials

Nom Description Valeur

Microsoft.ApiManagement/service/enregistreurs d’événements

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

Contraintes:
Longueur maximale =
Modèle = ^[^*#&+:<>?]+$ (obligatoire)
Propriétés Propriétés du contrat d’entité d’enregistreur d’événements. LoggerContractProperties
type Type de ressource 'Microsoft.ApiManagement/service/loggers'

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

Déployer sur Azure 		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

Déployer sur Azure 		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.
Créer Azure Front Door devant la Gestion des API Azure

Déployer sur Azure 		Cet exemple montre comment utiliser Azure Front Door comme équilibreur de charge global devant Gestion des API Azure.
Analyse de l’API Moesif et de monétisation

Déployer sur Azure 		Le modèle journalisera les appels d’API de Gestion des API Azure à l’analytique des API Moesif et à la plateforme de monétisation

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource service/enregistreurs d’événements 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/enregistreurs d’événements, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/loggers@2024-05-01"
  name = "string"
  body = jsonencode({
    properties = {
      credentials = {
        {customized property} = "string"
      }
      description = "string"
      isBuffered = bool
      loggerType = "string"
      resourceId = "string"
    }
  })
}

Valeurs de propriété

LoggerContractProperties

Nom Description Valeur
Pouvoirs Nom et chaîne de connexion SendRule du hub d’événements pour l’enregistreur d’événements AzureEventHub.
Clé d’instrumentation pour l’enregistreur d’événements ApplicationInsights.		 LoggerContractPropertiesCredentials
description Description de l’enregistreur d’événements. corde

Contraintes:
Longueur maximale =
isBuffered Indique si les enregistrements sont mis en mémoire tampon dans l’enregistreur d’événements avant la publication. La valeur par défaut est supposée être true. Bool
loggerType Type d’enregistreur d’événements. 'applicationInsights'
'azureEventHub'
'azureMonitor' (obligatoire)
resourceId ID de ressource Azure d’une cible de journal (ressource Azure Event Hub ou ressource Azure Application Insights). corde

LoggerContractPropertiesCredentials

Nom Description Valeur

Microsoft.ApiManagement/service/enregistreurs d’événements

Nom Description Valeur
nom Nom de la ressource corde

Contraintes:
Longueur maximale =
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é d’enregistreur d’événements. LoggerContractProperties
type Type de ressource « Microsoft.ApiManagement/service/loggers@2024-05-01 »