Freigeben über

Event Hubs - Create Or Update

  • Referenz
Dienst:
Event Hubs
API-Version:
2024-01-01

Erstellt oder aktualisiert einen neuen Event Hub als geschachtelte Ressource in einem Namespace.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
eventHubName
 path True

string

Der Event Hub-Name
namespaceName
 path True

string

Der Namespacename

RegEx-Muster: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$
resourceGroupName
 path True

string

Name der Ressourcengruppe innerhalb des Azure-Abonnements.
subscriptionId
 path True

string

Abonnementanmeldeinformationen, die ein Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version
 query True

string

Client-API-Version.

Anforderungstext

Name Typ Beschreibung
properties.captureDescription

CaptureDescription

Eigenschaften der Erfassungsbeschreibung
properties.messageRetentionInDays

integer

Anzahl der Tage zum Beibehalten der Ereignisse für diesen Event Hub. Der Wert sollte zwischen 1 und 7 Tagen betragen.
properties.partitionCount

integer

Anzahl der für den Event Hub erstellten Partitionen. Zulässige Werte liegen zwischen 1 und 32 Partitionen.
properties.retentionDescription

RetentionDescription

Event Hub-Aufbewahrungseinstellungen
properties.status

EntityStatus

Listet die möglichen Werte für die status des Event Hubs auf.
properties.userMetadata

string

Ruft die Metadaten des Benutzers ab und legt diese fest.

Antworten

Name Typ Beschreibung
200 OK

Eventhub

Event Hub erfolgreich erstellt.
Other Status Codes

ErrorResponse

EventHub-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

EventHubCreate

Beispielanforderung

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
    }
  }
}

Beispiel für eine Antwort

Statuscode:
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
    }
  }
}

Definitionen

Name Beschreibung
CaptureDescription

Eigenschaften zum Konfigurieren der Erfassungsbeschreibung für eventhub
CaptureIdentity

Ein -Wert, der angibt, ob die Erfassungsbeschreibung aktiviert ist.
CaptureIdentityType

Typ der verwalteten Azure Active Directory-Identität.
CleanupPolicyRetentionDescription

Listet die möglichen Werte für die Bereinigungsrichtlinie auf.
createdByType

Der Identitätstyp, der die Ressource erstellt hat.
Destination

Erfassen von Speicherdetails für die Erfassungsbeschreibung
EncodingCaptureDescription

Listet die möglichen Werte für das Codierungsformat der Erfassungsbeschreibung auf. Hinweis: "AvroDeflate" wird in der neuen API-Version veraltet sein.
EntityStatus

Listet die möglichen Werte für die status des Event Hubs auf.
ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail

Die Fehlerdetails.
ErrorResponse

Fehlerantwort gibt an, dass der Event Hub-Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.
Eventhub

Einzelnes Element im Listen- oder Event Hub-Vorgang abrufen
RetentionDescription

Eigenschaften zum Konfigurieren von Aufbewahrungseinstellungen für den EventHub
systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

CaptureDescription

Eigenschaften zum Konfigurieren der Erfassungsbeschreibung für eventhub

Name Typ Beschreibung
destination

Destination

Eigenschaften des Ziels, in dem die Erfassung gespeichert wird. (Speicherkonto, Blobnamen)
enabled

boolean

Ein -Wert, der angibt, ob die Erfassungsbeschreibung aktiviert ist.
encoding

EncodingCaptureDescription

Listet die möglichen Werte für das Codierungsformat der Erfassungsbeschreibung auf. Hinweis: "AvroDeflate" wird in der neuen API-Version veraltet sein.
intervalInSeconds

integer

Im Zeitfenster können Sie die Häufigkeit festlegen, mit der die Erfassung in Azure Blobs erfolgt. Der Wert sollte zwischen 60 und 900 Sekunden betragen.
sizeLimitInBytes

integer

Das Größenfenster definiert die Datenmenge, die in Ihrem Event Hub vor einem Erfassungsvorgang erstellt wurde. Der Wert sollte zwischen 10485760 und 524288000 Bytes betragen.
skipEmptyArchives

boolean

Ein -Wert, der angibt, ob leere Archive übersprungen werden sollen.

CaptureIdentity

Ein -Wert, der angibt, ob die Erfassungsbeschreibung aktiviert ist.

Name Typ Beschreibung
type

CaptureIdentityType

Typ der verwalteten Azure Active Directory-Identität.
userAssignedIdentity

string

ARM-ID der verwalteten Benutzeridentität. Diese Eigenschaft ist erforderlich, ist der Typ UserAssignedIdentity. Wenn der Typ SystemAssigned lautet, wird die dem Namespace zugeordnete systemseitig zugewiesene Identität verwendet.

CaptureIdentityType

Typ der verwalteten Azure Active Directory-Identität.

Name Typ Beschreibung
SystemAssigned

string

