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

Microsoft.NotificationHubs 命名空间

Bicep 资源定义

可以使用面向以下操作部署命名空间资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.NotificationHubs/namespaces 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.NotificationHubs/namespaces@2023-10-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  properties: {
    dataCenter: 'string'
    namespaceType: 'string'
    networkAcls: {
      ipRules: [
        {
          ipMask: 'string'
          rights: [
            'string'
          ]
        }
      ]
      publicNetworkRule: {
        rights: [
          'string'
        ]
      }
    }
    pnsCredentials: {
      admCredential: {
        properties: {
          authTokenUrl: 'string'
          clientId: 'string'
          clientSecret: 'string'
        }
      }
      apnsCredential: {
        properties: {
          apnsCertificate: 'string'
          appId: 'string'
          appName: 'string'
          certificateKey: 'string'
          endpoint: 'string'
          keyId: 'string'
          thumbprint: 'string'
          token: 'string'
        }
      }
      baiduCredential: {
        properties: {
          baiduApiKey: 'string'
          baiduEndPoint: 'string'
          baiduSecretKey: 'string'
        }
      }
      browserCredential: {
        properties: {
          subject: 'string'
          vapidPrivateKey: 'string'
          vapidPublicKey: 'string'
        }
      }
      fcmV1Credential: {
        properties: {
          clientEmail: 'string'
          privateKey: 'string'
          projectId: 'string'
        }
      }
      gcmCredential: {
        properties: {
          gcmEndpoint: 'string'
          googleApiKey: 'string'
        }
      }
      mpnsCredential: {
        properties: {
          certificateKey: 'string'
          mpnsCertificate: 'string'
          thumbprint: 'string'
        }
      }
      wnsCredential: {
        properties: {
          certificateKey: 'string'
          packageSid: 'string'
          secretKey: 'string'
          windowsLiveEndpoint: 'string'
          wnsCertificate: 'string'
        }
      }
      xiaomiCredential: {
        properties: {
          appSecret: 'string'
          endpoint: 'string'
        }
      }
    }
    provisioningState: 'string'
    publicNetworkAccess: 'string'
    replicationRegion: 'string'
    scaleUnit: 'string'
    status: 'string'
    zoneRedundancy: 'string'
  }
}

属性值

namespaces

名称 说明
name 资源名称 字符串 (必需)

字符限制:6-50

有效字符:
字母数字和连字符

以字母开头。 以字母数字结尾。

资源名称在 Azure 中必须是唯一的。
location 资源所在的地理位置 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku 命名空间的 SKU 说明 需要 sku ()
properties 表示命名空间属性。 NamespaceProperties

NamespaceProperties

名称 说明
dataCenter 已弃用。 字符串
namespaceType 定义 NamespaceType 的值。 “Messaging”
“NotificationHub”
networkAcls 网络授权规则的集合。 NetworkAcls
pnsCredentials 通知中心或通知中心命名空间 PNS 凭据的集合。 PnsCredentials
provisioningState 定义 OperationProvisioningState 的值。 “已取消”
'Disabled'
“Failed”
“InProgress”
'Pending'
'Succeeded'
“未知”
publicNetworkAccess 公用网络访问的类型。 'Disabled'
'Enabled'
replicationRegion 允许的复制区域 'AustraliaEast'
'BrazilSouth'
'Default'
“None”
“NorthEurope”
'SouthAfricaNorth'
'SouthEastAsia'
“WestUs2”
scaleUnit 获取或设置创建命名空间的 scaleUnit 字符串
status 命名空间状态。 “Created”
'Creating'
'正在删除'
“Suspended”
zoneRedundancy 命名空间 SKU 名称。 'Disabled'
'Enabled'

NetworkAcls

名称 说明
ipRules IP 规则列表。 IpRule[]
publicNetworkRule 默认 (公共 Internet) 网络授权规则,如果未匹配其他网络规则,则包含权限。 PublicInternetAuthorizationRule

IpRule

名称 说明
ipMask IP 掩码。 字符串 (必需)

约束:
最小长度 = 1
权限 访问权限列表。 包含任何一项的字符串数组:
'Listen'
“管理”
“发送” (必需)

PublicInternetAuthorizationRule

名称 说明
权限 访问权限列表。 包含任何一项的字符串数组:
'Listen'
“管理”
“发送” (必需)

