Event Hubs - List By Namespace

Riferimento

Servizio:: Event Hubs

Versione API:: 2024-01-01

Ottiene tutti gli hub eventi in uno spazio dei nomi.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
namespaceName	path	True	string	Nome dello spazio dei nomi Criterio di espressione regolare: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Nome del gruppo di risorse all'interno della sottoscrizione di Azure.
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco una sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione dell'API client.
$skip	query		integer	Skip viene usato solo se un'operazione precedente ha restituito un risultato parziale. Se una risposta precedente contiene un elemento nextLink, il valore dell'elemento nextLink includerà un parametro skip che specifica un punto iniziale da usare per le chiamate successive.
$top	query		integer	Può essere usato per limitare il numero di risultati ai più recenti N usageDetails.

Risposte

Nome	Tipo	Descrizione
200 OK	EventHubListResult	È stato recuperato l'elenco di Hub eventi.
Other Status Codes	ErrorResponse	Risposta di errore di EventHub che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

EventHubsListAll

Esempio di richiesta

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


/**
 * Samples for EventHubs ListByNamespace.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/EventHubs/
     * EHEventHubListByNameSpace.json
     */
    /**
     * Sample code: EventHubsListAll.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void eventHubsListAll(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.eventHubs().manager().serviceClient().getEventHubs().listByNamespace(
            "Default-NotificationHubs-AustraliaEast", "sdk-Namespace-5357", null, null,
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.eventhub import EventHubManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-eventhub
# USAGE
    python eh_event_hub_list_by_name_space.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = EventHubManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="e2f361f0-3b27-4503-a9cc-21cfba380093",
    )

    response = client.event_hubs.list_by_namespace(
        resource_group_name="Default-NotificationHubs-AustraliaEast",
        namespace_name="sdk-Namespace-5357",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/EventHubs/EHEventHubListByNameSpace.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armeventhub_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/eventhub/armeventhub"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b574e2a41acda14a90ef237006e8bbdda2b63c63/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/EventHubs/EHEventHubListByNameSpace.json
func ExampleEventHubsClient_NewListByNamespacePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armeventhub.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewEventHubsClient().NewListByNamespacePager("Default-NotificationHubs-AustraliaEast", "sdk-Namespace-5357", &armeventhub.EventHubsClientListByNamespaceOptions{Skip: nil,
		Top: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ListResult = armeventhub.ListResult{
		// 	Value: []*armeventhub.Eventhub{
		// 		{
		// 			Name: to.Ptr("sdk-eventhub-10"),
		// 			Type: to.Ptr("Microsoft.EventHub/Namespaces/EventHubs"),
		// 			ID: to.Ptr("/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.EventHub/namespaces/sdk-Namespace-716/eventhubs/sdk-eventhub-10"),
		// 			Properties: &armeventhub.Properties{
		// 				CaptureDescription: &armeventhub.CaptureDescription{
		// 					Destination: &armeventhub.Destination{
		// 						Name: to.Ptr("EventHubArchive.AzureBlockBlob"),
		// 						Properties: &armeventhub.DestinationProperties{
		// 							ArchiveNameFormat: to.Ptr("{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}"),
		// 							BlobContainer: to.Ptr("container"),
		// 							StorageAccountResourceID: to.Ptr("/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-Storage-SouthCentralUS/providers/Microsoft.ClassicStorage/storageAccounts/arjunteststorage"),
		// 						},
		// 					},
		// 					Enabled: to.Ptr(true),
		// 					Encoding: to.Ptr(armeventhub.EncodingCaptureDescriptionAvro),
		// 					IntervalInSeconds: to.Ptr[int32](120),
		// 					SizeLimitInBytes: to.Ptr[int32](10485763),
		// 				},
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-28T02:45:55.877Z"); return t}()),
		// 				MessageRetentionInDays: to.Ptr[int64](4),
		// 				PartitionCount: to.Ptr[int64](4),
		// 				PartitionIDs: []*string{
		// 					to.Ptr("0"),
		// 					to.Ptr("1"),
		// 					to.Ptr("2"),
		// 					to.Ptr("3")},
		// 					RetentionDescription: &armeventhub.RetentionDescription{
		// 						CleanupPolicy: to.Ptr(armeventhub.CleanupPolicyRetentionDescriptionDelete),
		// 						RetentionTimeInHours: to.Ptr[int64](96),
		// 						TombstoneRetentionTimeInHours: to.Ptr[int32](1),
		// 					},
		// 					Status: to.Ptr(armeventhub.EntityStatusActive),
		// 					UpdatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-28T02:46:05.877Z"); return t}()),
		// 				},
		// 		}},
		// 	}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { EventHubManagementClient } = require("@azure/arm-eventhub");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets all the Event Hubs in a Namespace.
 *
 * @summary Gets all the Event Hubs in a Namespace.
 * x-ms-original-file: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/EventHubs/EHEventHubListByNameSpace.json
 */
