Package com.azure.resourcemanager.communication.models

Interface DomainResource

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

    • 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: Azure Resource Manager metadata containing createdBy and modifiedBy information.
        Returns:
        the systemData value.

      • provisioningState

        DomainsProvisioningState provisioningState()
        Gets the provisioningState property: Provisioning state of the resource.
        Returns:
        the provisioningState value.

      • dataLocation

        String dataLocation()
        Gets the dataLocation property: The location where the Domains resource data is stored at rest.
        Returns:
        the dataLocation value.

      • fromSenderDomain

        String fromSenderDomain()
        Gets the fromSenderDomain property: P2 sender domain that is displayed to the email recipients [RFC 5322].
        Returns:
        the fromSenderDomain value.

      • mailFromSenderDomain

        String mailFromSenderDomain()
        Gets the mailFromSenderDomain property: P1 sender domain that is present on the email envelope [RFC 5321].
        Returns:
        the mailFromSenderDomain value.

      • domainManagement

        DomainManagement domainManagement()
        Gets the domainManagement property: Describes how a Domains resource is being managed.
        Returns:
        the domainManagement value.

      • verificationStates

        DomainPropertiesVerificationStates verificationStates()
        Gets the verificationStates property: List of VerificationStatusRecord.
        Returns:
        the verificationStates value.

      • verificationRecords

        DomainPropertiesVerificationRecords verificationRecords()
        Gets the verificationRecords property: List of DnsRecord.
        Returns:
        the verificationRecords value.

      • validSenderUsernames

        Map<String,​String> validSenderUsernames()
        Gets the validSenderUsernames property: Collection of valid sender usernames. This is a key-value pair where key=username and value=display name.
        Returns:
        the validSenderUsernames value.

      • userEngagementTracking

        UserEngagementTracking userEngagementTracking()
        Gets the userEngagementTracking property: Describes whether user engagement tracking is enabled or disabled.
        Returns:
        the userEngagementTracking 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.

      • resourceGroupName

        String resourceGroupName()
        Gets the name of the resource group.
        Returns:
        the name of the resource group.

      • innerModel

        DomainResourceInner innerModel()
        Gets the inner com.azure.resourcemanager.communication.fluent.models.DomainResourceInner object.
        Returns:
        the inner object.

      • update

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

      • refresh

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

      • refresh

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

      • initiateVerification

        void initiateVerification​(VerificationParameter parameters)
        Initiate verification of DNS record.
        Parameters:
        parameters - Type of verification to be initiated.
        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.

      • initiateVerification

        void initiateVerification​(VerificationParameter parameters,
                          com.azure.core.util.Context context)
        Initiate verification of DNS record.
        Parameters:
        parameters - Type of verification to be initiated.
        context - The context to associate with this operation.
        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.

      • cancelVerification

        void cancelVerification​(VerificationParameter parameters)
        Cancel verification of DNS record.
        Parameters:
        parameters - Type of verification to be canceled.
        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.

      • cancelVerification

        void cancelVerification​(VerificationParameter parameters,
                        com.azure.core.util.Context context)
        Cancel verification of DNS record.
        Parameters:
        parameters - Type of verification to be canceled.
        context - The context to associate with this operation.
        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.