Partager via

Event Hubs - Create Or Update

  • Référence
Service:
Event Hubs
Version d'API:
2024-01-01

Crée ou met à jour un hub d’événements en tant que ressource imbriquée dans un espace de noms.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}?api-version=2024-01-01

Paramètres URI

Nom Dans Obligatoire Type Description
eventHubName
 path True

string

Nom du hub d’événements
namespaceName
 path True

string

Nom de l’espace de noms

Modèle d’expression régulière: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$
resourceGroupName
 path True

string

Nom du groupe de ressources dans l’abonnement Azure.
subscriptionId
 path True

string

Informations d’identification d’abonnement qui identifient de manière unique un abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version
 query True

string

Version de l’API cliente.

Corps de la demande

Nom Type Description
properties.captureDescription

CaptureDescription

Propriétés de la description de capture
properties.messageRetentionInDays

integer

Nombre de jours pour conserver les événements pour ce hub d’événements, la valeur doit être de 1 à 7 jours
properties.partitionCount

integer

Nombre de partitions créées pour event hub, les valeurs autorisées sont comprises entre 1 et 32 partitions.
properties.retentionDescription

RetentionDescription

Paramètres de rétention Event Hub
properties.status

EntityStatus

Énumère les valeurs possibles pour la status du hub d’événements.
properties.userMetadata

string

Obtient et définit les métadonnées de l’utilisateur.

Réponses

Nom Type Description
200 OK

Eventhub

Hub d’événements créé avec succès.
Other Status Codes

ErrorResponse

Réponse d’erreur Eventhub décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

EventHubCreate

Exemple de requête

PUT https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5357/eventhubs/sdk-EventHub-6547?api-version=2024-01-01

{
  "properties": {
    "messageRetentionInDays": 4,
    "partitionCount": 4,
    "status": "Active",
    "userMetadata": "key",
    "captureDescription": {
      "enabled": true,
      "encoding": "Avro",
      "destination": {
        "name": "EventHubArchive.AzureBlockBlob",
        "properties": {
          "storageAccountResourceId": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-Storage-SouthCentralUS/providers/Microsoft.ClassicStorage/storageAccounts/arjunteststorage",
          "blobContainer": "container",
          "archiveNameFormat": "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}"
        },
        "identity": {
          "type": "UserAssigned",
          "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2"
        }
      },
      "intervalInSeconds": 120,
      "sizeLimitInBytes": 10485763
    },
    "retentionDescription": {
      "cleanupPolicy": "Compact",
      "retentionTimeInHours": 96,
      "tombstoneRetentionTimeInHours": 1
    }
  }
}

Exemple de réponse

Code d’état:
200 
{
  "id": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.EventHub/namespaces/sdk-Namespace-716/eventhubs/sdk-EventHub-10",
  "name": "sdk-EventHub-10",
  "type": "Microsoft.EventHub/Namespaces/EventHubs",
  "properties": {
    "messageRetentionInDays": 4,
    "partitionCount": 4,
    "status": "Active",
    "userMetadata": "key",
    "createdAt": "2017-06-28T02:45:55.877Z",
    "updatedAt": "2017-06-28T02:46:05.877Z",
    "partitionIds": [
      "0",
      "1",
      "2",
      "3"
    ],
    "captureDescription": {
      "enabled": true,
      "encoding": "Avro",
      "destination": {
        "name": "EventHubArchive.AzureBlockBlob",
        "properties": {
          "storageAccountResourceId": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-Storage-SouthCentralUS/providers/Microsoft.ClassicStorage/storageAccounts/arjunteststorage",
          "blobContainer": "container",
          "archiveNameFormat": "{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}"
        },
        "identity": {
          "type": "UserAssigned",
          "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2"
        }
      },
      "intervalInSeconds": 120,
      "sizeLimitInBytes": 10485763
    },
    "retentionDescription": {
      "cleanupPolicy": "Compact",
      "retentionTimeInHours": 96,
      "tombstoneRetentionTimeInHours": 1
    }
  }
}

Définitions

Nom Description
CaptureDescription

Propriétés permettant de configurer la description de capture pour eventhub
CaptureIdentity

Valeur qui indique si la description de capture est activée.
CaptureIdentityType

Type d’identité managée Azure Active Directory.
CleanupPolicyRetentionDescription

Énumère les valeurs possibles pour la stratégie de nettoyage
createdByType

Type d’identité qui a créé la ressource.
Destination

Capturer les détails du stockage pour la description de la capture
EncodingCaptureDescription

Énumère les valeurs possibles pour le format d’encodage de la description de capture. Remarque : « AvroDeflate » sera déprécié dans la nouvelle version de l’API
EntityStatus

Énumère les valeurs possibles pour la status du hub d’événements.
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail

Détail de l’erreur.
ErrorResponse

La réponse d’erreur indique que le service Event Hub n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.
Eventhub

Élément unique dans l’opération List ou Get Event Hub
RetentionDescription

Propriétés permettant de configurer les paramètres de rétention pour eventhub
systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

CaptureDescription

Propriétés permettant de configurer la description de capture pour eventhub

Nom Type Description
destination

Destination

Propriétés de destination où la capture sera stockée. (Compte de stockage, noms d’objets blob)
enabled

boolean

Valeur qui indique si la description de capture est activée.
encoding

EncodingCaptureDescription

