CommunicationServices | @azure/arm-communication

Interface representing a CommunicationServices.

Hierarchy

CommunicationServices

Implemented by

CommunicationServicesImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResource, options?: CommunicationServicesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<CommunicationServicesCreateOrUpdateResponse>, CommunicationServicesCreateOrUpdateResponse>>

- Defined in operationsInterfaces/communicationServices.ts:123
Create a new CommunicationService or update an existing CommunicationService.

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
- Optional options: CommunicationServicesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CommunicationServicesCreateOrUpdateResponse>, CommunicationServicesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/communicationServices.ts:141
Create a new CommunicationService or update an existing CommunicationService.

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
- Optional options: CommunicationServicesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<CommunicationServicesCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/communicationServices.ts:153
Operation to delete a CommunicationService.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- communicationServiceName: string
  
  The name of the CommunicationService resource.
- Optional options: CommunicationServicesDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/communicationServices.ts:164
Operation to delete a CommunicationService.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- communicationServiceName: string
  
  The name of the CommunicationService resource.
- Optional options: CommunicationServicesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginRegenerateKey

beginRegenerateKey(resourceGroupName: string, communicationServiceName: string, parameters: RegenerateKeyParameters, options?: CommunicationServicesRegenerateKeyOptionalParams): Promise<PollerLike<PollOperationState<CommunicationServicesRegenerateKeyResponse>, CommunicationServicesRegenerateKeyResponse>>

- Defined in operationsInterfaces/communicationServices.ts:188
Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.

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.
- Optional options: CommunicationServicesRegenerateKeyOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CommunicationServicesRegenerateKeyResponse>, CommunicationServicesRegenerateKeyResponse>>

beginRegenerateKeyAndWait

beginRegenerateKeyAndWait(resourceGroupName: string, communicationServiceName: string, parameters: RegenerateKeyParameters, options?: CommunicationServicesRegenerateKeyOptionalParams): Promise<CommunicationServicesRegenerateKeyResponse>

- Defined in operationsInterfaces/communicationServices.ts:207
Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.

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.
- Optional options: CommunicationServicesRegenerateKeyOptionalParams
  
  The options parameters.
Returns Promise<CommunicationServicesRegenerateKeyResponse>

beginUpdate

beginUpdate(resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResourceUpdate, options?: CommunicationServicesUpdateOptionalParams): Promise<PollerLike<PollOperationState<CommunicationServicesUpdateResponse>, CommunicationServicesUpdateResponse>>

- Defined in operationsInterfaces/communicationServices.ts:81
Operation to update an existing CommunicationService.

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
- Optional options: CommunicationServicesUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<CommunicationServicesUpdateResponse>, CommunicationServicesUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResourceUpdate, options?: CommunicationServicesUpdateOptionalParams): Promise<CommunicationServicesUpdateResponse>

- Defined in operationsInterfaces/communicationServices.ts:99
Operation to update an existing CommunicationService.

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
- Optional options: CommunicationServicesUpdateOptionalParams
  
  The options parameters.
Returns Promise<CommunicationServicesUpdateResponse>

checkNameAvailability

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

- Defined in operationsInterfaces/communicationServices.ts:59
Checks that the CommunicationService name is valid and is not already in use.

Parameters
- nameAvailabilityParameters: NameAvailabilityParameters
  
  Parameters supplied to the operation.
- Optional options: CommunicationServicesCheckNameAvailabilityOptionalParams
  
  The options parameters.
Returns Promise<CommunicationServicesCheckNameAvailabilityResponse>

get

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

- Defined in operationsInterfaces/communicationServices.ts:111
Get the CommunicationService and its properties.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- communicationServiceName: string
  
  The name of the CommunicationService resource.
- Optional options: CommunicationServicesGetOptionalParams
  
  The options parameters.
Returns Promise<CommunicationServicesGetResponse>

linkNotificationHub

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

- Defined in operationsInterfaces/communicationServices.ts:69
Links an Azure Notification Hub to this communication service.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- communicationServiceName: string
  
  The name of the CommunicationService resource.
- Optional options: CommunicationServicesLinkNotificationHubOptionalParams
  
  The options parameters.
Returns Promise<CommunicationServicesLinkNotificationHubResponse>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: CommunicationServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<CommunicationServiceResource>

- Defined in operationsInterfaces/communicationServices.ts:50
Handles requests to list all resources in a resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: CommunicationServicesListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<CommunicationServiceResource>

listBySubscription

listBySubscription(options?: CommunicationServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<CommunicationServiceResource>

- Defined in operationsInterfaces/communicationServices.ts:42
Handles requests to list all resources in a subscription.

Parameters
- Optional options: CommunicationServicesListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<CommunicationServiceResource>

listKeys

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

- Defined in operationsInterfaces/communicationServices.ts:175
Get the access keys of the CommunicationService resource.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- communicationServiceName: string
  
  The name of the CommunicationService resource.
- Optional options: CommunicationServicesListKeysOptionalParams
  
  The options parameters.
Returns Promise<CommunicationServicesListKeysResponse>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

communicationServiceName: string

parameters: CommunicationServiceResource

Optional options: CommunicationServicesCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<CommunicationServicesCreateOrUpdateResponse>, CommunicationServicesCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

communicationServiceName: string

parameters: CommunicationServiceResource

Optional options: CommunicationServicesCreateOrUpdateOptionalParams

Returns Promise<CommunicationServicesCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

communicationServiceName: string

Optional options: CommunicationServicesDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

communicationServiceName: string

Optional options: CommunicationServicesDeleteOptionalParams

Returns Promise<void>

beginRegenerateKey

Parameters

resourceGroupName: string

communicationServiceName: string

parameters: RegenerateKeyParameters

Optional options: CommunicationServicesRegenerateKeyOptionalParams

Returns Promise<PollerLike<PollOperationState<CommunicationServicesRegenerateKeyResponse>, CommunicationServicesRegenerateKeyResponse>>

beginRegenerateKeyAndWait

Parameters

resourceGroupName: string

communicationServiceName: string

parameters: RegenerateKeyParameters

Optional options: CommunicationServicesRegenerateKeyOptionalParams

Returns Promise<CommunicationServicesRegenerateKeyResponse>

beginUpdate

Parameters

resourceGroupName: string

communicationServiceName: string

parameters: CommunicationServiceResourceUpdate

Optional options: CommunicationServicesUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<CommunicationServicesUpdateResponse>, CommunicationServicesUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

communicationServiceName: string

parameters: CommunicationServiceResourceUpdate

Optional options: CommunicationServicesUpdateOptionalParams

Returns Promise<CommunicationServicesUpdateResponse>

checkNameAvailability

Parameters

nameAvailabilityParameters: NameAvailabilityParameters

Optional options: CommunicationServicesCheckNameAvailabilityOptionalParams

Returns Promise<CommunicationServicesCheckNameAvailabilityResponse>

get

Parameters

resourceGroupName: string

communicationServiceName: string

Optional options: CommunicationServicesGetOptionalParams

Returns Promise<CommunicationServicesGetResponse>

linkNotificationHub

Parameters

resourceGroupName: string

communicationServiceName: string

Optional options: CommunicationServicesLinkNotificationHubOptionalParams

Returns Promise<CommunicationServicesLinkNotificationHubResponse>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: CommunicationServicesListByResourceGroupOptionalParams