Interface CommunicationServiceResource


public interface CommunicationServiceResource
An immutable client-side representation of CommunicationServiceResource.
  • Method Details

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

      Gets the provisioningState property: Provisioning state of the resource.
      Returns:
      the provisioningState value.
    • hostname

      String hostname()
      Gets the hostname property: FQDN of the CommunicationService instance.
      Returns:
      the hostname value.
    • dataLocation

      String dataLocation()
      Gets the dataLocation property: The location where the communication service stores its data at rest.
      Returns:
      the dataLocation value.
    • notificationHubId

      String notificationHubId()
      Gets the notificationHubId property: Resource ID of an Azure Notification Hub linked to this resource.
      Returns:
      the notificationHubId value.
    • version

      String version()
      Gets the version property: Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs.
      Returns:
      the version value.
    • immutableResourceId

      String immutableResourceId()
      Gets the immutableResourceId property: The immutable resource Id of the communication service.
      Returns:
      the immutableResourceId value.
    • linkedDomains

      List<String> linkedDomains()
      Gets the linkedDomains property: List of email Domain resource Ids.
      Returns:
      the linkedDomains 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

      Gets the inner com.azure.resourcemanager.communication.fluent.models.CommunicationServiceResourceInner object.
      Returns:
      the inner object.
    • update

      Begins update for the CommunicationServiceResource resource.
      Returns:
      the stage of resource update.
    • refresh

      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.
    • refresh

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

      LinkedNotificationHub linkNotificationHub()
      Link Notification Hub

      Links an Azure Notification Hub to this communication service.

      Returns:
      a notification hub that has been linked to the communication service.
      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.
    • linkNotificationHubWithResponse

      com.azure.core.http.rest.Response<LinkedNotificationHub> linkNotificationHubWithResponse(LinkNotificationHubParameters linkNotificationHubParameters, com.azure.core.util.Context context)
      Link Notification Hub

      Links an Azure Notification Hub to this communication service.

      Parameters:
      linkNotificationHubParameters - Parameters supplied to the operation.
      context - The context to associate with this operation.
      Returns:
      a notification hub that has been linked to the communication service 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.
    • listKeys

      List Keys

      Get the access keys of the CommunicationService resource.

      Returns:
      the access keys of the CommunicationService resource.
      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.
    • listKeysWithResponse

      com.azure.core.http.rest.Response<CommunicationServiceKeys> listKeysWithResponse(com.azure.core.util.Context context)
      List Keys

      Get the access keys of the CommunicationService resource.

      Parameters:
      context - The context to associate with this operation.
      Returns:
      the access keys of the CommunicationService resource 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

      Regenerate Key

      Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.

      Parameters:
      parameters - Parameter that describes the Regenerate Key Operation.
      Returns:
      a class representing the access keys of a CommunicationService.
      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

      CommunicationServiceKeys regenerateKey(RegenerateKeyParameters parameters, com.azure.core.util.Context context)
      Regenerate Key

      Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.

      Parameters:
      parameters - Parameter that describes the Regenerate Key Operation.
      context - The context to associate with this operation.
      Returns:
      a class representing the access keys of a CommunicationService.
      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.