Namespaces - Get

Service:: Service Bus

API Version:: 2026-01-01

Gets a description for the specified namespace.

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

URI Parameters

Name	In	Required	Type	Description
namespaceName	path	True	string minLength: 6 maxLength: 50	The namespace name
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	SBNamespace	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

NameSpaceGet

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "name": "sdk-Namespace-2924",
  "type": "Microsoft.ServiceBus/Namespaces",
  "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-2924",
  "location": "South Central US",
  "properties": {
    "createdAt": "2017-05-25T22:26:36.76Z",
    "disableLocalAuth": false,
    "metricId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4:sdk-namespace-2924",
    "minimumTlsVersion": "1.2",
    "platformCapabilities": {
      "confidentialCompute": {
        "mode": "Disabled"
      }
    },
    "privateEndpointConnections": [
      {
        "name": "privateEndpointConnectionName",
        "type": "Microsoft.EventHub/Namespaces/PrivateEndpointConnections",
        "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ResurceGroupSample/providers/Microsoft.EventHub/namespaces/NamespaceSample/privateEndpointConnections/privateEndpointConnectionName",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ResurceGroupSample/providers/Microsoft.Network/privateEndpoints/NamespaceSample"
          },
          "privateLinkServiceConnectionState": {
            "description": "Auto-Approved",
            "status": "Approved"
          },
          "provisioningState": "Succeeded"
        }
      }
    ],
    "provisioningState": "Succeeded",
    "serviceBusEndpoint": "https://sdk-Namespace-2924.servicebus.windows-int.net:443/",
    "updatedAt": "2017-05-25T22:26:59.35Z"
  },
  "sku": {
    "name": "Standard",
    "tier": "Standard"
  },
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  }
}

Definitions

Name	Description
ConfidentialCompute
ConnectionState	ConnectionState information.
createdByType	The type of identity that created the resource.
Encryption	Properties to configure Encryption
EndPointProvisioningState	Provisioning state of the Private Endpoint Connection.
ErrorAdditionalInfo	The resource management error additional info.
ErrorResponse	The resource management error response.
ErrorResponseError	The error object.
GeoDataReplicationProperties	GeoDR Replication properties
GeoDRRoleType	GeoDR Role Types
Identity	Properties to configure User Assigned Identities for Bring your Own Keys
KeyVaultProperties	Properties to configure keyVault Properties
ManagedServiceIdentityType	Type of managed service identity.
Mode	Setting to Enable or Disable Confidential Compute
NamespaceReplicaLocation	Namespace replication properties
PlatformCapabilities
PrivateEndpoint	PrivateEndpoint information.
PrivateEndpointConnection	Properties of the PrivateEndpointConnection.
PrivateLinkConnectionStatus	Status of the connection.
PublicNetworkAccess	This determines if traffic is allowed over public network. By default it is enabled.
SBNamespace	Description of a namespace resource.
SBSku	SKU of the namespace.
SkuName	Name of this SKU.
SkuTier	The billing tier of this particular SKU.
systemData	Metadata pertaining to creation and last modification of the resource.
TlsVersion	The minimum TLS version for the cluster to support, e.g. '1.3'
UserAssignedIdentity	Recognized Dictionary value.
UserAssignedIdentityProperties

ConfidentialCompute

Object

Name	Type	Description
mode	Mode	Setting to Enable or Disable Confidential Compute

ConnectionState

Object

ConnectionState information.

Name	Type	Description
description	string	Description of the connection state.
status	PrivateLinkConnectionStatus	Status of the connection.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

Encryption

Object

Properties to configure Encryption

Name	Type	Default value	Description
keySource	enum: Microsoft.KeyVault	Microsoft.KeyVault	Enumerates the possible value of keySource for Encryption
keyVaultProperties	KeyVaultProperties[]		Properties of KeyVault
requireInfrastructureEncryption	boolean		Enable Infrastructure Encryption (Double Encryption)

EndPointProvisioningState

Enumeration

Provisioning state of the Private Endpoint Connection.

Value	Description
Creating
Updating
Deleting
Succeeded
Canceled
Failed

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info		The additional info.
type	string	The additional info type.

ErrorResponse

Object

The resource management error response.

Name	Type	Description
error	ErrorResponseError	The error object.

ErrorResponseError

Object

The error object.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorResponse[]	The error details.
message	string	The error message.
target	string	The error target.

GeoDataReplicationProperties

Object

GeoDR Replication properties

Name	Type	Description
locations	NamespaceReplicaLocation[]	A list of regions where replicas of the namespace are maintained.
maxReplicationLagDurationInSeconds	integer (int32)	The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day.

GeoDRRoleType

Enumeration

GeoDR Role Types

Value	Description
Primary
Secondary

Identity

Object

Properties to configure User Assigned Identities for Bring your Own Keys