PnsCredentials

名称 说明
admCredential NotificationHub AdmCredential 的说明。 AdmCredential
apnsCredential NotificationHub ApnsCredential 的说明。 ApnsCredential
baiduCredential NotificationHub BaiduCredential 的说明。 百度Credential
browserCredential NotificationHub BrowserCredential 的说明。 BrowserCredential
fcmV1Credential NotificationHub FcmV1Credential 的说明。 FcmV1Credential
gcmCredential NotificationHub GcmCredential 的说明。 GcmCredential
mpnsCredential NotificationHub MpnsCredential 的说明。 MpnsCredential
wnsCredential NotificationHub WnsCredential 的说明。 WnsCredential
xiaomiCredential NotificationHub XiaomiCredential 的说明。 XiaomiCredential

AdmCredential

名称 说明
properties NotificationHub AdmCredential 的说明。 AdmCredentialProperties (必需)

AdmCredentialProperties

名称 说明
authTokenUrl 获取或设置授权令牌的 URL。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
clientId 获取或设置客户端标识符。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
clientSecret 获取或设置凭据机密访问密钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。

ApnsCredential

名称 说明
properties NotificationHub ApnsCredential 的说明。 ApnsCredentialProperties (必需)

ApnsCredentialProperties

名称 说明
apnsCertificate 获取或设置 APNS 证书。 字符串

约束:
敏感值。 作为安全参数传入。
appId 获取或设置颁发者 (iss) 已注册声明密钥,其值为
从开发人员帐户获取的 10 个字符的团队 ID
字符串

约束:
敏感值。 作为安全参数传入。
appName 获取或设置应用程序的名称 字符串

约束:
敏感值。 作为安全参数传入。
certificateKey 获取或设置证书密钥。 字符串

约束:
敏感值。 作为安全参数传入。
endpoint 获取或设置此凭据的终结点。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
keyId 获取或设置一个 10 个字符的密钥标识符, (儿童) 密钥,从 获取
你的开发人员帐户
字符串

约束:
敏感值。 作为安全参数传入。
thumbprint 获取或设置 APNS 证书指纹 字符串

约束:
敏感值。 作为安全参数传入。
令牌 获取或设置提供程序身份验证令牌,通过
开发人员帐户
字符串

约束:
敏感值。 作为安全参数传入。

百度Credential

名称 说明
properties NotificationHub BaiduCredential 的说明。 需要百度CredentialProperties ()

BaiduCredentialProperties

名称 说明
baiduApiKey 获取或设置百度 Api 密钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
baiduEndPoint 获取或设置百度终结点。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
baiduSecretKey 获取或设置百度密钥 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。

BrowserCredential

名称 说明
properties NotificationHub BrowserCredential 的说明。 BrowserCredentialProperties (必需)

BrowserCredentialProperties

名称 说明
subject 获取或设置 Web 推送主题。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
vapidPrivateKey 获取或设置 VAPID 私钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
vapidPublicKey 获取或设置 VAPID 公钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。

FcmV1Credential

名称 说明
properties NotificationHub FcmV1Credential 的说明。 FcmV1CredentialProperties (必需)

FcmV1CredentialProperties

名称 说明
clientEmail 获取或设置客户端电子邮件。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
privateKey 获取或设置私钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
projectId 获取或设置项目 ID。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。

GcmCredential

名称 说明
properties NotificationHub GcmCredential 的说明。 需要 GcmCredentialProperties ()

GcmCredentialProperties

名称 说明
gcmEndpoint 获取或设置 GCM 终结点。 字符串

约束:
敏感值。 作为安全参数传入。
googleApiKey 获取或设置 Google API 密钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。

MpnsCredential

名称 说明
properties NotificationHub MpnsCredential 的说明。 需要 mpnsCredentialProperties ()

MpnsCredentialProperties

名称 说明
certificateKey 获取或设置此凭据的证书密钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
mpnsCertificate 获取或设置 MPNS 证书。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
thumbprint 获取或设置 MPNS 证书指纹 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。

WnsCredential

名称 说明
properties NotificationHub WnsCredential 的说明。 需要 WnsCredentialProperties ()

WnsCredentialProperties

名称 说明
certificateKey Ges 或设置 WNS 证书密钥。 字符串

约束:
敏感值。 作为安全参数传入。
packageSid 获取或设置此凭据的包 ID。 字符串

