CommunicationServicesClient Interface

Package:

com.azure.resourcemanager.communication.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-communication:2.3.0

public interface CommunicationServicesClient

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

Method Summary

Modifier and Type	Method and Description
abstract SyncPoller<PollResult<CommunicationServiceResourceInner>,CommunicationServiceResourceInner>	beginCreateOrUpdate(String resourceGroupName, String communicationServiceName, CommunicationServiceResourceInner parameters) Create Or Update Create a new CommunicationService or update an existing CommunicationService.
abstract SyncPoller<PollResult<CommunicationServiceResourceInner>,CommunicationServiceResourceInner>	beginCreateOrUpdate(String resourceGroupName, String communicationServiceName, CommunicationServiceResourceInner parameters, Context context) Create Or Update Create a new CommunicationService or update an existing CommunicationService.
abstract SyncPoller<PollResult<Void>,Void>	beginDelete(String resourceGroupName, String communicationServiceName) Delete Operation to delete a CommunicationService.
abstract SyncPoller<PollResult<Void>,Void>	beginDelete(String resourceGroupName, String communicationServiceName, Context context) Delete Operation to delete a CommunicationService.
abstract CheckNameAvailabilityResponseInner	checkNameAvailability(NameAvailabilityParameters nameAvailabilityParameters) Check Name Availability Checks that the CommunicationService name is valid and is not already in use.
abstract Response<CheckNameAvailabilityResponseInner>	checkNameAvailabilityWithResponse(NameAvailabilityParameters nameAvailabilityParameters, Context context) Check Name Availability Checks that the CommunicationService name is valid and is not already in use.
abstract CommunicationServiceResourceInner	createOrUpdate(String resourceGroupName, String communicationServiceName, CommunicationServiceResourceInner parameters) Create Or Update Create a new CommunicationService or update an existing CommunicationService.
abstract CommunicationServiceResourceInner	createOrUpdate(String resourceGroupName, String communicationServiceName, CommunicationServiceResourceInner parameters, Context context) Create Or Update Create a new CommunicationService or update an existing CommunicationService.
abstract void	delete(String resourceGroupName, String communicationServiceName) Delete Operation to delete a CommunicationService.
abstract void	delete(String resourceGroupName, String communicationServiceName, Context context) Delete Operation to delete a CommunicationService.
abstract CommunicationServiceResourceInner	getByResourceGroup(String resourceGroupName, String communicationServiceName) Get Get the CommunicationService and its properties.
abstract Response<CommunicationServiceResourceInner>	getByResourceGroupWithResponse(String resourceGroupName, String communicationServiceName, Context context) Get Get the CommunicationService and its properties.
abstract LinkedNotificationHubInner	linkNotificationHub(String resourceGroupName, String communicationServiceName) Link Notification Hub Links an Azure Notification Hub to this communication service.
abstract Response<LinkedNotificationHubInner>	linkNotificationHubWithResponse(String resourceGroupName, String communicationServiceName, LinkNotificationHubParameters linkNotificationHubParameters, Context context) Link Notification Hub Links an Azure Notification Hub to this communication service.
abstract PagedIterable<CommunicationServiceResourceInner>	list() List By Subscription Handles requests to list all resources in a subscription.
abstract PagedIterable<CommunicationServiceResourceInner>	list(Context context) List By Subscription Handles requests to list all resources in a subscription.
abstract PagedIterable<CommunicationServiceResourceInner>	listByResourceGroup(String resourceGroupName) List By Resource Group Handles requests to list all resources in a resource group.
abstract PagedIterable<CommunicationServiceResourceInner>	listByResourceGroup(String resourceGroupName, Context context) List By Resource Group Handles requests to list all resources in a resource group.
abstract CommunicationServiceKeysInner	listKeys(String resourceGroupName, String communicationServiceName) List Keys Get the access keys of the CommunicationService resource.
abstract Response<CommunicationServiceKeysInner>	listKeysWithResponse(String resourceGroupName, String communicationServiceName, Context context) List Keys Get the access keys of the CommunicationService resource.
abstract CommunicationServiceKeysInner	regenerateKey(String resourceGroupName, String communicationServiceName, RegenerateKeyParameters parameters) Regenerate Key Regenerate CommunicationService access key.
abstract Response<CommunicationServiceKeysInner>	regenerateKeyWithResponse(String resourceGroupName, String communicationServiceName, RegenerateKeyParameters parameters, Context context) Regenerate Key Regenerate CommunicationService access key.
abstract CommunicationServiceResourceInner	update(String resourceGroupName, String communicationServiceName, CommunicationServiceResourceUpdate parameters) Update Operation to update an existing CommunicationService.
abstract Response<CommunicationServiceResourceInner>	updateWithResponse(String resourceGroupName, String communicationServiceName, CommunicationServiceResourceUpdate parameters, Context context) Update Operation to update an existing CommunicationService.

