Share via

PartnerNamespace Class

EventGrid Partner Namespace.

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

PartnerNamespace(*, location: str, tags: Dict[str, str] | None = None, partner_registration_fully_qualified_id: str | None = None, minimum_tls_version_allowed: str | _models.TlsVersion | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, inbound_ip_rules: List[_models.InboundIpRule] | None = None, disable_local_auth: bool = False, partner_topic_routing_mode: str | _models.PartnerTopicRoutingMode = 'SourceEventAttribute', **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
partner_registration_fully_qualified_id
str

The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.

Default value: None
minimum_tls_version_allowed
str or TlsVersion

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

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.PartnerNamespaceProperties.InboundIpRules" />. Known values are: "Enabled", "Disabled", and "SecuredByPerimeter".

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
disable_local_auth
bool

This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only Microsoft Entra ID token will be used to authenticate if user is allowed to publish to the partner namespace.

Default value: False
partner_topic_routing_mode
str or PartnerTopicRoutingMode

This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic. Known values are: "SourceEventAttribute" and "ChannelNameHeader".

Default value: SourceEventAttribute

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.
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 PartnerNamespaceProvisioningState

Provisioning state of the partner namespace. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed".
partner_registration_fully_qualified_id
str

The fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
minimum_tls_version_allowed
str or TlsVersion

Minimum TLS version of the publisher allowed to publish to this partner namespace. Known values are: "1.0", "1.1", and "1.2".
endpoint
str

Endpoint for the partner namespace.
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.PartnerNamespaceProperties.InboundIpRules" />. Known values are: "Enabled", "Disabled", and "SecuredByPerimeter".
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.
disable_local_auth
bool

This boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only Microsoft Entra ID token will be used to authenticate if user is allowed to publish to the partner namespace.
partner_topic_routing_mode
str or PartnerTopicRoutingMode

This determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic. Known values are: "SourceEventAttribute" and "ChannelNameHeader".