Class TopicProperties
java.lang.Object
com.azure.resourcemanager.eventgrid.fluent.models.TopicProperties
Properties of the Topic.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the dataResidencyBoundary property: Data Residency Boundary of the resource.Get the disableLocalAuth property: This boolean is used to enable or disable local auth.endpoint()
Get the endpoint property: Endpoint for the topic.Get the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.Get the inputSchema property: This determines the format that Event Grid should expect for incoming events published to the topic.Get the inputSchemaMapping property: This enables publishing using custom event schemas.Get the metricResourceId property: Metric resource id for the topic.Get the privateEndpointConnections property: The privateEndpointConnections property.Get the provisioningState property: Provisioning state of the topic.Get the publicNetworkAccess property: This determines if traffic is allowed over public network.void
validate()
Validates the instance.withDataResidencyBoundary
(DataResidencyBoundary dataResidencyBoundary) Set the dataResidencyBoundary property: Data Residency Boundary of the resource.withDisableLocalAuth
(Boolean disableLocalAuth) Set the disableLocalAuth property: This boolean is used to enable or disable local auth.withInboundIpRules
(List<InboundIpRule> inboundIpRules) Set the inboundIpRules property: This can be used to restrict traffic from specific IPs instead of all IPs.withInputSchema
(InputSchema inputSchema) Set the inputSchema property: This determines the format that Event Grid should expect for incoming events published to the topic.withInputSchemaMapping
(InputSchemaMapping inputSchemaMapping) Set the inputSchemaMapping property: This enables publishing using custom event schemas.withPublicNetworkAccess
(PublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: This determines if traffic is allowed over public network.
-
Constructor Details
-
TopicProperties
public TopicProperties()
-
-
Method Details
-
privateEndpointConnections
Get the privateEndpointConnections property: The privateEndpointConnections property.- Returns:
- the privateEndpointConnections value.
-
provisioningState
Get the provisioningState property: Provisioning state of the topic.- Returns:
- the provisioningState value.
-
endpoint
Get the endpoint property: Endpoint for the topic.- Returns:
- the endpoint value.
-
inputSchema
Get the inputSchema property: This determines the format that Event Grid should expect for incoming events published to the topic.- Returns:
- the inputSchema value.
-
withInputSchema
Set the inputSchema property: This determines the format that Event Grid should expect for incoming events published to the topic.- Parameters:
inputSchema
- the inputSchema value to set.- Returns:
- the TopicProperties object itself.
-
inputSchemaMapping
Get 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.
-
withInputSchemaMapping
Set 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.- Parameters:
inputSchemaMapping
- the inputSchemaMapping value to set.- Returns:
- the TopicProperties object itself.
-
metricResourceId
Get the metricResourceId property: Metric resource id for the topic.- Returns:
- the metricResourceId value.
-
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.TopicProperties.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.TopicProperties.InboundIpRules" />.- Parameters:
publicNetworkAccess
- the publicNetworkAccess value to set.- Returns:
- the TopicProperties 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 TopicProperties 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 topic.- 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 topic.- Parameters:
disableLocalAuth
- the disableLocalAuth value to set.- Returns:
- the TopicProperties object itself.
-
dataResidencyBoundary
Get the dataResidencyBoundary property: Data Residency Boundary of the resource.- Returns:
- the dataResidencyBoundary value.
-
withDataResidencyBoundary
Set the dataResidencyBoundary property: Data Residency Boundary of the resource.- Parameters:
dataResidencyBoundary
- the dataResidencyBoundary value to set.- Returns:
- the TopicProperties object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-