Class DomainProperties
java.lang.Object
com.azure.resourcemanager.eventgrid.fluent.models.DomainProperties
Properties of the Event Grid Domain Resource.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the autoCreateTopicWithFirstSubscription property: This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.Get the autoDeleteTopicWithLastSubscription property: This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.Get the dataResidencyBoundary property: Data Residency Boundary of the resource.Get the disableLocalAuth property: This boolean is used to enable or disable local auth.endpoint()
Get the endpoint property: Endpoint for the Event Grid Domain Resource which is used for publishing the events.Get the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.Get the inputSchema property: This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.Get the inputSchemaMapping property: Information about the InputSchemaMapping which specified the info about mapping event payload.Get the metricResourceId property: Metric resource id for the Event Grid Domain Resource.Get the privateEndpointConnections property: List of private endpoint connections.Get the provisioningState property: Provisioning state of the Event Grid Domain Resource.Get the publicNetworkAccess property: This determines if traffic is allowed over public network.void
validate()
Validates the instance.withAutoCreateTopicWithFirstSubscription
(Boolean autoCreateTopicWithFirstSubscription) Set the autoCreateTopicWithFirstSubscription property: This Boolean is used to specify the creation mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.withAutoDeleteTopicWithLastSubscription
(Boolean autoDeleteTopicWithLastSubscription) Set the autoDeleteTopicWithLastSubscription property: This Boolean is used to specify the deletion mechanism for 'all' the Event Grid Domain Topics associated with this Event Grid Domain resource.withDataResidencyBoundary
(DataResidencyBoundary dataResidencyBoundary) Set the dataResidencyBoundary property: Data Residency Boundary of the resource.withDisableLocalAuth
(Boolean disableLocalAuth) Set the disableLocalAuth property: This boolean is used to enable or disable local auth.withInboundIpRules
(List<InboundIpRule> inboundIpRules) Set the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.withInputSchema
(InputSchema inputSchema) Set the inputSchema property: This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.withInputSchemaMapping
(InputSchemaMapping inputSchemaMapping) Set the inputSchemaMapping property: Information about the InputSchemaMapping which specified the info about mapping event payload.withPublicNetworkAccess
(PublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: This determines if traffic is allowed over public network.
-
Constructor Details
-
DomainProperties
public DomainProperties()
-
-
Method Details
-
privateEndpointConnections
Get the privateEndpointConnections property: List of private endpoint connections.- Returns:
- the privateEndpointConnections value.
-
provisioningState
Get the provisioningState property: Provisioning state of the Event Grid Domain Resource.- Returns:
- the provisioningState value.
-
endpoint
Get the endpoint property: Endpoint for the Event Grid Domain Resource which is used for publishing the events.- Returns:
- the endpoint value.
-
inputSchema
Get the inputSchema property: This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.- Returns:
- the inputSchema value.
-
withInputSchema
Set the inputSchema property: This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.- Parameters:
inputSchema
- the inputSchema value to set.- Returns:
- the DomainProperties object itself.
-
inputSchemaMapping
Get the inputSchemaMapping property: Information about the InputSchemaMapping which specified the info about mapping event payload.- Returns:
- the inputSchemaMapping value.
-
withInputSchemaMapping
Set the inputSchemaMapping property: Information about the InputSchemaMapping which specified the info about mapping event payload.- Parameters:
inputSchemaMapping
- the inputSchemaMapping value to set.- Returns:
- the DomainProperties object itself.
-
metricResourceId
Get the metricResourceId property: Metric resource id for the Event Grid Domain Resource.- Returns:
- the metricResourceId value.
-
publicNetworkAccess
Get the publicNetworkAccess property: 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" />.- Returns:
- the publicNetworkAccess value.
-
withPublicNetworkAccess
Set the publicNetworkAccess property: 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" />.- Parameters:
publicNetworkAccess
- the publicNetworkAccess value to set.- Returns:
- the DomainProperties object itself.
-
inboundIpRules
Get the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.- Returns:
- the inboundIpRules value.
-
withInboundIpRules
Set the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.- Parameters:
inboundIpRules
- the inboundIpRules value to set.- Returns:
- the DomainProperties object itself.
-
disableLocalAuth
Get the disableLocalAuth property: 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.- Returns:
- the disableLocalAuth value.
-
withDisableLocalAuth
Set the disableLocalAuth property: 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.- Parameters:
disableLocalAuth
- the disableLocalAuth value to set.- Returns:
- the DomainProperties object itself.
-
autoCreateTopicWithFirstSubscription
Get the autoCreateTopicWithFirstSubscription property: 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.- Returns:
- the autoCreateTopicWithFirstSubscription value.
-
withAutoCreateTopicWithFirstSubscription
public DomainProperties withAutoCreateTopicWithFirstSubscription(Boolean autoCreateTopicWithFirstSubscription) Set the autoCreateTopicWithFirstSubscription property: 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.- Parameters:
autoCreateTopicWithFirstSubscription
- the autoCreateTopicWithFirstSubscription value to set.- Returns:
- the DomainProperties object itself.
-
autoDeleteTopicWithLastSubscription
Get the autoDeleteTopicWithLastSubscription property: 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.- Returns:
- the autoDeleteTopicWithLastSubscription value.
-
withAutoDeleteTopicWithLastSubscription
public DomainProperties withAutoDeleteTopicWithLastSubscription(Boolean autoDeleteTopicWithLastSubscription) Set the autoDeleteTopicWithLastSubscription property: 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.- Parameters:
autoDeleteTopicWithLastSubscription
- the autoDeleteTopicWithLastSubscription value to set.- Returns:
- the DomainProperties object itself.
-
dataResidencyBoundary
Get the dataResidencyBoundary property: Data Residency Boundary of the resource.- Returns:
- the dataResidencyBoundary value.
-
withDataResidencyBoundary
Set the dataResidencyBoundary property: Data Residency Boundary of the resource.- Parameters:
dataResidencyBoundary
- the dataResidencyBoundary value to set.- Returns:
- the DomainProperties object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-