async function eventHubsListAll() {
  const subscriptionId =
    process.env["EVENTHUB_SUBSCRIPTION_ID"] || "e2f361f0-3b27-4503-a9cc-21cfba380093";
  const resourceGroupName =
    process.env["EVENTHUB_RESOURCE_GROUP"] || "Default-NotificationHubs-AustraliaEast";
  const namespaceName = "sdk-Namespace-5357";
  const credential = new DefaultAzureCredential();
  const client = new EventHubManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.eventHubs.listByNamespace(resourceGroupName, namespaceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.EventHubs.Models;
using Azure.ResourceManager.EventHubs;

// Generated from example definition: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/EventHubs/EHEventHubListByNameSpace.json
// this example is just showing the usage of "EventHubs_ListByNamespace" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this EventHubsNamespaceResource created on azure
// for more information of creating EventHubsNamespaceResource, please refer to the document of EventHubsNamespaceResource
string subscriptionId = "e2f361f0-3b27-4503-a9cc-21cfba380093";
string resourceGroupName = "Default-NotificationHubs-AustraliaEast";
string namespaceName = "sdk-Namespace-5357";
ResourceIdentifier eventHubsNamespaceResourceId = EventHubsNamespaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName);
EventHubsNamespaceResource eventHubsNamespace = client.GetEventHubsNamespaceResource(eventHubsNamespaceResourceId);

// get the collection of this EventHubResource
EventHubCollection collection = eventHubsNamespace.GetEventHubs();

// invoke the operation and iterate over the result
await foreach (EventHubResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    EventHubData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Risposta di esempio

Codice di stato:: 200

{
  "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
        }
      }
    }
  ]
}

Definizioni

Nome	Descrizione
CaptureDescription	Proprietà per configurare la descrizione dell'acquisizione per EventHub
CaptureIdentity	Valore che indica se la descrizione dell'acquisizione è abilitata.
CaptureIdentityType	Tipo di identità gestita di Azure Active Directory.
CleanupPolicyRetentionDescription	Enumera i valori possibili per i criteri di pulizia
createdByType	Tipo di identità che ha creato la risorsa.
Destination	Acquisire i dettagli di archiviazione per la descrizione dell'acquisizione
EncodingCaptureDescription	Enumera i valori possibili per il formato di codifica della descrizione dell'acquisizione. Nota: 'AvroDeflate' sarà deprecato nella nuova versione dell'API
EntityStatus	Enumera i valori possibili per lo stato dell'hub eventi.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta errore indica che il servizio Hub eventi non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.
Eventhub	Elemento singolo nell'operazione List o Get Event Hub
EventHubListResult	Risultato dell'operazione List EventHubs.
RetentionDescription	Proprietà per configurare le impostazioni di conservazione per l'hub eventi
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

CaptureDescription

Proprietà per configurare la descrizione dell'acquisizione per EventHub

Nome	Tipo	Descrizione
destination	Destination	Proprietà della destinazione in cui verrà archiviata l'acquisizione. (Account di archiviazione, Nomi BLOB)
enabled	boolean	Valore che indica se la descrizione dell'acquisizione è abilitata.
encoding	EncodingCaptureDescription	Enumera i valori possibili per il formato di codifica della descrizione dell'acquisizione. Nota: 'AvroDeflate' sarà deprecato nella nuova versione dell'API
intervalInSeconds	integer	L'intervallo di tempo consente di impostare la frequenza con cui verrà eseguita l'acquisizione nei BLOB di Azure, il valore deve essere compreso tra 60 e 900 secondi
sizeLimitInBytes	integer	La finestra dimensioni definisce la quantità di dati compilati nell'hub eventi prima di un'operazione di acquisizione, il valore deve essere compreso tra 10485760 e 524288000 byte
skipEmptyArchives	boolean	Valore che indica se ignorare gli archivi vuoti

CaptureIdentity

Valore che indica se la descrizione dell'acquisizione è abilitata.

