Namespace interface

Namespace resource.

Extends

Properties

identity

Identity information for the Namespace resource.

inboundIpRules

This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

isZoneRedundant

This is an optional property and it allows the user to specify if the namespace resource supports zone-redundancy capability or not. If this property is not specified explicitly by the user, its default value depends on the following conditions: a. For Availability Zones enabled regions - The default property value would be true. b. For non-Availability Zones enabled regions - The default property value would be false. Once specified, this property cannot be updated.

minimumTlsVersionAllowed

Minimum TLS version of the publisher allowed to publish to this namespace. Only TLS version 1.2 is supported.

privateEndpointConnections

List of private endpoint connections.

provisioningState

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

publicNetworkAccess

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring

sku

Represents available Sku pricing tiers.

systemData

The system metadata relating to the namespace resource. NOTE: This property will not be serialized. It can only be populated by the server.

topicsConfiguration

Topics configuration information for the namespace resource

topicSpacesConfiguration

Topic spaces configuration information for the namespace resource

Inherited Properties

id

Fully qualified identifier of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

location

Location of the resource.

name

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

tags

Tags of the resource.

type

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

Property Details

identity

Identity information for the Namespace resource.

identity?: IdentityInfo

Property Value

inboundIpRules

This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.

inboundIpRules?: InboundIpRule[]

Property Value

isZoneRedundant

This is an optional property and it allows the user to specify if the namespace resource supports zone-redundancy capability or not. If this property is not specified explicitly by the user, its default value depends on the following conditions: a. For Availability Zones enabled regions - The default property value would be true. b. For non-Availability Zones enabled regions - The default property value would be false. Once specified, this property cannot be updated.

isZoneRedundant?: boolean

Property Value

boolean

minimumTlsVersionAllowed

Minimum TLS version of the publisher allowed to publish to this namespace. Only TLS version 1.2 is supported.

minimumTlsVersionAllowed?: string

Property Value

string

privateEndpointConnections

List of private endpoint connections.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

provisioningState

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

provisioningState?: string

Property Value

string

publicNetworkAccess

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring

publicNetworkAccess?: string

Property Value

string

sku

Represents available Sku pricing tiers.

sku?: NamespaceSku

Property Value

systemData

The system metadata relating to the namespace resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

topicsConfiguration

Topics configuration information for the namespace resource

topicsConfiguration?: TopicsConfiguration

Property Value

topicSpacesConfiguration

Topic spaces configuration information for the namespace resource

topicSpacesConfiguration?: TopicSpacesConfiguration

Property Value

Inherited Property Details

id

Fully qualified identifier of the resource. 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

Location of the resource.

location: string

Property Value

string

Inherited From TrackedResource.location

name

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

Tags of the resource.

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

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

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

type?: string

Property Value

string

Inherited From TrackedResource.type