Name	Type	Description
principalId	string	ObjectId from the KeyVault
tenantId	string	TenantId from the KeyVault
type	ManagedServiceIdentityType	Type of managed service identity.
userAssignedIdentities	<string, UserAssignedIdentity>	Properties for User Assigned Identities

KeyVaultProperties

Object

Properties to configure keyVault Properties

Name	Type	Description
identity	UserAssignedIdentityProperties
keyName	string	Name of the Key from KeyVault
keyVaultUri	string	Uri of KeyVault
keyVersion	string	Version of KeyVault

ManagedServiceIdentityType

Enumeration

Type of managed service identity.

Value	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

Mode

Enumeration

Setting to Enable or Disable Confidential Compute

Value	Description
Disabled
Enabled

NamespaceReplicaLocation

Object

Namespace replication properties

Name	Type	Description
clusterArmId	string	Optional property that denotes the ARM ID of the Cluster. This is required, if a namespace replica should be placed in a Dedicated Event Hub Cluster
locationName	string	Azure regions where a replica of the namespace is maintained
roleType	GeoDRRoleType	GeoDR Role Types

PlatformCapabilities

Object

Name	Type	Description
confidentialCompute	ConfidentialCompute

PrivateEndpoint

Object

PrivateEndpoint information.

Name	Type	Description
id	string	The ARM identifier for Private Endpoint.

PrivateEndpointConnection

Object

Properties of the PrivateEndpointConnection.

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.privateEndpoint	PrivateEndpoint	The Private Endpoint resource for this Connection.
properties.privateLinkServiceConnectionState	ConnectionState	Details about the state of the connection.
properties.provisioningState	EndPointProvisioningState	Provisioning state of the Private Endpoint Connection.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateLinkConnectionStatus

Enumeration

Status of the connection.

Value	Description
Pending
Approved
Rejected
Disconnected

PublicNetworkAccess

Enumeration

This determines if traffic is allowed over public network. By default it is enabled.

Value	Description
Enabled
Disabled
SecuredByPerimeter

SBNamespace

Object

Description of a namespace resource.

Name	Type	Default value	Description
id	string (arm-id)		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	Identity		Properties of BYOK Identity description
location	string		The geo-location where the resource lives
name	string		The name of the resource
properties.alternateName	string		Alternate name for namespace
properties.createdAt	string (date-time)		The time the namespace was created
properties.disableLocalAuth	boolean		This property disables SAS authentication for the Service Bus namespace.
properties.encryption	Encryption		Properties of BYOK Encryption description
properties.geoDataReplication	GeoDataReplicationProperties		Geo Data Replication settings for the namespace
properties.ipV6Enabled	boolean		Value that indicates whether IPv6 is enabled for public network access.
properties.metricId	string		Identifier for Azure Insights metrics
properties.minimumTlsVersion	TlsVersion		The minimum TLS version for the cluster to support, e.g. '1.2'
properties.platformCapabilities	PlatformCapabilities
properties.premiumMessagingPartitions	integer (int32)		The number of partitions of a Service Bus namespace. This property is only applicable to Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4
properties.privateEndpointConnections	PrivateEndpointConnection[]		List of private endpoint connections.
properties.provisioningState	string		Provisioning state of the namespace.
properties.publicNetworkAccess	PublicNetworkAccess	Enabled	This determines if traffic is allowed over public network. By default it is enabled.
properties.serviceBusEndpoint	string		Endpoint you can use to perform Service Bus operations.
properties.status	string		Status of the namespace.
properties.updatedAt	string (date-time)		The time the namespace was updated.
properties.zoneRedundant	boolean		Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones.
sku	SBSku		Properties of SKU
systemData	systemData		Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object		Resource tags.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

SBSku

Object

SKU of the namespace.

Name	Type	Description
capacity	integer (int32)	Messaging units for your service bus premium namespace. Valid capacities are {1, 2, 4, 8, 16} multiples of your properties.premiumMessagingPartitions setting. For example, If properties.premiumMessagingPartitions is 1 then possible capacity values are 1, 2, 4, 8, and 16. If properties.premiumMessagingPartitions is 4 then possible capacity values are 4, 8, 16, 32 and 64
name	SkuName	Name of this SKU.
tier	SkuTier	The billing tier of this particular SKU.

SkuName

Enumeration

Name of this SKU.

Value	Description
Basic
Standard
Premium

SkuTier

Enumeration

The billing tier of this particular SKU.

Value	Description
Basic
Standard
Premium

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

TlsVersion

Enumeration

The minimum TLS version for the cluster to support, e.g. '1.3'

Value	Description
1.0
1.1
1.2
1.3

UserAssignedIdentity

Object

Recognized Dictionary value.

Name	Type	Description
clientId	string	Client Id of user assigned identity
principalId	string	Principal Id of user assigned identity

UserAssignedIdentityProperties

Object

Name	Type	Description
userAssignedIdentity	string	ARM ID of user Identity selected for encryption