Espaces de noms Microsoft.EventHub/eventhubs 2024-01-01
Définition de ressource Bicep
Les espaces de noms/type de ressource eventhubs peuvent être déployés 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.EventHub/namespaces/eventhubs, ajoutez le bicep suivant à votre modèle.
resource symbolicname 'Microsoft.EventHub/namespaces/eventhubs@2024-01-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
captureDescription: {
destination: {
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
name: 'string'
properties: {
archiveNameFormat: 'string'
blobContainer: 'string'
dataLakeAccountName: 'string'
dataLakeFolderPath: 'string'
dataLakeSubscriptionId: 'string'
storageAccountResourceId: 'string'
}
}
enabled: bool
encoding: 'string'
intervalInSeconds: int
sizeLimitInBytes: int
skipEmptyArchives: bool
}
messageRetentionInDays: int
partitionCount: int
retentionDescription: {
cleanupPolicy: 'string'
retentionTimeInHours: int
tombstoneRetentionTimeInHours: int
}
status: 'string'
userMetadata: 'string'
}
}
Valeurs de propriété
CaptureDescription
CaptureIdentity
| Nom | Description | Valeur |
|---|---|---|
| type | Type d’identité managée Azure Active Directory. | 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentity | ID ARM de l’identité utilisateur managée. Cette propriété est obligatoire est le type UserAssignedIdentity. Si le type est SystemAssigned, l’identité affectée par le système associée à l’espace de noms est utilisée. | corde |
Destination
| Nom | Description | Valeur |
|---|---|---|
| identité | Valeur qui indique si la description de capture est activée. | CaptureIdentity |
| nom | Nom de la destination de capture | corde |
| Propriétés | Propriétés décrivant le compte de stockage, le conteneur d’objets blob et le format de nom d’archive pour la destination de capture | DestinationProperties |
DestinationProperties
| Nom | Description | Valeur |
|---|---|---|
| archiveNameFormat | Convention d’affectation de noms d’objets blob pour l’archivage, par exemple {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Ici, tous les paramètres (Espace de noms,EventHub .. etc.) sont obligatoires, quel que soit l’ordre | corde |
| blobContainer | Nom du conteneur d’objets blob | corde |
| dataLakeAccountName | Nom d’Azure Data Lake Store pour les événements capturés | corde |
| dataLakeFolderPath | Chemin d’accès du dossier de destination pour les événements capturés | corde |
| dataLakeSubscriptionId | ID d’abonnement d’Azure Data Lake Store | corde Contraintes: Longueur minimale = 36 Longueur maximale = 36 Modèle = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| storageAccountResourceId | ID de ressource du compte de stockage à utiliser pour créer les objets blob | corde |
EventhubProperties
| Nom | Description | Valeur |
|---|---|---|
| captureDescription | Propriétés de la description de capture | CaptureDescription |
| messageRetentionInDays | Nombre de jours pour conserver les événements pour ce hub d’événements, la valeur doit être comprise entre 1 et 7 jours | Int Contraintes: Valeur minimale = 1 |
| partitionCount | Nombre de partitions créées pour le hub d’événements, les valeurs autorisées sont comprises entre 1 et 32 partitions. | Int Contraintes: Valeur minimale = 1 |
| retentionDescription | Paramètres de rétention event Hub | RetentionDescription |
| statut | Énumère les valeurs possibles pour l’état du hub d’événements. | 'Actif' 'Création' 'Suppression' 'Désactivé' 'ReceiveDisabled' 'Renommage' « Restauration » 'SendDisabled' 'Inconnu' |
| userMetadata | Obtient et définit les métadonnées de l’utilisateur. | corde |
Microsoft.EventHub/namespaces/eventhubs
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 (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 : espaces de noms |
| Propriétés | Propriétés fournies à l’opération Créer ou mettre à jour Event Hub. | EventhubProperties |
RetentionDescription
| Nom | Description | Valeur |
|---|---|---|
| cleanupPolicy | Énumère les valeurs possibles pour la stratégie de nettoyage | 'Compact' 'Supprimer' |
| retentionTimeInHours | Nombre d’heures de conservation des événements pour ce hub d’événements. Cette valeur est utilisée uniquement lorsque cleanupPolicy est Delete. Si cleanupPolicy est Compacter la valeur retournée de cette propriété est Long.MaxValue | Int |
| tombstoneRetentionTimeInHours | Nombre d’heures pour conserver les marqueurs tombstone d’un hub d’événements compacté. Cette valeur est utilisée uniquement lorsque cleanupPolicy est Compact. Le consommateur doit terminer la lecture du marqueur tombstone dans ce délai spécifié si le consommateur commence à démarrer le décalage pour s’assurer qu’il obtient un instantané valide pour la clé spécifique décrite par le marqueur tombstone dans le hub d’événements compacté | Int |
Exemples de démarrage rapide
Les exemples de démarrage rapide suivants déploient ce type de ressource.
| Fichier Bicep | Description |
|---|---|
| Azure Digital Twins avec de connexion d’historique des données temporelles | Ce modèle crée une instance Azure Digital Twins configurée avec une connexion d’historique des données de série chronologique. Pour créer une connexion, d’autres ressources doivent être créées, telles qu’un espace de noms Event Hubs, un hub d’événements, un cluster Azure Data Explorer et une base de données. Les données sont envoyées à un hub d’événements qui transfère finalement les données au cluster Azure Data Explorer. Les données sont stockées dans une table de base de données dans le cluster |
| Application de fonction Azure avec Event Hub et Managed Identity | son modèle provisionne une application de fonction Azure sur un plan de consommation Linux, ainsi qu’un hub d’événements, stockage Azure et Application Insights. L’application de fonction est en mesure d’utiliser l’identité managée pour se connecter au hub d’événements et au compte de stockage |
| Créer un hub d’événements | Ce modèle vous permet de déployer un espace de noms EventHubs avec un hub d’événements. |
| Créer un espace de noms EventHubs, Event Hub, & groupe de consommateurs | Ce modèle vous permet de déployer un espace de noms Event Hubs Standard, un Event Hub et un groupe de consommateurs. |
| Crée un cluster Eventhub, des nomsapce & eventhub | Ce modèle vous permet de créer un cluster, un espace de noms et un eventhub EventHub dans un cluster |
| Déployer une base de données Azure Data Explorer avec de connexion Event Grid | Déployez la base de données Azure Data Explorer avec la connexion Event Grid. |
| Déployer une base de données Azure Data Explorer avec de connexion Event Hub | Déployez la base de données Azure Data Explorer avec la connexion Event Hub. |
| Déployer le service MedTech | Le service MedTech est l’un des services de données Azure Health conçus pour ingérer des données d’appareil à partir de plusieurs appareils, transformer les données d’appareil en observations FHIR, qui sont ensuite conservées dans le service FHIR Azure Health Data Services. |
| déployer le service MedTech, y compris un Azure IoT Hub | Le service MedTech est l’un des services de données Azure Health conçus pour ingérer des données d’appareil à partir de plusieurs appareils, transformer les données d’appareil en observations FHIR, qui sont ensuite conservées dans le service FHIR Azure Health Data Services. |
| Déployer sports Analytics sur l’architecture Azure | Crée un compte de stockage Azure avec ADLS Gen2 activé, une instance Azure Data Factory avec des services liés pour le compte de stockage (une base de données Azure SQL si déployée) et une instance Azure Databricks. L’identité AAD pour l’utilisateur qui déploie le modèle et l’identité managée pour l’instance ADF reçoivent le rôle Contributeur aux données blob de stockage sur le compte de stockage. Il existe également des options pour déployer une instance Azure Key Vault, une base de données Azure SQL et un Hub d’événements Azure (pour les cas d’utilisation de streaming). Lorsqu’un coffre de clés Azure est déployé, l’identité managée de la fabrique de données et l’identité AAD pour l’utilisateur qui déploie le modèle reçoivent le rôle Utilisateur des secrets Key Vault. |
| CDN FrontDoor avec waf, domaines et journaux d’activité sur EventHub | Ce modèle crée un profil cdn Azure FrontDoor. Créez waf avec des règles personnalisées et gérées, des itinéraires cdn, des origines et des groupes avec leur association avec WAF et des itinéraires, configure des domaines personnalisés, créez un hub d’événements et des paramètres de diagnostic pour envoyer des journaux d’accès CDN à l’aide d’Event Hub. |
| 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
Les espaces de noms/type de ressource eventhubs peuvent être déployés 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.EventHub/namespaces/eventhubs, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.EventHub/namespaces/eventhubs",
"apiVersion": "2024-01-01",
"name": "string",
"properties": {
"captureDescription": {
"destination": {
"identity": {
"type": "string",
"userAssignedIdentity": "string"
},
"name": "string",
"properties": {
"archiveNameFormat": "string",
"blobContainer": "string",
"dataLakeAccountName": "string",
"dataLakeFolderPath": "string",
"dataLakeSubscriptionId": "string",
"storageAccountResourceId": "string"
}
},
"enabled": "bool",
"encoding": "string",
"intervalInSeconds": "int",
"sizeLimitInBytes": "int",
"skipEmptyArchives": "bool"
},
"messageRetentionInDays": "int",
"partitionCount": "int",
"retentionDescription": {
"cleanupPolicy": "string",
"retentionTimeInHours": "int",
"tombstoneRetentionTimeInHours": "int"
},
"status": "string",
"userMetadata": "string"
}
}
Valeurs de propriété
CaptureDescription
CaptureIdentity
| Nom | Description | Valeur |
|---|---|---|
| type | Type d’identité managée Azure Active Directory. | 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentity | ID ARM de l’identité utilisateur managée. Cette propriété est obligatoire est le type UserAssignedIdentity. Si le type est SystemAssigned, l’identité affectée par le système associée à l’espace de noms est utilisée. | corde |
Destination
| Nom | Description | Valeur |
|---|---|---|
| identité | Valeur qui indique si la description de capture est activée. | CaptureIdentity |
| nom | Nom de la destination de capture | corde |
| Propriétés | Propriétés décrivant le compte de stockage, le conteneur d’objets blob et le format de nom d’archive pour la destination de capture | DestinationProperties |
DestinationProperties
| Nom | Description | Valeur |
|---|---|---|
| archiveNameFormat | Convention d’affectation de noms d’objets blob pour l’archivage, par exemple {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Ici, tous les paramètres (Espace de noms,EventHub .. etc.) sont obligatoires, quel que soit l’ordre | corde |
| blobContainer | Nom du conteneur d’objets blob | corde |
| dataLakeAccountName | Nom d’Azure Data Lake Store pour les événements capturés | corde |
| dataLakeFolderPath | Chemin d’accès du dossier de destination pour les événements capturés | corde |
| dataLakeSubscriptionId | ID d’abonnement d’Azure Data Lake Store | corde Contraintes: Longueur minimale = 36 Longueur maximale = 36 Modèle = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| storageAccountResourceId | ID de ressource du compte de stockage à utiliser pour créer les objets blob | corde |
EventhubProperties
| Nom | Description | Valeur |
|---|---|---|
| captureDescription | Propriétés de la description de capture | CaptureDescription |
| messageRetentionInDays | Nombre de jours pour conserver les événements pour ce hub d’événements, la valeur doit être comprise entre 1 et 7 jours | Int Contraintes: Valeur minimale = 1 |
| partitionCount | Nombre de partitions créées pour le hub d’événements, les valeurs autorisées sont comprises entre 1 et 32 partitions. | Int Contraintes: Valeur minimale = 1 |
| retentionDescription | Paramètres de rétention event Hub | RetentionDescription |
| statut | Énumère les valeurs possibles pour l’état du hub d’événements. | 'Actif' 'Création' 'Suppression' 'Désactivé' 'ReceiveDisabled' 'Renommage' « Restauration » 'SendDisabled' 'Inconnu' |
| userMetadata | Obtient et définit les métadonnées de l’utilisateur. | corde |
Microsoft.EventHub/namespaces/eventhubs
| Nom | Description | Valeur |
|---|---|---|
| apiVersion | Version de l’API | '2024-01-01' |
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 (obligatoire) |
| Propriétés | Propriétés fournies à l’opération Créer ou mettre à jour Event Hub. | EventhubProperties |
| type | Type de ressource | 'Microsoft.EventHub/namespaces/eventhubs' |
RetentionDescription
| Nom | Description | Valeur |
|---|---|---|
| cleanupPolicy | Énumère les valeurs possibles pour la stratégie de nettoyage | 'Compact' 'Supprimer' |
| retentionTimeInHours | Nombre d’heures de conservation des événements pour ce hub d’événements. Cette valeur est utilisée uniquement lorsque cleanupPolicy est Delete. Si cleanupPolicy est Compacter la valeur retournée de cette propriété est Long.MaxValue | Int |
| tombstoneRetentionTimeInHours | Nombre d’heures pour conserver les marqueurs tombstone d’un hub d’événements compacté. Cette valeur est utilisée uniquement lorsque cleanupPolicy est Compact. Le consommateur doit terminer la lecture du marqueur tombstone dans ce délai spécifié si le consommateur commence à démarrer le décalage pour s’assurer qu’il obtient un instantané valide pour la clé spécifique décrite par le marqueur tombstone dans le hub d’événements compacté | Int |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
Azure Digital Twins avec de connexion d’historique des données temporelles
|
Ce modèle crée une instance Azure Digital Twins configurée avec une connexion d’historique des données de série chronologique. Pour créer une connexion, d’autres ressources doivent être créées, telles qu’un espace de noms Event Hubs, un hub d’événements, un cluster Azure Data Explorer et une base de données. Les données sont envoyées à un hub d’événements qui transfère finalement les données au cluster Azure Data Explorer. Les données sont stockées dans une table de base de données dans le cluster |
|
Application de fonction Azure avec Event Hub et Managed Identity
|
son modèle provisionne une application de fonction Azure sur un plan de consommation Linux, ainsi qu’un hub d’événements, stockage Azure et Application Insights. L’application de fonction est en mesure d’utiliser l’identité managée pour se connecter au hub d’événements et au compte de stockage |
|
Créer un hub d’événements
|
Ce modèle vous permet de déployer un espace de noms EventHubs avec un hub d’événements. |
|
Créer un espace de noms EventHubs, Event Hub, & groupe de consommateurs
|
Ce modèle vous permet de déployer un espace de noms Event Hubs Standard, un Event Hub et un groupe de consommateurs. |
|
Crée un cluster Eventhub, des nomsapce & eventhub
|
Ce modèle vous permet de créer un cluster, un espace de noms et un eventhub EventHub dans un cluster |
|
Déployer une base de données Azure Data Explorer avec de connexion Event Grid
|
Déployez la base de données Azure Data Explorer avec la connexion Event Grid. |
|
Déployer une base de données Azure Data Explorer avec de connexion Event Hub
|
Déployez la base de données Azure Data Explorer avec la connexion Event Hub. |
|
Déployer le service MedTech
|
Le service MedTech est l’un des services de données Azure Health conçus pour ingérer des données d’appareil à partir de plusieurs appareils, transformer les données d’appareil en observations FHIR, qui sont ensuite conservées dans le service FHIR Azure Health Data Services. |
|
déployer le service MedTech, y compris un Azure IoT Hub
|
Le service MedTech est l’un des services de données Azure Health conçus pour ingérer des données d’appareil à partir de plusieurs appareils, transformer les données d’appareil en observations FHIR, qui sont ensuite conservées dans le service FHIR Azure Health Data Services. |
|
Déployer sports Analytics sur l’architecture Azure
|
Crée un compte de stockage Azure avec ADLS Gen2 activé, une instance Azure Data Factory avec des services liés pour le compte de stockage (une base de données Azure SQL si déployée) et une instance Azure Databricks. L’identité AAD pour l’utilisateur qui déploie le modèle et l’identité managée pour l’instance ADF reçoivent le rôle Contributeur aux données blob de stockage sur le compte de stockage. Il existe également des options pour déployer une instance Azure Key Vault, une base de données Azure SQL et un Hub d’événements Azure (pour les cas d’utilisation de streaming). Lorsqu’un coffre de clés Azure est déployé, l’identité managée de la fabrique de données et l’identité AAD pour l’utilisateur qui déploie le modèle reçoivent le rôle Utilisateur des secrets Key Vault. |
|
CDN FrontDoor avec waf, domaines et journaux d’activité sur EventHub
|
Ce modèle crée un profil cdn Azure FrontDoor. Créez waf avec des règles personnalisées et gérées, des itinéraires cdn, des origines et des groupes avec leur association avec WAF et des itinéraires, configure des domaines personnalisés, créez un hub d’événements et des paramètres de diagnostic pour envoyer des journaux d’accès CDN à l’aide d’Event Hub. |
|
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 Terraform (fournisseur AzAPI)
Les espaces de noms/type de ressource eventhubs peuvent être déployés 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.EventHub/namespaces/eventhubs, ajoutez la terraform suivante à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventHub/namespaces/eventhubs@2024-01-01"
name = "string"
body = jsonencode({
properties = {
captureDescription = {
destination = {
identity = {
type = "string"
userAssignedIdentity = "string"
}
name = "string"
properties = {
archiveNameFormat = "string"
blobContainer = "string"
dataLakeAccountName = "string"
dataLakeFolderPath = "string"
dataLakeSubscriptionId = "string"
storageAccountResourceId = "string"
}
}
enabled = bool
encoding = "string"
intervalInSeconds = int
sizeLimitInBytes = int
skipEmptyArchives = bool
}
messageRetentionInDays = int
partitionCount = int
retentionDescription = {
cleanupPolicy = "string"
retentionTimeInHours = int
tombstoneRetentionTimeInHours = int
}
status = "string"
userMetadata = "string"
}
})
}
Valeurs de propriété
CaptureDescription
CaptureIdentity
| Nom | Description | Valeur |
|---|---|---|
| type | Type d’identité managée Azure Active Directory. | 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentity | ID ARM de l’identité utilisateur managée. Cette propriété est obligatoire est le type UserAssignedIdentity. Si le type est SystemAssigned, l’identité affectée par le système associée à l’espace de noms est utilisée. | corde |
Destination
| Nom | Description | Valeur |
|---|---|---|
| identité | Valeur qui indique si la description de capture est activée. | CaptureIdentity |
| nom | Nom de la destination de capture | corde |
| Propriétés | Propriétés décrivant le compte de stockage, le conteneur d’objets blob et le format de nom d’archive pour la destination de capture | DestinationProperties |
DestinationProperties
| Nom | Description | Valeur |
|---|---|---|
| archiveNameFormat | Convention d’affectation de noms d’objets blob pour l’archivage, par exemple {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Ici, tous les paramètres (Espace de noms,EventHub .. etc.) sont obligatoires, quel que soit l’ordre | corde |
| blobContainer | Nom du conteneur d’objets blob | corde |
| dataLakeAccountName | Nom d’Azure Data Lake Store pour les événements capturés | corde |
| dataLakeFolderPath | Chemin d’accès du dossier de destination pour les événements capturés | corde |
| dataLakeSubscriptionId | ID d’abonnement d’Azure Data Lake Store | corde Contraintes: Longueur minimale = 36 Longueur maximale = 36 Modèle = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| storageAccountResourceId | ID de ressource du compte de stockage à utiliser pour créer les objets blob | corde |
EventhubProperties
| Nom | Description | Valeur |
|---|---|---|
| captureDescription | Propriétés de la description de capture | CaptureDescription |
| messageRetentionInDays | Nombre de jours pour conserver les événements pour ce hub d’événements, la valeur doit être comprise entre 1 et 7 jours | Int Contraintes: Valeur minimale = 1 |
| partitionCount | Nombre de partitions créées pour le hub d’événements, les valeurs autorisées sont comprises entre 1 et 32 partitions. | Int Contraintes: Valeur minimale = 1 |
| retentionDescription | Paramètres de rétention event Hub | RetentionDescription |
| statut | Énumère les valeurs possibles pour l’état du hub d’événements. | 'Actif' 'Création' 'Suppression' 'Désactivé' 'ReceiveDisabled' 'Renommage' « Restauration » 'SendDisabled' 'Inconnu' |
| userMetadata | Obtient et définit les métadonnées de l’utilisateur. | corde |
Microsoft.EventHub/namespaces/eventhubs
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 (obligatoire) |
| parent_id | ID de la ressource qui est le parent de cette ressource. | ID de ressource de type : espaces de noms |
| Propriétés | Propriétés fournies à l’opération Créer ou mettre à jour Event Hub. | EventhubProperties |
| type | Type de ressource | « Microsoft.EventHub/namespaces/eventhubs@2024-01-01 » |
RetentionDescription
| Nom | Description | Valeur |
|---|---|---|
| cleanupPolicy | Énumère les valeurs possibles pour la stratégie de nettoyage | 'Compact' 'Supprimer' |
| retentionTimeInHours | Nombre d’heures de conservation des événements pour ce hub d’événements. Cette valeur est utilisée uniquement lorsque cleanupPolicy est Delete. Si cleanupPolicy est Compacter la valeur retournée de cette propriété est Long.MaxValue | Int |
| tombstoneRetentionTimeInHours | Nombre d’heures pour conserver les marqueurs tombstone d’un hub d’événements compacté. Cette valeur est utilisée uniquement lorsque cleanupPolicy est Compact. Le consommateur doit terminer la lecture du marqueur tombstone dans ce délai spécifié si le consommateur commence à démarrer le décalage pour s’assurer qu’il obtient un instantané valide pour la clé spécifique décrite par le marqueur tombstone dans le hub d’événements compacté | Int |