Nome	Tipo	Descrizione
type	CaptureIdentityType	Tipo di identità gestita di Azure Active Directory.
userAssignedIdentity	string	ID ARM dell'identità utente gestita. Questa proprietà è obbligatoria. Il tipo è UserAssignedIdentity. Se il tipo è SystemAssigned, verrà usata l'identità assegnata dal sistema associata allo spazio dei nomi.

CaptureIdentityType

Tipo di identità gestita di Azure Active Directory.

Nome	Tipo	Descrizione
SystemAssigned	string
UserAssigned	string

CleanupPolicyRetentionDescription

Enumera i valori possibili per i criteri di pulizia

Nome	Tipo	Descrizione
Compact	string
Delete	string

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

Destination

Acquisire i dettagli di archiviazione per la descrizione dell'acquisizione

Nome	Tipo	Descrizione
identity	CaptureIdentity	Valore che indica se la descrizione dell'acquisizione è abilitata.
name	string	Nome per la destinazione di acquisizione
properties.archiveNameFormat	string	Convenzione di denominazione BLOB per l'archivio, ad esempio {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. In questo caso tutti i parametri (Spazio dei nomi, Hub eventi e così via) sono obbligatori indipendentemente dall'ordine
properties.blobContainer	string	Nome contenitore BLOB
properties.dataLakeAccountName	string	Nome di Azure Data Lake Store per gli eventi acquisiti
properties.dataLakeFolderPath	string	Percorso della cartella di destinazione per gli eventi acquisiti
properties.dataLakeSubscriptionId	string	ID sottoscrizione di Azure Data Lake Store
properties.storageAccountResourceId	string	ID risorsa dell'account di archiviazione da usare per creare i BLOB

EncodingCaptureDescription

Enumera i valori possibili per il formato di codifica della descrizione dell'acquisizione. Nota: 'AvroDeflate' sarà deprecato nella nuova versione dell'API

Nome	Tipo	Descrizione
Avro	string
AvroDeflate	string

EntityStatus

Enumera i valori possibili per lo stato dell'hub eventi.

Nome	Tipo	Descrizione
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta errore indica che il servizio Hub eventi non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

Eventhub

Elemento singolo nell'operazione List o Get Event Hub

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Posizione geografica in cui risiede la risorsa
name	string	nome della risorsa.
properties.captureDescription	CaptureDescription	Proprietà della descrizione dell'acquisizione
properties.createdAt	string	Ora esatta di creazione dell'hub eventi.
properties.messageRetentionInDays	integer	Numero di giorni per conservare gli eventi per l'hub eventi, il valore deve essere compreso tra 1 e 7 giorni
properties.partitionCount	integer	Il numero di partizioni create per l'hub eventi, i valori consentiti sono compresi tra 1 e 32 partizioni.
properties.partitionIds	string[]	Numero corrente di partizioni nell'hub eventi.
properties.retentionDescription	RetentionDescription	Impostazioni di conservazione dell'hub eventi
properties.status	EntityStatus	Enumera i valori possibili per lo stato dell'hub eventi.
properties.updatedAt	string	Ora esatta dell'aggiornamento del messaggio.
properties.userMetadata	string	Ottiene e imposta i metadati dell'utente.
systemData	systemData	Metadati di sistema relativi a questa risorsa.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

EventHubListResult

Risultato dell'operazione List EventHubs.

Nome	Tipo	Descrizione
nextLink	string	Collegamento al set di risultati successivo. Non vuoto se Value contiene un elenco incompleto di Hub eventi.
value	Eventhub[]	Risultato dell'operazione List EventHubs.

RetentionDescription

Proprietà per configurare le impostazioni di conservazione per l'hub eventi

Nome	Tipo	Descrizione
cleanupPolicy	CleanupPolicyRetentionDescription	Enumera i valori possibili per i criteri di pulizia
retentionTimeInHours	integer	Numero di ore per conservare gli eventi per l'hub eventi. Questo valore viene usato solo quando cleanupPolicy è Delete. Se cleanupPolicy è Compact il valore restituito di questa proprietà è Long.MaxValue
tombstoneRetentionTimeInHours	integer	Numero di ore per conservare i marcatori di rimozione definitiva di un hub eventi compattato. Questo valore viene usato solo quando cleanupPolicy è Compact. Il consumer deve completare la lettura del marcatore di rimozione definitiva entro questo intervallo di tempo specificato se il consumer inizia dall'offset iniziale per assicurarsi di ottenere uno snapshot valido per la chiave specifica descritta dal marcatore di rimozione definitiva all'interno dell'hub eventi compattato

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Tipo di identità che ha modificato l'ultima volta la risorsa.
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.