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 매개 변수

Name	In(다음 안에)	필수	형식	Description
namespaceName	path	True	string	네임스페이스 이름 regex 패턴: ^[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로 제한하는 데 사용할 수 있습니다.

응답

Name	형식	Description
200 OK	EventHubListResult	Event Hubs 목록을 성공적으로 검색했습니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 Eventhub 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

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

정의

Name	Description
CaptureDescription	eventhub에 대한 캡처 설명을 구성하는 속성
CaptureIdentity	캡처 설명을 사용할 수 있는지 여부를 나타내는 값입니다.
CaptureIdentityType	Azure Active Directory 관리 ID 유형입니다.
CleanupPolicyRetentionDescription	정리 정책에 사용할 수 있는 값을 열거합니다.
createdByType	리소스를 만든 ID의 형식입니다.
Destination	캡처 설명을 위한 스토리지 세부 정보 캡처
EncodingCaptureDescription	캡처 설명의 인코딩 형식에 사용할 수 있는 값을 열거합니다. 참고: 'AvroDeflate'는 새 API 버전에서 더 이상 사용되지 않습니다.
EntityStatus	이벤트 허브의 상태 가능한 값을 열거합니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답은 Event Hub 서비스가 들어오는 요청을 처리할 수 없음을 나타냅니다. 그 이유는 오류 메시지에 제공됩니다.
Eventhub	이벤트 허브 나열 또는 가져오기 작업의 단일 항목
EventHubListResult	EventHubs 나열 작업의 결과입니다.
RetentionDescription	eventhub에 대한 보존 설정을 구성하는 속성
systemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

CaptureDescription

eventhub에 대한 캡처 설명을 구성하는 속성

Name	형식	Description
destination	Destination	캡처가 저장될 대상의 속성입니다. (스토리지 계정, Blob 이름)
enabled	boolean	캡처 설명을 사용할 수 있는지 여부를 나타내는 값입니다.
encoding	EncodingCaptureDescription	캡처 설명의 인코딩 형식에 사용할 수 있는 값을 열거합니다. 참고: 'AvroDeflate'는 새 API 버전에서 더 이상 사용되지 않습니다.
intervalInSeconds	integer	시간 창을 사용하면 캡처가 Azure Blob으로 발생하는 빈도를 설정할 수 있습니다. 값은 60~900초 사이여야 합니다.
sizeLimitInBytes	integer	크기 창은 캡처 작업 전에 Event Hub에 빌드된 데이터의 양을 정의합니다. 값은 10485760~524288000 바이트 사이여야 합니다.
skipEmptyArchives	boolean	빈 보관을 건너뛸지 여부를 나타내는 값입니다.

CaptureIdentity

캡처 설명을 사용할 수 있는지 여부를 나타내는 값입니다.

Name	형식	Description
type	CaptureIdentityType	Azure Active Directory 관리 ID 유형입니다.
userAssignedIdentity	string	관리되는 사용자 ID의 ARM ID입니다. 이 속성은 UserAssignedIdentity 형식이 필요합니다. Type이 SystemAssigned이면 네임스페이스와 연결된 시스템 할당 ID가 사용됩니다.

CaptureIdentityType

Azure Active Directory 관리 ID 유형입니다.

Name	형식	Description
SystemAssigned	string
UserAssigned	string

CleanupPolicyRetentionDescription

정리 정책에 사용할 수 있는 값을 열거합니다.

Name	형식	Description
Compact	string
Delete	string

createdByType

리소스를 만든 ID의 형식입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Destination

캡처 설명을 위한 스토리지 세부 정보 캡처

Name	형식	Description
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 버전에서 더 이상 사용되지 않습니다.

Name	형식	Description
Avro	string
AvroDeflate	string

EntityStatus

이벤트 허브의 상태 가능한 값을 열거합니다.

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

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

오류 응답은 Event Hub 서비스가 들어오는 요청을 처리할 수 없음을 나타냅니다. 그 이유는 오류 메시지에 제공됩니다.

Name	형식	Description
error	ErrorDetail	Error 개체.

Eventhub

이벤트 허브 나열 또는 가져오기 작업의 단일 항목

Name	형식	Description
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	사용자의 메타데이터를 가져오고 설정합니다.
systemData	systemData	이 리소스와 관련된 시스템 메타 데이터입니다.
type	string	리소스 형식입니다. 예: "Microsoft.EventHub/Namespaces" 또는 "Microsoft.EventHub/Namespaces/EventHubs"

EventHubListResult

EventHubs 나열 작업의 결과입니다.

Name	형식	Description
nextLink	string	다음 결과 집합에 연결합니다. 값에 EventHubs의 불완전한 목록이 포함되어 있으면 비어 있지 않습니다.
value	Eventhub[]	EventHubs 나열 작업의 결과입니다.

RetentionDescription

eventhub에 대한 보존 설정을 구성하는 속성

Name	형식	Description
cleanupPolicy	CleanupPolicyRetentionDescription	정리 정책에 사용할 수 있는 값을 열거합니다.
retentionTimeInHours	integer	이 이벤트 허브에 대한 이벤트를 보존하는 데 소요되는 시간입니다. 이 값은 cleanupPolicy가 Delete인 경우에만 사용됩니다. cleanupPolicy가 Compact이면 이 속성의 반환된 값은 Long.MaxValue입니다.
tombstoneRetentionTimeInHours	integer	압축된 이벤트 허브의 삭제 표시 표식을 유지하는 데 소요되는 시간입니다. 이 값은 cleanupPolicy가 Compact인 경우에만 사용됩니다. 소비자는 압축된 이벤트 허브 내에서 삭제 표시 표식에 설명된 특정 키에 대한 유효한 스냅샷 가져오기 위해 시작 오프셋에서 시작하는 경우 지정된 시간 내에 삭제 표시 표식 읽기를 완료해야 합니다.

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	UTC(리소스 만들기)의 타임스탬프입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string	리소스를 마지막으로 수정한 ID 유형입니다.
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID 유형입니다.