Event Hubs - List By Namespace

Referencia

Servicio:: Event Hubs

Versión de la API:: 2024-01-01

Obtiene todos los Event Hubs de un espacio de nombres.

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

Con parámetros opcionales:

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 de identificador URI

Nombre	En	Requerido	Tipo	Description
namespaceName	path	True	string	El nombre del espacio de nombres Patrón de Regex: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción de Azure.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única una suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de la API de cliente.
$skip	query		integer	Skip solo se usa si una operación anterior devolvió un resultado parcial. Si una respuesta anterior contiene un elemento nextLink, el valor del elemento nextLink incluirá un parámetro skip que especifica un punto de partida que se usará para las llamadas posteriores.
$top	query		integer	Se puede usar para limitar el número de resultados a los N usageDetails más recientes.

Respuestas

Nombre	Tipo	Description
200 OK	EventHubListResult	Se recuperó correctamente la lista de Event Hubs.
Other Status Codes	ErrorResponse	Respuesta de error del centro de eventos que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

EventHubsListAll

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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
        }
      }
    }
  ]
}

Definiciones

Nombre	Description
CaptureDescription	Propiedades para configurar la descripción de captura para eventhub
CaptureIdentity	Valor que indica si la descripción de la captura está habilitada.
CaptureIdentityType	Tipo de identidad administrada de Azure Active Directory.
CleanupPolicyRetentionDescription	Enumera los valores posibles para la directiva de limpieza.
createdByType	Tipo de identidad que creó el recurso.
Destination	Detalles de almacenamiento de captura para la descripción de la captura
EncodingCaptureDescription	Enumera los valores posibles para el formato de codificación de la descripción de captura. Nota: "AvroDeflate" quedará en desuso en la nueva versión de la API
EntityStatus	Enumera los valores posibles para el estado del centro de eventos.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	La respuesta de error indica que el servicio event hubs no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.
Eventhub	Elemento único en la operación List or Get Event Hubs
EventHubListResult	Resultado de la operación List EventHubs.
RetentionDescription	Propiedades para configurar las opciones de retención para el centro de eventos
systemData	Metadatos relacionados con la creación y la última modificación del recurso.

CaptureDescription

Propiedades para configurar la descripción de captura para eventhub

Nombre	Tipo	Description
destination	Destination	Propiedades del destino donde se almacenará la captura. (Cuenta de almacenamiento, nombres de blobs)
enabled	boolean	Valor que indica si la descripción de la captura está habilitada.
encoding	EncodingCaptureDescription	Enumera los valores posibles para el formato de codificación de la descripción de captura. Nota: "AvroDeflate" quedará en desuso en la nueva versión de la API
intervalInSeconds	integer	El período de tiempo permite establecer la frecuencia con la que se producirá la captura en blobs de Azure, el valor debe estar entre 60 y 900 segundos.
sizeLimitInBytes	integer	La ventana de tamaño define la cantidad de datos compilados en el centro de eventos antes de una operación de captura, el valor debe estar entre 10485760 a 524288000 bytes.
skipEmptyArchives	boolean	Valor que indica si se omiten los archivos vacíos.

CaptureIdentity

Valor que indica si la descripción de la captura está habilitada.

Nombre	Tipo	Description
type	CaptureIdentityType	Tipo de identidad administrada de Azure Active Directory.
userAssignedIdentity	string	Id. de ARM de identidad de usuario administrado. Esta propiedad es necesaria es el tipo UserAssignedIdentity. Si el tipo es SystemAssigned, se usará la identidad asignada por el sistema asociada al espacio de nombres.

CaptureIdentityType

Tipo de identidad administrada de Azure Active Directory.

Nombre	Tipo	Description
SystemAssigned	string
UserAssigned	string

CleanupPolicyRetentionDescription

Enumera los valores posibles para la directiva de limpieza.

Nombre	Tipo	Description
Compact	string
Delete	string

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Destination

Detalles de almacenamiento de captura para la descripción de la captura

Nombre	Tipo	Description
identity	CaptureIdentity	Valor que indica si la descripción de la captura está habilitada.
name	string	Nombre del destino de captura
properties.archiveNameFormat	string	Convención de nomenclatura de blobs para el archivo, por ejemplo, {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Aquí todos los parámetros (espacio de nombres, EventHub, etc.) son obligatorios, independientemente del orden.
properties.blobContainer	string	Nombre del contenedor de blobs
properties.dataLakeAccountName	string	Nombre de Azure Data Lake Store para los eventos capturados
properties.dataLakeFolderPath	string	Ruta de acceso de la carpeta de destino para los eventos capturados
properties.dataLakeSubscriptionId	string	Identificador de suscripción de Azure Data Lake Store
properties.storageAccountResourceId	string	Identificador de recurso de la cuenta de almacenamiento que se va a usar para crear los blobs

EncodingCaptureDescription

Enumera los valores posibles para el formato de codificación de la descripción de captura. Nota: "AvroDeflate" quedará en desuso en la nueva versión de la API

Nombre	Tipo	Description
Avro	string
AvroDeflate	string

EntityStatus

Enumera los valores posibles para el estado del centro de eventos.

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

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

La respuesta de error indica que el servicio event hubs no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Eventhub

Elemento único en la operación List or Get Event Hubs

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso.
properties.captureDescription	CaptureDescription	Propiedades de la descripción de captura
properties.createdAt	string	Hora exacta en que se creó el centro de eventos.
properties.messageRetentionInDays	integer	Número de días para conservar los eventos de este centro de eventos, el valor debe ser de 1 a 7 días.
properties.partitionCount	integer	Número de particiones creadas para el centro de eventos, los valores permitidos son de 1 a 32 particiones.
properties.partitionIds	string[]	Número actual de particiones en el centro de eventos.
properties.retentionDescription	RetentionDescription	Configuración de retención del centro de eventos
properties.status	EntityStatus	Enumera los valores posibles para el estado del centro de eventos.
properties.updatedAt	string	Hora exacta en que se actualizó el mensaje.
properties.userMetadata	string	Obtiene y establece los metadatos del usuario.
systemData	systemData	Metadatos del sistema relacionados con este recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

EventHubListResult

Resultado de la operación List EventHubs.

Nombre	Tipo	Description
nextLink	string	Vínculo al siguiente conjunto de resultados. No está vacío si Value contiene una lista incompleta de EventHubs.
value	Eventhub[]	Resultado de la operación List EventHubs.

RetentionDescription

Propiedades para configurar las opciones de retención para el centro de eventos

Nombre	Tipo	Description
cleanupPolicy	CleanupPolicyRetentionDescription	Enumera los valores posibles para la directiva de limpieza.
retentionTimeInHours	integer	Número de horas para conservar los eventos de este centro de eventos. Este valor solo se usa cuando cleanupPolicy es Delete. Si cleanupPolicy es Compact, el valor devuelto de esta propiedad es Long.MaxValue.
tombstoneRetentionTimeInHours	integer	Número de horas para conservar los marcadores de la piedra de exclusión de un centro de eventos compacto. Este valor solo se usa cuando cleanupPolicy es Compact. El consumidor debe completar la lectura del marcador de marcador de lápiz dentro de esta cantidad de tiempo especificada si el consumidor comienza desde el desplazamiento inicial para asegurarse de que obtienen una instantánea válida para la clave específica descrita por el marcador de lápiz de exclusión dentro del centro de eventos compactado.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Tipo de identidad que modificó por última vez el recurso.
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.