Topic Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.2.0

public interface Topic

An immutable client-side representation of Topic.

Method Summary

Modifier and Type	Method and Description
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 topic.
abstract EventTypeInfo	eventTypeInfo() Gets the eventTypeInfo property: Event Type Information for the user topic.
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 resource.
abstract List<InboundIpRule>	inboundIpRules() Gets the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.
abstract TopicInner	innerModel() Gets the inner com.azure.resourcemanager.eventgrid.fluent.models.TopicInner object.
abstract InputSchema	inputSchema() Gets the inputSchema property: This determines the format that Event Grid should expect for incoming events published to the topic.
abstract InputSchemaMapping	inputSchemaMapping() Gets the inputSchemaMapping property: This enables publishing using custom event schemas.
abstract TopicSharedAccessKeys	listSharedAccessKeys() List keys for a topic.
abstract Response<TopicSharedAccessKeys>	listSharedAccessKeysWithResponse(Context context) List keys for a topic.
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 topic.
abstract TlsVersion	minimumTlsVersionAllowed() Gets the minimumTlsVersionAllowed property: Minimum TLS version of the publisher allowed to publish to this topic.
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 TopicProvisioningState	provisioningState() Gets the provisioningState property: Provisioning state of the topic.
abstract PublicNetworkAccess	publicNetworkAccess() Gets the publicNetworkAccess property: This determines if traffic is allowed over public network.
abstract Topic	refresh() Refreshes the resource to sync with Azure.
abstract Topic	refresh(Context context) Refreshes the resource to sync with Azure.
abstract TopicSharedAccessKeys	regenerateKey(TopicRegenerateKeyRequest regenerateKeyRequest) Regenerate key for a topic.
abstract TopicSharedAccessKeys	regenerateKey(TopicRegenerateKeyRequest regenerateKeyRequest, Context context) Regenerate key for a topic.
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 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 Topic resource.

Method Details

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 AAD token will be used to authenticate if user is allowed to publish to the topic.

Returns:

the disableLocalAuth value.

endpoint

public abstract String endpoint()

Gets the endpoint property: Endpoint for the topic.

Returns:

the endpoint value.

eventTypeInfo

public abstract EventTypeInfo eventTypeInfo()

Gets the eventTypeInfo property: Event Type Information for the user topic. 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 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 TopicInner innerModel()

Gets the inner com.azure.resourcemanager.eventgrid.fluent.models.TopicInner 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 topic.

Returns:

the inputSchema value.

inputSchemaMapping

public abstract InputSchemaMapping inputSchemaMapping()

Gets the inputSchemaMapping property: This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema.

Returns:

the inputSchemaMapping value.

listSharedAccessKeys

public abstract TopicSharedAccessKeys listSharedAccessKeys()

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

Returns:

shared access keys of the Topic.

listSharedAccessKeysWithResponse

public abstract Response<TopicSharedAccessKeys> listSharedAccessKeysWithResponse(Context context)

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

Parameters:

context - The context to associate with this operation.

Returns:

shared access keys of the Topic 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 topic.

Returns:

the metricResourceId value.

minimumTlsVersionAllowed

public abstract TlsVersion minimumTlsVersionAllowed()

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

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 TopicProvisioningState provisioningState()

Gets the provisioningState property: Provisioning state of the topic.

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.TopicProperties.InboundIpRules" />.

Returns:

the publicNetworkAccess value.

refresh

public abstract Topic refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract Topic 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 TopicSharedAccessKeys regenerateKey(TopicRegenerateKeyRequest regenerateKeyRequest)

Regenerate key for a topic. Regenerate a shared access key for a topic.

Parameters:

regenerateKeyRequest - Request body to regenerate key.

Returns:

shared access keys of the Topic.

regenerateKey

public abstract TopicSharedAccessKeys regenerateKey(TopicRegenerateKeyRequest regenerateKeyRequest, Context context)

Regenerate key for a topic. Regenerate a shared access key for a topic.

Parameters:

regenerateKeyRequest - Request body to regenerate key.

context - The context to associate with this operation.

Returns:

shared access keys of the Topic.

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.

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 Topic.Update update()

Begins update for the Topic resource.

Returns:

the stage of resource update.