EHNamespace interface

Package:

@azure/arm-eventhub

Single Namespace item in List or Get Operation

Extends

ProxyResource

Properties

alternateName	Alternate name specified when alias and namespace names are same.
clusterArmId	Cluster ARM ID of the Namespace.
createdAt	The time the Namespace was created.
disableLocalAuth	This property disables SAS authentication for the Event Hubs 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.
isAutoInflateEnabled	Value that indicates whether AutoInflate is enabled for eventhub namespace.
kafkaEnabled	Value that indicates whether Kafka is enabled for eventhub namespace.
location	Resource location.
maximumThroughputUnits	Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)
metricId	Identifier for Azure Insights metrics.
minimumTlsVersion	The minimum TLS version for the cluster to support, e.g. '1.2'
platformCapabilities
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 resource
status	Status of the Namespace.
tags	Resource tags.
updatedAt	The time the Namespace was updated.
zoneRedundant	Enabling this property creates a Standard Event Hubs 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}
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

alternateName

Alternate name specified when alias and namespace names are same.

alternateName?: string

Property Value

string

clusterArmId

Cluster ARM ID of the Namespace.

clusterArmId?: string

Property Value

string

createdAt

The time the Namespace was created.

createdAt?: Date

Property Value

Date

disableLocalAuth

This property disables SAS authentication for the Event Hubs 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

isAutoInflateEnabled

Value that indicates whether AutoInflate is enabled for eventhub namespace.

isAutoInflateEnabled?: boolean

Property Value

boolean

kafkaEnabled

Value that indicates whether Kafka is enabled for eventhub namespace.

kafkaEnabled?: boolean

Property Value

boolean

location

Resource location.

location?: string

Property Value

string

maximumThroughputUnits

Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)

maximumThroughputUnits?: number

Property Value

number

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

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 resource

sku?: Sku

Property Value

Sku

status

Status of the Namespace.

status?: string

Property Value

string

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

updatedAt

The time the Namespace was updated.

updatedAt?: Date

Property Value

Date

zoneRedundant

Enabling this property creates a Standard Event Hubs 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 ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

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

type?: string

Property Value

string

Inherited From ProxyResource.type