Share via

Namespace Class

Namespace resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

Namespace(*, location: str, tags: Dict[str, str] | None = None, sku: _models.NamespaceSku | None = None, identity: _models.IdentityInfo | None = None, private_endpoint_connections: List[_models.PrivateEndpointConnection] | None = None, topics_configuration: _models.TopicsConfiguration | None = None, topic_spaces_configuration: _models.TopicSpacesConfiguration | None = None, is_zone_redundant: bool | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, inbound_ip_rules: List[_models.InboundIpRule] | None = None, minimum_tls_version_allowed: str | _models.TlsVersion | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
location
str

Location of the resource. Required.
tags
dict[str, str]

Tags of the resource.

Default value: None
sku
NamespaceSku

Represents available Sku pricing tiers.

Default value: None
identity
IdentityInfo

Identity information for the Namespace resource.

Default value: None
private_endpoint_connections
list[PrivateEndpointConnection]

List of private endpoint connections.

Default value: None
topics_configuration
TopicsConfiguration

Topics configuration information for the namespace resource.

Default value: None
topic_spaces_configuration
TopicSpacesConfiguration

Topic spaces configuration information for the namespace resource.

Default value: None
is_zone_redundant
bool

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:

  1. For Availability Zones enabled regions - The default property value would be true.

  2. For non-Availability Zones enabled regions - The default property value would be false.

Once specified, this property cannot be updated.

Default value: None
public_network_access
str or PublicNetworkAccess

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules" />. Known values are: "Enabled" and "Disabled".

Default value: None
inbound_ip_rules
list[InboundIpRule]

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

Default value: None
minimum_tls_version_allowed
str or TlsVersion

Minimum TLS version of the publisher allowed to publish to this namespace. Only TLS version 1.2 is supported. Known values are: "1.0", "1.1", and "1.2".

Default value: None

Variables

Name Description
id
str

Fully qualified identifier of the resource.
name
str

Name of the resource.
type
str

Type of the resource.
location
str

Location of the resource. Required.
tags
dict[str, str]

Tags of the resource.
sku
NamespaceSku

Represents available Sku pricing tiers.
identity
IdentityInfo

Identity information for the Namespace resource.
system_data
SystemData

The system metadata relating to the Event Grid resource.
private_endpoint_connections
list[PrivateEndpointConnection]

List of private endpoint connections.
provisioning_state
str or NamespaceProvisioningState

Provisioning state of the namespace resource. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", "Deleted", "DeleteFailed", "CreateFailed", and "UpdatedFailed".
topics_configuration
TopicsConfiguration

Topics configuration information for the namespace resource.
topic_spaces_configuration
TopicSpacesConfiguration

Topic spaces configuration information for the namespace resource.
is_zone_redundant
bool

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:

  1. For Availability Zones enabled regions - The default property value would be true.

  2. For non-Availability Zones enabled regions - The default property value would be false.

Once specified, this property cannot be updated.
public_network_access
str or PublicNetworkAccess

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules" />. Known values are: "Enabled" and "Disabled".
inbound_ip_rules
list[InboundIpRule]

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

Minimum TLS version of the publisher allowed to publish to this namespace. Only TLS version 1.2 is supported. Known values are: "1.0", "1.1", and "1.2".