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

Namespaces - Get

参考

服务:: Service Bus

API 版本:: 2024-01-01

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

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

URI 参数

名称	在	必需	类型	说明
namespaceName	path	True	string minLength: 6 maxLength: 50	命名空间名称
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string	唯一标识Microsoft Azure 订阅的订阅凭据。订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	SBNamespace	已成功返回Namespace。
Other Status Codes	ErrorResponse	描述操作失败的原因的 ServiceBus 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

NameSpaceGet

GET https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924?api-version=2024-01-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ServiceBus.Models;
using Azure.ResourceManager.ServiceBus;

// Generated from example definition: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/examples/NameSpaces/SBNameSpaceGet.json
// this example is just showing the usage of "Namespaces_Get" 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 ServiceBusNamespaceResource created on azure
// for more information of creating ServiceBusNamespaceResource, please refer to the document of ServiceBusNamespaceResource
string subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
string resourceGroupName = "ArunMonocle";
string namespaceName = "sdk-Namespace-2924";
ResourceIdentifier serviceBusNamespaceResourceId = ServiceBusNamespaceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName);
ServiceBusNamespaceResource serviceBusNamespace = client.GetServiceBusNamespaceResource(serviceBusNamespaceResourceId);

// invoke the operation
ServiceBusNamespaceResource result = await serviceBusNamespace.GetAsync();

// the variable result 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
ServiceBusNamespaceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924",
  "name": "sdk-Namespace-2924",
  "type": "Microsoft.ServiceBus/Namespaces",
  "location": "South Central US",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924",
    "createdAt": "2017-05-25T22:26:36.76Z",
    "updatedAt": "2017-05-25T22:26:59.35Z",
    "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/",
    "minimumTlsVersion": "1.2",
    "disableLocalAuth": 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"
          }
        }
      }
    ]
  }
}

定义

名称	说明
ConnectionState	ConnectionState 信息。
createdByType	创建资源的标识的类型。
EndPointProvisioningState	专用终结点连接的预配状态。
Error	错误对象。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorResponse	资源管理错误响应。
keySource	枚举 KeySource for Encryption 的可能值
KeyVaultProperties	用于配置 keyVault 属性的属性
ManagedServiceIdentityType	托管服务标识的类型。
PrivateEndpoint	PrivateEndpoint 信息。
PrivateEndpointConnection	PrivateEndpointConnection 的属性。
PrivateLinkConnectionStatus	连接状态。
PublicNetworkAccess	这决定了是否允许通过公用网络流量。默认情况下，它处于启用状态。
SBNamespace	命名空间资源的说明。
SBSku	命名空间的 SKU。
SkuName	此 SKU 的名称。
SkuTier	此特定 SKU 的计费层。
systemData	与创建和上次修改资源相关的元数据。
TlsVersion	要支持的群集的最低 TLS 版本，例如“1.2”
UserAssignedIdentity	已识别的字典值。

ConnectionState

Object

ConnectionState 信息。

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

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

EndPointProvisioningState

枚举

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

值	说明
Canceled
Creating
Deleting
Failed
Succeeded
Updating

Error

Object

错误对象。

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

ErrorAdditionalInfo

Object

资源管理错误附加信息。

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

ErrorResponse

Object

资源管理错误响应。

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

keySource

枚举

枚举 KeySource for Encryption 的可能值

值	说明
Microsoft.KeyVault

KeyVaultProperties

Object

用于配置 keyVault 属性的属性

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

ManagedServiceIdentityType

枚举

托管服务标识的类型。

值	说明
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

PrivateEndpoint

Object

PrivateEndpoint 信息。

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

PrivateEndpointConnection

Object

PrivateEndpointConnection 的属性。

名称	类型	说明
id	string	资源的完全限定资源 ID。 Ex - /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
Disconnected
Pending
Rejected

PublicNetworkAccess

枚举

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

值	说明
Disabled
Enabled
SecuredByPerimeter

SBNamespace

Object

命名空间资源的说明。

名称	类型	默认值	说明
id	string		资源 ID
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.createdAt	string (date-time)		创建命名空间的时间
properties.disableLocalAuth	boolean		此属性禁用服务总线命名空间的 SAS 身份验证。
properties.encryption.keySource	keySource	Microsoft.KeyVault	枚举 KeySource for Encryption 的可能值
properties.encryption.keyVaultProperties	KeyVaultProperties[]		KeyVault 的属性
properties.encryption.requireInfrastructureEncryption	boolean		启用基础结构加密（双重加密）
properties.metricId	string		Azure Insights 指标的标识符
properties.minimumTlsVersion	TlsVersion		要支持的群集的最低 TLS 版本，例如“1.2”
properties.premiumMessagingPartitions	integer (int32)		服务总线命名空间的分区数。此属性仅适用于高级 SKU 命名空间。默认值为 1，可能值为 1、2 和 4
properties.privateEndpointConnections	PrivateEndpointConnection[]		专用终结点连接列表。
properties.provisioningState	string		命名空间的预配状态。
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	这决定了是否允许通过公用网络流量。默认情况下，它处于启用状态。
properties.serviceBusEndpoint	string		可用于执行服务总线操作的终结点。
properties.status	string		命名空间的状态。
properties.updatedAt	string (date-time)		命名空间的更新时间。
properties.zoneRedundant	boolean		启用此属性会在支持的可用性区域中创建高级服务总线Namespace。
sku	SBSku		SKU 的属性
systemData	systemData		与此资源相关的系统元数据。
tags	object		资源标记
type	string		资源类型

SBSku

Object

命名空间的 SKU。

名称	类型	说明
capacity	integer (int32)	服务总线高级命名空间的消息传送单元。有效容量为 {1， 2， 4， 8， 16} 个属性的倍数。premiumMessagingPartitions 设置。例如，如果 properties.premiumMessagingPartitions 为 1，则可能的容量值为 1、2、4、8 和 16。如果 properties.premiumMessagingPartitions 为 4，则可能的容量值为 4、8、16、32 和 64
name	SkuName	此 SKU 的名称。
tier	SkuTier	此特定 SKU 的计费层。

SkuName

枚举

此 SKU 的名称。

值	说明
Basic
Premium
Standard

SkuTier

枚举

此特定 SKU 的计费层。

值	说明
Basic
Premium
Standard

systemData

Object

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

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

TlsVersion

枚举

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

值	说明
1.0
1.1
1.2

UserAssignedIdentity

Object

已识别的字典值。

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

通过

Namespaces - Get

URI 参数

响应

安全性

azure_auth

作用域

示例

NameSpaceGet

示例请求

示例响应

定义

ConnectionState

createdByType

EndPointProvisioningState

Error

ErrorAdditionalInfo

ErrorResponse

keySource

KeyVaultProperties

ManagedServiceIdentityType

PrivateEndpoint

PrivateEndpointConnection

PrivateLinkConnectionStatus

PublicNetworkAccess

SBNamespace

SBSku

SkuName

SkuTier

systemData

TlsVersion

UserAssignedIdentity

其他资源