Namespaces - List

Serviço:

Event Hubs

Versão da API:

2024-01-01

Lista todos os Namespaces disponíveis em uma assinatura, independentemente dos grupos de recursos.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API do cliente.

Respostas

Nome	Tipo	Description
200 OK	EHNamespaceListResult	Namespaces retornados com êxito.
Other Status Codes	ErrorResponse	Resposta de erro do Eventhub descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

NamespacesListBySubscription

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/SampleSubscription/providers/Microsoft.EventHub/namespaces?api-version=2024-01-01

Java

/**
 * Samples for Namespaces List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/NameSpaces/EHNameSpaceList.
     * json
     */
    /**
     * Sample code: NamespacesListBySubscription.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void namespacesListBySubscription(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.eventHubs().manager().serviceClient().getNamespaces().list(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_name_space_list.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="SampleSubscription",
    )

    response = client.namespaces.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/NameSpaces/EHNameSpaceList.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/NameSpaces/EHNameSpaceList.json
func ExampleNamespacesClient_NewListPager() {
	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.NewNamespacesClient().NewListPager(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.EHNamespaceListResult = armeventhub.EHNamespaceListResult{
		// 	Value: []*armeventhub.EHNamespace{
		// 		{
		// 			Name: to.Ptr("NamespaceSample"),
		// 			Type: to.Ptr("Microsoft.EventHub/Namespaces"),
		// 			ID: to.Ptr("/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample"),
		// 			Location: to.Ptr("East US"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Identity: &armeventhub.Identity{
		// 				Type: to.Ptr(armeventhub.ManagedServiceIdentityTypeSystemAssignedUserAssigned),
		// 				PrincipalID: to.Ptr("PrincipalIdGUID"),
		// 				TenantID: to.Ptr("TenantIdGUID"),
		// 				UserAssignedIdentities: map[string]*armeventhub.UserAssignedIdentity{
		// 					"/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": &armeventhub.UserAssignedIdentity{
		// 						ClientID: to.Ptr("ClientIdGUID"),
		// 						PrincipalID: to.Ptr("PrincipalIdGUID"),
		// 					},
		// 					"/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": &armeventhub.UserAssignedIdentity{
		// 						ClientID: to.Ptr("6a35400f-6ccb-4817-8f1a-ce19ea4523bc"),
		// 						PrincipalID: to.Ptr("ce2d5953-5c15-40ca-9d51-cc3f4a63b0f5"),
		// 					},
		// 				},
		// 			},
		// 			Properties: &armeventhub.EHNamespaceProperties{
		// 				ClusterArmID: to.Ptr("/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test"),
		// 				CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-30T00:28:38.963Z"); return t}()),
		// 				DisableLocalAuth: to.Ptr(false),
		// 				Encryption: &armeventhub.Encryption{
		// 					KeySource: to.Ptr("Microsoft.KeyVault"),
		// 					KeyVaultProperties: []*armeventhub.KeyVaultProperties{
		// 						{
		// 							Identity: &armeventhub.UserAssignedIdentityProperties{
		// 								UserAssignedIdentity: to.Ptr("/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1"),
		// 							},
		// 							KeyName: to.Ptr("Samplekey"),
		// 							KeyVaultURI: to.Ptr("https://sample-keyvault-user.vault-int.azure-int.net"),
		// 							KeyVersion: to.Ptr(""),
		// 					}},
		// 					RequireInfrastructureEncryption: to.Ptr(false),
		// 				},
		// 				IsAutoInflateEnabled: to.Ptr(false),
		// 				MaximumThroughputUnits: to.Ptr[int32](0),
		// 				MetricID: to.Ptr("MetricGUID:NamespaceSample"),
		// 				MinimumTLSVersion: to.Ptr(armeventhub.TLSVersionOne2),
		// 				ProvisioningState: to.Ptr("Succeeded"),
		// 				ServiceBusEndpoint: to.Ptr("https://NamespaceSample.servicebus.windows-int.net:443/"),
		// 				UpdatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-30T00:30:55.143Z"); return t}()),
		// 				ZoneRedundant: to.Ptr(false),
		// 			},
		// 			SKU: &armeventhub.SKU{
		// 				Name: to.Ptr(armeventhub.SKUNameStandard),
		// 				Capacity: to.Ptr[int32](0),
		// 				Tier: to.Ptr(armeventhub.SKUTierStandard),
		// 			},
		// 	}},
		// }
	}
}

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 Lists all the available Namespaces within a subscription, irrespective of the resource groups.
 *
 * @summary Lists all the available Namespaces within a subscription, irrespective of the resource groups.
 * x-ms-original-file: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/NameSpaces/EHNameSpaceList.json
 */
