Compartir a través de


Namespaces - Get

Obtiene la descripción del espacio de nombres especificado.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
namespaceName
path True

string

minLength: 6
maxLength: 50
pattern: ^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$

Nombre del espacio de nombres

resourceGroupName
path True

string

minLength: 1
maxLength: 90

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 de cada llamada de servicio.

api-version
query True

string

Versión de la API de cliente.

Respuestas

Nombre Tipo Description
200 OK

EHNamespace

Espacio de nombres devuelto correctamente.

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 de 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 suplantar la cuenta de usuario

Ejemplos

NameSpaceGet

Solicitud de ejemplo

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

Respuesta de muestra

{
  "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"
  }
}

Definiciones

Nombre Description
ConnectionState

Detalles sobre el estado de la conexión.

createdByType

Tipo de identidad que creó el recurso.

EHNamespace

Elemento de espacio de nombres único en la operación List or Get

EndPointProvisioningState

Estado de aprovisionamiento de la conexión de punto de conexión privado.

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.

keySource

Enumera el valor posible de keySource para el cifrado.

KeyVaultProperties

Propiedades de KeyVault

ManagedServiceIdentityType

Tipo de identidad de servicio administrada.

PrivateEndpoint

El recurso Punto de conexión privado para esta conexión.

PrivateEndpointConnection

Lista de conexiones de punto de conexión privado.

PrivateLinkConnectionStatus

Estado de la conexión.

PublicNetworkAccess

Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado.

Sku

Propiedades del recurso de SKU

SkuName

Nombre de esta SKU.

SkuTier

Nivel de facturación de esta SKU determinada.

systemData

Metadatos relativos a la creación y última modificación del recurso.

TlsVersion

Versión mínima de TLS para que el clúster admita, por ejemplo, "1.2".

UserAssignedIdentity

Valor de diccionario reconocido.

ConnectionState

Detalles sobre el estado de la conexión.

Nombre Tipo Description
description

string

Descripción del estado de conexión.

status

PrivateLinkConnectionStatus

Estado de la conexión.

createdByType

Tipo de identidad que creó el recurso.

Valor Description
Application
Key
ManagedIdentity
User

EHNamespace

Elemento de espacio de nombres único en la operación List or Get

Nombre Tipo Valor predeterminado Description
id

string

Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity.principalId

string

ObjectId de KeyVault

identity.tenantId

string

TenantId de KeyVault

identity.type

ManagedServiceIdentityType

Tipo de identidad de servicio administrada.

identity.userAssignedIdentities

<string,  UserAssignedIdentity>

Propiedades de identidades asignadas por el usuario

location

string

Ubicación del recurso.

name

string

Nombre del recurso

properties.alternateName

string

Nombre alternativo especificado cuando los nombres de alias y espacios de nombres son los mismos.

properties.clusterArmId

string

Id. de ARM del clúster del espacio de nombres.

properties.createdAt

string (date-time)

Hora en que se creó el espacio de nombres.

properties.disableLocalAuth

boolean

Esta propiedad deshabilita la autenticación de SAS para el espacio de nombres de Event Hubs.

properties.encryption.keySource

keySource

Microsoft.KeyVault

Enumera el valor posible de keySource para el cifrado.

properties.encryption.keyVaultProperties

KeyVaultProperties[]

Propiedades de KeyVault

properties.encryption.requireInfrastructureEncryption

boolean

Habilitación del cifrado de infraestructura (cifrado doble)

properties.isAutoInflateEnabled

boolean

Valor que indica si AutoInflate está habilitado para el espacio de nombres del centro de eventos.

properties.kafkaEnabled

boolean

Valor que indica si Kafka está habilitado para el espacio de nombres del centro de eventos.

properties.maximumThroughputUnits

integer (int32)

minimum: 0

Límite superior de unidades de rendimiento cuando se habilita AutoInflate, el valor debe estar comprendido entre 0 y 20 unidades de rendimiento. ( '0' si AutoInflateEnabled = true)

properties.metricId

string

Identificador de las métricas de Azure Insights.