约束:
敏感值。 作为安全参数传入。
secretKey 获取或设置密钥。 字符串

约束:
敏感值。 作为安全参数传入。
windowsLiveEndpoint 获取或设置 Windows Live 终结点。 字符串

约束:
敏感值。 作为安全参数传入。
wnsCertificate 获取或设置 WNS 证书。 字符串

约束:
敏感值。 作为安全参数传入。

XiaomiCredential

名称 说明
properties NotificationHub XiaomiCredentialProperties 的说明。 小米CredentialProperties (所需的)

XiaomiCredentialProperties

名称 说明
appSecret 获取或设置应用机密。 字符串

约束:
敏感值。 作为安全参数传入。
endpoint 获取或设置小米服务终结点。 字符串

约束:
敏感值。 作为安全参数传入。

SKU

名称 说明
容量 获取或设置资源的容量 int
family 获取或设置 SKU 系列 字符串
name 命名空间 SKU 名称。 'Basic'
“免费”
需要“标准” ()
大小 获取或设置 SKU 大小 字符串
获取或设置特定 SKU 的层 字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
创建 Azure 通知中心

部署到 Azure
创建最初由 John Downs 创作的 Azure 通知中心模板。
使用SQL 数据库预配移动应用

部署到 Azure
此模板预配移动应用、SQL 数据库和通知中心。 它在移动应用中为数据库和通知中心配置连接字符串。

ARM 模板资源定义

命名空间资源类型可以使用面向以下对象的操作进行部署:

有关每个 API 版本中更改的属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.NotificationHubs/namespaces 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.NotificationHubs/namespaces",
  "apiVersion": "2023-10-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "properties": {
    "dataCenter": "string",
    "namespaceType": "string",
    "networkAcls": {
      "ipRules": [
        {
          "ipMask": "string",
          "rights": [ "string" ]
        }
      ],
      "publicNetworkRule": {
        "rights": [ "string" ]
      }
    },
    "pnsCredentials": {
      "admCredential": {
        "properties": {
          "authTokenUrl": "string",
          "clientId": "string",
          "clientSecret": "string"
        }
      },
      "apnsCredential": {
        "properties": {
          "apnsCertificate": "string",
          "appId": "string",
          "appName": "string",
          "certificateKey": "string",
          "endpoint": "string",
          "keyId": "string",
          "thumbprint": "string",
          "token": "string"
        }
      },
      "baiduCredential": {
        "properties": {
          "baiduApiKey": "string",
          "baiduEndPoint": "string",
          "baiduSecretKey": "string"
        }
      },
      "browserCredential": {
        "properties": {
          "subject": "string",
          "vapidPrivateKey": "string",
          "vapidPublicKey": "string"
        }
      },
      "fcmV1Credential": {
        "properties": {
          "clientEmail": "string",
          "privateKey": "string",
          "projectId": "string"
        }
      },
      "gcmCredential": {
        "properties": {
          "gcmEndpoint": "string",
          "googleApiKey": "string"
        }
      },
      "mpnsCredential": {
        "properties": {
          "certificateKey": "string",
          "mpnsCertificate": "string",
          "thumbprint": "string"
        }
      },
      "wnsCredential": {
        "properties": {
          "certificateKey": "string",
          "packageSid": "string",
          "secretKey": "string",
          "windowsLiveEndpoint": "string",
          "wnsCertificate": "string"
        }
      },
      "xiaomiCredential": {
        "properties": {
          "appSecret": "string",
          "endpoint": "string"
        }
      }
    },
    "provisioningState": "string",
    "publicNetworkAccess": "string",
    "replicationRegion": "string",
    "scaleUnit": "string",
    "status": "string",
    "zoneRedundancy": "string"
  }
}

属性值

namespaces

名称 说明 Value
type 资源类型 “Microsoft.NotificationHubs/namespaces”
apiVersion 资源 API 版本 “2023-10-01-preview”
name 资源名称 字符串 (必需)

字符限制:6-50

有效字符:
字母数字和连字符

以字母开头。 以字母数字结尾。

资源名称在 Azure 中必须是唯一的。
location 资源所在的地理位置 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
sku 命名空间的 SKU 说明 需要 sku ()
properties 表示命名空间属性。 NamespaceProperties

NamespaceProperties

