Event Hubs - List By Namespace

Service:

Event Hubs

API-versie:

2024-01-01

Hiermee haalt u alle Event Hubs in een naamruimte op.

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

Met optionele parameters:

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

Name	In	Vereist	Type	Description
namespaceName	path	True	string	De naam van de naamruimte Regex-patroon: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$
resourceGroupName	path	True	string	Naam van de resourcegroep binnen het Azure-abonnement.
subscriptionId	path	True	string	Abonnementsreferenties waarmee een Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Client-API-versie.
$skip	query		integer	Skip wordt alleen gebruikt als een eerdere bewerking een gedeeltelijk resultaat heeft geretourneerd. Als een eerder antwoord een nextLink-element bevat, bevat de waarde van het element nextLink een skip-parameter die een beginpunt aangeeft dat voor volgende aanroepen moet worden gebruikt.
$top	query		integer	Kan worden gebruikt om het aantal resultaten te beperken tot de meest recente N usageDetails.

Antwoorden

Name	Type	Description
200 OK	EventHubListResult	De lijst met Event Hubs is opgehaald.
Other Status Codes	ErrorResponse	Eventhub-foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

EventHubsListAll

Voorbeeldaanvraag

HTTP

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

Java

/**
 * 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

Python

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

Go

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

JavaScript

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

dotnet

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
CaptureDescription	Eigenschappen voor het configureren van de capture-beschrijving voor eventhub
CaptureIdentity	Een waarde die aangeeft of de beschrijving van het vastleggen is ingeschakeld.
CaptureIdentityType	Type beheerde identiteit van Azure Active Directory.
CleanupPolicyRetentionDescription	Inventariseert de mogelijke waarden voor opschoningsbeleid
createdByType	Het type identiteit waarmee de resource is gemaakt.
Destination	Opslagdetails vastleggen voor een beschrijving van de opname
EncodingCaptureDescription	Inventariseert de mogelijke waarden voor de coderingsindeling van de beschrijving van de opname. Opmerking: AvroDeflate wordt afgeschaft in nieuwe API-versie
EntityStatus	Inventariseert de mogelijke waarden voor de status van de Event Hub.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie geeft aan dat de Event Hub-service de binnenkomende aanvraag niet kan verwerken. De reden wordt opgegeven in het foutbericht.
Eventhub	Eén item in De bewerking Lijst of Event Hub ophalen
EventHubListResult	Het resultaat van de Bewerking List EventHubs.
RetentionDescription	Eigenschappen voor het configureren van retentie-instellingen voor eventhub
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

CaptureDescription

Eigenschappen voor het configureren van de capture-beschrijving voor eventhub

Name	Type	Description
destination	Destination	Eigenschappen van bestemming waar de opname wordt opgeslagen. (Opslagaccount, blobnamen)
enabled	boolean	Een waarde die aangeeft of de beschrijving van het vastleggen is ingeschakeld.
encoding	EncodingCaptureDescription	Inventariseert de mogelijke waarden voor de coderingsindeling van de beschrijving van de opname. Opmerking: AvroDeflate wordt afgeschaft in nieuwe API-versie
intervalInSeconds	integer	Met het tijdvenster kunt u de frequentie instellen waarmee het vastleggen naar Azure-blobs wordt uitgevoerd, een waarde tussen 60 en 900 seconden
sizeLimitInBytes	integer	Het groottevenster definieert de hoeveelheid gegevens die is opgebouwd in uw Event Hub vóór een opnamebewerking. De waarde moet tussen 10485760 en 524288000 bytes zijn
skipEmptyArchives	boolean	Een waarde die aangeeft of lege archieven moeten worden overgeslagen

CaptureIdentity

Een waarde die aangeeft of de beschrijving van het vastleggen is ingeschakeld.

Name	Type	Description
type	CaptureIdentityType	Type beheerde identiteit van Azure Active Directory.
userAssignedIdentity	string	ARM-id van beheerde gebruikersidentiteit. Deze eigenschap is vereist is het type UserAssignedIdentity. Als het type SystemAssigned is, wordt de door het systeem toegewezen identiteit die is gekoppeld aan de naamruimte gebruikt.

CaptureIdentityType

Type beheerde identiteit van Azure Active Directory.

Name	Type	Description
SystemAssigned	string
UserAssigned	string

CleanupPolicyRetentionDescription

Inventariseert de mogelijke waarden voor opschoningsbeleid

Name	Type	Description
Compact	string
Delete	string

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Destination

Opslagdetails vastleggen voor een beschrijving van de opname

Name	Type	Description
identity	CaptureIdentity	Een waarde die aangeeft of de beschrijving van het vastleggen is ingeschakeld.
name	string	Naam voor opnamebestemming
properties.archiveNameFormat	string	Blob-naamconventie voor archief, bijvoorbeeld {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Hier zijn alle parameters (naamruimte, EventHub enz.) verplicht, ongeacht de volgorde
properties.blobContainer	string	Naam van blobcontainer
properties.dataLakeAccountName	string	De Azure Data Lake Store-naam voor de vastgelegde gebeurtenissen
properties.dataLakeFolderPath	string	Het pad naar de doelmap voor de vastgelegde gebeurtenissen
properties.dataLakeSubscriptionId	string	Abonnements-id van Azure Data Lake Store
properties.storageAccountResourceId	string	Resource-id van het opslagaccount dat moet worden gebruikt om de blobs te maken

EncodingCaptureDescription

Inventariseert de mogelijke waarden voor de coderingsindeling van de beschrijving van de opname. Opmerking: AvroDeflate wordt afgeschaft in nieuwe API-versie

Name	Type	Description
Avro	string
AvroDeflate	string

EntityStatus

Inventariseert de mogelijke waarden voor de status van de Event Hub.

Name	Type	Description
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie geeft aan dat de Event Hub-service de binnenkomende aanvraag niet kan verwerken. De reden wordt opgegeven in het foutbericht.

Name	Type	Description
error	ErrorDetail	Het foutobject.

Eventhub

Eén item in De bewerking Lijst of Event Hub ophalen

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.captureDescription	CaptureDescription	Eigenschappen van de beschrijving van de opname
properties.createdAt	string	Exact tijdstip waarop de Event Hub is gemaakt.
properties.messageRetentionInDays	integer	Aantal dagen voor het bewaren van de gebeurtenissen voor deze Event Hub. De waarde moet 1 tot 7 dagen zijn
properties.partitionCount	integer	Het aantal partities dat is gemaakt voor de Event Hub. Toegestane waarden liggen tussen 1 en 32 partities.
properties.partitionIds	string[]	Huidig aantal shards op de Event Hub.
properties.retentionDescription	RetentionDescription	Retentie-instellingen voor Event Hub
properties.status	EntityStatus	Inventariseert de mogelijke waarden voor de status van de Event Hub.
properties.updatedAt	string	Het exacte tijdstip waarop het bericht is bijgewerkt.
properties.userMetadata	string	Hiermee worden metagegevens van de gebruiker opgehaald en ingesteld.
systemData	systemData	De systeemmetagegevens met betrekking tot deze resource.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.EventHub/Namespaces' of 'Microsoft.EventHub/Namespaces/EventHubs'

EventHubListResult

Het resultaat van de Bewerking List EventHubs.

Name	Type	Description
nextLink	string	Koppeling naar de volgende set resultaten. Niet leeg als Waarde een onvolledige lijst met EventHubs bevat.
value	Eventhub[]	Resultaat van de Bewerking List EventHubs.

RetentionDescription

Eigenschappen voor het configureren van retentie-instellingen voor eventhub

Name	Type	Description
cleanupPolicy	CleanupPolicyRetentionDescription	Inventariseert de mogelijke waarden voor opschoningsbeleid
retentionTimeInHours	integer	Aantal uren voor het bewaren van de gebeurtenissen voor deze Event Hub. Deze waarde wordt alleen gebruikt wanneer cleanupPolicy Delete is. Als cleanupPolicy Compact is, is de geretourneerde waarde van deze eigenschap Long.MaxValue
tombstoneRetentionTimeInHours	integer	Aantal uren voor het bewaren van de tombstone-markeringen van een gecomprimeerde Event Hub. Deze waarde wordt alleen gebruikt wanneer cleanupPolicy Compact is. De consument moet de tombstone-markering binnen deze opgegeven tijd voltooien als de consument begint met het starten van offset om ervoor te zorgen dat deze een geldige momentopname krijgt voor de specifieke sleutel die wordt beschreven door de tombstone-markering in de gecomprimeerde Event Hub

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	Het tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	Het type identiteit dat de resource het laatst heeft gewijzigd.
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.