DomainProperties Class

Package:

com.azure.resourcemanager.eventgrid.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.1.0

• java.lang.Object
• • com.azure.resourcemanager.eventgrid.fluent.models.DomainProperties

public final class DomainProperties

Properties of the Event Grid Domain Resource.

Constructor Summary

Constructor	Description
DomainProperties()

Method Summary

Modifier and Type	Method and Description
Boolean	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.
Boolean	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.
Boolean	disableLocalAuth() Get the disableLocalAuth property: This boolean is used to enable or disable local auth.
String	endpoint() Get the endpoint property: Endpoint for the domain.
List<InboundIpRule>	inboundIpRules() Get the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.
InputSchema	inputSchema() Get the inputSchema property: This determines the format that Event Grid should expect for incoming events published to the domain.
InputSchemaMapping	inputSchemaMapping() Get the inputSchemaMapping property: Information about the InputSchemaMapping which specified the info about mapping event payload.
String	metricResourceId() Get the metricResourceId property: Metric resource id for the domain.
List<PrivateEndpointConnectionInner>	privateEndpointConnections() Get the privateEndpointConnections property: List of private endpoint connections.
DomainProvisioningState	provisioningState() Get the provisioningState property: Provisioning state of the Event Grid Domain Resource.
PublicNetworkAccess	publicNetworkAccess() Get the publicNetworkAccess property: This determines if traffic is allowed over public network.
void	validate() Validates the instance.
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.
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.
DomainProperties	withDisableLocalAuth(Boolean disableLocalAuth) Set the disableLocalAuth property: This boolean is used to enable or disable local auth.
DomainProperties	withInboundIpRules(List<InboundIpRule> inboundIpRules) Set the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.
DomainProperties	withInputSchema(InputSchema inputSchema) Set the inputSchema property: This determines the format that Event Grid should expect for incoming events published to the domain.
DomainProperties	withInputSchemaMapping(InputSchemaMapping inputSchemaMapping) Set the inputSchemaMapping property: Information about the InputSchemaMapping which specified the info about mapping event payload.
DomainProperties	withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: This determines if traffic is allowed over public network.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DomainProperties

public DomainProperties()

Method Details

autoCreateTopicWithFirstSubscription

public Boolean 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.

autoDeleteTopicWithLastSubscription

public Boolean 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.

disableLocalAuth

public Boolean 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.

endpoint

public String endpoint()

Get the endpoint property: Endpoint for the domain.

Returns:

the endpoint value.

inboundIpRules

public List 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.

inputSchema

public InputSchema inputSchema()

Get the inputSchema property: This determines the format that Event Grid should expect for incoming events published to the domain.

Returns:

the inputSchema value.

inputSchemaMapping

public InputSchemaMapping inputSchemaMapping()

Get the inputSchemaMapping property: Information about the InputSchemaMapping which specified the info about mapping event payload.

Returns:

the inputSchemaMapping value.

metricResourceId

public String metricResourceId()

Get the metricResourceId property: Metric resource id for the domain.

Returns:

the metricResourceId value.

privateEndpointConnections

public List privateEndpointConnections()

Get the privateEndpointConnections property: List of private endpoint connections.

Returns:

the privateEndpointConnections value.

provisioningState

public DomainProvisioningState provisioningState()

Get the provisioningState property: Provisioning state of the Event Grid Domain Resource.

Returns:

the provisioningState value.

publicNetworkAccess

public PublicNetworkAccess 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 .

Returns:

the publicNetworkAccess value.

validate

public void validate()

Validates the instance.

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.

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.

withDisableLocalAuth

public DomainProperties withDisableLocalAuth(Boolean disableLocalAuth)

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.

withInboundIpRules

public DomainProperties withInboundIpRules(List inboundIpRules)

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.

withInputSchema

public DomainProperties withInputSchema(InputSchema inputSchema)

Set the inputSchema property: This determines the format that Event Grid should expect for incoming events published to the domain.

Parameters:

inputSchema - the inputSchema value to set.

Returns:

the DomainProperties object itself.

withInputSchemaMapping

public DomainProperties withInputSchemaMapping(InputSchemaMapping inputSchemaMapping)

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.

withPublicNetworkAccess

public DomainProperties withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess)

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 .

Parameters:

publicNetworkAccess - the publicNetworkAccess value to set.

Returns:

the DomainProperties object itself.

Azure SDK for Java

Latest