Event Hubs - List By Namespace

Služba:

Event Hubs

Verze rozhraní API:

2024-01-01

Získá všechna centra událostí v oboru názvů.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
namespaceName	path	True	string	Název oboru názvů Vzor regulárního výrazu: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$
resourceGroupName	path	True	string	Název skupiny prostředků v rámci předplatného Azure.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
api-version	query	True	string	Verze rozhraní API klienta.
$skip	query		integer	Skip se používá pouze v případě, že předchozí operace vrátila částečný výsledek. Pokud předchozí odpověď obsahuje prvek nextLink, bude hodnota elementu nextLink obsahovat parametr skip, který určuje počáteční bod pro další volání.
$top	query		integer	Lze použít k omezení počtu výsledků na nejnovější N usageDetails.

Odpovědi

Name	Typ	Description
200 OK	EventHubListResult	Seznam služby Event Hubs se úspěšně načetl.
Other Status Codes	ErrorResponse	Odpověď na chybu centra událostí popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

EventHubsListAll

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
CaptureDescription	Vlastnosti pro konfiguraci popisu zachycení pro eventhub
CaptureIdentity	Hodnota, která označuje, jestli je povolen popis zachycení.
CaptureIdentityType	Typ spravované identity Azure Active Directory
CleanupPolicyRetentionDescription	Vytvoří výčet možných hodnot pro zásady čištění.
createdByType	Typ identity, která prostředek vytvořila.
Destination	Podrobnosti o zachytávání úložiště pro popis zachycení
EncodingCaptureDescription	Vytvoří výčet možných hodnot pro formát kódování popisu záznamu. Poznámka: AvroDeflate bude v nové verzi rozhraní API zastaralá.
EntityStatus	Vytvoří výčet možných hodnot stavu centra událostí.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě
ErrorResponse	Chybová odpověď značí, že služba centra událostí nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě.
Eventhub	Jedna položka v operaci Výpis nebo Získání centra událostí
EventHubListResult	Výsledek operace List EventHubs
RetentionDescription	Vlastnosti pro konfiguraci nastavení uchovávání informací pro centrum událostí
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

CaptureDescription

Vlastnosti pro konfiguraci popisu zachycení pro eventhub

Name	Typ	Description
destination	Destination	Vlastnosti cíle, kam se bude ukládat zachytávání. (Účet úložiště, názvy objektů blob)
enabled	boolean	Hodnota, která označuje, jestli je povolen popis zachycení.
encoding	EncodingCaptureDescription	Vytvoří výčet možných hodnot pro formát kódování popisu záznamu. Poznámka: AvroDeflate bude v nové verzi rozhraní API zastaralá.
intervalInSeconds	integer	Časový interval umožňuje nastavit frekvenci, s jakou se bude provádět zachytávání objektů blob Azure. Hodnota by měla být v rozsahu 60 až 900 sekund.
sizeLimitInBytes	integer	Okno velikosti definuje množství dat vytvořených v centru událostí před operací zachycení. Hodnota by měla být mezi 10485760 a 524288000 bajtů.
skipEmptyArchives	boolean	Hodnota, která určuje, jestli se má přeskočit prázdné archivy

CaptureIdentity

Hodnota, která označuje, jestli je povolen popis zachycení.

Name	Typ	Description
type	CaptureIdentityType	Typ spravované identity Azure Active Directory
userAssignedIdentity	string	ID ARM spravované identity uživatele Tato vlastnost je povinná, je typ UserAssignedIdentity. Pokud je type SystemAssigned, použije se identita přiřazená systémem přidružená k oboru názvů.

CaptureIdentityType

Typ spravované identity Azure Active Directory

Name	Typ	Description
SystemAssigned	string
UserAssigned	string

CleanupPolicyRetentionDescription

Vytvoří výčet možných hodnot pro zásady čištění.

Name	Typ	Description
Compact	string
Delete	string

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Destination

