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

Notification Hubs - List

服务:

Notification Hubs

API 版本:

2023-09-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs?api-version=2023-09-01

具有可选参数:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs?$skipToken={$skipToken}&$top={$top}&api-version=2023-09-01

URI 参数

名称	在	必需	类型	说明
namespaceName	path	True	string	命名空间名称 正则表达式模式: ^[a-zA-Z][a-zA-Z0-9-]*$
resourceGroupName	path	True	string	资源组的名称。 此名称不区分大小写。
subscriptionId	path	True	string uuid	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string	要用于此操作的 API 版本。
$skipToken	query		string	延续标记。
$top	query		integer int32	页面大小。

响应

名称	类型	说明
200 OK	NotificationHubListResult	成功
Other Status Codes	ErrorResponse	错误代码和原因。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

NotificationHubs_List

示例请求

HTTP

GET https://management.azure.com/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs?api-version=2023-09-01

示例响应

状态代码:

200

{
  "value": [
    {
      "location": "East US",
      "properties": {
        "name": "test",
        "registrationTtl": "10675199.02:48:05.4775807",
        "dailyMaxActiveDevices": 0
      },
      "id": "/subscriptions/29cfa613-cbbc-4512-b1d6-1b3a92c7fa40/resourceGroups/5ktrial/providers/Microsoft.NotificationHubs/namespaces/nh-sdk-ns/notificationHubs/test",
      "name": "test",
      "type": "Microsoft.NotificationHubs/namespaces/notificationHubs",
      "tags": {
        "hubTag1": "hubTagValue1",
        "hubTag2": "hubTagValue2"
      }
    }
  ]
}

定义

名称	说明
AccessRights	定义 AccessRights 的值。
AdmCredential	NotificationHub AdmCredential 的说明。
AdmCredentialProperties	NotificationHub AdmCredential 的说明。
ApnsCredential	NotificationHub ApnsCredential 的说明。
ApnsCredentialProperties	NotificationHub ApnsCredential 的说明。
BaiduCredential	NotificationHub BaiduCredential 的说明。
BaiduCredentialProperties	NotificationHub BaiduCredential 的说明。
BrowserCredential	NotificationHub BrowserCredential 的说明。
BrowserCredentialProperties	NotificationHub BrowserCredential 的说明。
createdByType	创建资源的标识类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
GcmCredential	NotificationHub GcmCredential 的说明。
GcmCredentialProperties	NotificationHub GcmCredential 的说明。
MpnsCredential	NotificationHub MpnsCredential 的说明。
MpnsCredentialProperties	NotificationHub MpnsCredential 的说明。
NotificationHubListResult	List NotificationHub 操作的响应。
NotificationHubProperties	NotificationHub 属性。
NotificationHubResource	通知中心资源。
SharedAccessAuthorizationRuleProperties	SharedAccessAuthorizationRule 属性。
Sku	命名空间的 SKU 说明
SkuName	命名空间 SKU 名称。
systemData	与资源的创建和上次修改相关的元数据。
WnsCredential	NotificationHub WnsCredential 的说明。
WnsCredentialProperties	NotificationHub WnsCredential 的说明。
XiaomiCredential	NotificationHub XiaomiCredential 的说明。
XiaomiCredentialProperties	NotificationHub XiaomiCredentialProperties 的说明。

AccessRights

定义 AccessRights 的值。

名称	类型	说明
Listen	string
Manage	string
Send	string

AdmCredential

NotificationHub AdmCredential 的说明。

名称	类型	说明
properties	AdmCredentialProperties	NotificationHub AdmCredential 的说明。

AdmCredentialProperties

NotificationHub AdmCredential 的说明。

名称	类型	说明
authTokenUrl	string	获取或设置授权令牌的 URL。
clientId	string	获取或设置客户端标识符。
clientSecret	string	获取或设置凭据机密访问密钥。

ApnsCredential

NotificationHub ApnsCredential 的说明。

名称	类型	说明
properties	ApnsCredentialProperties	NotificationHub ApnsCredential 的说明。

ApnsCredentialProperties

NotificationHub ApnsCredential 的说明。

名称	类型	说明
apnsCertificate	string	获取或设置 APNS 证书。
appId	string	获取或设置颁发者 (iss) 注册的声明密钥，其值为从开发人员帐户获取的 10 个字符的团队 ID
appName	string	获取或设置应用程序的名称
certificateKey	string	获取或设置证书密钥。
endpoint	string	获取或设置此凭据的终结点。
keyId	string	获取或设置从开发人员帐户获取 (儿童) 密钥的 10 个字符密钥标识符
thumbprint	string	获取或设置 APNS 证书指纹
token	string	获取或设置通过开发人员帐户获取的提供程序身份验证令牌

BaiduCredential

NotificationHub BaiduCredential 的说明。

名称	类型	说明
properties	BaiduCredentialProperties	NotificationHub BaiduCredential 的说明。

BaiduCredentialProperties

NotificationHub BaiduCredential 的说明。

名称	类型	说明
baiduApiKey	string	获取或设置百度 Api 密钥。
baiduEndPoint	string	获取或设置百度终结点。
baiduSecretKey	string	获取或设置百度密钥

