NotificationHubs interface

Pacote:

@azure/arm-notificationhubs

Interface que representa um NotificationHubs.

Métodos

checkNotificationHubAvailability(string, string, CheckAvailabilityParameters, NotificationHubsCheckNotificationHubAvailabilityOptionalParams)	Verifica a disponibilidade do notificationHub fornecido em um namespace.
createOrUpdate(string, string, string, NotificationHubCreateOrUpdateParameters, NotificationHubsCreateOrUpdateOptionalParams)	Cria/atualiza um NotificationHub em um namespace.
createOrUpdateAuthorizationRule(string, string, string, string, SharedAccessAuthorizationRuleCreateOrUpdateParameters, NotificationHubsCreateOrUpdateAuthorizationRuleOptionalParams)	Cria/Atualizações uma regra de autorização para um NotificationHub
debugSend(string, string, string, NotificationHubsDebugSendOptionalParams)	testar enviar uma notificação por push
delete(string, string, string, NotificationHubsDeleteOptionalParams)	Exclui um hub de notificação associado a um namespace.
deleteAuthorizationRule(string, string, string, string, NotificationHubsDeleteAuthorizationRuleOptionalParams)	Exclui uma regra de autorização notificationHub
get(string, string, string, NotificationHubsGetOptionalParams)	Lista os hubs de notificação associados a um namespace.
getAuthorizationRule(string, string, string, string, NotificationHubsGetAuthorizationRuleOptionalParams)	Obtém uma regra de autorização para um NotificationHub por nome.
getPnsCredentials(string, string, string, NotificationHubsGetPnsCredentialsOptionalParams)	Lista as credenciais PNS associadas a um hub de notificação.
list(string, string, NotificationHubsListOptionalParams)	Lista os hubs de notificação associados a um namespace.
listAuthorizationRules(string, string, string, NotificationHubsListAuthorizationRulesOptionalParams)	Obtém as regras de autorização para um NotificationHub.
listKeys(string, string, string, string, NotificationHubsListKeysOptionalParams)	Obtém o ConnectionStrings primário e secundário para o NotificationHub
patch(string, string, string, NotificationHubsPatchOptionalParams)	Aplicar patch a um NotificationHub em um namespace.
regenerateKeys(string, string, string, string, PolicykeyResource, NotificationHubsRegenerateKeysOptionalParams)	Regenera as chaves primárias/secundárias para a regra de autorização do NotificationHub

Detalhes do método

checkNotificationHubAvailability(string, string, CheckAvailabilityParameters, NotificationHubsCheckNotificationHubAvailabilityOptionalParams)

Verifica a disponibilidade do notificationHub fornecido em um namespace.

function checkNotificationHubAvailability(resourceGroupName: string, namespaceName: string, parameters: CheckAvailabilityParameters, options?: NotificationHubsCheckNotificationHubAvailabilityOptionalParams): Promise<CheckAvailabilityResult>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

parameters

CheckAvailabilityParameters

O nome do notificationHub.

options

NotificationHubsCheckNotificationHubAvailabilityOptionalParams

Os parâmetros de opções.

Retornos

Promise<CheckAvailabilityResult>

createOrUpdate(string, string, string, NotificationHubCreateOrUpdateParameters, NotificationHubsCreateOrUpdateOptionalParams)

Cria/atualiza um NotificationHub em um namespace.

function createOrUpdate(resourceGroupName: string, namespaceName: string, notificationHubName: string, parameters: NotificationHubCreateOrUpdateParameters, options?: NotificationHubsCreateOrUpdateOptionalParams): Promise<NotificationHubResource>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

notificationHubName

string

O nome do hub de notificação.

parameters

NotificationHubCreateOrUpdateParameters

Parâmetros fornecidos para criar/atualizar um Recurso notificationHub.

options

NotificationHubsCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<NotificationHubResource>

createOrUpdateAuthorizationRule(string, string, string, string, SharedAccessAuthorizationRuleCreateOrUpdateParameters, NotificationHubsCreateOrUpdateAuthorizationRuleOptionalParams)

Cria/Atualizações uma regra de autorização para um NotificationHub

function createOrUpdateAuthorizationRule(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, parameters: SharedAccessAuthorizationRuleCreateOrUpdateParameters, options?: NotificationHubsCreateOrUpdateAuthorizationRuleOptionalParams): Promise<SharedAccessAuthorizationRuleResource>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

notificationHubName

string

O nome do hub de notificação.

authorizationRuleName

string

Nome da regra de autorização.

parameters

SharedAccessAuthorizationRuleCreateOrUpdateParameters

A regra de autorização de acesso compartilhado.

options

NotificationHubsCreateOrUpdateAuthorizationRuleOptionalParams

Os parâmetros de opções.

Retornos

Promise<SharedAccessAuthorizationRuleResource>

debugSend(string, string, string, NotificationHubsDebugSendOptionalParams)

testar enviar uma notificação por push

function debugSend(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: NotificationHubsDebugSendOptionalParams): Promise<DebugSendResponse>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

notificationHubName

string

O nome do hub de notificação.

options

NotificationHubsDebugSendOptionalParams

Os parâmetros de opções.

