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 eliminar um CommunicationService.
beginDeleteAndWait(string, string, CommunicationServicesDeleteOptionalParams)	Operação para eliminar um CommunicationService.
checkNameAvailability(NameAvailabilityParameters, CommunicationServicesCheckNameAvailabilityOptionalParams)	Verifica se o nome CommunicationService é válido e ainda não está a ser utilizado.
get(string, string, CommunicationServicesGetOptionalParams)	Obtenha o CommunicationService e as respetivas propriedades.
linkNotificationHub(string, string, CommunicationServicesLinkNotificationHubOptionalParams)	Liga um Hub de Notificação do Azure a este serviço de comunicação.
listByResourceGroup(string, CommunicationServicesListByResourceGroupOptionalParams)	Processa pedidos para listar todos os recursos num grupo de recursos.
listBySubscription(CommunicationServicesListBySubscriptionOptionalParams)	Processa pedidos para listar todos os recursos numa subscrição.
listKeys(string, string, CommunicationServicesListKeysOptionalParams)	Obtenha as chaves de acesso do recurso CommunicationService.
regenerateKey(string, string, RegenerateKeyParameters, CommunicationServicesRegenerateKeyOptionalParams)	Regenerar a chave de acesso CommunicationService. Não é possível regenerar PrimaryKey e SecondaryKey ao mesmo tempo.
update(string, string, CommunicationServiceResourceUpdate, CommunicationServicesUpdateOptionalParams)	Operação para atualizar um CommunicationService existente.

Detalhes de 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 não é sensível a maiúsculas e 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.

Devoluções

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 não é sensível a maiúsculas e 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.

Devoluções

Promise<CommunicationServiceResource>

beginDelete(string, string, CommunicationServicesDeleteOptionalParams)

Operação para eliminar 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 não é sensível a maiúsculas e minúsculas.

communicationServiceName

string

O nome do recurso CommunicationService.

options

CommunicationServicesDeleteOptionalParams

Os parâmetros de opções.

Devoluções

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

beginDeleteAndWait(string, string, CommunicationServicesDeleteOptionalParams)

Operação para eliminar um CommunicationService.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

communicationServiceName

string

O nome do recurso CommunicationService.

options

CommunicationServicesDeleteOptionalParams

Os parâmetros de opções.

Devoluções

Promise<void>

checkNameAvailability(NameAvailabilityParameters, CommunicationServicesCheckNameAvailabilityOptionalParams)

Verifica se o nome CommunicationService é válido e ainda não está a ser utilizado.

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

Parâmetros

nameAvailabilityParameters

NameAvailabilityParameters

Parâmetros fornecidos à operação.

options

CommunicationServicesCheckNameAvailabilityOptionalParams

Os parâmetros de opções.

Devoluções

Promise<CheckNameAvailabilityResponse>

get(string, string, CommunicationServicesGetOptionalParams)

Obtenha o CommunicationService e as respetivas propriedades.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

communicationServiceName

string

O nome do recurso CommunicationService.

options

CommunicationServicesGetOptionalParams

Os parâmetros de opções.

Devoluções

Promise<CommunicationServiceResource>

linkNotificationHub(string, string, CommunicationServicesLinkNotificationHubOptionalParams)

Liga um Hub de Notificação do Azure a este 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 não é sensível a maiúsculas e minúsculas.

communicationServiceName

string

O nome do recurso CommunicationService.

options

CommunicationServicesLinkNotificationHubOptionalParams

Os parâmetros de opções.

Devoluções

Promise<LinkedNotificationHub>

listByResourceGroup(string, CommunicationServicesListByResourceGroupOptionalParams)

Processa pedidos para listar todos os recursos num 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 não é sensível a maiúsculas e minúsculas.

options

CommunicationServicesListByResourceGroupOptionalParams

Os parâmetros de opções.

Devoluções

PagedAsyncIterableIterator<CommunicationServiceResource, CommunicationServiceResource[], PageSettings>

listBySubscription(CommunicationServicesListBySubscriptionOptionalParams)

Processa pedidos para listar todos os recursos numa subscrição.

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

Parâmetros

options

CommunicationServicesListBySubscriptionOptionalParams

Os parâmetros de opções.

Devoluções

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 não é sensível a maiúsculas e minúsculas.

communicationServiceName

string

O nome do recurso CommunicationService.

options

CommunicationServicesListKeysOptionalParams

Os parâmetros de opções.

Devoluções

Promise<CommunicationServiceKeys>

regenerateKey(string, string, RegenerateKeyParameters, CommunicationServicesRegenerateKeyOptionalParams)

Regenerar a chave de acesso CommunicationService. Não é possível regenerar PrimaryKey e SecondaryKey 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 não é sensível a maiúsculas e 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.

Devoluções

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 não é sensível a maiúsculas e 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.

Devoluções

Promise<CommunicationServiceResource>