Event Hubs - List By Namespace

Odwołanie

Usługa:: Event Hubs

Wersja interfejsu API:: 2024-01-01

Pobiera wszystkie usługi Event Hubs w przestrzeni nazw.

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

Z parametrami opcjonalnymi:

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 identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
namespaceName	path	True	string	Nazwa przestrzeni nazw Wzorzec wyrażenia regularnego: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach subskrypcji platformy Azure.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta.
$skip	query		integer	Pomiń jest używany tylko wtedy, gdy poprzednia operacja zwróciła częściowy wynik. Jeśli poprzednia odpowiedź zawiera element nextLink, wartość elementu nextLink będzie zawierać parametr skip, który określa punkt wyjścia do użycia dla kolejnych wywołań.
$top	query		integer	Może służyć do ograniczenia liczby wyników do najnowszego N użyciaDetails.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	EventHubListResult	Pomyślnie pobrano listę usługi Event Hubs.
Other Status Codes	ErrorResponse	Odpowiedź z błędem usługi EventHub opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

EventHubsListAll

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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
        }
      }
    }
  ]
}

Definicje

Nazwa	Opis
CaptureDescription	Właściwości służące do konfigurowania opisu przechwytywania dla usługi EventHub
CaptureIdentity	Wartość wskazująca, czy opis przechwytywania jest włączony.
CaptureIdentityType	Typ tożsamości zarządzanej usługi Azure Active Directory.
CleanupPolicyRetentionDescription	Wylicza możliwe wartości zasad oczyszczania
createdByType	Typ tożsamości, która utworzyła zasób.
Destination	Przechwytywanie szczegółów magazynu na potrzeby opisu przechwytywania
EncodingCaptureDescription	Wylicza możliwe wartości dla formatu kodowania opisu przechwytywania. Uwaga: wartość "AvroDeflate" będzie przestarzała w nowej wersji interfejsu API
EntityStatus	Wylicza możliwe wartości stanu centrum zdarzeń.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd wskazuje, że usługa Event Hub nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.
Eventhub	Pojedynczy element na liście lub operacja pobierania centrum zdarzeń
EventHubListResult	Wynik operacji List EventHubs.
RetentionDescription	Właściwości służące do konfigurowania ustawień przechowywania dla usługi EventHub
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

CaptureDescription

Właściwości służące do konfigurowania opisu przechwytywania dla usługi EventHub

Nazwa	Typ	Opis
destination	Destination	Właściwości miejsca docelowego, w którym będzie przechowywane przechwytywanie. (Konto magazynu, nazwy obiektów blob)
enabled	boolean	Wartość wskazująca, czy opis przechwytywania jest włączony.
encoding	EncodingCaptureDescription	Wylicza możliwe wartości dla formatu kodowania opisu przechwytywania. Uwaga: wartość "AvroDeflate" będzie przestarzała w nowej wersji interfejsu API
intervalInSeconds	integer	Przedział czasu umożliwia ustawienie częstotliwości, z jaką będzie wykonywane przechwytywanie do obiektów blob platformy Azure. Wartość powinna wynosić od 60 do 900 sekund
sizeLimitInBytes	integer	Okno rozmiaru definiuje ilość danych utworzonych w centrum zdarzeń przed operacją przechwytywania. Wartość powinna należeć do 10485760 do 524288000 bajtów
skipEmptyArchives	boolean	Wartość wskazująca, czy pomijać puste archiwa

CaptureIdentity

Wartość wskazująca, czy opis przechwytywania jest włączony.

Nazwa	Typ	Opis
type	CaptureIdentityType	Typ tożsamości zarządzanej usługi Azure Active Directory.
userAssignedIdentity	string	Identyfikator usługi ARM tożsamości użytkownika zarządzanego. Ta właściwość jest wymagana, jest typem UserAssignedIdentity. Jeśli typ ma wartość SystemAssigned, zostanie użyta tożsamość przypisana przez system skojarzona z przestrzenią nazw.

CaptureIdentityType

Typ tożsamości zarządzanej usługi Azure Active Directory.

Nazwa	Typ	Opis
SystemAssigned	string
UserAssigned	string

CleanupPolicyRetentionDescription

Wylicza możliwe wartości zasad oczyszczania

Nazwa	Typ	Opis
Compact	string
Delete	string

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

