Domain Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

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

public interface Domain

An immutable client-side representation of Domain.

Method Summary

Modifier and Type	Method and Description
abstract Boolean	autoCreateTopicWithFirstSubscription() Gets 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.
abstract Boolean	autoDeleteTopicWithLastSubscription() Gets 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.
abstract DataResidencyBoundary	dataResidencyBoundary() Gets the dataResidencyBoundary property: Data Residency Boundary of the resource.
abstract Boolean	disableLocalAuth() Gets the disableLocalAuth property: This boolean is used to enable or disable local auth.
abstract String	endpoint() Gets the endpoint property: Endpoint for the Event Grid Domain Resource which is used for publishing the events.
abstract EventTypeInfo	eventTypeInfo() Gets the eventTypeInfo property: Event Type Information for the domain.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract IdentityInfo	identity() Gets the identity property: Identity information for the Event Grid Domain resource.
abstract List<InboundIpRule>	inboundIpRules() Gets the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.
abstract DomainInner	innerModel() Gets the inner com.azure.resourcemanager.eventgrid.fluent.models.DomainInner object.
abstract InputSchema	inputSchema() Gets the inputSchema property: This determines the format that Event Grid should expect for incoming events published to the Event Grid Domain Resource.
abstract InputSchemaMapping	inputSchemaMapping() Gets the inputSchemaMapping property: Information about the InputSchemaMapping which specified the info about mapping event payload.
abstract DomainSharedAccessKeys	listSharedAccessKeys() List keys for a domain.
abstract Response<DomainSharedAccessKeys>	listSharedAccessKeysWithResponse(Context context) List keys for a domain.
abstract String	location() Gets the location property: The geo-location where the resource lives.
abstract String	metricResourceId() Gets the metricResourceId property: Metric resource id for the Event Grid Domain Resource.
abstract TlsVersion	minimumTlsVersionAllowed() Gets the minimumTlsVersionAllowed property: Minimum TLS version of the publisher allowed to publish to this domain.
abstract String	name() Gets the name property: The name of the resource.
abstract List<PrivateEndpointConnection>	privateEndpointConnections() Gets the privateEndpointConnections property: List of private endpoint connections.
abstract DomainProvisioningState	provisioningState() Gets the provisioningState property: Provisioning state of the Event Grid Domain Resource.
abstract PublicNetworkAccess	publicNetworkAccess() Gets the publicNetworkAccess property: This determines if traffic is allowed over public network.
abstract Domain	refresh() Refreshes the resource to sync with Azure.
abstract Domain	refresh(Context context) Refreshes the resource to sync with Azure.
abstract DomainSharedAccessKeys	regenerateKey(DomainRegenerateKeyRequest regenerateKeyRequest) Regenerate key for a domain.
abstract Response<DomainSharedAccessKeys>	regenerateKeyWithResponse(DomainRegenerateKeyRequest regenerateKeyRequest, Context context) Regenerate key for a domain.
abstract Region	region() Gets the region of the resource.
abstract String	regionName() Gets the name of the resource region.
abstract String	resourceGroupName() Gets the name of the resource group.
abstract ResourceSku	sku() Gets the sku property: The Sku pricing tier for the Event Grid Domain resource.
abstract SystemData	systemData() Gets the systemData property: The system metadata relating to the Event Grid resource.
abstract Map<String,String>	tags() Gets the tags property: Resource tags.
abstract String	type() Gets the type property: The type of the resource.
abstract Update	update() Begins update for the Domain resource.

Method Details

autoCreateTopicWithFirstSubscription

public abstract Boolean autoCreateTopicWithFirstSubscription()

Gets 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 abstract Boolean autoDeleteTopicWithLastSubscription()

Gets 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 abstract DataResidencyBoundary dataResidencyBoundary()

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

Returns:

the dataResidencyBoundary value.

disableLocalAuth

public abstract Boolean disableLocalAuth()

Gets 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 abstract String endpoint()

Gets the endpoint property: Endpoint for the Event Grid Domain Resource which is used for publishing the events.

Returns:

the endpoint value.

eventTypeInfo

public abstract EventTypeInfo eventTypeInfo()

Gets 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.

id

public abstract String id()

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

Returns:

the id value.

identity

public abstract IdentityInfo identity()

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

Returns:

the identity value.

inboundIpRules

public abstract List<InboundIpRule> inboundIpRules()

Gets 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.

innerModel

public abstract DomainInner innerModel()

Gets the inner com.azure.resourcemanager.eventgrid.fluent.models.DomainInner object.

Returns:

the inner object.

inputSchema

public abstract InputSchema inputSchema()

Gets 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 abstract InputSchemaMapping inputSchemaMapping()

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

Returns:

the inputSchemaMapping value.

listSharedAccessKeys

public abstract DomainSharedAccessKeys listSharedAccessKeys()

List keys for a domain. List the two keys used to publish to a domain.

Returns:

shared access keys of the Domain.

listSharedAccessKeysWithResponse

public abstract Response<DomainSharedAccessKeys> listSharedAccessKeysWithResponse(Context context)

List keys for a domain. List the two keys used to publish to a domain.

Parameters:

context - The context to associate with this operation.

Returns:

shared access keys of the Domain along with Response<T>.

location

public abstract String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location value.

metricResourceId

public abstract String metricResourceId()

Gets the metricResourceId property: Metric resource id for the Event Grid Domain Resource.

Returns:

the metricResourceId value.

minimumTlsVersionAllowed

public abstract TlsVersion minimumTlsVersionAllowed()

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

Returns:

the minimumTlsVersionAllowed value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

privateEndpointConnections

public abstract List<PrivateEndpointConnection> privateEndpointConnections()

Gets the privateEndpointConnections property: List of private endpoint connections.

Returns:

the privateEndpointConnections value.

provisioningState

public abstract DomainProvisioningState provisioningState()

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

Returns:

the provisioningState value.

publicNetworkAccess

public abstract PublicNetworkAccess publicNetworkAccess()

Gets 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.

refresh

public abstract Domain refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract Domain refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

regenerateKey

public abstract DomainSharedAccessKeys regenerateKey(DomainRegenerateKeyRequest regenerateKeyRequest)

Regenerate key for a domain. Regenerate a shared access key for a domain.

Parameters:

regenerateKeyRequest - Request body to regenerate key.

Returns:

shared access keys of the Domain.

regenerateKeyWithResponse

public abstract Response<DomainSharedAccessKeys> regenerateKeyWithResponse(DomainRegenerateKeyRequest regenerateKeyRequest, Context context)

Regenerate key for a domain. Regenerate a shared access key for a domain.

Parameters:

regenerateKeyRequest - Request body to regenerate key.

context - The context to associate with this operation.

Returns:

shared access keys of the Domain along with Response<T>.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

sku

public abstract ResourceSku sku()

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

Returns:

the sku value.

systemData

public abstract SystemData systemData()

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

Returns:

the systemData value.

tags

public abstract Map<String,String> tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract Domain.Update update()

Begins update for the Domain resource.

Returns:

the stage of resource update.