Partager via


Service/enregistreurs d’événements Microsoft.ApiManagement 2021-04-01-preview

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 des ressources

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

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

Valeurs de propriétés

service/loggers

Nom Description Valeur
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.
chaîne (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é d’enregistreur d’événements. LoggerContractProperties

LoggerContractProperties

Nom Description Valeur
credentials Le nom et l’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. string
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). string

LoggerContractPropertiesCredentials

Nom Description Valeur
{propriété personnalisée} string

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 instance de Gestion des API et toutes les sous-ressources à l’aide d’un modèle

Déployer sur Azure
Ce modèle montre comment créer un service Gestion des API et configurer des sous-entités
Créer des Gestion des API dans un réseau virtuel interne avec App Gateway

Déployer sur Azure
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.
Analyse et monétisation de l’API Moesif

Déployer sur Azure
Le modèle journalisera les appels d’API d’Azure Gestion des API vers la plateforme d’analyse et de monétisation de l’API Moesif
Créer Azure Front Door devant Azure Gestion des API

Déployer sur Azure
Cet exemple montre comment utiliser Azure Front Door comme équilibreur de charge global devant Azure Gestion des API.
Application Gateway avec Gestion des API interne et Web App

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

Pour créer une ressource Microsoft.ApiManagement/service/loggers, ajoutez le code JSON suivant à votre modèle.

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

Valeurs de propriétés

service/loggers

Nom Description Valeur
type Type de ressource 'Microsoft.ApiManagement/service/loggers'
apiVersion Version de l’API de ressource '2021-04-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 de l’entité d’enregistreur d’événements. LoggerContractProperties

LoggerContractProperties

Nom Description Valeur
credentials Le nom et la 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. string
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). string

LoggerContractPropertiesCredentials

Nom Description Valeur
{propriété personnalisée} string

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 instance de Gestion des API et toutes les sous-ressources à l’aide d’un modèle

Déployer sur Azure
Ce modèle montre comment créer un service Gestion des API et configurer des sous-entités
Créer des Gestion des API dans un réseau virtuel interne avec App Gateway

Déployer sur Azure
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.
Analytique et monétisation de l’API Moesif

Déployer sur Azure
Le modèle journalisera les appels d’API d’Azure Gestion des API vers la plateforme d’analytique et de monétisation de l’API Moesif
Créer Azure Front Door devant Azure Gestion des API

Déployer sur Azure
Cet exemple montre comment utiliser Azure Front Door comme équilibreur de charge global devant Azure Gestion des API.
Application Gateway avec l’Gestion des API interne et l’application web

Déployer sur Azure
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 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 d’API, consultez journal des modifications.

Format des ressources

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

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

Valeurs de propriétés

service/loggers

Nom Description Valeur
type Type de ressource « Microsoft.ApiManagement/service/loggers@2021-04-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 de l’entité d’enregistreur d’événements. LoggerContractProperties

LoggerContractProperties

Nom Description Valeur
credentials Le nom et la 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. string
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). string

LoggerContractPropertiesCredentials

Nom Description Valeur
{propriété personnalisée} string