CommunicationServices interface

Package:

@azure/arm-communication

Interface representing a CommunicationServices.

Methods

beginCreateOrUpdate(string, string, CommunicationServiceResource, CommunicationServicesCreateOrUpdateOptionalParams)	Create a new CommunicationService or update an existing CommunicationService.
beginCreateOrUpdateAndWait(string, string, CommunicationServiceResource, CommunicationServicesCreateOrUpdateOptionalParams)	Create a new CommunicationService or update an existing CommunicationService.
beginDelete(string, string, CommunicationServicesDeleteOptionalParams)	Operation to delete a CommunicationService.
beginDeleteAndWait(string, string, CommunicationServicesDeleteOptionalParams)	Operation to delete a CommunicationService.
checkNameAvailability(NameAvailabilityParameters, CommunicationServicesCheckNameAvailabilityOptionalParams)	Checks that the CommunicationService name is valid and is not already in use.
get(string, string, CommunicationServicesGetOptionalParams)	Get the CommunicationService and its properties.
linkNotificationHub(string, string, CommunicationServicesLinkNotificationHubOptionalParams)	Links an Azure Notification Hub to this communication service.
listByResourceGroup(string, CommunicationServicesListByResourceGroupOptionalParams)	Handles requests to list all resources in a resource group.
listBySubscription(CommunicationServicesListBySubscriptionOptionalParams)	Handles requests to list all resources in a subscription.
listKeys(string, string, CommunicationServicesListKeysOptionalParams)	Get the access keys of the CommunicationService resource.
regenerateKey(string, string, RegenerateKeyParameters, CommunicationServicesRegenerateKeyOptionalParams)	Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
update(string, string, CommunicationServiceResourceUpdate, CommunicationServicesUpdateOptionalParams)	Operation to update an existing CommunicationService.

Method Details

beginCreateOrUpdate(string, string, CommunicationServiceResource, CommunicationServicesCreateOrUpdateOptionalParams)

Create a new CommunicationService or update an existing CommunicationService.

function beginCreateOrUpdate(resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResource, options?: CommunicationServicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<CommunicationServiceResource>, CommunicationServiceResource>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

communicationServiceName

string

The name of the CommunicationService resource.

parameters

CommunicationServiceResource

Parameters for the create or update operation

options

CommunicationServicesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<CommunicationServiceResource>, CommunicationServiceResource>>

beginCreateOrUpdateAndWait(string, string, CommunicationServiceResource, CommunicationServicesCreateOrUpdateOptionalParams)

Create a new CommunicationService or update an existing CommunicationService.

function beginCreateOrUpdateAndWait(resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResource, options?: CommunicationServicesCreateOrUpdateOptionalParams): Promise<CommunicationServiceResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

communicationServiceName

string

The name of the CommunicationService resource.

parameters

CommunicationServiceResource

Parameters for the create or update operation

options

CommunicationServicesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<CommunicationServiceResource>

beginDelete(string, string, CommunicationServicesDeleteOptionalParams)

Operation to delete a CommunicationService.

function beginDelete(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

communicationServiceName

string

The name of the CommunicationService resource.

options

CommunicationServicesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, CommunicationServicesDeleteOptionalParams)

Operation to delete a CommunicationService.

function beginDeleteAndWait(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

communicationServiceName

string

The name of the CommunicationService resource.

options

CommunicationServicesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

checkNameAvailability(NameAvailabilityParameters, CommunicationServicesCheckNameAvailabilityOptionalParams)

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

function checkNameAvailability(nameAvailabilityParameters: NameAvailabilityParameters, options?: CommunicationServicesCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResponse>

Parameters

nameAvailabilityParameters

NameAvailabilityParameters

Parameters supplied to the operation.

options

CommunicationServicesCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameAvailabilityResponse>

get(string, string, CommunicationServicesGetOptionalParams)

Get the CommunicationService and its properties.

function get(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesGetOptionalParams): Promise<CommunicationServiceResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

communicationServiceName

string

The name of the CommunicationService resource.

options

CommunicationServicesGetOptionalParams

The options parameters.

Returns

Promise<CommunicationServiceResource>

linkNotificationHub(string, string, CommunicationServicesLinkNotificationHubOptionalParams)

Links an Azure Notification Hub to this communication service.

function linkNotificationHub(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesLinkNotificationHubOptionalParams): Promise<LinkedNotificationHub>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

communicationServiceName

string

The name of the CommunicationService resource.

options

CommunicationServicesLinkNotificationHubOptionalParams

The options parameters.

Returns

Promise<LinkedNotificationHub>

listByResourceGroup(string, CommunicationServicesListByResourceGroupOptionalParams)

Handles requests to list all resources in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: CommunicationServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<CommunicationServiceResource, CommunicationServiceResource[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

CommunicationServicesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CommunicationServiceResource, CommunicationServiceResource[], PageSettings>

listBySubscription(CommunicationServicesListBySubscriptionOptionalParams)

Handles requests to list all resources in a subscription.

function listBySubscription(options?: CommunicationServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<CommunicationServiceResource, CommunicationServiceResource[], PageSettings>

Parameters

options

CommunicationServicesListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<CommunicationServiceResource, CommunicationServiceResource[], PageSettings>

listKeys(string, string, CommunicationServicesListKeysOptionalParams)

Get the access keys of the CommunicationService resource.

function listKeys(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesListKeysOptionalParams): Promise<CommunicationServiceKeys>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

communicationServiceName

string

The name of the CommunicationService resource.

options

CommunicationServicesListKeysOptionalParams

The options parameters.

Returns

Promise<CommunicationServiceKeys>

regenerateKey(string, string, RegenerateKeyParameters, CommunicationServicesRegenerateKeyOptionalParams)

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

function regenerateKey(resourceGroupName: string, communicationServiceName: string, parameters: RegenerateKeyParameters, options?: CommunicationServicesRegenerateKeyOptionalParams): Promise<CommunicationServiceKeys>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

communicationServiceName

string

The name of the CommunicationService resource.

parameters

RegenerateKeyParameters

Parameter that describes the Regenerate Key Operation.

options

CommunicationServicesRegenerateKeyOptionalParams

The options parameters.

Returns

Promise<CommunicationServiceKeys>

update(string, string, CommunicationServiceResourceUpdate, CommunicationServicesUpdateOptionalParams)

Operation to update an existing CommunicationService.

function update(resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResourceUpdate, options?: CommunicationServicesUpdateOptionalParams): Promise<CommunicationServiceResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

communicationServiceName

string

The name of the CommunicationService resource.

parameters

CommunicationServiceResourceUpdate

Parameters for the update operation

options

CommunicationServicesUpdateOptionalParams

The options parameters.

Returns

Promise<CommunicationServiceResource>