你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

NotificationHubs interface

表示 NotificationHubs 的接口。

方法

checkNotificationHubAvailability(string, string, CheckAvailabilityParameters, NotificationHubsCheckNotificationHubAvailabilityOptionalParams)

检查命名空间中给定 notificationHub 的可用性。

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

在命名空间中创建/更新 NotificationHub。

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

为 NotificationHub 创建/更新授权规则

debugSend(string, string, string, NotificationHubsDebugSendOptionalParams)

测试发送推送通知

delete(string, string, string, NotificationHubsDeleteOptionalParams)

删除与命名空间关联的通知中心。

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

删除 notificationHub 授权规则

get(string, string, string, NotificationHubsGetOptionalParams)

列出与命名空间关联的通知中心。

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

按名称获取 NotificationHub 的授权规则。

getPnsCredentials(string, string, string, NotificationHubsGetPnsCredentialsOptionalParams)

列出与通知中心关联的 PNS 凭据。

list(string, string, NotificationHubsListOptionalParams)

列出与命名空间关联的通知中心。

listAuthorizationRules(string, string, string, NotificationHubsListAuthorizationRulesOptionalParams)

获取 NotificationHub 的授权规则。

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

获取 NotificationHub 的主要和辅助 ConnectionStrings

patch(string, string, string, NotificationHubsPatchOptionalParams)

修补命名空间中的 NotificationHub。

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

将主密钥/辅助密钥重新生成到 NotificationHub 授权规则

方法详细信息

checkNotificationHubAvailability(string, string, CheckAvailabilityParameters, NotificationHubsCheckNotificationHubAvailabilityOptionalParams)

检查命名空间中给定 notificationHub 的可用性。

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

参数

resourceGroupName

string

资源组的名称。

namespaceName

string

命名空间名称。

parameters
CheckAvailabilityParameters

notificationHub 名称。

返回

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

在命名空间中创建/更新 NotificationHub。

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

参数

resourceGroupName

string

资源组的名称。

namespaceName

string

命名空间名称。

notificationHubName

string

通知中心名称。

parameters
NotificationHubCreateOrUpdateParameters

提供给创建/更新 NotificationHub 资源的参数。

返回

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

为 NotificationHub 创建/更新授权规则

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

参数

resourceGroupName

string

资源组的名称。

namespaceName

string

命名空间名称。

notificationHubName

string

通知中心名称。

authorizationRuleName

string

授权规则名称。

parameters
SharedAccessAuthorizationRuleCreateOrUpdateParameters

共享访问授权规则。

返回

debugSend(string, string, string, NotificationHubsDebugSendOptionalParams)

测试发送推送通知

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

参数

resourceGroupName

string

资源组的名称。

namespaceName

string

命名空间名称。

notificationHubName

string

通知中心名称。

options
NotificationHubsDebugSendOptionalParams

选项参数。

返回

delete(string, string, string, NotificationHubsDeleteOptionalParams)

删除与命名空间关联的通知中心。

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

参数

resourceGroupName

string

资源组的名称。

namespaceName

string

命名空间名称。

notificationHubName

string

通知中心名称。

options
NotificationHubsDeleteOptionalParams

选项参数。

返回

Promise<void>

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

删除 notificationHub 授权规则

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

参数

resourceGroupName

string

资源组的名称。

namespaceName

string

命名空间名称。

notificationHubName

string

通知中心名称。

authorizationRuleName

string

授权规则名称。

返回

Promise<void>

get(string, string, string, NotificationHubsGetOptionalParams)

列出与命名空间关联的通知中心。

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

参数

resourceGroupName

string

资源组的名称。

namespaceName

string

命名空间名称。

notificationHubName

string

通知中心名称。

options
NotificationHubsGetOptionalParams

选项参数。

返回

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

按名称获取 NotificationHub 的授权规则。

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

参数

resourceGroupName

string

资源组的名称。

namespaceName

string

命名空间名称

notificationHubName

string

通知中心名称。

authorizationRuleName

string

授权规则名称。

返回

getPnsCredentials(string, string, string, NotificationHubsGetPnsCredentialsOptionalParams)

列出与通知中心关联的 PNS 凭据。

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

参数

resourceGroupName

string

资源组的名称。

namespaceName

string

命名空间名称。

notificationHubName

string

通知中心名称。

返回

list(string, string, NotificationHubsListOptionalParams)

列出与命名空间关联的通知中心。

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

参数

resourceGroupName

string

资源组的名称。

namespaceName

string

命名空间名称。

options
NotificationHubsListOptionalParams

选项参数。

返回

listAuthorizationRules(string, string, string, NotificationHubsListAuthorizationRulesOptionalParams)

获取 NotificationHub 的授权规则。

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

参数

resourceGroupName

string

资源组的名称。

namespaceName

string

命名空间名称

notificationHubName

string

通知中心名称。

返回

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

获取 NotificationHub 的主要和辅助 ConnectionStrings

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

参数

resourceGroupName

string

资源组的名称。

namespaceName

string

命名空间名称。

notificationHubName

string

通知中心名称。

authorizationRuleName

string

指定 authorizationRule 的 NotificationHub 的连接字符串。

options
NotificationHubsListKeysOptionalParams

选项参数。

返回

Promise<ResourceListKeys>

patch(string, string, string, NotificationHubsPatchOptionalParams)

修补命名空间中的 NotificationHub。

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

参数

resourceGroupName

string

资源组的名称。

namespaceName

string

命名空间名称。

notificationHubName

string

通知中心名称。

options
NotificationHubsPatchOptionalParams

选项参数。

返回

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

将主密钥/辅助密钥重新生成到 NotificationHub 授权规则

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

参数

resourceGroupName

string

资源组的名称。

namespaceName

string

命名空间名称。

notificationHubName

string

通知中心名称。

authorizationRuleName

string

指定 authorizationRule 的 NotificationHub 的连接字符串。

parameters
PolicykeyResource

提供用于重新生成 NotificationHub 授权规则密钥的参数。

返回

Promise<ResourceListKeys>