名称 说明
dataCenter 已弃用。 字符串
namespaceType 定义 NamespaceType 的值。 “消息传送”
“NotificationHub”
networkAcls 网络授权规则的集合。 NetworkAcls
pnsCredentials 通知中心或通知中心命名空间 PNS 凭据的集合。 PnsCredentials
provisioningState 定义 OperationProvisioningState 的值。 “已取消”
“Disabled”
“失败”
“InProgress”
“挂起”
“成功”
“未知”
publicNetworkAccess 公用网络访问的类型。 “Disabled”
“已启用”
replicationRegion 允许的复制区域 “AustraliaEast”
“BrazilSouth”
'Default'
“None”
“NorthEurope”
“SouthAfricaNorth”
“SouthEastAsia”
“WestUs2”
scaleUnit 获取或设置创建命名空间的 scaleUnit 字符串
status 命名空间状态。 “已创建”
“正在创建”
“正在删除”
“Suspended”
zoneRedundancy 命名空间 SKU 名称。 “Disabled”
“已启用”

NetworkAcls

名称 说明
ipRules IP 规则列表。 IpRule[]
publicNetworkRule 默认 (公共 Internet) 网络授权规则,如果未匹配其他网络规则,则包含权限。 PublicInternetAuthorizationRule

IpRule

名称 说明
ipMask IP 掩码。 字符串 (必需)

约束:
最小长度 = 1
权限 访问权限列表。 包含任何一项的字符串数组:
'Listen'
“管理”
“发送” (必需)

PublicInternetAuthorizationRule

名称 说明
权限 访问权限列表。 包含任何一项的字符串数组:
'Listen'
“管理”
“发送” (必需)

PnsCredentials

名称 说明
admCredential NotificationHub AdmCredential 的说明。 AdmCredential
apnsCredential NotificationHub ApnsCredential 的说明。 ApnsCredential
baiduCredential NotificationHub BaiduCredential 的说明。 百度Credential
browserCredential NotificationHub BrowserCredential 的说明。 BrowserCredential
fcmV1Credential NotificationHub FcmV1Credential 的说明。 FcmV1Credential
gcmCredential NotificationHub GcmCredential 的说明。 GcmCredential
mpnsCredential NotificationHub MpnsCredential 的说明。 MpnsCredential
wnsCredential NotificationHub WnsCredential 的说明。 WnsCredential
xiaomiCredential NotificationHub XiaomiCredential 的说明。 XiaomiCredential

AdmCredential

名称 说明
properties NotificationHub AdmCredential 的说明。 AdmCredentialProperties (必需)

AdmCredentialProperties

名称 说明
authTokenUrl 获取或设置授权令牌的 URL。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
clientId 获取或设置客户端标识符。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
clientSecret 获取或设置凭据机密访问密钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。

ApnsCredential

名称 说明
properties NotificationHub ApnsCredential 的说明。 ApnsCredentialProperties (必需)

ApnsCredentialProperties

名称 说明
apnsCertificate 获取或设置 APNS 证书。 字符串

约束:
敏感值。 作为安全参数传入。
appId 获取或设置颁发者 (iss) 已注册声明密钥,其值为
从开发人员帐户获取的 10 个字符的团队 ID
字符串

约束:
敏感值。 作为安全参数传入。
appName 获取或设置应用程序的名称 字符串

约束:
敏感值。 作为安全参数传入。
certificateKey 获取或设置证书密钥。 字符串

约束:
敏感值。 作为安全参数传入。
endpoint 获取或设置此凭据的终结点。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
keyId 获取或设置一个 10 个字符的密钥标识符, (儿童) 密钥,从 获取
你的开发人员帐户
字符串

约束:
敏感值。 作为安全参数传入。
thumbprint 获取或设置 APNS 证书指纹 字符串

约束:
敏感值。 作为安全参数传入。
令牌 获取或设置提供程序身份验证令牌,通过
开发人员帐户
字符串

约束:
敏感值。 作为安全参数传入。

百度Credential

名称 说明
properties NotificationHub BaiduCredential 的说明。 需要百度CredentialProperties ()

BaiduCredentialProperties

名称 说明
baiduApiKey 获取或设置百度 Api 密钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
baiduEndPoint 获取或设置百度终结点。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
baiduSecretKey 获取或设置百度密钥 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。

BrowserCredential