Retornos

Promise<DebugSendResponse>

delete(string, string, string, NotificationHubsDeleteOptionalParams)

Exclui um hub de notificação associado a um namespace.

function delete(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: NotificationHubsDeleteOptionalParams): Promise<void>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

notificationHubName

string

O nome do hub de notificação.

options

NotificationHubsDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

deleteAuthorizationRule(string, string, string, string, NotificationHubsDeleteAuthorizationRuleOptionalParams)

Exclui uma regra de autorização notificationHub

function deleteAuthorizationRule(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, options?: NotificationHubsDeleteAuthorizationRuleOptionalParams): Promise<void>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

notificationHubName

string

O nome do hub de notificação.

authorizationRuleName

string

Nome da regra de autorização.

options

NotificationHubsDeleteAuthorizationRuleOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

get(string, string, string, NotificationHubsGetOptionalParams)

Lista os hubs de notificação associados a um namespace.

function get(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: NotificationHubsGetOptionalParams): Promise<NotificationHubResource>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

notificationHubName

string

O nome do hub de notificação.

options

NotificationHubsGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<NotificationHubResource>

getAuthorizationRule(string, string, string, string, NotificationHubsGetAuthorizationRuleOptionalParams)

Obtém uma regra de autorização para um NotificationHub por nome.

function getAuthorizationRule(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, options?: NotificationHubsGetAuthorizationRuleOptionalParams): Promise<SharedAccessAuthorizationRuleResource>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace

notificationHubName

string

O nome do hub de notificação.

authorizationRuleName

string

nome da regra de autorização.

options

NotificationHubsGetAuthorizationRuleOptionalParams

Os parâmetros de opções.

Retornos

Promise<SharedAccessAuthorizationRuleResource>

getPnsCredentials(string, string, string, NotificationHubsGetPnsCredentialsOptionalParams)

Lista as credenciais PNS associadas a um hub de notificação.

function getPnsCredentials(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: NotificationHubsGetPnsCredentialsOptionalParams): Promise<PnsCredentialsResource>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

notificationHubName

string

O nome do hub de notificação.

options

NotificationHubsGetPnsCredentialsOptionalParams

Os parâmetros de opções.

Retornos

Promise<PnsCredentialsResource>

list(string, string, NotificationHubsListOptionalParams)

Lista os hubs de notificação associados a um namespace.

function list(resourceGroupName: string, namespaceName: string, options?: NotificationHubsListOptionalParams): PagedAsyncIterableIterator<NotificationHubResource, NotificationHubResource[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

options

NotificationHubsListOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<NotificationHubResource, NotificationHubResource[], PageSettings>

listAuthorizationRules(string, string, string, NotificationHubsListAuthorizationRulesOptionalParams)

Obtém as regras de autorização para um NotificationHub.

function listAuthorizationRules(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: NotificationHubsListAuthorizationRulesOptionalParams): PagedAsyncIterableIterator<SharedAccessAuthorizationRuleResource, SharedAccessAuthorizationRuleResource[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace

notificationHubName

string

O nome do hub de notificação.

options

NotificationHubsListAuthorizationRulesOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<SharedAccessAuthorizationRuleResource, SharedAccessAuthorizationRuleResource[], PageSettings>

listKeys(string, string, string, string, NotificationHubsListKeysOptionalParams)

Obtém o ConnectionStrings primário e secundário para o NotificationHub

function listKeys(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, options?: NotificationHubsListKeysOptionalParams): Promise<ResourceListKeys>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

notificationHubName

string

O nome do hub de notificação.

authorizationRuleName

string

A cadeia de conexão do NotificationHub para o authorizationRule especificado.

options

NotificationHubsListKeysOptionalParams

Os parâmetros de opções.

Retornos

Promise<ResourceListKeys>

patch(string, string, string, NotificationHubsPatchOptionalParams)

Aplicar patch a um NotificationHub em um namespace.

function patch(resourceGroupName: string, namespaceName: string, notificationHubName: string, options?: NotificationHubsPatchOptionalParams): Promise<NotificationHubResource>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

notificationHubName

string

O nome do hub de notificação.

options

NotificationHubsPatchOptionalParams

Os parâmetros de opções.

Retornos

Promise<NotificationHubResource>

regenerateKeys(string, string, string, string, PolicykeyResource, NotificationHubsRegenerateKeysOptionalParams)

Regenera as chaves primárias/secundárias para a regra de autorização do NotificationHub

function regenerateKeys(resourceGroupName: string, namespaceName: string, notificationHubName: string, authorizationRuleName: string, parameters: PolicykeyResource, options?: NotificationHubsRegenerateKeysOptionalParams): Promise<ResourceListKeys>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos.

namespaceName

string

O nome do namespace.

notificationHubName

string

O nome do hub de notificação.

authorizationRuleName

string

A cadeia de conexão do NotificationHub para o authorizationRule especificado.

parameters

PolicykeyResource

Parâmetros fornecidos para regenerar a chave de regra de autorização do NotificationHub.

options

NotificationHubsRegenerateKeysOptionalParams

Os parâmetros de opções.

Retornos

Promise<ResourceListKeys>