CommunicationServices Interface

Package:

com.azure.resourcemanager.communication.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-communication:2.1.0

public interface CommunicationServices

Resource collection API of CommunicationServices.

Method Summary

Modifier and Type	Method and Description
abstract CheckNameAvailabilityResponse	checkNameAvailability(NameAvailabilityParameters nameAvailabilityParameters) Check Name Availability Checks that the CommunicationService name is valid and is not already in use.
abstract Response<CheckNameAvailabilityResponse>	checkNameAvailabilityWithResponse(NameAvailabilityParameters nameAvailabilityParameters, Context context) Check Name Availability Checks that the CommunicationService name is valid and is not already in use.
abstract Blank	define(String name) Begins definition for a new CommunicationServiceResource resource.
abstract void	delete(String resourceGroupName, String communicationServiceName, Context context) Delete Operation to delete a CommunicationService.
abstract void	deleteById(String id) Delete Operation to delete a CommunicationService.
abstract void	deleteByIdWithResponse(String id, Context context) Delete Operation to delete a CommunicationService.
abstract void	deleteByResourceGroup(String resourceGroupName, String communicationServiceName) Delete Operation to delete a CommunicationService.
abstract CommunicationServiceResource	getById(String id) Get Get the CommunicationService and its properties.
abstract Response<CommunicationServiceResource>	getByIdWithResponse(String id, Context context) Get Get the CommunicationService and its properties.
abstract CommunicationServiceResource	getByResourceGroup(String resourceGroupName, String communicationServiceName) Get Get the CommunicationService and its properties.
abstract Response<CommunicationServiceResource>	getByResourceGroupWithResponse(String resourceGroupName, String communicationServiceName, Context context) Get Get the CommunicationService and its properties.
abstract LinkedNotificationHub	linkNotificationHub(String resourceGroupName, String communicationServiceName) Link Notification Hub Links an Azure Notification Hub to this communication service.
abstract Response<LinkedNotificationHub>	linkNotificationHubWithResponse(String resourceGroupName, String communicationServiceName, LinkNotificationHubParameters linkNotificationHubParameters, Context context) Link Notification Hub Links an Azure Notification Hub to this communication service.
abstract PagedIterable<CommunicationServiceResource>	list() List By Subscription Handles requests to list all resources in a subscription.
abstract PagedIterable<CommunicationServiceResource>	list(Context context) List By Subscription Handles requests to list all resources in a subscription.
abstract PagedIterable<CommunicationServiceResource>	listByResourceGroup(String resourceGroupName) List By Resource Group Handles requests to list all resources in a resource group.
abstract PagedIterable<CommunicationServiceResource>	listByResourceGroup(String resourceGroupName, Context context) List By Resource Group Handles requests to list all resources in a resource group.
abstract CommunicationServiceKeys	listKeys(String resourceGroupName, String communicationServiceName) List Keys Get the access keys of the CommunicationService resource.
abstract Response<CommunicationServiceKeys>	listKeysWithResponse(String resourceGroupName, String communicationServiceName, Context context) List Keys Get the access keys of the CommunicationService resource.
abstract CommunicationServiceKeys	regenerateKey(String resourceGroupName, String communicationServiceName, RegenerateKeyParameters parameters) Regenerate Key Regenerate CommunicationService access key.
abstract Response<CommunicationServiceKeys>	regenerateKeyWithResponse(String resourceGroupName, String communicationServiceName, RegenerateKeyParameters parameters, Context context) Regenerate Key Regenerate CommunicationService access key.

Method Details

checkNameAvailability

public abstract CheckNameAvailabilityResponse 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 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>.

define

public abstract CommunicationServiceResource.DefinitionStages.Blank define(String name)

Begins definition for a new CommunicationServiceResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new CommunicationServiceResource definition.

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.

deleteById

public abstract void deleteById(String id)

Delete Operation to delete a CommunicationService.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Delete Operation to delete a CommunicationService.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(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.

getById

public abstract CommunicationServiceResource getById(String id)

Get Get the CommunicationService and its properties.

Parameters:

id - the resource ID.

Returns:

the CommunicationService and its properties along with Response<T>.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Get Get the CommunicationService and its properties.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the CommunicationService and its properties along with Response<T>.

getByResourceGroup

public abstract CommunicationServiceResource 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 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 LinkedNotificationHub 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 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 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 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 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 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 CommunicationServiceKeys 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 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 CommunicationServiceKeys 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 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>.