名称 说明
properties NotificationHub BrowserCredential 的说明。 BrowserCredentialProperties (必需)

BrowserCredentialProperties

名称 说明
subject 获取或设置 Web 推送主题。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
vapidPrivateKey 获取或设置 VAPID 私钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
vapidPublicKey 获取或设置 VAPID 公钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。

FcmV1Credential

名称 说明
properties NotificationHub FcmV1Credential 的说明。 FcmV1CredentialProperties (必需)

FcmV1CredentialProperties

名称 说明
clientEmail 获取或设置客户端电子邮件。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
privateKey 获取或设置私钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
projectId 获取或设置项目 ID。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。

GcmCredential

名称 说明
properties NotificationHub GcmCredential 的说明。 GcmCredentialProperties (必需)

GcmCredentialProperties

名称 说明
gcmEndpoint 获取或设置 GCM 终结点。 字符串

约束:
敏感值。 作为安全参数传入。
googleApiKey 获取或设置 Google API 密钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。

MpnsCredential

名称 说明
properties NotificationHub MpnsCredential 的说明。 需要 mpnsCredentialProperties ()

MpnsCredentialProperties

名称 说明
certificateKey 获取或设置此凭据的证书密钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
mpnsCertificate 获取或设置 MPNS 证书。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
thumbprint 获取或设置 MPNS 证书指纹 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。

WnsCredential

名称 说明
properties NotificationHub WnsCredential 的说明。 需要 WnsCredentialProperties ()

WnsCredentialProperties

名称 说明
certificateKey Ges 或设置 WNS 证书密钥。 字符串

约束:
敏感值。 作为安全参数传入。
packageSid 获取或设置此凭据的包 ID。 字符串

约束:
敏感值。 作为安全参数传入。
secretKey 获取或设置密钥。 字符串

约束:
敏感值。 作为安全参数传入。
windowsLiveEndpoint 获取或设置 Windows Live 终结点。 字符串

约束:
敏感值。 作为安全参数传入。
wnsCertificate 获取或设置 WNS 证书。 字符串

约束:
敏感值。 作为安全参数传入。

XiaomiCredential

名称 说明
properties NotificationHub XiaomiCredentialProperties 的说明。 小米CredentialProperties (所需的)

XiaomiCredentialProperties

名称 说明
appSecret 获取或设置应用机密。 字符串

约束:
敏感值。 作为安全参数传入。
endpoint 获取或设置小米服务终结点。 字符串

约束:
敏感值。 作为安全参数传入。

SKU

名称 说明
容量 获取或设置资源的容量 int
family 获取或设置 SKU 系列 字符串
name 命名空间 SKU 名称。 'Basic'
“免费”
需要“标准” ()
大小 获取或设置 SKU 大小 字符串
获取或设置特定 SKU 的层 字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
创建 Azure 通知中心

部署到 Azure
创建最初由 John Downs 创作的 Azure 通知中心模板。
使用SQL 数据库预配移动应用

部署到 Azure
此模板预配移动应用、SQL 数据库和通知中心。 它在移动应用中为数据库和通知中心配置连接字符串。

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署命名空间资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.NotificationHubs/namespaces 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NotificationHubs/namespaces@2023-10-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      dataCenter = "string"
      namespaceType = "string"
      networkAcls = {
        ipRules = [
          {
            ipMask = "string"
            rights = [
              "string"
            ]
          }
        ]
        publicNetworkRule = {
          rights = [
            "string"
          ]
        }
      }
      pnsCredentials = {
        admCredential = {
          properties = {
            authTokenUrl = "string"
            clientId = "string"
            clientSecret = "string"
          }
        }
        apnsCredential = {
          properties = {
            apnsCertificate = "string"
            appId = "string"
            appName = "string"
            certificateKey = "string"
            endpoint = "string"
            keyId = "string"
            thumbprint = "string"
            token = "string"
          }
        }
        baiduCredential = {
          properties = {
            baiduApiKey = "string"
            baiduEndPoint = "string"
            baiduSecretKey = "string"
          }
        }
        browserCredential = {
          properties = {
            subject = "string"
            vapidPrivateKey = "string"
            vapidPublicKey = "string"
          }
        }
        fcmV1Credential = {
          properties = {
            clientEmail = "string"
            privateKey = "string"
            projectId = "string"
          }
        }
        gcmCredential = {
          properties = {
            gcmEndpoint = "string"
            googleApiKey = "string"
          }
        }
        mpnsCredential = {
          properties = {
            certificateKey = "string"
            mpnsCertificate = "string"
            thumbprint = "string"
          }
        }
        wnsCredential = {
          properties = {
            certificateKey = "string"
            packageSid = "string"
            secretKey = "string"
            windowsLiveEndpoint = "string"
            wnsCertificate = "string"
          }
        }
        xiaomiCredential = {
          properties = {
            appSecret = "string"
            endpoint = "string"
          }
        }
      }
      provisioningState = "string"
      publicNetworkAccess = "string"
      replicationRegion = "string"
      scaleUnit = "string"
      status = "string"
      zoneRedundancy = "string"
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  })
}

