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

Inheritance

azure.mgmt.eventgrid.models._models_py3.TrackedResource

Domain

Constructor

Domain(*, location: str, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.eventgrid.models._models_py3.IdentityInfo] = None, input_schema: Optional[Union[str, azure.mgmt.eventgrid.models._event_grid_management_client_enums.InputSchema]] = None, input_schema_mapping: Optional[azure.mgmt.eventgrid.models._models_py3.InputSchemaMapping] = None, public_network_access: Optional[Union[str, azure.mgmt.eventgrid.models._event_grid_management_client_enums.PublicNetworkAccess]] = None, inbound_ip_rules: Optional[List[azure.mgmt.eventgrid.models._models_py3.InboundIpRule]] = None, disable_local_auth: Optional[bool] = False, auto_create_topic_with_first_subscription: Optional[bool] = True, auto_delete_topic_with_last_subscription: Optional[bool] = True, data_residency_boundary: Optional[Union[str, azure.mgmt.eventgrid.models._event_grid_management_client_enums.DataResidencyBoundary]] = None, **kwargs)

Variables

id

str

Fully qualified identifier of the resource.

name

str

Name of the resource.

type

str

Type of the resource.

location

str

Required. Location of the resource.

tags

dict[str, str]

A set of tags. Tags of the resource.

system_data

SystemData

The system metadata relating to the Event Grid Domain resource.

identity

IdentityInfo

Identity information for 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. Possible values include: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed".

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. Possible values include: "EventGridSchema", "CustomEventSchema", "CloudEventSchemaV1_0".

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" />. Possible values include: "Enabled", "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.

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. Possible values include: "WithinGeopair", "WithinRegion".