properties.minimumTlsVersion

TlsVersion

Versión mínima de TLS para que el clúster admita, por ejemplo, "1.2".

properties.privateEndpointConnections

PrivateEndpointConnection[]

Lista de conexiones de punto de conexión privado.

properties.provisioningState

string

Estado de aprovisionamiento del espacio de nombres.

properties.publicNetworkAccess

PublicNetworkAccess

Enabled

Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado.

properties.serviceBusEndpoint

string

Punto de conexión que puede usar para realizar operaciones de Service Bus.

properties.status

string

Estado del espacio de nombres.

properties.updatedAt

string (date-time)

Hora en que se actualizó el espacio de nombres.

properties.zoneRedundant

boolean

Al habilitar esta propiedad, se crea un espacio de nombres de Event Hubs estándar en las regiones que admiten zonas de disponibilidad.

sku

Sku

Propiedades del recurso de SKU

systemData

systemData

Metadatos del sistema relacionados con este recurso.

tags

object

Etiquetas de recursos.

type

string

Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

EndPointProvisioningState

Estado de aprovisionamiento de la conexión de punto de conexión privado.

Valor Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

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[]

Detalles del error.

message

string

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.

keySource

Enumera el valor posible de keySource para el cifrado.

Valor Description
Microsoft.KeyVault

KeyVaultProperties

Propiedades de KeyVault

Nombre Tipo Description
identity.userAssignedIdentity

string

Id. de ARM de la identidad de usuario seleccionada para el cifrado

keyName

string

Nombre de la clave de KeyVault

keyVaultUri

string

Uri de KeyVault

keyVersion

string

Versión de clave

ManagedServiceIdentityType

Tipo de identidad de servicio administrada.

Valor Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

PrivateEndpoint

El recurso Punto de conexión privado para esta conexión.

Nombre Tipo Description
id

string

Identificador de ARM para punto de conexión privado.

PrivateEndpointConnection

Lista de conexiones de punto de conexión privado.

Nombre Tipo Description
id

string

Identificador de recurso completo para el 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.privateEndpoint

PrivateEndpoint

El recurso Punto de conexión privado para esta conexión.

properties.privateLinkServiceConnectionState

ConnectionState

Detalles sobre el estado de la conexión.

properties.provisioningState

EndPointProvisioningState

Estado de aprovisionamiento de la conexión de punto de conexión privado.

systemData

systemData

Metadatos del sistema relacionados con este recurso.

type

string

Tipo del recurso. Por ejemplo, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

PrivateLinkConnectionStatus

Estado de la conexión.

Valor Description
Approved
Disconnected
Pending
Rejected

PublicNetworkAccess

Esto determina si se permite el tráfico a través de la red pública. De forma predeterminada, está habilitado.

Valor Description
Disabled
Enabled
SecuredByPerimeter

Sku

Propiedades del recurso de SKU

Nombre Tipo Description
capacity

integer (int32)

minimum: 0

Las unidades de rendimiento de Event Hubs para los niveles Básico o Estándar, donde el valor debe ser de 0 a 20 unidades de rendimiento. Las unidades Premium de Event Hubs para el nivel Premium, donde el valor debe ser de 0 a 10 unidades Premium.

name

SkuName

Nombre de esta SKU.

tier

SkuTier

Nivel de facturación de esta SKU determinada.

SkuName

Nombre de esta SKU.

Valor Description
Basic
Premium
Standard

SkuTier

Nivel de facturación de esta SKU determinada.

Valor Description
Basic
Premium
Standard

systemData

Metadatos relativos a la creación y última modificación del recurso.

Nombre Tipo Description
createdAt

string (date-time)

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 (date-time)

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.

TlsVersion

Versión mínima de TLS para que el clúster admita, por ejemplo, "1.2".

Valor Description
1.0
1.1
1.2

UserAssignedIdentity

Valor de diccionario reconocido.

Nombre Tipo Description
clientId

string

Identificador de cliente de la identidad asignada por el usuario

principalId

string

Identificador de entidad de seguridad de la identidad asignada por el usuario