Domain Class

EventGrid Domain.

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.

Inheritance

azure.mgmt.eventgrid.models._models_py3.TrackedResource

Domain

Constructor

Domain(*, location: str, tags: Dict[str, str] | None = None, sku: _models.ResourceSku | None = None, identity: _models.IdentityInfo | None = None, minimum_tls_version_allowed: str | _models.TlsVersion | None = None, input_schema: str | _models.InputSchema | None = None, event_type_info: _models.EventTypeInfo | None = None, input_schema_mapping: _models.InputSchemaMapping | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, inbound_ip_rules: List[_models.InboundIpRule] | None = None, disable_local_auth: bool = False, auto_create_topic_with_first_subscription: bool = True, auto_delete_topic_with_last_subscription: bool = True, data_residency_boundary: str | _models.DataResidencyBoundary | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
location	str Location of the resource. Required.
tags	dict[str, str] Tags of the resource.
sku	ResourceSku The Sku pricing tier for the Event Grid Domain resource.
identity	IdentityInfo Identity information for the Event Grid Domain resource.
minimum_tls_version_allowed	str or TlsVersion Minimum TLS version of the publisher allowed to publish to this domain. Known values are: "1.0", "1.1", and "1.2".
input_schema	str or InputSchema This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. Known values are: "EventGridSchema", "CustomEventSchema", and "CloudEventSchemaV1_0".
event_type_info	EventTypeInfo Event Type Information for the domain. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.
input_schema_mapping	InputSchemaMapping Information about the InputSchemaMapping which specified the info about mapping event payload.
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.DomainProperties.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 AAD token will be used to authenticate if user is allowed to publish to the domain.
auto_create_topic_with_first_subscription	bool This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed. Default value: True
auto_delete_topic_with_last_subscription	bool This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Default value: True
data_residency_boundary	str or DataResidencyBoundary Data Residency Boundary of the resource. Known values are: "WithinGeopair" and "WithinRegion".

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	ResourceSku The Sku pricing tier for the Event Grid Domain resource.
identity	IdentityInfo Identity information for the Event Grid Domain resource.
system_data	SystemData The system metadata relating to the Event Grid Domain resource.
private_endpoint_connections	list[PrivateEndpointConnection] List of private endpoint connections.
provisioning_state	str or DomainProvisioningState Provisioning state of the Event Grid Domain Resource. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed".
minimum_tls_version_allowed	str or TlsVersion Minimum TLS version of the publisher allowed to publish to this domain. Known values are: "1.0", "1.1", and "1.2".
endpoint	str Endpoint for the Event Grid Domain Resource which is used for publishing the events.
input_schema	str or InputSchema This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource. Known values are: "EventGridSchema", "CustomEventSchema", and "CloudEventSchemaV1_0".
event_type_info	EventTypeInfo Event Type Information for the domain. This information is provided by the publisher and can be used by the subscriber to view different types of events that are published.
input_schema_mapping	InputSchemaMapping Information about the InputSchemaMapping which specified the info about mapping event payload.
metric_resource_id	str Metric resource id for the Event Grid Domain Resource.
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.DomainProperties.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 AAD token will be used to authenticate if user is allowed to publish to the domain.
auto_create_topic_with_first_subscription	bool This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, creation of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is null or set to true, Event Grid is responsible of automatically creating the domain topic when the first event subscription is created at the scope of the domain topic. If this property is set to false, then creating the first event subscription will require creating a domain topic by the user. The self-management mode can be used if the user wants full control of when the domain topic is created, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user. Also, note that in auto-managed creation mode, user is allowed to create the domain topic on demand if needed.
auto_delete_topic_with_last_subscription	bool This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource. In this context, deletion of domain topic can be auto-managed (when true) or self-managed (when false). The default value for this property is true. When this property is set to true, Event Grid is responsible of automatically deleting the domain topic when the last event subscription at the scope of the domain topic is deleted. If this property is set to false, then the user needs to manually delete the domain topic when it is no longer needed (e.g., when last event subscription is deleted and the resource needs to be cleaned up). The self-management mode can be used if the user wants full control of when the domain topic needs to be deleted, while auto-managed mode provides the flexibility to perform less operations and manage fewer resources by the user.
data_residency_boundary	str or DataResidencyBoundary Data Residency Boundary of the resource. Known values are: "WithinGeopair" and "WithinRegion".