Package com.azure.resourcemanager.eventgrid.models

Interface Domain

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

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

      • systemData

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

      • identity

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

      • privateEndpointConnections

        List<PrivateEndpointConnection> privateEndpointConnections()
        Gets the privateEndpointConnections property: List of private endpoint connections.
        Returns:
        the privateEndpointConnections value.

      • provisioningState

        DomainProvisioningState provisioningState()
        Gets the provisioningState property: Provisioning state of the Event Grid Domain Resource.
        Returns:
        the provisioningState value.

      • endpoint

        String endpoint()
        Gets the endpoint property: Endpoint for the domain.
        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 domain.
        Returns:
        the inputSchema value.

      • inputSchemaMapping

        InputSchemaMapping inputSchemaMapping()
        Gets the inputSchemaMapping property: Information about the InputSchemaMapping which specified the info about mapping event payload.
        Returns:
        the inputSchemaMapping value.

      • metricResourceId

        String metricResourceId()
        Gets the metricResourceId property: Metric resource id for the domain.
        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.DomainProperties.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 domain.
        Returns:
        the disableLocalAuth value.

      • autoCreateTopicWithFirstSubscription

        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

        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.

      • 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

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

      • update

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

      • refresh

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

      • refresh

        Domain 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

        DomainSharedAccessKeys listSharedAccessKeys()
        List the two keys used to publish to a domain.
        Returns:
        shared access keys of the Domain.
        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<DomainSharedAccessKeys> listSharedAccessKeysWithResponse​(com.azure.core.util.Context context)
        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.
        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

        DomainSharedAccessKeys regenerateKey​(DomainRegenerateKeyRequest regenerateKeyRequest)
        Regenerate a shared access key for a domain.
        Parameters:
        regenerateKeyRequest - Request body to regenerate key.
        Returns:
        shared access keys of the Domain.
        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.

      • regenerateKeyWithResponse

        com.azure.core.http.rest.Response<DomainSharedAccessKeys> regenerateKeyWithResponse​(DomainRegenerateKeyRequest regenerateKeyRequest,
                                                                                    com.azure.core.util.Context context)
        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.
        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.