async function namespacesListBySubscription() {
  const subscriptionId = process.env["EVENTHUB_SUBSCRIPTION_ID"] || "SampleSubscription";
  const credential = new DefaultAzureCredential();
  const client = new EventHubManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.namespaces.list()) {
    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.Resources;
using Azure.ResourceManager.EventHubs;

// Generated from example definition: specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/examples/NameSpaces/EHNameSpaceList.json
// this example is just showing the usage of "Namespaces_List" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "SampleSubscription";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (EventHubsNamespaceResource item in subscriptionResource.GetEventHubsNamespacesAsync())
{
    // 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
    EventHubsNamespaceData 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 de exemplo

Código de status:

200

{
  "value": [
    {
      "sku": {
        "name": "Standard",
        "tier": "Standard",
        "capacity": 0
      },
      "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample",
      "name": "NamespaceSample",
      "type": "Microsoft.EventHub/Namespaces",
      "location": "East US",
      "tags": {},
      "identity": {
        "principalId": "PrincipalIdGUID",
        "tenantId": "TenantIdGUID",
        "type": "SystemAssigned, UserAssigned",
        "userAssignedIdentities": {
          "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1": {
            "clientId": "ClientIdGUID",
            "principalId": "PrincipalIdGUID"
          },
          "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud2": {
            "clientId": "6a35400f-6ccb-4817-8f1a-ce19ea4523bc",
            "principalId": "ce2d5953-5c15-40ca-9d51-cc3f4a63b0f5"
          }
        }
      },
      "properties": {
        "isAutoInflateEnabled": false,
        "disableLocalAuth": false,
        "maximumThroughputUnits": 0,
        "zoneRedundant": false,
        "minimumTlsVersion": "1.2",
        "encryption": {
          "keySource": "Microsoft.KeyVault",
          "keyVaultProperties": [
            {
              "keyName": "Samplekey",
              "keyVaultUri": "https://sample-keyvault-user.vault-int.azure-int.net",
              "keyVersion": "",
              "identity": {
                "userAssignedIdentity": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.ManagedIdentity/userAssignedIdentities/ud1"
              }
            }
          ],
          "requireInfrastructureEncryption": false
        },
        "clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test",
        "provisioningState": "Succeeded",
        "metricId": "MetricGUID:NamespaceSample",
        "createdAt": "2021-01-30T00:28:38.963Z",
        "updatedAt": "2021-01-30T00:30:55.143Z",
        "serviceBusEndpoint": "https://NamespaceSample.servicebus.windows-int.net:443/"
      }
    }
  ]
}

Definições

Nome	Description
ConnectionState	Detalhes sobre o estado da conexão.
createdByType	O tipo de identidade que criou o recurso.
EHNamespace	Resultado da operação namespace de lista
EHNamespaceListResult	A resposta da operação namespace de lista
EndPointProvisioningState	Estado de provisionamento da Conexão de Ponto de Extremidade Privado.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	A resposta de erro indica que o serviço hub de eventos não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.
keySource	Enumera o valor possível de keySource for Encryption
KeyVaultProperties	Propriedades do KeyVault
ManagedServiceIdentityType	Tipo de identidade de serviço gerenciado.
PrivateEndpoint	O recurso de ponto de extremidade privado para esta conexão.
PrivateEndpointConnection	Lista de conexões de ponto de extremidade privado.
PrivateLinkConnectionStatus	Status da conexão.
PublicNetworkAccess	Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado.
Sku	Propriedades do recurso de sku
SkuName	Nome dessa SKU.
SkuTier	A camada de cobrança deste SKU específico.
systemData	Metadados relativos à criação e última modificação do recurso.
TlsVersion	A versão mínima do TLS para o cluster dar suporte, por exemplo, '1.2'
UserAssignedIdentity	Valor reconhecido do Dicionário.

ConnectionState

Objeto

Detalhes sobre o estado da conexão.

Nome	Tipo	Description
description	string	Descrição do estado da conexão.
status	PrivateLinkConnectionStatus	Status da conexão.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

EHNamespace

Objeto

Resultado da operação namespace de lista

Nome	Tipo	Valor padrão	Description
id	string		ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity.principalId	string		ObjectId do KeyVault
identity.tenantId	string		TenantId do KeyVault
identity.type	ManagedServiceIdentityType		Tipo de identidade de serviço gerenciado.
identity.userAssignedIdentities	<string,  UserAssignedIdentity>		Propriedades para identidades atribuídas pelo usuário
location	string		Local do recurso.
name	string		O nome do recurso
properties.alternateName	string		Nome alternativo especificado quando os nomes de alias e namespace são iguais.
properties.clusterArmId	string		ID do ARM do cluster do Namespace.
properties.createdAt	string (date-time)		A hora em que o Namespace foi criado.
properties.disableLocalAuth	boolean		Essa propriedade desabilita a autenticação SAS para o namespace dos Hubs de Eventos.
properties.encryption.keySource	keySource	Microsoft.KeyVault	Enumera o valor possível de keySource for Encryption
properties.encryption.keyVaultProperties	KeyVaultProperties[]		Propriedades do KeyVault
properties.encryption.requireInfrastructureEncryption	boolean		Habilitar Criptografia de Infraestrutura (Criptografia Dupla)
properties.isAutoInflateEnabled	boolean		Valor que indica se o AutoInflate está habilitado para o namespace do eventhub.
properties.kafkaEnabled	boolean		Valor que indica se o Kafka está habilitado para o namespace do eventhub.
properties.maximumThroughputUnits	integer (int32) minimum: 0		Limite superior de unidades de taxa de transferência quando AutoInflate está habilitado, o valor deve estar dentro de 0 a 20 unidades de taxa de transferência. ( '0' se AutoInflateEnabled = true)
properties.metricId	string		Identificador para métricas do Azure Insights.
properties.minimumTlsVersion	TlsVersion		A versão mínima do TLS para o cluster dar suporte, por exemplo, '1.2'
properties.privateEndpointConnections	PrivateEndpointConnection[]		Lista de conexões de ponto de extremidade privado.
properties.provisioningState	string		Estado de provisionamento do Namespace.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado.
properties.serviceBusEndpoint	string		Ponto de extremidade que você pode usar para executar operações do Barramento de Serviço.
properties.status	string		Status do Namespace.
properties.updatedAt	string (date-time)		A hora em que o Namespace foi atualizado.
properties.zoneRedundant	boolean		Habilitar essa propriedade cria um Namespace de Hubs de Eventos Padrão em zonas de disponibilidade com suporte em regiões.
sku	Sku		Propriedades do recurso de sku
systemData	systemData		Os metadados do sistema relacionados a esse recurso.
tags	object		Marcas de recurso.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

EHNamespaceListResult

Objeto

A resposta da operação namespace de lista

Nome	Tipo	Description
nextLink	string	Link para o próximo conjunto de resultados. Não está vazio se o Valor contiver uma lista incompleta de namespaces.
value	EHNamespace[]	Resultado da operação namespace de lista

EndPointProvisioningState

Enumeração

Estado de provisionamento da Conexão de Ponto de Extremidade Privado.

Valor	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

Nome	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

Objeto

A resposta de erro indica que o serviço hub de eventos não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

keySource

Enumeração

Enumera o valor possível de keySource for Encryption

Valor	Description
Microsoft.KeyVault

KeyVaultProperties

Objeto

Propriedades do KeyVault

Nome	Tipo	Description
identity.userAssignedIdentity	string	ID do ARM da identidade do usuário selecionada para criptografia
keyName	string	Nome da chave do KeyVault
keyVaultUri	string	Uri de KeyVault
keyVersion	string	Versão da chave

ManagedServiceIdentityType

Enumeração

Tipo de identidade de serviço gerenciado.

Valor	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

PrivateEndpoint

Objeto

O recurso de ponto de extremidade privado para esta conexão.

Nome	Tipo	Description
id	string	O identificador do ARM para o ponto de extremidade privado.

PrivateEndpointConnection

Objeto

Lista de conexões de ponto de extremidade privado.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A localização geográfica onde o recurso reside
name	string	O nome do recurso
properties.privateEndpoint	PrivateEndpoint	O recurso de ponto de extremidade privado para esta conexão.
properties.privateLinkServiceConnectionState	ConnectionState	Detalhes sobre o estado da conexão.
properties.provisioningState	EndPointProvisioningState	Estado de provisionamento da Conexão de Ponto de Extremidade Privado.
systemData	systemData	Os metadados do sistema relacionados a esse recurso.
type	string	O tipo do recurso. Por exemplo, "Microsoft.EventHub/Namespaces" ou "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Enumeração

Status da conexão.

Valor	Description
Approved
Disconnected
Pending
Rejected

PublicNetworkAccess

Enumeração

Isso determina se o tráfego é permitido pela rede pública. Por padrão, ele está habilitado.

Valor	Description
Disabled
Enabled
SecuredByPerimeter

Sku

Objeto

Propriedades do recurso de sku

Nome	Tipo	Description
capacity	integer (int32) minimum: 0	As unidades de taxa de transferência dos Hubs de Eventos para as camadas Básica ou Standard, em que o valor deve ser de 0 a 20 unidades de taxa de transferência. As unidades premium dos Hubs de Eventos para a camada Premium, em que o valor deve ser de 0 a 10 unidades premium.
name	SkuName	Nome dessa SKU.
tier	SkuTier	A camada de cobrança deste SKU específico.

SkuName

Enumeração

Nome dessa SKU.

Valor	Description
Basic
Premium
Standard

SkuTier

Enumeração

A camada de cobrança deste SKU específico.

Valor	Description
Basic
Premium
Standard

systemData

Objeto

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

Nome	Tipo	Description
createdAt	string (date-time)	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 (date-time)	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.

TlsVersion

Enumeração

A versão mínima do TLS para o cluster dar suporte, por exemplo, '1.2'

Valor	Description
1.0
1.1
1.2

UserAssignedIdentity

Objeto

Valor reconhecido do Dicionário.

Nome	Tipo	Description
clientId	string	ID do cliente da identidade atribuída pelo usuário
principalId	string	ID da entidade de segurança da identidade atribuída pelo usuário