Package com.azure.resourcemanager.communication.fluent

Interface CommunicationServicesClient

  • public interface CommunicationServicesClient
    An instance of this class provides access to all the operations defined in CommunicationServicesClient.

    • Method Detail

      • checkNameAvailability

        NameAvailabilityInner checkNameAvailability()
        Checks that the CommunicationService name is valid and is not already in use.
        Returns:
        result of the request to check name availability.
        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.

      • checkNameAvailabilityWithResponse

        com.azure.core.http.rest.Response<NameAvailabilityInner> checkNameAvailabilityWithResponse​(NameAvailabilityParameters nameAvailabilityParameters,
                                                                                           com.azure.core.util.Context context)
        Checks that the CommunicationService name is valid and is not already in use.
        Parameters:
        nameAvailabilityParameters - Parameters supplied to the operation.
        context - The context to associate with this operation.
        Returns:
        result of the request to check name availability 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.

      • linkNotificationHub

        LinkedNotificationHubInner linkNotificationHub​(String resourceGroupName,
                                               String communicationServiceName)
        Links an Azure Notification Hub to this communication service.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        Returns:
        a notification hub that has been linked to the communication service.
        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.

      • linkNotificationHubWithResponse

        com.azure.core.http.rest.Response<LinkedNotificationHubInner> linkNotificationHubWithResponse​(String resourceGroupName,
                                                                                              String communicationServiceName,
                                                                                              LinkNotificationHubParameters linkNotificationHubParameters,
                                                                                              com.azure.core.util.Context context)
        Links an Azure Notification Hub to this communication service.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        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.

      • list

        com.azure.core.http.rest.PagedIterable<CommunicationServiceResourceInner> list()
        Handles requests to list all resources in a subscription.
        Returns:
        object that includes an array of CommunicationServices and a possible link for next set.
        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.

      • list

        com.azure.core.http.rest.PagedIterable<CommunicationServiceResourceInner> list​(com.azure.core.util.Context context)
        Handles requests to list all resources in a subscription.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        object that includes an array of CommunicationServices and a possible link for next set.
        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.

      • listByResourceGroup

        com.azure.core.http.rest.PagedIterable<CommunicationServiceResourceInner> listByResourceGroup​(String resourceGroupName)
        Handles requests to list all resources in a resource group.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        Returns:
        object that includes an array of CommunicationServices and a possible link for next set.
        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.

      • listByResourceGroup

        com.azure.core.http.rest.PagedIterable<CommunicationServiceResourceInner> listByResourceGroup​(String resourceGroupName,
                                                                                              com.azure.core.util.Context context)
        Handles requests to list all resources in a resource group.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        context - The context to associate with this operation.
        Returns:
        object that includes an array of CommunicationServices and a possible link for next set.
        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.

      • update

        CommunicationServiceResourceInner update​(String resourceGroupName,
                                         String communicationServiceName)
        Operation to update an existing CommunicationService.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        Returns:
        a class representing a CommunicationService resource.
        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.

      • updateWithResponse

        com.azure.core.http.rest.Response<CommunicationServiceResourceInner> updateWithResponse​(String resourceGroupName,
                                                                                        String communicationServiceName,
                                                                                        CommunicationServiceResourceInner parameters,
                                                                                        com.azure.core.util.Context context)
        Operation to update an existing CommunicationService.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        parameters - Parameters for the update operation.
        context - The context to associate with this operation.
        Returns:
        a class representing a 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.

      • getByResourceGroup

        CommunicationServiceResourceInner getByResourceGroup​(String resourceGroupName,
                                                     String communicationServiceName)
        Get the CommunicationService and its properties.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        Returns:
        the CommunicationService and its properties.
        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.

      • getByResourceGroupWithResponse

        com.azure.core.http.rest.Response<CommunicationServiceResourceInner> getByResourceGroupWithResponse​(String resourceGroupName,
                                                                                                    String communicationServiceName,
                                                                                                    com.azure.core.util.Context context)
        Get the CommunicationService and its properties.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        context - The context to associate with this operation.
        Returns:
        the CommunicationService and its properties 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.

      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CommunicationServiceResourceInner>,​CommunicationServiceResourceInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                                                    String communicationServiceName,
                                                                                                                                                                                    CommunicationServiceResourceInner parameters)
        Create a new CommunicationService or update an existing CommunicationService.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        parameters - Parameters for the create or update operation.
        Returns:
        a class representing a CommunicationService resource along with Response on successful completion of Mono.
        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.

      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CommunicationServiceResourceInner>,​CommunicationServiceResourceInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                                                    String communicationServiceName,
                                                                                                                                                                                    CommunicationServiceResourceInner parameters,
                                                                                                                                                                                    com.azure.core.util.Context context)
        Create a new CommunicationService or update an existing CommunicationService.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        parameters - Parameters for the create or update operation.
        context - The context to associate with this operation.
        Returns:
        a class representing a CommunicationService resource along with Response on successful completion of Mono.
        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.

      • createOrUpdate

        CommunicationServiceResourceInner createOrUpdate​(String resourceGroupName,
                                                 String communicationServiceName,
                                                 CommunicationServiceResourceInner parameters)
        Create a new CommunicationService or update an existing CommunicationService.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        parameters - Parameters for the create or update operation.
        Returns:
        a class representing a CommunicationService resource.
        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.

      • createOrUpdate

        CommunicationServiceResourceInner createOrUpdate​(String resourceGroupName,
                                                 String communicationServiceName)
        Create a new CommunicationService or update an existing CommunicationService.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        Returns:
        a class representing a CommunicationService resource.
        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.

      • createOrUpdate

        CommunicationServiceResourceInner createOrUpdate​(String resourceGroupName,
                                                 String communicationServiceName,
                                                 CommunicationServiceResourceInner parameters,
                                                 com.azure.core.util.Context context)
        Create a new CommunicationService or update an existing CommunicationService.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        parameters - Parameters for the create or update operation.
        context - The context to associate with this operation.
        Returns:
        a class representing a CommunicationService resource.
        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.

      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                  String communicationServiceName)
        Operation to delete a CommunicationService.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        Returns:
        the Response on successful completion of Mono.
        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.

      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                  String communicationServiceName,
                                                                                                                  com.azure.core.util.Context context)
        Operation to delete a CommunicationService.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        context - The context to associate with this operation.
        Returns:
        the Response on successful completion of Mono.
        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.

      • delete

        void delete​(String resourceGroupName,
            String communicationServiceName)
        Operation to delete a CommunicationService.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        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.

      • delete

        void delete​(String resourceGroupName,
            String communicationServiceName,
            com.azure.core.util.Context context)
        Operation to delete a CommunicationService.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        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.

      • listKeys

        CommunicationServiceKeysInner listKeys​(String resourceGroupName,
                                       String communicationServiceName)
        Get the access keys of the CommunicationService resource.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        Returns:
        the access keys of the CommunicationService resource.
        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.

      • listKeysWithResponse

        com.azure.core.http.rest.Response<CommunicationServiceKeysInner> listKeysWithResponse​(String resourceGroupName,
                                                                                      String communicationServiceName,
                                                                                      com.azure.core.util.Context context)
        Get the access keys of the CommunicationService resource.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        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

        CommunicationServiceKeysInner regenerateKey​(String resourceGroupName,
                                            String communicationServiceName,
                                            RegenerateKeyParameters parameters)
        Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        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.

      • regenerateKeyWithResponse

        com.azure.core.http.rest.Response<CommunicationServiceKeysInner> regenerateKeyWithResponse​(String resourceGroupName,
                                                                                           String communicationServiceName,
                                                                                           RegenerateKeyParameters parameters,
                                                                                           com.azure.core.util.Context context)
        Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        communicationServiceName - The name of the CommunicationService resource.
        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 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.