DomainUpdateParameters Class

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

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

• java.lang.Object
• • com.azure.resourcemanager.eventgrid.models.DomainUpdateParameters

Implements

JsonSerializable<DomainUpdateParameters>

public final class DomainUpdateParameters
implements JsonSerializable<DomainUpdateParameters>

Properties of the Domain update.

Constructor Summary

Constructor	Description
DomainUpdateParameters()	Creates an instance of DomainUpdateParameters 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: The data residency boundary for the domain.
Boolean	disableLocalAuth() Get the disableLocalAuth property: This boolean is used to enable or disable local auth.
EventTypeInfo	eventTypeInfo() Get the eventTypeInfo property: The eventTypeInfo for the domain.
static DomainUpdateParameters	fromJson(JsonReader jsonReader) Reads an instance of DomainUpdateParameters from the JsonReader.
IdentityInfo	identity() Get the identity property: Identity information for the resource.
List<InboundIpRule>	inboundIpRules() Get the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.
TlsVersion	minimumTlsVersionAllowed() Get the minimumTlsVersionAllowed property: Minimum TLS version of the publisher allowed to publish to this domain.
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 domain.
Map<String,String>	tags() Get the tags property: Tags of the domains resource.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
DomainUpdateParameters	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.
DomainUpdateParameters	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.
DomainUpdateParameters	withDataResidencyBoundary(DataResidencyBoundary dataResidencyBoundary) Set the dataResidencyBoundary property: The data residency boundary for the domain.
DomainUpdateParameters	withDisableLocalAuth(Boolean disableLocalAuth) Set the disableLocalAuth property: This boolean is used to enable or disable local auth.
DomainUpdateParameters	withEventTypeInfo(EventTypeInfo eventTypeInfo) Set the eventTypeInfo property: The eventTypeInfo for the domain.
DomainUpdateParameters	withIdentity(IdentityInfo identity) Set the identity property: Identity information for the resource.
DomainUpdateParameters	withInboundIpRules(List<InboundIpRule> inboundIpRules) Set the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.
DomainUpdateParameters	withMinimumTlsVersionAllowed(TlsVersion minimumTlsVersionAllowed) Set the minimumTlsVersionAllowed property: Minimum TLS version of the publisher allowed to publish to this domain.
DomainUpdateParameters	withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: This determines if traffic is allowed over public network.
DomainUpdateParameters	withSku(ResourceSku sku) Set the sku property: The Sku pricing tier for the domain.
DomainUpdateParameters	withTags(Map<String,String> tags) Set the tags property: Tags of the domains resource.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DomainUpdateParameters

public DomainUpdateParameters()

Creates an instance of DomainUpdateParameters 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: The data residency boundary for the domain.

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.

eventTypeInfo

public EventTypeInfo eventTypeInfo()

Get the eventTypeInfo property: The eventTypeInfo for the domain.

Returns:

the eventTypeInfo value.

fromJson

public static DomainUpdateParameters fromJson(JsonReader jsonReader)

Reads an instance of DomainUpdateParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If an error occurs while reading the DomainUpdateParameters.

identity

public IdentityInfo identity()

Get the identity property: Identity information for the 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.

minimumTlsVersionAllowed

public TlsVersion minimumTlsVersionAllowed()

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

Returns:

the minimumTlsVersionAllowed 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.DomainUpdateParameterProperties.InboundIpRules" />.

Returns:

the publicNetworkAccess value.

sku

public ResourceSku sku()

Get the sku property: The Sku pricing tier for the domain.

Returns:

the sku value.

tags

public Map<String,String> tags()

Get the tags property: Tags of the domains resource.

Returns:

the tags value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withAutoCreateTopicWithFirstSubscription

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

withAutoDeleteTopicWithLastSubscription

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

withDataResidencyBoundary

public DomainUpdateParameters withDataResidencyBoundary(DataResidencyBoundary dataResidencyBoundary)

Set the dataResidencyBoundary property: The data residency boundary for the domain.

Parameters:

dataResidencyBoundary - the dataResidencyBoundary value to set.

Returns:

the DomainUpdateParameters object itself.

withDisableLocalAuth

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

withEventTypeInfo

public DomainUpdateParameters withEventTypeInfo(EventTypeInfo eventTypeInfo)

Set the eventTypeInfo property: The eventTypeInfo for the domain.

Parameters:

eventTypeInfo - the eventTypeInfo value to set.

Returns:

the DomainUpdateParameters object itself.

withIdentity

public DomainUpdateParameters withIdentity(IdentityInfo identity)

Set the identity property: Identity information for the resource.

Parameters:

identity - the identity value to set.

Returns:

the DomainUpdateParameters object itself.

withInboundIpRules

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

withMinimumTlsVersionAllowed

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

withPublicNetworkAccess

public DomainUpdateParameters 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.DomainUpdateParameterProperties.InboundIpRules" />.

Parameters:

publicNetworkAccess - the publicNetworkAccess value to set.

Returns:

the DomainUpdateParameters object itself.

withSku

public DomainUpdateParameters withSku(ResourceSku sku)

Set the sku property: The Sku pricing tier for the domain.

Parameters:

sku - the sku value to set.

Returns:

the DomainUpdateParameters object itself.

withTags

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

Set the tags property: Tags of the domains resource.

Parameters:

tags - the tags value to set.

Returns:

the DomainUpdateParameters object itself.