属性值

namespaces

名称 说明 Value
type 资源类型 “Microsoft.NotificationHubs/namespaces@2023-10-01-preview”
name 资源名称 字符串 (必需)

字符限制:6-50

有效字符:
字母数字和连字符

以字母开头。 以字母数字结尾。

资源名称在 Azure 中必须是唯一的。
location 资源所在的地理位置 字符串 (必需)
parent_id 若要部署到资源组,请使用该资源组的 ID。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。
sku 命名空间的 SKU 说明 需要 sku ()
properties 表示命名空间属性。 NamespaceProperties

NamespaceProperties

名称 说明
dataCenter 已弃用。 字符串
namespaceType 定义 NamespaceType 的值。 “消息传递”
“NotificationHub”
networkAcls 网络授权规则的集合。 NetworkAcls
pnsCredentials 通知中心或通知中心命名空间 PNS 凭据的集合。 PnsCredentials
provisioningState 定义 OperationProvisioningState 的值。 “已取消”
“Disabled”
“Failed”
“InProgress”
“挂起”
“Succeeded”
"Unknown"
publicNetworkAccess 公用网络访问的类型。 “Disabled”
“Enabled”
replicationRegion 允许的复制区域 “AustraliaEast”
“BrazilSouth”
“Default”
"None"
“NorthEurope”
“SouthAfricaNorth”
“SouthEastAsia”
“WestUs2”
scaleUnit 获取或设置创建命名空间的 scaleUnit 字符串
status 命名空间状态。 “Created”
“正在创建”
“正在删除”
“Suspended”
zoneRedundancy 命名空间 SKU 名称。 “Disabled”
“Enabled”

NetworkAcls

名称 说明
ipRules IP 规则列表。 IpRule[]
publicNetworkRule 默认 (公共 Internet) 网络授权规则,如果没有其他网络规则匹配,则包含权限。 PublicInternetAuthorizationRule

IpRule

名称 说明
ipMask IP 掩码。 字符串 (必需)

约束:
最小长度 = 1
权限 访问权限列表。 包含任意项的字符串数组:
“Listen”
“管理”
“发送” (必需)

PublicInternetAuthorizationRule

名称 说明
权限 访问权限列表。 包含任意项的字符串数组:
“Listen”
“管理”
“发送” (必需)

PnsCredentials

名称 说明
admCredential NotificationHub AdmCredential 的说明。 AdmCredential
apnsCredential NotificationHub ApnsCredential 的说明。 ApnsCredential
baiduCredential NotificationHub BaiduCredential 的说明。 百度Credential
browserCredential NotificationHub BrowserCredential 的说明。 BrowserCredential
fcmV1Credential NotificationHub FcmV1Credential 的说明。 FcmV1Credential
gcmCredential NotificationHub GcmCredential 的说明。 GcmCredential
mpnsCredential NotificationHub MpnsCredential 的说明。 MpnsCredential
wnsCredential NotificationHub WnsCredential 的说明。 WnsCredential
xiaomiCredential NotificationHub XiaomiCredential 的说明。 XiaomiCredential

AdmCredential

名称 说明
properties NotificationHub AdmCredential 的说明。 需要 AdmCredentialProperties ()

AdmCredentialProperties

名称 说明
authTokenUrl 获取或设置授权令牌的 URL。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
clientId 获取或设置客户端标识符。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
clientSecret 获取或设置凭据机密访问密钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。

ApnsCredential

名称 说明
properties NotificationHub ApnsCredential 的说明。 需要 ApnsCredentialProperties ()

