你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Namespaces - Get

参考

Service:: Event Hubs

API Version:: 2024-01-01

获取指定命名空间的说明。

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

URI 参数

名称	在	必需	类型	说明
namespaceName	path	True	string	命名空间名称 Regex pattern: `^[a-zA-Z][a-zA-Z0-9-]{6,50}[a-zA-Z0-9]$`
resourceGroupName	path	True	string	Azure 订阅中的资源组的名称。
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	EHNamespace	已成功返回命名空间。
Other Status Codes	ErrorResponse	描述操作失败原因的 Eventhub 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

NameSpaceGet

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

定义

名称	说明
ConnectionState	有关连接状态的详细信息。
createdByType	创建资源的标识类型。
EHNamespace	列表或获取操作中的单个命名空间项
EndPointProvisioningState	专用终结点连接的预配状态。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应指示事件中心服务无法处理传入请求。错误消息中提供了原因。
keySource	枚举用于加密的 keySource 的可能值
KeyVaultProperties	KeyVault 的属性
ManagedServiceIdentityType	托管服务标识的类型。
PrivateEndpoint	此连接的专用终结点资源。
PrivateEndpointConnection	专用终结点连接列表。
PrivateLinkConnectionStatus	连接状态。
PublicNetworkAccess	这确定是否允许通过公用网络进行流量。默认情况下，它处于启用状态。
Sku	SKU 资源的属性
SkuName	此 SKU 的名称。
SkuTier	此特定 SKU 的计费层。
systemData	与资源的创建和上次修改相关的元数据。
TlsVersion	要支持的群集的最低 TLS 版本，例如“1.2”
UserAssignedIdentity	已识别字典值。

ConnectionState

有关连接状态的详细信息。

名称	类型	说明
description	string	连接状态的说明。
status	PrivateLinkConnectionStatus	连接状态。

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

EHNamespace

列表或获取操作中的单个命名空间项

名称	类型	默认值	说明
id	string		资源的完全限定的资源 ID。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity.principalId	string		KeyVault 中的 ObjectId
identity.tenantId	string		KeyVault 中的 TenantId
identity.type	ManagedServiceIdentityType		托管服务标识的类型。
identity.userAssignedIdentities	<string, UserAssignedIdentity>		用户分配的标识的属性
location	string		资源位置。
name	string		资源的名称
properties.alternateName	string		别名和命名空间名称相同时指定的备用名称。
properties.clusterArmId	string		命名空间的群集 ARM ID。
properties.createdAt	string		创建命名空间的时间。
properties.disableLocalAuth	boolean		此属性禁用事件中心命名空间的 SAS 身份验证。
properties.encryption.keySource	keySource	Microsoft.KeyVault	枚举用于加密的 keySource 的可能值
properties.encryption.keyVaultProperties	KeyVaultProperties[]		KeyVault 的属性
properties.encryption.requireInfrastructureEncryption	boolean		启用基础结构加密 (双重加密)
properties.isAutoInflateEnabled	boolean		指示是否为 eventhub 命名空间启用 AutoInflate 的值。
properties.kafkaEnabled	boolean		指示是否为 eventhub 命名空间启用 Kafka 的值。
properties.maximumThroughputUnits	integer		启用 AutoInflate 时吞吐量单位的上限，值应为 0 到 20 个吞吐量单位。如果 AutoInflateEnabled = true) ， (“0”
properties.metricId	string		Azure Insights 指标的标识符。
properties.minimumTlsVersion	TlsVersion		要支持的群集的最低 TLS 版本，例如“1.2”
properties.privateEndpointConnections	PrivateEndpointConnection[]		专用终结点连接列表。
properties.provisioningState	string		命名空间的预配状态。
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	这确定是否允许通过公用网络进行流量。默认情况下，它处于启用状态。
properties.serviceBusEndpoint	string		可用于执行服务总线操作的终结点。
properties.status	string		命名空间的状态。
properties.updatedAt	string		更新命名空间的时间。
properties.zoneRedundant	boolean		启用此属性会在区域支持的可用性区域中创建标准事件中心命名空间。
sku	Sku		SKU 资源的属性
systemData	systemData		与此资源相关的系统元数据。
tags	object		资源标记。
type	string		资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

EndPointProvisioningState

专用终结点连接的预配状态。

名称	类型	说明
Canceled	string
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应指示事件中心服务无法处理传入请求。错误消息中提供了原因。

名称	类型	说明
error	ErrorDetail	错误对象。

keySource

枚举用于加密的 keySource 的可能值

名称	类型	说明
Microsoft.KeyVault	string

KeyVaultProperties

KeyVault 的属性

名称	类型	说明
identity.userAssignedIdentity	string	选择用于加密的用户标识的 ARM ID
keyName	string	KeyVault 中的密钥名称
keyVaultUri	string	KeyVault 的 URI
keyVersion	string	密钥版本

ManagedServiceIdentityType

托管服务标识的类型。

名称	类型	说明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

PrivateEndpoint

此连接的专用终结点资源。

名称	类型	说明
id	string	专用终结点的 ARM 标识符。

PrivateEndpointConnection

专用终结点连接列表。

名称	类型	说明
id	string	资源的完全限定的资源 ID。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	资源所在的地理位置
name	string	资源的名称
properties.privateEndpoint	PrivateEndpoint	此连接的专用终结点资源。
properties.privateLinkServiceConnectionState	ConnectionState	有关连接状态的详细信息。
properties.provisioningState	EndPointProvisioningState	专用终结点连接的预配状态。
systemData	systemData	与此资源相关的系统元数据。
type	string	资源类型。例如“Microsoft.EventHub/Namespaces”或“Microsoft.EventHub/Namespaces/EventHubs”

PrivateLinkConnectionStatus

连接状态。

名称	类型	说明
Approved	string
Disconnected	string
Pending	string
Rejected	string

PublicNetworkAccess

这确定是否允许通过公用网络进行流量。默认情况下，它处于启用状态。

名称	类型	说明
Disabled	string
Enabled	string
SecuredByPerimeter	string

Sku

SKU 资源的属性

名称	类型	说明
capacity	integer	基本层或标准层的事件中心吞吐量单位，其值应为 0 到 20 个吞吐量单位。高级层的事件中心高级单位，其值应为 0 到 10 个高级单位。
name	SkuName	此 SKU 的名称。
tier	SkuTier	此特定 SKU 的计费层。

SkuName

此 SKU 的名称。

名称	类型	说明
Basic	string
Premium	string
Standard	string

SkuTier

此特定 SKU 的计费层。

名称	类型	说明
Basic	string
Premium	string
Standard	string

systemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	上次修改资源的标识类型。
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。

TlsVersion

要支持的群集的最低 TLS 版本，例如“1.2”

名称	类型	说明
1.0	string
1.1	string
1.2	string

UserAssignedIdentity

已识别字典值。

名称	类型	说明
clientId	string	用户分配标识的客户端 ID
principalId	string	用户分配标识的主体 ID