Method Details

beginCreateOrUpdate

public abstract SyncPoller<PollResult<CommunicationServiceResourceInner>,CommunicationServiceResourceInner> beginCreateOrUpdate(String resourceGroupName, String communicationServiceName, CommunicationServiceResourceInner parameters)

Create Or Update 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:

the SyncPoller<T,U> for polling of a class representing a CommunicationService resource.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<CommunicationServiceResourceInner>,CommunicationServiceResourceInner> beginCreateOrUpdate(String resourceGroupName, String communicationServiceName, CommunicationServiceResourceInner parameters, Context context)

Create Or Update 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:

the SyncPoller<T,U> for polling of a class representing a CommunicationService resource.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String communicationServiceName)

Delete 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 SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String communicationServiceName, Context context)

Delete 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 SyncPoller<T,U> for polling of long-running operation.

checkNameAvailability

public abstract CheckNameAvailabilityResponseInner checkNameAvailability(NameAvailabilityParameters nameAvailabilityParameters)

Check Name Availability Checks that the CommunicationService name is valid and is not already in use.

Parameters:

nameAvailabilityParameters - Parameters supplied to the operation.

Returns:

the check availability result.

checkNameAvailabilityWithResponse

public abstract Response<CheckNameAvailabilityResponseInner> checkNameAvailabilityWithResponse(NameAvailabilityParameters nameAvailabilityParameters, Context context)

Check Name Availability 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:

the check availability result along with Response<T>.

createOrUpdate

public abstract CommunicationServiceResourceInner createOrUpdate(String resourceGroupName, String communicationServiceName, CommunicationServiceResourceInner parameters)

Create Or Update 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.

createOrUpdate

public abstract CommunicationServiceResourceInner createOrUpdate(String resourceGroupName, String communicationServiceName, CommunicationServiceResourceInner parameters, Context context)

Create Or Update 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.

delete

public abstract void delete(String resourceGroupName, String communicationServiceName)

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

delete

public abstract void delete(String resourceGroupName, String communicationServiceName, Context context)

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

getByResourceGroup

public abstract CommunicationServiceResourceInner getByResourceGroup(String resourceGroupName, String communicationServiceName)

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

getByResourceGroupWithResponse

public abstract Response<CommunicationServiceResourceInner> getByResourceGroupWithResponse(String resourceGroupName, String communicationServiceName, Context context)

Get 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<T>.

linkNotificationHub

public abstract LinkedNotificationHubInner linkNotificationHub(String resourceGroupName, String communicationServiceName)

Link Notification Hub 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.

linkNotificationHubWithResponse

public abstract Response<LinkedNotificationHubInner> linkNotificationHubWithResponse(String resourceGroupName, String communicationServiceName, LinkNotificationHubParameters linkNotificationHubParameters, Context context)

Link Notification Hub 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<T>.

list

public abstract PagedIterable<CommunicationServiceResourceInner> list()

List By Subscription Handles requests to list all resources in a subscription.

Returns:

object that includes an array of CommunicationServices and a possible link for next set as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<CommunicationServiceResourceInner> list(Context context)

List By Subscription 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 as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<CommunicationServiceResourceInner> listByResourceGroup(String resourceGroupName)

List By Resource Group 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 as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<CommunicationServiceResourceInner> listByResourceGroup(String resourceGroupName, Context context)

List By Resource Group 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 as paginated response with PagedIterable<T>.

listKeys

public abstract CommunicationServiceKeysInner listKeys(String resourceGroupName, String communicationServiceName)

List Keys 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.

listKeysWithResponse

public abstract Response<CommunicationServiceKeysInner> listKeysWithResponse(String resourceGroupName, String communicationServiceName, Context context)

List Keys 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<T>.

regenerateKey

public abstract CommunicationServiceKeysInner regenerateKey(String resourceGroupName, String communicationServiceName, RegenerateKeyParameters parameters)

Regenerate Key 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.

regenerateKeyWithResponse

public abstract Response<CommunicationServiceKeysInner> regenerateKeyWithResponse(String resourceGroupName, String communicationServiceName, RegenerateKeyParameters parameters, Context context)

Regenerate Key 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<T>.

update

public abstract CommunicationServiceResourceInner update(String resourceGroupName, String communicationServiceName, CommunicationServiceResourceUpdate parameters)

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

Returns:

a class representing a CommunicationService resource.

updateWithResponse

public abstract Response<CommunicationServiceResourceInner> updateWithResponse(String resourceGroupName, String communicationServiceName, CommunicationServiceResourceUpdate parameters, Context context)

Update 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<T>.