Podrobnosti o zachytávání úložiště pro popis zachycení

Name	Typ	Description
identity	CaptureIdentity	Hodnota, která označuje, jestli je povolen popis zachycení.
name	string	Název cíle zachycení
properties.archiveNameFormat	string	Zásady vytváření názvů objektů blob pro archivaci, například {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Zde jsou všechny parametry (obor názvů, EventHub atd.) povinné bez ohledu na pořadí.
properties.blobContainer	string	Název kontejneru objektů blob
properties.dataLakeAccountName	string	Název Azure Data Lake Store pro zachycené události
properties.dataLakeFolderPath	string	Cesta k cílové složce pro zachycené události
properties.dataLakeSubscriptionId	string	ID předplatného Azure Data Lake Store
properties.storageAccountResourceId	string	ID prostředku účtu úložiště, který se má použít k vytvoření objektů blob

EncodingCaptureDescription

Vytvoří výčet možných hodnot pro formát kódování popisu záznamu. Poznámka: AvroDeflate bude v nové verzi rozhraní API zastaralá.

Name	Typ	Description
Avro	string
AvroDeflate	string

EntityStatus

Vytvoří výčet možných hodnot stavu centra událostí.

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

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorDetail

Podrobnosti o chybě

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď značí, že služba centra událostí nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě.

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

Eventhub

Jedna položka v operaci Výpis nebo Získání centra událostí

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
location	string	Geografické umístění, kde se prostředek nachází
name	string	Název prostředku
properties.captureDescription	CaptureDescription	Vlastnosti popisu zachycení
properties.createdAt	string	Přesný čas vytvoření centra událostí
properties.messageRetentionInDays	integer	Počet dnů pro uchování událostí pro toto centrum událostí, hodnota by měla být 1 až 7 dnů.
properties.partitionCount	integer	Počet oddílů vytvořených pro centrum událostí a povolené hodnoty jsou od 1 do 32 oddílů.
properties.partitionIds	string[]	Aktuální počet horizontálních oddílů v centru událostí
properties.retentionDescription	RetentionDescription	Nastavení uchovávání informací centra událostí
properties.status	EntityStatus	Vytvoří výčet možných hodnot stavu centra událostí.
properties.updatedAt	string	Přesný čas, kdy byla zpráva aktualizována.
properties.userMetadata	string	Získá a nastaví metadata uživatele.
systemData	systemData	Metadata systému vztahující se k tomuto prostředku.
type	string	Typ prostředku. Například Microsoft.EventHub/Namespaces nebo Microsoft.EventHub/Namespaces

EventHubListResult

Výsledek operace List EventHubs

Name	Typ	Description
nextLink	string	Odkaz na další sadu výsledků Není prázdné, pokud value obsahuje neúplný seznam EventHubs.
value	Eventhub[]	Výsledek operace List EventHubs

RetentionDescription

Vlastnosti pro konfiguraci nastavení uchovávání informací pro centrum událostí

Name	Typ	Description
cleanupPolicy	CleanupPolicyRetentionDescription	Vytvoří výčet možných hodnot pro zásady čištění.
retentionTimeInHours	integer	Počet hodin uchování událostí pro toto centrum událostí Tato hodnota se používá pouze v případě, že cleanupPolicy je Delete. Pokud cleanupPolicy je Compact, vrácená hodnota této vlastnosti je Long.MaxValue
tombstoneRetentionTimeInHours	integer	Počet hodin, po které se mají zachovat značky odstraněných objektů zkomprimovaného centra událostí Tato hodnota se používá pouze v případě, že má cleanupPolicy hodnotu Compact. Pokud příjemce začne počátečním posunem, musí příjemce dokončit čtení značky odstraněného objektu během této zadané doby, aby se zajistilo, že získá platný snímek pro konkrétní klíč popsaný značkou odstraněného objektu v rámci zkomprimovaného centra událostí.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která vytvořila prostředek.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Typ identity, která naposledy změnila prostředek.
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.