UserAssigned

string

CleanupPolicyRetentionDescription

Listet die möglichen Werte für die Bereinigungsrichtlinie auf.

Name Typ Beschreibung
Compact

string

Delete

string

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

Destination

Erfassen von Speicherdetails für die Erfassungsbeschreibung

Name Typ Beschreibung
identity

CaptureIdentity

Ein -Wert, der angibt, ob die Erfassungsbeschreibung aktiviert ist.
name

string

Name für das Erfassungsziel
properties.archiveNameFormat

string

Blobbenennungskonvention für archivieren, z. B. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Hier sind alle Parameter (Namespace, EventHub usw.) unabhängig von der Reihenfolge obligatorisch.
properties.blobContainer

string

Name des Blobcontainers
properties.dataLakeAccountName

string

Der Name des Azure Data Lake-Speichers für die erfassten Ereignisse
properties.dataLakeFolderPath

string

Der Zielordnerpfad für die erfassten Ereignisse
properties.dataLakeSubscriptionId

string

Abonnement-ID von Azure Data Lake Store
properties.storageAccountResourceId

string

Ressourcen-ID des Speicherkontos, das zum Erstellen der Blobs verwendet werden soll

EncodingCaptureDescription

Listet die möglichen Werte für das Codierungsformat der Erfassungsbeschreibung auf. Hinweis: "AvroDeflate" wird in der neuen API-Version veraltet sein.

Name Typ Beschreibung
Avro

string

AvroDeflate

string

EntityStatus

Listet die möglichen Werte für die status des Event Hubs auf.

Name Typ Beschreibung
Active

string

Creating

string

Deleting

string

Disabled

string

ReceiveDisabled

string

Renaming

string

Restoring

string

SendDisabled

string

Unknown

string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.
type

string

Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.
code

string

Der Fehlercode.
details

ErrorDetail[]

Die Fehlerdetails.
message

string

Die Fehlermeldung.
target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort gibt an, dass der Event Hub-Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

Eventhub

Einzelnes Element im Listen- oder Event Hub-Vorgang abrufen

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

Der geografische Standort, an dem sich die Ressource befindet
name

string

Der Name der Ressource
properties.captureDescription

CaptureDescription

Eigenschaften der Erfassungsbeschreibung
properties.createdAt

string

Die genaue Zeit, zu der der Event Hub erstellt wurde.
properties.messageRetentionInDays

integer

Anzahl der Tage zum Beibehalten der Ereignisse für diesen Event Hub. Der Wert sollte zwischen 1 und 7 Tagen betragen.
properties.partitionCount

integer

Anzahl der für den Event Hub erstellten Partitionen. Zulässige Werte liegen zwischen 1 und 32 Partitionen.
properties.partitionIds

string[]

Aktuelle Anzahl von Shards im Event Hub.
properties.retentionDescription

RetentionDescription

Event Hub-Aufbewahrungseinstellungen
properties.status

EntityStatus

Listet die möglichen Werte für die status des Event Hubs auf.
properties.updatedAt

string

Die genaue Uhrzeit, zu der die Nachricht aktualisiert wurde.
properties.userMetadata

string

Ruft die Metadaten des Benutzers ab und legt diese fest.
systemData

systemData

Die Systemmetadaten zu dieser Ressource.
type

string

Der Typ der Ressource. Z.B. "Microsoft.EventHub/Namespaces" oder "Microsoft.EventHub/Namespaces/EventHubs"

RetentionDescription

Eigenschaften zum Konfigurieren von Aufbewahrungseinstellungen für den EventHub

Name Typ Beschreibung
cleanupPolicy

CleanupPolicyRetentionDescription

Listet die möglichen Werte für die Bereinigungsrichtlinie auf.
retentionTimeInHours

integer

Anzahl der Stunden zum Aufbewahren der Ereignisse für diesen Event Hub. Dieser Wert wird nur verwendet, wenn cleanupPolicy auf Delete festgelegt ist. Wenn cleanupPolicy compact ist, lautet der zurückgegebene Wert dieser Eigenschaft Long.MaxValue.
tombstoneRetentionTimeInHours

integer

Anzahl der Stunden zum Beibehalten der Grabsteinmarker eines komprimierten Event Hubs. Dieser Wert wird nur verwendet, wenn cleanupPolicy auf Compact festgelegt ist. Consumer muss das Lesen des Grabsteinmarkers innerhalb dieser angegebenen Zeitspanne abschließen, wenn der Consumer mit dem Startoffset beginnt, um sicherzustellen, dass er eine gültige Momentaufnahme für den bestimmten Schlüssel erhält, der vom Tombstonemarker innerhalb des komprimierten Event Hubs beschrieben wird.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy

string

Die Identität, die die Ressource erstellt hat.
createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt

string

Der Identitätstyp, der die Ressource zuletzt geändert hat.
lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.