ApnsCredentialProperties

名称 说明
apnsCertificate 获取或设置 APNS 证书。 字符串

约束:
敏感值。 作为安全参数传入。
appId 获取或设置颁发者 (iss) 注册的声明密钥,其值为
从开发人员帐户获取的 10 个字符的团队 ID
字符串

约束:
敏感值。 作为安全参数传入。
appName 获取或设置应用程序的名称 字符串

约束:
敏感值。 作为安全参数传入。
certificateKey 获取或设置证书密钥。 字符串

约束:
敏感值。 作为安全参数传入。
endpoint 获取或设置此凭据的终结点。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
keyId 获取或设置一个 10 个字符的密钥标识符 (子) 密钥,从 中获取
你的开发人员帐户
字符串

约束:
敏感值。 作为安全参数传入。
thumbprint 获取或设置 APNS 证书指纹 字符串

约束:
敏感值。 作为安全参数传入。
令牌 获取或设置提供程序身份验证令牌,通过
开发人员帐户
字符串

约束:
敏感值。 作为安全参数传入。

百度Credential

名称 说明
properties NotificationHub BaiduCredential 的说明。 需要百度CredentialProperties ()

BaiduCredentialProperties

名称 说明
baiduApiKey 获取或设置百度 Api 密钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
baiduEndPoint 获取或设置百度终结点。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
baiduSecretKey 获取或设置百度密钥 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。

BrowserCredential

名称 说明
properties NotificationHub BrowserCredential 的说明。 BrowserCredentialProperties (必需)

BrowserCredentialProperties

名称 说明
subject 获取或设置 Web 推送主题。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
vapidPrivateKey 获取或设置 VAPID 私钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
vapidPublicKey 获取或设置 VAPID 公钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。

FcmV1Credential

名称 说明
properties NotificationHub FcmV1Credential 的说明。 FcmV1CredentialProperties (必需)

FcmV1CredentialProperties

名称 说明
clientEmail 获取或设置客户端电子邮件。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
privateKey 获取或设置私钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
projectId 获取或设置项目 ID。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。

GcmCredential

名称 说明
properties NotificationHub GcmCredential 的说明。 需要 GcmCredentialProperties ()

GcmCredentialProperties

名称 说明
gcmEndpoint 获取或设置 GCM 终结点。 字符串

约束:
敏感值。 作为安全参数传入。
googleApiKey 获取或设置 Google API 密钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。

MpnsCredential

名称 说明
properties NotificationHub MpnsCredential 的说明。 需要 mpnsCredentialProperties ()

MpnsCredentialProperties

名称 说明
certificateKey 获取或设置此凭据的证书密钥。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
mpnsCertificate 获取或设置 MPNS 证书。 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。
thumbprint 获取或设置 MPNS 证书指纹 字符串 (必需)

约束:
最小长度 = 1
敏感值。 作为安全参数传入。

WnsCredential

名称 说明
properties NotificationHub WnsCredential 的说明。 需要 WnsCredentialProperties ()

WnsCredentialProperties

名称 说明
certificateKey Ges 或设置 WNS 证书密钥。 字符串

约束:
敏感值。 作为安全参数传入。
packageSid 获取或设置此凭据的包 ID。 字符串

约束:
敏感值。 作为安全参数传入。
secretKey 获取或设置密钥。 字符串

约束:
敏感值。 作为安全参数传入。
windowsLiveEndpoint 获取或设置 Windows Live 终结点。 字符串

约束:
敏感值。 作为安全参数传入。
wnsCertificate 获取或设置 WNS 证书。 字符串

约束:
敏感值。 作为安全参数传入。

XiaomiCredential

名称 说明
properties NotificationHub XiaomiCredentialProperties 的说明。 小米CredentialProperties (所需的)

XiaomiCredentialProperties

名称 说明
appSecret 获取或设置应用机密。 字符串

约束:
敏感值。 作为安全参数传入。
endpoint 获取或设置小米服务终结点。 字符串

约束:
敏感值。 作为安全参数传入。

SKU

名称 说明
容量 获取或设置资源的容量 int
family 获取或设置 SKU 系列 字符串
name 命名空间 SKU 名称。 "Basic"
"Free"
需要“标准” ()
大小 获取或设置 SKU 大小 字符串
获取或设置特定 SKU 的层 字符串