Compartilhar via


Namespaces - Get

Obtém a descrição do namespace especificado.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
namespaceName
path True

string

O nome do namespace

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 assinatura do azure.

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

EHNamespace

Namespace retornado com êxito.

Other Status Codes

ErrorResponse

Resposta de erro do Eventhub que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do 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

NameSpaceGet

Solicitação de exemplo

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

Resposta de exemplo

{
  "sku": {
    "name": "Standard",
    "tier": "Standard",
    "capacity": 1
  },
  "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
    },
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample/privateEndpointConnections/privateEndpointConnectionName",
        "name": "privateEndpointConnectionName",
        "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
        "properties": {
          "provisioningState": "Succeeded",
          "privateEndpoint": {
            "id": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.Network/privateEndpoints/NamespaceSample"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-Approved"
          }
        }
      }
    ],
    "provisioningState": "Succeeded",
    "clusterArmId": "/subscriptions/SampleSubscription/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/clusters/enc-test",
    "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

Item de namespace único na lista ou operação get

EndPointProvisioningState

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

ErrorAdditionalInfo

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

ErrorDetail

Os detalhes 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 para Criptografia

KeyVaultProperties

Propriedades do KeyVault

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciada.

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 desse 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 de Dicionário Reconhecido.

ConnectionState

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

O tipo de identidade que criou o recurso.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

EHNamespace

Item de namespace único na lista ou operação get

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 gerenciada.

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 alias e nomes de namespace são iguais.

properties.clusterArmId

string

ID do ARM do cluster do Namespace.

properties.createdAt

string

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 para Criptografia

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

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

A hora em que o Namespace foi atualizado.

properties.zoneRedundant

boolean

Habilitar essa propriedade cria um Namespace dos Hubs de Eventos Standard em regiões com suporte para zonas de disponibilidade.

sku

Sku

Propriedades do recurso de sku

systemData

systemData

Os metadados do sistema relacionados a esse recurso.

tags

object

Marcas de recurso.

type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

EndPointProvisioningState

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

Nome Tipo Description
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

ErrorAdditionalInfo

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

Os detalhes 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

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 valor possível de keySource para Criptografia

Nome Tipo Description
Microsoft.KeyVault

string

KeyVaultProperties

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 do KeyVault

keyVersion

string

Versão da chave

ManagedServiceIdentityType

Tipo de identidade de serviço gerenciada.

Nome Tipo Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

PrivateEndpoint

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

Nome Tipo Description
id

string

O identificador arm para o ponto de extremidade privado.

PrivateEndpointConnection

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 em que 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

Tipo do recurso. Por exemplo, "Microsoft.EventHub/Namespaces" ou "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Status da conexão.

Nome Tipo Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

PublicNetworkAccess

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

Nome Tipo Description
Disabled

string

Enabled

string

SecuredByPerimeter

string

Sku

Propriedades do recurso de sku

Nome Tipo Description
capacity

integer

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 desse SKU específico.

SkuName

Nome dessa SKU.

Nome Tipo Description
Basic

string

Premium

string

Standard

string

SkuTier

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

Nome Tipo Description
Basic

string

Premium

string

Standard

string

systemData

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

Nome 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.

TlsVersion

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

Nome Tipo Description
1.0

string

1.1

string

1.2

string

UserAssignedIdentity

Valor de Dicionário Reconhecido.

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