Freigeben über


Event Hubs - List By Namespace

Ruft alle Event Hubs in einem Namespace ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs?api-version=2024-01-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs?api-version=2024-01-01&$skip={$skip}&$top={$top}

URI-Parameter

Name In Erforderlich Typ Beschreibung
namespaceName
path True

string

minLength: 6
maxLength: 50
pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$

Der Namespacename

resourceGroupName
path True

string

minLength: 1
maxLength: 90

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.

$skip
query

integer

minimum: 0
maximum: 1000

Skip wird nur verwendet, wenn ein vorheriger Vorgang ein Teilergebnis zurückgegeben hat. Wenn eine vorherige Antwort ein nextLink-Element enthält, enthält der Wert des nextLink-Elements einen Skip-Parameter, der einen Ausgangspunkt angibt, der für nachfolgende Aufrufe verwendet werden soll.

$top
query

integer

minimum: 1
maximum: 1000

Kann verwendet werden, um die Anzahl der Ergebnisse auf die letzten N usageDetails zu beschränken.

Antworten

Name Typ Beschreibung
200 OK

EventHubListResult

Die Liste der Event Hubs wurde erfolgreich abgerufen.

Other Status Codes

ErrorResponse

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

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

EventHubsListAll

Beispielanforderung

GET https://management.azure.com/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5357/eventhubs?api-version=2024-01-01

Beispiel für eine Antwort

{
  "value": [
    {
      "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",
        "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}"
            }
          },
          "intervalInSeconds": 120,
          "sizeLimitInBytes": 10485763
        },
        "retentionDescription": {
          "cleanupPolicy": "Delete",
          "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 Aufnahmebeschreibung auf. Hinweis: "AvroDeflate" ist in der neuen API-Version veraltet.

EntityStatus

Listet die möglichen Werte für den Status des Event Hub auf.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das 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 Get Event Hub-Vorgang

EventHubListResult

Das Ergebnis des List EventHubs-Vorgangs.

RetentionDescription

Eigenschaften zum Konfigurieren von Aufbewahrungseinstellungen für den EventHub

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

CaptureDescription

Eigenschaften zum Konfigurieren der Erfassungsbeschreibung für eventhub

Name Typ Beschreibung
destination

Destination

Eigenschaften des Ziels, in dem die Erfassung gespeichert wird. (Speicherkonto, BLOB-Namen)

enabled

boolean

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

encoding

EncodingCaptureDescription

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

intervalInSeconds

integer (int32)

Mit dem Zeitfenster können Sie die Häufigkeit festlegen, mit der die Aufnahme in Azure Blobs erfolgt, der Wert sollte zwischen 60 und 900 Sekunden betragen.

sizeLimitInBytes

integer (int32)

Das Fenster "Größe" definiert die Datenmenge, die in Ihrem Event Hub erstellt wurde, bevor ein Erfassungsvorgang ausgeführt wird. 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" ist, wird die dem Namespace zugeordnete System-Identität verwendet.

CaptureIdentityType

Typ der verwalteten Azure Active Directory-Identität.

Wert Beschreibung
SystemAssigned
UserAssigned

CleanupPolicyRetentionDescription

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

Wert Beschreibung
Compact
Delete

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Wert Beschreibung
Application
Key
ManagedIdentity
User

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 Aufnahmeziel

properties.archiveNameFormat

string

Blobbenennungskonvention für Das Archiv, 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

Blobcontainername

properties.dataLakeAccountName

string

Der Name des Azure Data Lake Store für die erfassten Ereignisse

properties.dataLakeFolderPath

string

Der Zielordnerpfad für die erfassten Ereignisse

properties.dataLakeSubscriptionId

string (uuid)

Abonnement-ID des 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 Aufnahmebeschreibung auf. Hinweis: "AvroDeflate" ist in der neuen API-Version veraltet.

Wert Beschreibung
Avro
AvroDeflate

EntityStatus

Listet die möglichen Werte für den Status des Event Hub auf.

Wert Beschreibung
Active
Creating
Deleting
Disabled
ReceiveDisabled
Renaming
Restoring
SendDisabled
Unknown

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

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 Get Event Hub-Vorgang

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /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 Aufnahmebeschreibung

properties.createdAt

string (date-time)

Genauer Zeitpunkt, zu dem der Event Hub erstellt wurde.

properties.messageRetentionInDays

integer (int64)

minimum: 1

Die Anzahl der Tage, um die Ereignisse für diesen Event Hub beizubehalten, sollte der Wert 1 bis 7 Tage betragen.

properties.partitionCount

integer (int64)

minimum: 1

Die Anzahl der partitionen, die für den Event Hub erstellt wurden, sind zulässige Werte von 1 bis 32 Partitionen.

properties.partitionIds

string[]

Aktuelle Anzahl von Shards auf dem Event Hub.

properties.retentionDescription

RetentionDescription

Event Hub-Aufbewahrungseinstellungen

properties.status

EntityStatus

Listet die möglichen Werte für den Status des Event Hub auf.

properties.updatedAt

string (date-time)

Die genaue Uhrzeit, zu der die Nachricht aktualisiert wurde.

properties.userMetadata

string

Ruft Metadaten des Benutzers ab und legt diese fest.

systemData

systemData

Die Systemmetadaten, die sich auf diese Ressource beziehen.

type

string

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

EventHubListResult

Das Ergebnis des List EventHubs-Vorgangs.

Name Typ Beschreibung
nextLink

string

Verknüpfen Sie den nächsten Ergebnissatz. Nicht leer, wenn "Value" eine unvollständige Liste von EventHubs enthält.

value

Eventhub[]

Ergebnis des List EventHubs-Vorgangs.

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 (int64)

Die Anzahl der Stunden, um die Ereignisse für diesen Event Hub beizubehalten. Dieser Wert wird nur verwendet, wenn cleanupPolicy gelöscht wird. Wenn cleanupPolicy compact ist, lautet der zurückgegebene Wert dieser Eigenschaft Long.MaxValue

tombstoneRetentionTimeInHours

integer (int32)

Die Anzahl der Stunden, um die Grabsteinmarkierungen eines komprimierten Event Hub beizubehalten. Dieser Wert wird nur verwendet, wenn cleanupPolicy kompakt ist. Verbraucher müssen das Lesen der Tombstone-Markierung innerhalb dieses angegebenen Zeitraums abschließen, wenn der Verbraucher mit dem Startoffset beginnt, um sicherzustellen, dass sie eine gültige Momentaufnahme für den spezifischen Schlüssel erhalten, der vom Tombstone-Marker im komprimierten Event Hub beschrieben wird.

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name Typ Beschreibung
createdAt

string (date-time)

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 (date-time)

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.