Énumère les valeurs possibles pour le format d’encodage de la description de capture. Remarque : « AvroDeflate » sera déprécié dans la nouvelle version de l’API
intervalInSeconds

integer

La fenêtre de temps vous permet de définir la fréquence avec laquelle la capture sur les objets blob Azure se produira, la valeur doit être comprise entre 60 et 900 secondes
sizeLimitInBytes

integer

La fenêtre de taille définit la quantité de données générées dans votre hub d’événements avant une opération de capture. La valeur doit être comprise entre 10485760 et 524288000 octets
skipEmptyArchives

boolean

Valeur qui indique s’il faut ignorer les archives vides

CaptureIdentity

Valeur qui indique si la description de capture est activée.

Nom Type Description
type

CaptureIdentityType

Type d’identité managée Azure Active Directory.
userAssignedIdentity

string

ID ARM de l’identité utilisateur managée. Cette propriété est obligatoire si le type est UserAssignedIdentity. Si le type est SystemAssigned, l’identité affectée par le système associée à l’espace de noms est utilisée.

CaptureIdentityType

Type d’identité managée Azure Active Directory.

Nom Type Description
SystemAssigned

string

UserAssigned

string

CleanupPolicyRetentionDescription

Énumère les valeurs possibles pour la stratégie de nettoyage

Nom Type Description
Compact

string

Delete

string

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

Destination

Capturer les détails du stockage pour la description de la capture

Nom Type Description
identity

CaptureIdentity

Valeur qui indique si la description de capture est activée.
name

string

Nom de la destination de capture
properties.archiveNameFormat

string

Convention d’affectation de noms d’objets blob pour l’archive, par exemple {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Hour}/{Minute}/{Second}. Ici, tous les paramètres (Espace de noms, EventHub,etc.) sont obligatoires, quel que soit l’ordre
properties.blobContainer

string

Nom du conteneur d’objets blob
properties.dataLakeAccountName

string

Nom Azure Data Lake Store pour les événements capturés
properties.dataLakeFolderPath

string

Chemin du dossier de destination pour les événements capturés
properties.dataLakeSubscriptionId

string

ID d’abonnement d’Azure Data Lake Store
properties.storageAccountResourceId

string

ID de ressource du compte de stockage à utiliser pour créer les objets blob

EncodingCaptureDescription

Énumère les valeurs possibles pour le format d’encodage de la description de capture. Remarque : « AvroDeflate » sera déprécié dans la nouvelle version de l’API

Nom Type Description
Avro

string

AvroDeflate

string

EntityStatus

Énumère les valeurs possibles pour la status du hub d’événements.

Nom Type Description
Active

string

Creating

string

Deleting

string

Disabled

string

ReceiveDisabled

string

Renaming

string

Restoring

string

SendDisabled

string

Unknown

string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires
type

string

Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d'erreur.
details

ErrorDetail[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

ErrorResponse

La réponse d’erreur indique que le service Event Hub n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

Nom Type Description
error

ErrorDetail

Objet error.

Eventhub

Élément unique dans l’opération List ou Get Event Hub

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

Emplacement géographique où réside la ressource
name

string

nom de la ressource.
properties.captureDescription

CaptureDescription

Propriétés de la description de capture
properties.createdAt

string

Heure exacte à laquelle le hub d’événements a été créé.
properties.messageRetentionInDays

integer

Nombre de jours pour conserver les événements pour ce hub d’événements, la valeur doit être de 1 à 7 jours
properties.partitionCount

integer

Nombre de partitions créées pour event hub, les valeurs autorisées sont comprises entre 1 et 32 partitions.
properties.partitionIds

string[]

Nombre actuel de partitions sur l’Event Hub.
properties.retentionDescription

RetentionDescription

Paramètres de rétention Event Hub
properties.status

EntityStatus

Énumère les valeurs possibles pour la status du hub d’événements.
properties.updatedAt

string

Heure exacte à laquelle le message a été mis à jour.
properties.userMetadata

string

Obtient et définit les métadonnées de l’utilisateur.
systemData

systemData

Métadonnées système relatives à cette ressource.
type

string

Type de la ressource. Par exemple, « Microsoft.EventHub/Namespaces » ou « Microsoft.EventHub/Namespaces/EventHubs »

RetentionDescription

Propriétés permettant de configurer les paramètres de rétention pour eventhub

Nom Type Description
cleanupPolicy

CleanupPolicyRetentionDescription

Énumère les valeurs possibles pour la stratégie de nettoyage
retentionTimeInHours

integer

Nombre d’heures de conservation des événements pour ce hub d’événements. Cette valeur est utilisée uniquement lorsque cleanupPolicy a la valeur Delete. Si cleanupPolicy est Compact, la valeur renvoyée de cette propriété est Long.MaxValue
tombstoneRetentionTimeInHours

integer

Nombre d’heures pour conserver les marqueurs tombstone d’un Event Hub compacté. Cette valeur est utilisée uniquement lorsque cleanupPolicy est Compact. Le consommateur doit terminer la lecture du marqueur tombstone dans ce laps de temps spécifié si le consommateur commence à démarrer le décalage pour s’assurer qu’il obtient une instantané valide pour la clé spécifique décrite par le marqueur tombstone dans le hub d’événements compacté

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).
createdBy

string

Identité qui a créé la ressource.
createdByType

createdByType

Type d’identité qui a créé la ressource.
lastModifiedAt

string

Type d’identité qui a modifié la ressource pour la dernière fois.
lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.