Package com.azure.resourcemanager.eventgrid.models

Interface Topic

  • public interface Topic
    An immutable client-side representation of Topic.

    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.

      • name

        String name()
        Gets the name property: The name of the resource.
        Returns:
        the name value.

      • type

        String type()
        Gets the type property: The type of the resource.
        Returns:
        the type value.

      • location

        String location()
        Gets the location property: The geo-location where the resource lives.
        Returns:
        the location value.

      • tags

        Map<String,​String> tags()
        Gets the tags property: Resource tags.
        Returns:
        the tags value.

      • identity

        IdentityInfo identity()
        Gets the identity property: Identity information for the resource.
        Returns:
        the identity value.

      • systemData

        com.azure.core.management.SystemData systemData()
        Gets the systemData property: The system metadata relating to Topic resource.
        Returns:
        the systemData value.

      • privateEndpointConnections

        List<PrivateEndpointConnection> privateEndpointConnections()
        Gets the privateEndpointConnections property: The privateEndpointConnections property.
        Returns:
        the privateEndpointConnections value.

      • provisioningState

        TopicProvisioningState provisioningState()
        Gets the provisioningState property: Provisioning state of the topic.
        Returns:
        the provisioningState value.

      • endpoint

        String endpoint()
        Gets the endpoint property: Endpoint for the topic.
        Returns:
        the endpoint value.

      • inputSchema

        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

        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.

      • metricResourceId

        String metricResourceId()
        Gets the metricResourceId property: Metric resource id for the topic.
        Returns:
        the metricResourceId value.

      • publicNetworkAccess

        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.

      • inboundIpRules

        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.

      • disableLocalAuth

        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.

      • region

        com.azure.core.management.Region region()
        Gets the region of the resource.
        Returns:
        the region of the resource.

      • regionName

        String regionName()
        Gets the name of the resource region.
        Returns:
        the name of the resource region.

      • innerModel

        TopicInner innerModel()
        Gets the inner com.azure.resourcemanager.eventgrid.fluent.models.TopicInner object.
        Returns:
        the inner object.

      • update

        Topic.Update update()
        Begins update for the Topic resource.
        Returns:
        the stage of resource update.

      • refresh

        Topic refresh()
        Refreshes the resource to sync with Azure.
        Returns:
        the refreshed resource.

      • refresh

        Topic refresh​(com.azure.core.util.Context context)
        Refreshes the resource to sync with Azure.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the refreshed resource.

      • listSharedAccessKeys

        TopicSharedAccessKeys listSharedAccessKeys()
        List the two keys used to publish to a topic.
        Returns:
        shared access keys of the Topic.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listSharedAccessKeysWithResponse

        com.azure.core.http.rest.Response<TopicSharedAccessKeys> listSharedAccessKeysWithResponse​(com.azure.core.util.Context context)
        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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • regenerateKey

        TopicSharedAccessKeys regenerateKey​(TopicRegenerateKeyRequest regenerateKeyRequest)
        Regenerate a shared access key for a topic.
        Parameters:
        regenerateKeyRequest - Request body to regenerate key.
        Returns:
        shared access keys of the Topic.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • regenerateKey

        TopicSharedAccessKeys regenerateKey​(TopicRegenerateKeyRequest regenerateKeyRequest,
                                    com.azure.core.util.Context context)
        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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.