Destination

Przechwytywanie szczegółów magazynu na potrzeby opisu przechwytywania

Nazwa	Typ	Opis
identity	CaptureIdentity	Wartość wskazująca, czy opis przechwytywania jest włączony.
name	string	Nazwa miejsca docelowego przechwytywania
properties.archiveNameFormat	string	Konwencja nazewnictwa obiektów blob dla archiwum, np. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Tutaj wszystkie parametry (przestrzeń nazw, eventhub itp.) są obowiązkowe niezależnie od kolejności
properties.blobContainer	string	Nazwa kontenera obiektów blob
properties.dataLakeAccountName	string	Nazwa usługi Azure Data Lake Store dla przechwyconych zdarzeń
properties.dataLakeFolderPath	string	Ścieżka folderu docelowego dla przechwyconych zdarzeń
properties.dataLakeSubscriptionId	string	Identyfikator subskrypcji usługi Azure Data Lake Store
properties.storageAccountResourceId	string	Identyfikator zasobu konta magazynu do utworzenia obiektów blob

EncodingCaptureDescription

Wylicza możliwe wartości dla formatu kodowania opisu przechwytywania. Uwaga: wartość "AvroDeflate" będzie przestarzała w nowej wersji interfejsu API

Nazwa	Typ	Opis
Avro	string
AvroDeflate	string

EntityStatus

Wylicza możliwe wartości stanu centrum zdarzeń.

Nazwa	Typ	Opis
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd wskazuje, że usługa Event Hub nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.

Eventhub

Pojedynczy element na liście lub operacja pobierania centrum zdarzeń

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.captureDescription	CaptureDescription	Właściwości opisu przechwytywania
properties.createdAt	string	Dokładny czas utworzenia centrum zdarzeń.
properties.messageRetentionInDays	integer	Liczba dni przechowywania zdarzeń dla tego centrum zdarzeń. Wartość powinna wynosić od 1 do 7 dni
properties.partitionCount	integer	Liczba partycji utworzonych dla centrum zdarzeń dozwolone wartości to od 1 do 32 partycji.
properties.partitionIds	string[]	Bieżąca liczba fragmentów w centrum zdarzeń.
properties.retentionDescription	RetentionDescription	Ustawienia przechowywania centrum zdarzeń
properties.status	EntityStatus	Wylicza możliwe wartości stanu centrum zdarzeń.
properties.updatedAt	string	Dokładny czas aktualizacji wiadomości.
properties.userMetadata	string	Pobiera i ustawia metadane użytkownika.
systemData	systemData	Metadane systemowe odnoszące się do tego zasobu.
type	string	Typ zasobu. Np. "Microsoft.EventHub/Namespaces" lub "Microsoft.EventHub/Namespaces/EventHubs"

EventHubListResult

Wynik operacji List EventHubs.

Nazwa	Typ	Opis
nextLink	string	Połącz z następnym zestawem wyników. Wartość nie jest pusta, jeśli wartość zawiera niekompletną listę usługi EventHubs.
value	Eventhub[]	Wynik operacji List EventHubs.

RetentionDescription

Właściwości służące do konfigurowania ustawień przechowywania dla usługi EventHub

Nazwa	Typ	Opis
cleanupPolicy	CleanupPolicyRetentionDescription	Wylicza możliwe wartości zasad oczyszczania
retentionTimeInHours	integer	Liczba godzin przechowywania zdarzeń dla tego centrum zdarzeń. Ta wartość jest używana tylko wtedy, gdy cleanupPolicy to Delete. Jeśli cleanupPolicy to Compact, zwracana wartość tej właściwości to Long.MaxValue
tombstoneRetentionTimeInHours	integer	Liczba godzin przechowywania markerów reliktów kompaktowanego centrum zdarzeń. Ta wartość jest używana tylko wtedy, gdy cleanupPolicy to Compact. Użytkownik musi ukończyć odczytywanie znacznika reliktów w tym określonym czasie, jeśli odbiorca rozpoczyna się od przesunięcia początkowego, aby upewnić się, że otrzyma prawidłową migawkę dla określonego klucza opisanego przez znacznik tombstone w skompaktowanym centrum zdarzeń

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Typ tożsamości, która ostatnio zmodyfikowała zasób.
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.