Event Hubs - List By Namespace

Référence

Service:: Event Hubs

Version d'API:: 2024-01-01

Obtient tous les hubs d’événements d’un espace de noms.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
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 au sein de 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.
$skip	query		integer	Skip est utilisé uniquement si une opération précédente a retourné un résultat partiel. Si une réponse précédente contient un élément nextLink, la valeur de l’élément nextLink inclut un paramètre skip qui spécifie un point de départ à utiliser pour les appels suivants.
$top	query		integer	Peut être utilisé pour limiter le nombre de résultats aux N usageDetails les plus récents.

Réponses

Nom	Type	Description
200 OK	EventHubListResult	Récupération réussie de la liste d’Event Hubs.
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

EventHubsListAll

Exemple de requête

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

Exemple de réponse

Code d’état:: 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
        }
      }
    }
  ]
}

Définitions

Nom	Description
CaptureDescription	Propriétés pour 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	Détails du stockage de capture 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 nouvelle version de l’API
EntityStatus	Énumère les valeurs possibles pour le 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 demande entrante. La raison est fournie dans le message d’erreur.
Eventhub	Élément unique dans l’opération List ou Get Event Hub
EventHubListResult	Résultat de l’opération List EventHubs.
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 pour 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 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 Azure Blobs 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 accumulé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

Détails du stockage de capture 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 de nommage d’objets blob pour l’archive, par exemple {Namespace}/{EventHub}/{PartitionId}/{Année}/{Mois}/{Jour}/{Heure}/{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 nouvelle version de l’API

Nom	Type	Description
Avro	string
AvroDeflate	string

EntityStatus

Énumère les valeurs possibles pour le 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 demande entrante. La raison est fournie dans le message d’erreur.

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

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 de création de l’Event Hub.
properties.messageRetentionInDays	integer	Nombre de jours pour conserver les événements pour ce Hub d’événements, la valeur doit être comprise entre 1 et 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 le hub d’événements.
properties.retentionDescription	RetentionDescription	Paramètres de rétention d’Event Hub
properties.status	EntityStatus	Énumère les valeurs possibles pour le 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 »

EventHubListResult

Résultat de l’opération List EventHubs.

Nom	Type	Description
nextLink	string	Lien vers l’ensemble de résultats suivant. Non vide si Value contient la liste incomplète d’EventHubs.
value	Eventhub[]	Résultat de l’opération List 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 pour conserver les événements pour ce hub d’événements. Cette valeur est utilisée uniquement lorsque cleanupPolicy est 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 dernière ressource.
lastModifiedBy	string	Identité qui a modifié la dernière ressource.
lastModifiedByType	createdByType	Type d’identité qui a modifié la dernière ressource.