BrowserCredential

NotificationHub BrowserCredential 的说明。

名称	类型	说明
properties	BrowserCredentialProperties	NotificationHub BrowserCredential 的说明。

BrowserCredentialProperties

NotificationHub BrowserCredential 的说明。

名称	类型	说明
subject	string	获取或设置 Web 推送主题。
vapidPrivateKey	string	获取或设置 VAPID 私钥。
vapidPublicKey	string	获取或设置 VAPID 公钥。

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

GcmCredential

NotificationHub GcmCredential 的说明。

名称	类型	说明
properties	GcmCredentialProperties	NotificationHub GcmCredential 的说明。

GcmCredentialProperties

NotificationHub GcmCredential 的说明。

名称	类型	说明
gcmEndpoint	string	获取或设置 GCM 终结点。
googleApiKey	string	获取或设置 Google API 密钥。

MpnsCredential

NotificationHub MpnsCredential 的说明。

名称	类型	说明
properties	MpnsCredentialProperties	NotificationHub MpnsCredential 的说明。

MpnsCredentialProperties

NotificationHub MpnsCredential 的说明。

名称	类型	说明
certificateKey	string	获取或设置此凭据的证书密钥。
mpnsCertificate	string	获取或设置 MPNS 证书。
thumbprint	string	获取或设置 MPNS 证书指纹

NotificationHubListResult

List NotificationHub 操作的响应。

名称	类型	说明
nextLink	string	获取或设置指向下一组结果的链接。
value	NotificationHubResource[]	获取或设置 List AuthorizationRules 操作的结果。

NotificationHubProperties

NotificationHub 属性。

名称	类型	说明
admCredential	AdmCredential	NotificationHub AdmCredential 的说明。
apnsCredential	ApnsCredential	NotificationHub ApnsCredential 的说明。
authorizationRules	SharedAccessAuthorizationRuleProperties[]	获取或设置创建的 NotificationHub 的 AuthorizationRules
baiduCredential	BaiduCredential	NotificationHub BaiduCredential 的说明。
browserCredential	BrowserCredential	NotificationHub BrowserCredential 的说明。
dailyMaxActiveDevices	integer
gcmCredential	GcmCredential	NotificationHub GcmCredential 的说明。
mpnsCredential	MpnsCredential	NotificationHub MpnsCredential 的说明。
name	string	获取或设置 NotificationHub 名称。
registrationTtl	string	获取或设置创建的 NotificationHub 的 RegistrationTtl
wnsCredential	WnsCredential	NotificationHub WnsCredential 的说明。
xiaomiCredential	XiaomiCredential	NotificationHub XiaomiCredential 的说明。

NotificationHubResource

通知中心资源。

名称	类型	说明
id	string	资源的完全限定的资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
location	string	资源所在的地理位置
name	string	资源的名称
properties	NotificationHubProperties	NotificationHub 属性。
sku	Sku	命名空间的 SKU 说明
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

SharedAccessAuthorizationRuleProperties

SharedAccessAuthorizationRule 属性。

名称	类型	说明
claimType	string	获取描述声明类型的字符串
claimValue	string	获取描述声明值的字符串
createdTime	string	获取此规则的创建时间
keyName	string	获取描述授权规则的字符串。
modifiedTime	string	获取此规则的上次修改时间
primaryKey	string	获取 base64 编码的 256 位主密钥，用于签名和验证 SAS 令牌。
revision	integer	获取规则的修订号
rights	AccessRights[]	获取或设置与规则关联的权限。
secondaryKey	string	获取 base64 编码的 256 位主密钥，用于签名和验证 SAS 令牌。

Sku

命名空间的 SKU 说明

名称	类型	说明
capacity	integer	获取或设置资源的容量
family	string	获取或设置 SKU 系列
name	SkuName	命名空间 SKU 名称。
size	string	获取或设置 SKU 大小
tier	string	获取或设置特定 SKU 的层

SkuName

命名空间 SKU 名称。

名称	类型	说明
Basic	string
Free	string
Standard	string

systemData

与资源的创建和上次修改相关的元数据。

名称	类型	说明
createdAt	string	资源的创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。

WnsCredential

NotificationHub WnsCredential 的说明。

名称	类型	说明
properties	WnsCredentialProperties	NotificationHub WnsCredential 的说明。

WnsCredentialProperties

NotificationHub WnsCredential 的说明。

名称	类型	说明
certificateKey	string	Ges 或设置 WNS 证书密钥。
packageSid	string	获取或设置此凭据的包 ID。
secretKey	string	获取或设置密钥。
windowsLiveEndpoint	string	获取或设置 Windows Live 终结点。
wnsCertificate	string	获取或设置 WNS 证书。

XiaomiCredential

NotificationHub XiaomiCredential 的说明。

名称	类型	说明
properties	XiaomiCredentialProperties	NotificationHub XiaomiCredentialProperties 的说明。

XiaomiCredentialProperties

NotificationHub XiaomiCredentialProperties 的说明。

名称	类型	说明
appSecret	string	获取或设置应用机密。
endpoint	string	获取或设置小米服务终结点。