CommunicationServicesOperations interface
Interface representing a CommunicationServices operations.
Properties
| begin |
|
| begin |
|
| begin |
|
| begin |
|
| check |
Checks that the CommunicationService name is valid and is not already in use. |
| create |
Create a new CommunicationService or update an existing CommunicationService. |
| delete | |
| get | Get the CommunicationService and its properties. |
| link |
Links an Azure Notification Hub to this communication service. |
| list |
Handles requests to list all resources in a resource group. |
| list |
Handles requests to list all resources in a subscription. |
| list |
Get the access keys of the CommunicationService resource. |
| regenerate |
Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time. |
| update | Operation to update an existing CommunicationService. |
Property Details
beginCreateOrUpdate
Warning
This API is now deprecated.
use createOrUpdate instead
beginCreateOrUpdate: (resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResource, options?: CommunicationServicesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<CommunicationServiceResource>, CommunicationServiceResource>>Property Value
(resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResource, options?: CommunicationServicesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<CommunicationServiceResource>, CommunicationServiceResource>>
beginCreateOrUpdateAndWait
Warning
This API is now deprecated.
use createOrUpdate instead
beginCreateOrUpdateAndWait: (resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResource, options?: CommunicationServicesCreateOrUpdateOptionalParams) => Promise<CommunicationServiceResource>Property Value
(resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResource, options?: CommunicationServicesCreateOrUpdateOptionalParams) => Promise<CommunicationServiceResource>
beginDelete
Warning
This API is now deprecated.
use delete instead
beginDelete: (resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>Property Value
(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait
Warning
This API is now deprecated.
use delete instead
beginDeleteAndWait: (resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesDeleteOptionalParams) => Promise<void>Property Value
(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesDeleteOptionalParams) => Promise<void>
checkNameAvailability
Checks that the CommunicationService name is valid and is not already in use.
checkNameAvailability: (nameAvailabilityParameters: NameAvailabilityParameters, options?: CommunicationServicesCheckNameAvailabilityOptionalParams) => Promise<CheckNameAvailabilityResponse>Property Value
(nameAvailabilityParameters: NameAvailabilityParameters, options?: CommunicationServicesCheckNameAvailabilityOptionalParams) => Promise<CheckNameAvailabilityResponse>
createOrUpdate
Create a new CommunicationService or update an existing CommunicationService.
createOrUpdate: (resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResource, options?: CommunicationServicesCreateOrUpdateOptionalParams) => PollerLike<OperationState<CommunicationServiceResource>, CommunicationServiceResource>Property Value
(resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResource, options?: CommunicationServicesCreateOrUpdateOptionalParams) => PollerLike<OperationState<CommunicationServiceResource>, CommunicationServiceResource>
delete
delete: (resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesDeleteOptionalParams) => PollerLike<OperationState<void>, void>Property Value
(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesDeleteOptionalParams) => PollerLike<OperationState<void>, void>
get
Get the CommunicationService and its properties.
get: (resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesGetOptionalParams) => Promise<CommunicationServiceResource>Property Value
(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesGetOptionalParams) => Promise<CommunicationServiceResource>
linkNotificationHub
Links an Azure Notification Hub to this communication service.
linkNotificationHub: (resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesLinkNotificationHubOptionalParams) => Promise<LinkedNotificationHub>Property Value
(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesLinkNotificationHubOptionalParams) => Promise<LinkedNotificationHub>
listByResourceGroup
Handles requests to list all resources in a resource group.
listByResourceGroup: (resourceGroupName: string, options?: CommunicationServicesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<CommunicationServiceResource, CommunicationServiceResource[], PageSettings>Property Value
(resourceGroupName: string, options?: CommunicationServicesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<CommunicationServiceResource, CommunicationServiceResource[], PageSettings>
listBySubscription
Handles requests to list all resources in a subscription.
listBySubscription: (options?: CommunicationServicesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<CommunicationServiceResource, CommunicationServiceResource[], PageSettings>Property Value
(options?: CommunicationServicesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<CommunicationServiceResource, CommunicationServiceResource[], PageSettings>
listKeys
Get the access keys of the CommunicationService resource.
listKeys: (resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesListKeysOptionalParams) => Promise<CommunicationServiceKeys>Property Value
(resourceGroupName: string, communicationServiceName: string, options?: CommunicationServicesListKeysOptionalParams) => Promise<CommunicationServiceKeys>
regenerateKey
Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
regenerateKey: (resourceGroupName: string, communicationServiceName: string, parameters: RegenerateKeyParameters, options?: CommunicationServicesRegenerateKeyOptionalParams) => Promise<CommunicationServiceKeys>Property Value
(resourceGroupName: string, communicationServiceName: string, parameters: RegenerateKeyParameters, options?: CommunicationServicesRegenerateKeyOptionalParams) => Promise<CommunicationServiceKeys>
update
Operation to update an existing CommunicationService.
update: (resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResourceUpdate, options?: CommunicationServicesUpdateOptionalParams) => Promise<CommunicationServiceResource>Property Value
(resourceGroupName: string, communicationServiceName: string, parameters: CommunicationServiceResourceUpdate, options?: CommunicationServicesUpdateOptionalParams) => Promise<CommunicationServiceResource>