EHNamespace interface

  • Reference
Package:
@azure/arm-eventhub-profile-2020-09-01-hybrid

Single Namespace item in List or Get Operation

Extends
TrackedResource

Properties

clusterArmId

Cluster ARM ID of the Namespace.
createdAt

The time the Namespace was created. NOTE: This property will not be serialized. It can only be populated by the server.
encryption

Properties of BYOK Encryption description
identity

Properties of BYOK Identity description
isAutoInflateEnabled

Value that indicates whether AutoInflate is enabled for eventhub namespace.
kafkaEnabled

Value that indicates whether Kafka is enabled for eventhub namespace.
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. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

Provisioning state of the Namespace. NOTE: This property will not be serialized. It can only be populated by the server.
serviceBusEndpoint

Endpoint you can use to perform Service Bus operations. NOTE: This property will not be serialized. It can only be populated by the server.
sku

Properties of sku resource
status

Status of the Namespace. NOTE: This property will not be serialized. It can only be populated by the server.
updatedAt

The time the Namespace was updated. NOTE: This property will not be serialized. It can only be populated by the server.
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} NOTE: This property will not be serialized. It can only be populated by the server.
location

Resource location.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

clusterArmId

Cluster ARM ID of the Namespace.

clusterArmId?: string

Property Value

string

createdAt

The time the Namespace was created. NOTE: This property will not be serialized. It can only be populated by the server.

createdAt?: Date

Property Value

Date

encryption

Properties of BYOK Encryption description

encryption?: Encryption

Property Value

Encryption

identity

Properties of BYOK Identity description

identity?: Identity

Property Value

Identity

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

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. NOTE: This property will not be serialized. It can only be populated by the server.

metricId?: string

Property Value

string

provisioningState

Provisioning state of the Namespace. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

serviceBusEndpoint

Endpoint you can use to perform Service Bus operations. NOTE: This property will not be serialized. It can only be populated by the server.

serviceBusEndpoint?: string

Property Value

string

sku

Properties of sku resource

sku?: Sku

Property Value

Sku

status

Status of the Namespace. NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

updatedAt

The time the Namespace was updated. NOTE: This property will not be serialized. It can only be populated by the server.

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} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

Resource location.

location?: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type