CommunicationServices interface

Pacote:

@azure/arm-communication

Interface que representa um CommunicationServices.

Métodos

beginCreateOrUpdate(string, string, CommunicationServiceResource, CommunicationServicesCreateOrUpdateOptionalParams)	Crie um novo CommunicationService ou atualize um CommunicationService existente.
beginCreateOrUpdateAndWait(string, string, CommunicationServiceResource, CommunicationServicesCreateOrUpdateOptionalParams)	Crie um novo CommunicationService ou atualize um CommunicationService existente.
beginDelete(string, string, CommunicationServicesDeleteOptionalParams)	Operação para excluir um CommunicationService.
beginDeleteAndWait(string, string, CommunicationServicesDeleteOptionalParams)	Operação para excluir um CommunicationService.
checkNameAvailability(NameAvailabilityParameters, CommunicationServicesCheckNameAvailabilityOptionalParams)	Verifica se o nome communicationService é válido e ainda não está em uso.
get(string, string, CommunicationServicesGetOptionalParams)	Obtenha o CommunicationService e suas propriedades.
linkNotificationHub(string, string, CommunicationServicesLinkNotificationHubOptionalParams)	Vincula um Hub de Notificação do Azure a esse serviço de comunicação.
listByResourceGroup(string, CommunicationServicesListByResourceGroupOptionalParams)	Manipula solicitações para listar todos os recursos em um grupo de recursos.
listBySubscription(CommunicationServicesListBySubscriptionOptionalParams)	Manipula solicitações para listar todos os recursos em uma assinatura.
listKeys(string, string, CommunicationServicesListKeysOptionalParams)	Obtenha as chaves de acesso do recurso CommunicationService.
regenerateKey(string, string, RegenerateKeyParameters, CommunicationServicesRegenerateKeyOptionalParams)	Regenerar a chave de acesso CommunicationService. PrimaryKey e SecondaryKey não podem ser regenerados ao mesmo tempo.
update(string, string, CommunicationServiceResourceUpdate, CommunicationServicesUpdateOptionalParams)	Operação para atualizar um CommunicationService existente.

Detalhes do método

beginCreateOrUpdate(string, string, CommunicationServiceResource, CommunicationServicesCreateOrUpdateOptionalParams)

Crie um novo CommunicationService ou atualize um CommunicationService existente.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

communicationServiceName

string

O nome do recurso CommunicationService.

parameters

CommunicationServiceResource

Parâmetros para a operação de criação ou atualização

options

CommunicationServicesCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

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

beginCreateOrUpdateAndWait(string, string, CommunicationServiceResource, CommunicationServicesCreateOrUpdateOptionalParams)

Crie um novo CommunicationService ou atualize um CommunicationService existente.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

communicationServiceName

string

O nome do recurso CommunicationService.

parameters

CommunicationServiceResource

Parâmetros para a operação de criação ou atualização

options

CommunicationServicesCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<CommunicationServiceResource>

beginDelete(string, string, CommunicationServicesDeleteOptionalParams)

Operação para excluir um CommunicationService.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

communicationServiceName

string

O nome do recurso CommunicationService.

options

CommunicationServicesDeleteOptionalParams

Os parâmetros de opções.

Retornos

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

beginDeleteAndWait(string, string, CommunicationServicesDeleteOptionalParams)

Operação para excluir um CommunicationService.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

communicationServiceName

string

O nome do recurso CommunicationService.

options

CommunicationServicesDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

checkNameAvailability(NameAvailabilityParameters, CommunicationServicesCheckNameAvailabilityOptionalParams)

Verifica se o nome communicationService é válido e ainda não está em uso.

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

Parâmetros

nameAvailabilityParameters

NameAvailabilityParameters

Parâmetros fornecidos para a operação.

options

CommunicationServicesCheckNameAvailabilityOptionalParams

Os parâmetros de opções.

Retornos

Promise<CheckNameAvailabilityResponse>

get(string, string, CommunicationServicesGetOptionalParams)

Obtenha o CommunicationService e suas propriedades.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

communicationServiceName

string

O nome do recurso CommunicationService.

options

CommunicationServicesGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<CommunicationServiceResource>

linkNotificationHub(string, string, CommunicationServicesLinkNotificationHubOptionalParams)

Vincula um Hub de Notificação do Azure a esse serviço de comunicação.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

communicationServiceName

string

O nome do recurso CommunicationService.

options

CommunicationServicesLinkNotificationHubOptionalParams

Os parâmetros de opções.

Retornos

Promise<LinkedNotificationHub>

listByResourceGroup(string, CommunicationServicesListByResourceGroupOptionalParams)

Manipula solicitações para listar todos os recursos em um grupo de recursos.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

options

CommunicationServicesListByResourceGroupOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<CommunicationServiceResource, CommunicationServiceResource[], PageSettings>

listBySubscription(CommunicationServicesListBySubscriptionOptionalParams)

Manipula solicitações para listar todos os recursos em uma assinatura.

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

Parâmetros

options

CommunicationServicesListBySubscriptionOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<CommunicationServiceResource, CommunicationServiceResource[], PageSettings>

listKeys(string, string, CommunicationServicesListKeysOptionalParams)

Obtenha as chaves de acesso do recurso CommunicationService.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

communicationServiceName

string

O nome do recurso CommunicationService.

options

CommunicationServicesListKeysOptionalParams

Os parâmetros de opções.

Retornos

Promise<CommunicationServiceKeys>

regenerateKey(string, string, RegenerateKeyParameters, CommunicationServicesRegenerateKeyOptionalParams)

Regenerar a chave de acesso CommunicationService. PrimaryKey e SecondaryKey não podem ser regenerados ao mesmo tempo.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

communicationServiceName

string

O nome do recurso CommunicationService.

parameters

RegenerateKeyParameters

Parâmetro que descreve a operação Regenerar Chave.

options

CommunicationServicesRegenerateKeyOptionalParams

Os parâmetros de opções.

Retornos

Promise<CommunicationServiceKeys>

update(string, string, CommunicationServiceResourceUpdate, CommunicationServicesUpdateOptionalParams)

Operação para atualizar um CommunicationService existente.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

communicationServiceName

string

O nome do recurso CommunicationService.

parameters

CommunicationServiceResourceUpdate

Parâmetros para a operação de atualização

options

CommunicationServicesUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<CommunicationServiceResource>