DomainInner Class

Package:

com.azure.resourcemanager.eventgrid.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.3.0-beta.1

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.core.management.Resource
    • • com.azure.resourcemanager.eventgrid.fluent.models.DomainInner

public final class DomainInner
extends Resource

EventGrid Domain.

Constructor Summary

Constructor	Description
DomainInner()	Creates an instance of DomainInner class.

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.
DataResidencyBoundary	dataResidencyBoundary() Get the dataResidencyBoundary property: Data Residency Boundary of the 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 Event Grid Domain Resource which is used for publishing the events.
EventTypeInfo	eventTypeInfo() Get the eventTypeInfo property: Event Type Information for the domain.
static DomainInner	fromJson(JsonReader jsonReader) Reads an instance of DomainInner from the JsonReader.
String	id() Get the id property: Fully qualified resource Id for the resource.
IdentityInfo	identity() Get the identity property: Identity information for the Event Grid Domain resource.
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 Event Grid Domain Resource.
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 Event Grid Domain Resource.
TlsVersion	minimumTlsVersionAllowed() Get the minimumTlsVersionAllowed property: Minimum TLS version of the publisher allowed to publish to this domain.
String	name() Get the name property: The name of the resource.
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.
ResourceSku	sku() Get the sku property: The Sku pricing tier for the Event Grid Domain resource.
SystemData	systemData() Get the systemData property: The system metadata relating to the Event Grid resource.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: The type of the resource.
void	validate() Validates the instance.
DomainInner	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.
DomainInner	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.
DomainInner	withDataResidencyBoundary(DataResidencyBoundary dataResidencyBoundary) Set the dataResidencyBoundary property: Data Residency Boundary of the resource.
DomainInner	withDisableLocalAuth(Boolean disableLocalAuth) Set the disableLocalAuth property: This boolean is used to enable or disable local auth.
DomainInner	withEventTypeInfo(EventTypeInfo eventTypeInfo) Set the eventTypeInfo property: Event Type Information for the domain.
DomainInner	withIdentity(IdentityInfo identity) Set the identity property: Identity information for the Event Grid Domain resource.
DomainInner	withInboundIpRules(List<InboundIpRule> inboundIpRules) Set the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.
DomainInner	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.
DomainInner	withInputSchemaMapping(InputSchemaMapping inputSchemaMapping) Set the inputSchemaMapping property: Information about the InputSchemaMapping which specified the info about mapping event payload.
DomainInner	withLocation(String location)
DomainInner	withMinimumTlsVersionAllowed(TlsVersion minimumTlsVersionAllowed) Set the minimumTlsVersionAllowed property: Minimum TLS version of the publisher allowed to publish to this domain.
DomainInner	withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: This determines if traffic is allowed over public network.
DomainInner	withSku(ResourceSku sku) Set the sku property: The Sku pricing tier for the Event Grid Domain resource.
DomainInner	withTags(Map<String,String> tags)

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DomainInner

public DomainInner()

Creates an instance of DomainInner class.

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.

dataResidencyBoundary

public DataResidencyBoundary dataResidencyBoundary()

Get the dataResidencyBoundary property: Data Residency Boundary of the resource.

Returns:

the dataResidencyBoundary 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 Microsoft Entra ID 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 Event Grid Domain Resource which is used for publishing the events.

Returns:

the endpoint value.

eventTypeInfo

public EventTypeInfo eventTypeInfo()

Get the eventTypeInfo property: 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.

Returns:

the eventTypeInfo value.

fromJson

public static DomainInner fromJson(JsonReader jsonReader)

Reads an instance of DomainInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DomainInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

DomainInner.id()

Returns:

the id value.

identity

public IdentityInfo identity()

Get the identity property: Identity information for the Event Grid Domain resource.

Returns:

the identity value.

inboundIpRules

public List<InboundIpRule> 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 Event Grid Domain Resource.

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 Event Grid Domain Resource.

Returns:

the metricResourceId value.

minimumTlsVersionAllowed

public TlsVersion minimumTlsVersionAllowed()

Get the minimumTlsVersionAllowed property: Minimum TLS version of the publisher allowed to publish to this domain.

Returns:

the minimumTlsVersionAllowed value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

DomainInner.name()

Returns:

the name value.

privateEndpointConnections

public List<PrivateEndpointConnectionInner> 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 <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />.

Returns:

the publicNetworkAccess value.

sku

public ResourceSku sku()

Get the sku property: The Sku pricing tier for the Event Grid Domain resource.

Returns:

the sku value.

systemData

public SystemData systemData()

Get the systemData property: The system metadata relating to the Event Grid resource.

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

DomainInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

DomainInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

withAutoCreateTopicWithFirstSubscription

public DomainInner 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 DomainInner object itself.

withAutoDeleteTopicWithLastSubscription

public DomainInner 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 DomainInner object itself.

withDataResidencyBoundary

public DomainInner withDataResidencyBoundary(DataResidencyBoundary dataResidencyBoundary)

Set the dataResidencyBoundary property: Data Residency Boundary of the resource.

Parameters:

dataResidencyBoundary - the dataResidencyBoundary value to set.

Returns:

the DomainInner object itself.

withDisableLocalAuth

public DomainInner 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 Microsoft Entra ID token will be used to authenticate if user is allowed to publish to the domain.

Parameters:

disableLocalAuth - the disableLocalAuth value to set.

Returns:

the DomainInner object itself.

withEventTypeInfo

public DomainInner withEventTypeInfo(EventTypeInfo eventTypeInfo)

Set the eventTypeInfo property: 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.

Parameters:

eventTypeInfo - the eventTypeInfo value to set.

Returns:

the DomainInner object itself.

withIdentity

public DomainInner withIdentity(IdentityInfo identity)

Set the identity property: Identity information for the Event Grid Domain resource.

Parameters:

identity - the identity value to set.

Returns:

the DomainInner object itself.

withInboundIpRules

public DomainInner withInboundIpRules(List<InboundIpRule> 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 DomainInner object itself.

withInputSchema

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

Parameters:

inputSchema - the inputSchema value to set.

Returns:

the DomainInner object itself.

withInputSchemaMapping

public DomainInner 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 DomainInner object itself.

withLocation

public DomainInner withLocation(String location)

Overrides:

DomainInner.withLocation(String location)

Parameters:

location

withMinimumTlsVersionAllowed

public DomainInner withMinimumTlsVersionAllowed(TlsVersion minimumTlsVersionAllowed)

Set the minimumTlsVersionAllowed property: Minimum TLS version of the publisher allowed to publish to this domain.

Parameters:

minimumTlsVersionAllowed - the minimumTlsVersionAllowed value to set.

Returns:

the DomainInner object itself.

withPublicNetworkAccess

public DomainInner 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 <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />.

Parameters:

publicNetworkAccess - the publicNetworkAccess value to set.

Returns:

the DomainInner object itself.

withSku

public DomainInner withSku(ResourceSku sku)

Set the sku property: The Sku pricing tier for the Event Grid Domain resource.

Parameters:

sku - the sku value to set.

Returns:

the DomainInner object itself.

withTags

public DomainInner withTags(Map<String,String> tags)

Overrides:

DomainInner.withTags(Map<String,String> tags)

Parameters:

tags