SBNamespace interface

Package:
@azure/arm-servicebus

Description of a namespace resource.

Extends
TrackedResource

Properties

alternateName

Alternate name for namespace
createdAt

The time the namespace was created
disableLocalAuth

This property disables SAS authentication for the Service Bus namespace.
encryption

Properties of BYOK Encryption description
geoDataReplication

Geo Data Replication settings for the namespace
identity

Properties of BYOK Identity description
ipV6Enabled

Value that indicates whether IPv6 is enabled for public network access.
metricId

Identifier for Azure Insights metrics
minimumTlsVersion

The minimum TLS version for the cluster to support, e.g. '1.2'
platformCapabilities
premiumMessagingPartitions

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
privateEndpointConnections

List of private endpoint connections.
provisioningState

Provisioning state of the namespace.
publicNetworkAccess

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

Endpoint you can use to perform Service Bus operations.
sku

Properties of SKU
status

Status of the namespace.
updatedAt

The time the namespace was updated.
zoneRedundant

Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

The geo-location where the resource lives
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

alternateName

Alternate name for namespace

alternateName?: string

Property Value

string

createdAt

The time the namespace was created

createdAt?: Date

Property Value

Date

disableLocalAuth

This property disables SAS authentication for the Service Bus namespace.

disableLocalAuth?: boolean

Property Value

boolean

encryption

Properties of BYOK Encryption description

encryption?: Encryption

Property Value

Encryption

geoDataReplication

Geo Data Replication settings for the namespace

geoDataReplication?: GeoDataReplicationProperties

Property Value

GeoDataReplicationProperties

identity

Properties of BYOK Identity description

identity?: Identity

Property Value

Identity

ipV6Enabled

Value that indicates whether IPv6 is enabled for public network access.

ipV6Enabled?: boolean

Property Value

boolean

metricId

Identifier for Azure Insights metrics

metricId?: string

Property Value

string

minimumTlsVersion

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

minimumTlsVersion?: string

Property Value

string

platformCapabilities 

platformCapabilities?: PlatformCapabilities

Property Value

PlatformCapabilities

premiumMessagingPartitions

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

premiumMessagingPartitions?: number

Property Value

number

privateEndpointConnections

List of private endpoint connections.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

Provisioning state of the namespace.

provisioningState?: string

Property Value

string

publicNetworkAccess

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

publicNetworkAccess?: string

Property Value

string

serviceBusEndpoint

Endpoint you can use to perform Service Bus operations.

serviceBusEndpoint?: string

Property Value

string

sku

Properties of SKU

sku?: SBSku

Property Value

SBSku

status

Status of the namespace.

status?: string

Property Value

string

updatedAt

The time the namespace was updated.

updatedAt?: Date

Property Value

Date

zoneRedundant

Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones.

zoneRedundant?: boolean

Property Value

boolean

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type