Event Hubs - List By Namespace

Referência

Serviço:: Event Hubs

Versão da API:: 2024-01-01

Obtém todos os Hubs de Eventos num Espaço de Nomes.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
namespaceName	path	True	string	O nome do Espaço de Nomes Padrão Regex: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Nome do grupo de recursos na subscrição do azure.
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente uma subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API de Cliente.
$skip	query		integer	Ignorar só é utilizado se uma operação anterior devolveu um resultado parcial. Se uma resposta anterior contiver um elemento nextLink, o valor do elemento nextLink incluirá um parâmetro skip que especifica um ponto de partida a utilizar para chamadas subsequentes.
$top	query		integer	Pode ser utilizado para limitar o número de resultados às N usageDetails mais recentes.

Respostas

Name	Tipo	Description
200 OK	EventHubListResult	Obteve com êxito a lista de Hubs de Eventos.
Other Status Codes	ErrorResponse	Resposta de erro do Eventhub que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

EventHubsListAll

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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
        }
      }
    }
  ]
}

Definições

Name	Description
CaptureDescription	Propriedades para configurar a descrição da captura para o eventhub
CaptureIdentity	Um valor que indica se a descrição da captura está ativada.
CaptureIdentityType	Tipo de Identidade Gerida do Azure Active Directory.
CleanupPolicyRetentionDescription	Enumera os valores possíveis para a política de limpeza
createdByType	O tipo de identidade que criou o recurso.
Destination	Capturar detalhes de armazenamento para a descrição da captura
EncodingCaptureDescription	Enumera os valores possíveis para o formato de codificação da descrição da captura. Nota: "AvroDeflate" será preterido na Nova Versão da API
EntityStatus	Enumera os valores possíveis para o estado do Hub de Eventos.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	A resposta a erros indica que o serviço hub de eventos não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.
Eventhub	Item único na operação Listar ou Obter Hub de Eventos
EventHubListResult	O resultado da operação Listar EventHubs.
RetentionDescription	Propriedades para configurar as definições de retenção para o eventhub
systemData	Metadados relativos à criação e última modificação do recurso.

CaptureDescription

Propriedades para configurar a descrição da captura para o eventhub

Name	Tipo	Description
destination	Destination	Propriedades do Destino onde a captura será armazenada. (Conta de Armazenamento, Nomes de Blobs)
enabled	boolean	Um valor que indica se a descrição da captura está ativada.
encoding	EncodingCaptureDescription	Enumera os valores possíveis para o formato de codificação da descrição da captura. Nota: "AvroDeflate" será preterido na Nova Versão da API
intervalInSeconds	integer	A janela de tempo permite-lhe definir a frequência com que a captura para os Blobs do Azure irá ocorrer, o valor deve estar entre 60 e 900 segundos
sizeLimitInBytes	integer	A janela de tamanho define a quantidade de dados acumulados no Hub de Eventos antes de uma operação de captura, o valor deve estar entre 10485760 para 524288000 bytes
skipEmptyArchives	boolean	Um valor que indica se deve Ignorar Arquivos Vazios

CaptureIdentity

Um valor que indica se a descrição da captura está ativada.

Name	Tipo	Description
type	CaptureIdentityType	Tipo de Identidade Gerida do Azure Active Directory.
userAssignedIdentity	string	ID arm da Identidade de Utilizador Gerida. Esta propriedade é necessária é o tipo userAssignedIdentity. Se o tipo for SystemAssigned, será utilizada a Identidade Atribuída pelo Sistema Associada ao espaço de nomes.

CaptureIdentityType

Tipo de Identidade Gerida do Azure Active Directory.

Name	Tipo	Description
SystemAssigned	string
UserAssigned	string

CleanupPolicyRetentionDescription

Enumera os valores possíveis para a política de limpeza

Name	Tipo	Description
Compact	string
Delete	string

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Destination

Capturar detalhes de armazenamento para a descrição da captura

Name	Tipo	Description
identity	CaptureIdentity	Um valor que indica se a descrição da captura está ativada.
name	string	Nome para destino de captura
properties.archiveNameFormat	string	Convenção de nomenclatura de blobs para arquivo, por exemplo, {Espaço de Nomes}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Aqui, todos os parâmetros (Espaço de Nomes, EventHub .. etc.) são obrigatórios, independentemente da ordem
properties.blobContainer	string	Nome do contentor de blobs
properties.dataLakeAccountName	string	O nome do Azure Data Lake Store para os eventos capturados
properties.dataLakeFolderPath	string	O caminho da pasta de destino para os eventos capturados
properties.dataLakeSubscriptionId	string	ID da Subscrição do Azure Data Lake Store
properties.storageAccountResourceId	string	ID de recurso da conta de armazenamento a utilizar para criar os blobs

EncodingCaptureDescription

Enumera os valores possíveis para o formato de codificação da descrição da captura. Nota: "AvroDeflate" será preterido na Nova Versão da API

Name	Tipo	Description
Avro	string
AvroDeflate	string

EntityStatus

Enumera os valores possíveis para o estado do Hub de Eventos.

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

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

A resposta a erros indica que o serviço hub de eventos não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

Eventhub

Item único na operação Listar ou Obter Hub de Eventos

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A localização geográfica onde o recurso se encontra
name	string	O nome do recurso
properties.captureDescription	CaptureDescription	Propriedades da descrição da captura
properties.createdAt	string	Hora exata em que o Hub de Eventos foi criado.
properties.messageRetentionInDays	integer	Número de dias para manter os eventos deste Hub de Eventos, o valor deve ser de 1 a 7 dias
properties.partitionCount	integer	Número de partições criadas para o Hub de Eventos, os valores permitidos são de 1 a 32 partições.
properties.partitionIds	string[]	Número atual de partições horizontais no Hub de Eventos.
properties.retentionDescription	RetentionDescription	Definições de retenção do Hub de Eventos
properties.status	EntityStatus	Enumera os valores possíveis para o estado do Hub de Eventos.
properties.updatedAt	string	A hora exata em que a mensagem foi atualizada.
properties.userMetadata	string	Obtém e Define Metadados do Utilizador.
systemData	systemData	Os metadados do sistema relacionados com este recurso.
type	string	O tipo de recurso. Por exemplo, "Microsoft.EventHub/Namespaces" ou "Microsoft.EventHub/Namespaces/EventHubs"

EventHubListResult

O resultado da operação Listar EventHubs.

Name	Tipo	Description
nextLink	string	Ligue ao próximo conjunto de resultados. Não está vazio se Value contiver uma lista incompleta de EventHubs.
value	Eventhub[]	Resultado da operação Listar EventHubs.

RetentionDescription

Propriedades para configurar as definições de retenção para o eventhub

Name	Tipo	Description
cleanupPolicy	CleanupPolicyRetentionDescription	Enumera os valores possíveis para a política de limpeza
retentionTimeInHours	integer	Número de horas para reter os eventos deste Hub de Eventos. Este valor só é utilizado quando cleanupPolicy é Delete. Se cleanupPolicy é Compactar, o valor devolvido desta propriedade é Long.MaxValue
tombstoneRetentionTimeInHours	integer	Número de horas para manter os marcadores de lápide de um Hub de Eventos compactado. Este valor só é utilizado quando cleanupPolicy é Compact. O consumidor tem de concluir a leitura do marcador de lápide dentro deste período de tempo especificado se o consumidor começar a partir do desvio inicial para garantir que obtém um instantâneo válido para a chave específica descrita pelo marcador de lápide no Hub de Eventos compactado

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O tipo de identidade que modificou o recurso pela última vez.
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.