Event Hubs - List By Namespace

サービス:

Event Hubs

API バージョン:

2024-01-01

名前空間内のすべての Event Hubs を取得します。

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

省略可能なパラメーターを含む:

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 パラメーター

名前	/	必須	型	説明
namespaceName	path	True	string	名前空間名 正規表現パターン: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$
resourceGroupName	path	True	string	Azure サブスクリプション内のリソース グループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API のバージョン。
$skip	query		integer	Skip は、前の操作で部分的な結果が返された場合にのみ使用されます。 前の応答に nextLink 要素が含まれている場合、nextLink 要素の値には、後続の呼び出しに使用する開始点を指定する skip パラメーターが含まれます。
$top	query		integer	結果の数を最新の N usageDetails に制限するために使用できます。

応答

名前	型	説明
200 OK	EventHubListResult	Event Hubs の一覧が正常に取得されました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明する Eventhub エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントの借用

例

EventHubsListAll

要求のサンプル

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

応答のサンプル

状態コード:

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

定義

名前	説明
CaptureDescription	eventhub のキャプチャの説明を構成するためのプロパティ
CaptureIdentity	キャプチャの説明が有効かどうかを示す 値。
CaptureIdentityType	Azure Active Directory マネージド ID の種類。
CleanupPolicyRetentionDescription	クリーンアップ ポリシーで使用可能な値を列挙します
createdByType	リソースを作成した ID の種類。
Destination	キャプチャの説明に関するストレージの詳細をキャプチャする
EncodingCaptureDescription	キャプチャの説明のエンコード形式に使用できる値を列挙します。 注: 'AvroDeflate' は、新しい API バージョンでは非推奨になります
EntityStatus	イベント ハブの状態に使用できる値を列挙します。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに表示されます。
Eventhub	List 操作または Get Event Hub 操作の単一項目
EventHubListResult	List EventHubs 操作の結果。
RetentionDescription	eventhub の保持設定を構成するためのプロパティ
systemData	リソースの作成と最後の変更に関連するメタデータ。

CaptureDescription

eventhub のキャプチャの説明を構成するためのプロパティ

名前	型	説明
destination	Destination	キャプチャが格納される Destination のプロパティ。 (ストレージ アカウント、BLOB 名)
enabled	boolean	キャプチャの説明が有効かどうかを示す 値。
encoding	EncodingCaptureDescription	キャプチャの説明のエンコード形式に使用できる値を列挙します。 注: 'AvroDeflate' は、新しい API バージョンでは非推奨になります
intervalInSeconds	integer	時間枠を使用すると、Azure BLOB へのキャプチャが発生する頻度を設定できます。値は 60 ~ 900 秒にする必要があります
sizeLimitInBytes	integer	[サイズ] ウィンドウでは、キャプチャ操作の前に Event Hub に構築されたデータの量を定義します。値は 10485760 から 524288000 バイトの間にする必要があります
skipEmptyArchives	boolean	空のアーカイブをスキップするかどうかを示す 値

CaptureIdentity

キャプチャの説明が有効かどうかを示す 値。

名前	型	説明
type	CaptureIdentityType	Azure Active Directory マネージド ID の種類。
userAssignedIdentity	string	マネージド ユーザー ID の ARM ID。 このプロパティは、UserAssignedIdentity 型である必要があります。 型が SystemAssigned の場合は、名前空間に関連付けられているシステム割り当て ID が使用されます。

CaptureIdentityType

Azure Active Directory マネージド ID の種類。

名前	型	説明
SystemAssigned	string
UserAssigned	string

CleanupPolicyRetentionDescription

クリーンアップ ポリシーで使用可能な値を列挙します

名前	型	説明
Compact	string
Delete	string

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

Destination

キャプチャの説明に関するストレージの詳細をキャプチャする

名前	型	説明
identity	CaptureIdentity	キャプチャの説明が有効かどうかを示す 値。
name	string	キャプチャ先の名前
properties.archiveNameFormat	string	アーカイブの BLOB 名前付け規則 (例: {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second} など。 ここでは、順序に関係なく、すべてのパラメーター (名前空間、EventHub など) が必須です
properties.blobContainer	string	BLOB コンテナー名
properties.dataLakeAccountName	string	キャプチャされたイベントの Azure Data Lake Store 名
properties.dataLakeFolderPath	string	キャプチャされたイベントの宛先フォルダー パス
properties.dataLakeSubscriptionId	string	Azure Data Lake Store のサブスクリプション ID
properties.storageAccountResourceId	string	BLOB の作成に使用するストレージ アカウントのリソース ID

EncodingCaptureDescription

キャプチャの説明のエンコード形式に使用できる値を列挙します。 注: 'AvroDeflate' は、新しい API バージョンでは非推奨になります

名前	型	説明
Avro	string
AvroDeflate	string

EntityStatus

イベント ハブの状態に使用できる値を列挙します。

名前	型	説明
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラー メッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答は、Event Hub サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに表示されます。

名前	型	説明
error	ErrorDetail	error オブジェクト。

Eventhub

List 操作または Get Event Hub 操作の単一項目

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	リソースが保存されている地理的な場所
name	string	リソースの名前
properties.captureDescription	CaptureDescription	キャプチャの説明のプロパティ
properties.createdAt	string	イベント ハブが作成された正確な時刻。
properties.messageRetentionInDays	integer	このイベント ハブのイベントを保持する日数。値は 1 日から 7 日にする必要があります
properties.partitionCount	integer	イベント ハブ用に作成されたパーティションの数。使用できる値は 1 から 32 個のパーティションです。
properties.partitionIds	string[]	イベント ハブ上のシャードの現在の数。
properties.retentionDescription	RetentionDescription	イベント ハブの保持設定
properties.status	EntityStatus	イベント ハブの状態に使用できる値を列挙します。
properties.updatedAt	string	メッセージが更新された正確な時刻。
properties.userMetadata	string	User のメタデータを取得および設定します。
systemData	systemData	このリソースに関連するシステム メタデータ。
type	string	リソースの型。 例: "Microsoft.EventHub/Namespaces" または "Microsoft.EventHub/Namespaces/EventHubs"

EventHubListResult

List EventHubs 操作の結果。

名前	型	説明
nextLink	string	次の結果セットにリンクします。 Value に EventHubs の不完全なリストが含まれている場合は空ではありません。
value	Eventhub[]	List EventHubs 操作の結果。

RetentionDescription

eventhub の保持設定を構成するためのプロパティ

名前	型	説明
cleanupPolicy	CleanupPolicyRetentionDescription	クリーンアップ ポリシーで使用可能な値を列挙します
retentionTimeInHours	integer	このイベント ハブのイベントを保持する時間数。 この値は、cleanupPolicy が Delete の場合にのみ使用されます。 cleanupPolicy が Compact の場合、このプロパティの戻り値は Long.MaxValue です
tombstoneRetentionTimeInHours	integer	圧縮されたイベント ハブの廃棄石マーカーを保持する時間数。 この値は、cleanupPolicy が Compact の場合にのみ使用されます。 コンシューマーは、最適化されたイベント ハブ内の廃棄石マーカーによって記述された特定のキーの有効なスナップショットを取得するために、オフセットの開始から開始する場合、この指定された時間内に廃棄石マーカーの読み取りを完了する必要があります

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースを最後に変更した ID の種類。
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。