Class DomainUpdateParameters
java.lang.Object
com.azure.resourcemanager.eventgrid.models.DomainUpdateParameters
Properties of the Domain update.
-
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: The data residency boundary for the domain.Get the disableLocalAuth property: This boolean is used to enable or disable local auth.identity()
Get the identity property: Identity information for the resource.Get the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.Get the publicNetworkAccess property: This determines if traffic is allowed over public network.tags()
Get the tags property: Tags of the domains resource.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: The data residency boundary for the domain.withDisableLocalAuth
(Boolean disableLocalAuth) Set the disableLocalAuth property: This boolean is used to enable or disable local auth.withIdentity
(IdentityInfo identity) Set the identity property: Identity information for the resource.withInboundIpRules
(List<InboundIpRule> inboundIpRules) Set the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.withPublicNetworkAccess
(PublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: This determines if traffic is allowed over public network.Set the tags property: Tags of the domains resource.
-
Constructor Details
-
DomainUpdateParameters
public DomainUpdateParameters()
-
-
Method Details
-
tags
Get the tags property: Tags of the domains resource.- Returns:
- the tags value.
-
withTags
Set the tags property: Tags of the domains resource.- Parameters:
tags
- the tags value to set.- Returns:
- the DomainUpdateParameters object itself.
-
identity
Get the identity property: Identity information for the resource.- Returns:
- the identity value.
-
withIdentity
Set the identity property: Identity information for the resource.- Parameters:
identity
- the identity value to set.- Returns:
- the DomainUpdateParameters object itself.
-
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.
-
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.DomainUpdateParameterProperties.InboundIpRules" />.- Parameters:
publicNetworkAccess
- the publicNetworkAccess value to set.- Returns:
- the DomainUpdateParameters 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 DomainUpdateParameters 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 DomainUpdateParameters 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 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.
-
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 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.
-
dataResidencyBoundary
Get the dataResidencyBoundary property: The data residency boundary for the domain.- Returns:
- the dataResidencyBoundary value.
-
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.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-