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

Microsoft.NotificationHubs namespaces/notificationHubs 2016-03-01

Bicep 资源定义

可以使用面向以下操作部署 namespaces/notificationHubs 资源类型:

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

资源格式

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

resource symbolicname 'Microsoft.NotificationHubs/namespaces/notificationHubs@2016-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  parent: resourceSymbolicName
  properties: {
    admCredential: {
      properties: {
        authTokenUrl: 'string'
        clientId: 'string'
        clientSecret: 'string'
      }
    }
    apnsCredential: {
      properties: {
        apnsCertificate: 'string'
        certificateKey: 'string'
        endpoint: 'string'
        thumbprint: 'string'
      }
    }
    authorizationRules: [
      {
        rights: [
          'string'
        ]
      }
    ]
    baiduCredential: {
      properties: {
        baiduApiKey: 'string'
        baiduEndPoint: 'string'
        baiduSecretKey: 'string'
      }
    }
    gcmCredential: {
      properties: {
        gcmEndpoint: 'string'
        googleApiKey: 'string'
      }
    }
    mpnsCredential: {
      properties: {
        certificateKey: 'string'
        mpnsCertificate: 'string'
        thumbprint: 'string'
      }
    }
    name: 'string'
    registrationTtl: 'string'
    wnsCredential: {
      properties: {
        packageSid: 'string'
        secretKey: 'string'
        windowsLiveEndpoint: 'string'
      }
    }
  }
}

属性值

namespaces/notificationHubs

名称 说明
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。
字符串 (必需)

字符限制:1-260

有效字符:
字母数字、句点、连字符和下划线。

以字母数字开头。
location 资源位置 字符串 (必需)
标记 资源标记 标记名称和值的字典。 请参阅 模板中的标记
sku 创建的命名空间的 SKU Sku
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型为:命名空间的资源的符号名称
properties NotificationHub 的属性。 NotificationHubProperties (必需)

NotificationHubProperties

名称 说明
admCredential 创建的 NotificationHub 的 AdmCredential AdmCredential
apnsCredential 创建的 NotificationHub 的 ApnsCredential ApnsCredential
authorizationRules 创建的 NotificationHub 的 AuthorizationRules SharedAccessAuthorizationRuleProperties[]
baiduCredential 创建的 NotificationHub 的百度Credential 百度Credential
gcmCredential 创建的 NotificationHub 的 GcmCredential GcmCredential
mpnsCredential 创建的 NotificationHub 的 MpnsCredential MpnsCredential
name NotificationHub 名称。 字符串
registrationTtl 创建的 NotificationHub 的 RegistrationTtl 字符串
wnsCredential 创建的 NotificationHub 的 WnsCredential WnsCredential

AdmCredential

名称 说明
properties NotificationHub AdmCredential 的属性。 AdmCredentialProperties

AdmCredentialProperties

名称 说明
authTokenUrl 授权令牌的 URL。 字符串
clientId 客户端标识符。 字符串
clientSecret 凭据机密访问密钥。 字符串

ApnsCredential

名称 说明
properties NotificationHub ApnsCredential 的属性。 ApnsCredentialProperties

ApnsCredentialProperties

名称 说明
apnsCertificate APNS 证书。 字符串
certificateKey 证书密钥。 字符串
endpoint 此凭据的终结点。 字符串
thumbprint APNS 证书指纹 字符串

SharedAccessAuthorizationRuleProperties

名称 说明
权限 与规则关联的权限。 包含任意项的字符串数组:
“Listen”
“管理”
“Send”

百度Credential

名称 说明
properties NotificationHub BaiduCredential 的属性。 BaiduCredentialProperties

BaiduCredentialProperties

名称 说明
baiduApiKey 百度 API 密钥。 字符串
baiduEndPoint 百度终结点。 字符串
baiduSecretKey 百度密钥 字符串

GcmCredential

名称 说明
properties NotificationHub GcmCredential 的属性。 GcmCredentialProperties

GcmCredentialProperties

名称 说明
gcmEndpoint GCM 终结点。 字符串
googleApiKey Google API 密钥。 字符串

MpnsCredential

名称 说明
properties NotificationHub MpnsCredential 的属性。 MpnsCredentialProperties

MpnsCredentialProperties

名称 说明
certificateKey 此凭据的证书密钥。 字符串
mpnsCertificate MPNS 证书。 字符串
thumbprint MPNS 证书指纹 字符串

WnsCredential

名称 说明
properties NotificationHub WnsCredential 的属性。 WnsCredentialProperties

WnsCredentialProperties

名称 说明
packageSid 此凭据的包 ID。 字符串
secretKey 密钥。 字符串
windowsLiveEndpoint Windows Live 终结点。 字符串

SKU

名称 说明
容量 资源的容量 int
family SKU 系列 字符串
name 通知中心 SKU 的名称 “Basic”
“免费”
“标准” (必需)
大小 SKU 大小 字符串
特定 SKU 的层 字符串

快速入门模板

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

模板 说明
创建 Azure 通知中心

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

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

ARM 模板资源定义

命名空间/notificationHubs 资源类型可以通过针对以下操作进行部署:

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

资源格式

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

{
  "type": "Microsoft.NotificationHubs/namespaces/notificationHubs",
  "apiVersion": "2016-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "properties": {
    "admCredential": {
      "properties": {
        "authTokenUrl": "string",
        "clientId": "string",
        "clientSecret": "string"
      }
    },
    "apnsCredential": {
      "properties": {
        "apnsCertificate": "string",
        "certificateKey": "string",
        "endpoint": "string",
        "thumbprint": "string"
      }
    },
    "authorizationRules": [
      {
        "rights": [ "string" ]
      }
    ],
    "baiduCredential": {
      "properties": {
        "baiduApiKey": "string",
        "baiduEndPoint": "string",
        "baiduSecretKey": "string"
      }
    },
    "gcmCredential": {
      "properties": {
        "gcmEndpoint": "string",
        "googleApiKey": "string"
      }
    },
    "mpnsCredential": {
      "properties": {
        "certificateKey": "string",
        "mpnsCertificate": "string",
        "thumbprint": "string"
      }
    },
    "name": "string",
    "registrationTtl": "string",
    "wnsCredential": {
      "properties": {
        "packageSid": "string",
        "secretKey": "string",
        "windowsLiveEndpoint": "string"
      }
    }
  }
}

属性值

namespaces/notificationHubs

名称 说明 Value
type 资源类型 “Microsoft.NotificationHubs/namespaces/notificationHubs”
apiVersion 资源 API 版本 '2016-03-01'
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。
字符串 (必需)

字符限制:1-260

有效字符:
字母数字、句点、连字符和下划线。

以字母数字开头。
location 资源位置 字符串 (必需)
标记 资源标记 标记名称和值的字典。 请参阅 模板中的标记
sku 创建的命名空间的 SKU Sku
properties NotificationHub 的属性。 NotificationHubProperties (必需)

NotificationHubProperties

名称 说明
admCredential 创建的 NotificationHub 的 AdmCredential AdmCredential
apnsCredential 创建的 NotificationHub 的 ApnsCredential ApnsCredential
authorizationRules 创建的 NotificationHub 的 AuthorizationRules SharedAccessAuthorizationRuleProperties[]
baiduCredential 创建的 NotificationHub 的百度Credential 百度Credential
gcmCredential 创建的 NotificationHub 的 GcmCredential GcmCredential
mpnsCredential 创建的 NotificationHub 的 MpnsCredential MpnsCredential
name NotificationHub 名称。 字符串
registrationTtl 创建的 NotificationHub 的 RegistrationTtl 字符串
wnsCredential 创建的 NotificationHub 的 WnsCredential WnsCredential

AdmCredential

名称 说明
properties NotificationHub AdmCredential 的属性。 AdmCredentialProperties

AdmCredentialProperties

名称 说明
authTokenUrl 授权令牌的 URL。 字符串
clientId 客户端标识符。 字符串
clientSecret 凭据机密访问密钥。 字符串

ApnsCredential

名称 说明
properties NotificationHub ApnsCredential 的属性。 ApnsCredentialProperties

ApnsCredentialProperties

名称 说明
apnsCertificate APNS 证书。 字符串
certificateKey 证书密钥。 字符串
endpoint 此凭据的终结点。 字符串
thumbprint APNS 证书指纹 字符串

SharedAccessAuthorizationRuleProperties

名称 说明
权限 与规则关联的权限。 包含任何一项的字符串数组:
'Listen'
“管理”
'Send'

百度Credential

名称 说明
properties NotificationHub BaiduCredential 的属性。 BaiduCredentialProperties

BaiduCredentialProperties

名称 说明
baiduApiKey 百度 API 密钥。 字符串
baiduEndPoint 百度终结点。 字符串
baiduSecretKey 百度密钥 字符串

GcmCredential

名称 说明
properties NotificationHub GcmCredential 的属性。 GcmCredentialProperties

GcmCredentialProperties

名称 说明
gcmEndpoint GCM 终结点。 字符串
googleApiKey Google API 密钥。 字符串

MpnsCredential

名称 说明
properties NotificationHub MpnsCredential 的属性。 MpnsCredentialProperties

MpnsCredentialProperties

名称 说明
certificateKey 此凭据的证书密钥。 字符串
mpnsCertificate MPNS 证书。 字符串
thumbprint MPNS 证书指纹 字符串

WnsCredential

名称 说明
properties NotificationHub WnsCredential 的属性。 WnsCredentialProperties

WnsCredentialProperties

名称 说明
packageSid 此凭据的包 ID。 字符串
secretKey 密钥。 字符串
windowsLiveEndpoint Windows Live 终结点。 字符串

SKU

名称 说明
容量 资源的容量 int
family SKU 系列 字符串
name 通知中心 SKU 的名称 “Basic”
“免费”
“标准” (必需)
大小 SKU 大小 字符串
特定 SKU 的层 字符串

快速入门模板

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

模板 说明
创建 Azure 通知中心

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

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

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

命名空间/notificationHubs 资源类型可以通过针对以下操作进行部署:

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NotificationHubs/namespaces/notificationHubs@2016-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      admCredential = {
        properties = {
          authTokenUrl = "string"
          clientId = "string"
          clientSecret = "string"
        }
      }
      apnsCredential = {
        properties = {
          apnsCertificate = "string"
          certificateKey = "string"
          endpoint = "string"
          thumbprint = "string"
        }
      }
      authorizationRules = [
        {
          rights = [
            "string"
          ]
        }
      ]
      baiduCredential = {
        properties = {
          baiduApiKey = "string"
          baiduEndPoint = "string"
          baiduSecretKey = "string"
        }
      }
      gcmCredential = {
        properties = {
          gcmEndpoint = "string"
          googleApiKey = "string"
        }
      }
      mpnsCredential = {
        properties = {
          certificateKey = "string"
          mpnsCertificate = "string"
          thumbprint = "string"
        }
      }
      name = "string"
      registrationTtl = "string"
      wnsCredential = {
        properties = {
          packageSid = "string"
          secretKey = "string"
          windowsLiveEndpoint = "string"
        }
      }
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  })
}

属性值

namespaces/notificationHubs

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

字符限制:1-260

有效字符:
字母数字、句点、连字符和下划线。

以字母数字开头。
location 资源位置 字符串 (必需)
parent_id 此资源的父资源 ID。 类型为资源的 ID: 命名空间
标记 资源标记 标记名称和值的字典。
sku 创建的命名空间的 SKU Sku
properties NotificationHub 的属性。 NotificationHubProperties (必需)

NotificationHubProperties

名称 说明
admCredential 创建的 NotificationHub 的 AdmCredential AdmCredential
apnsCredential 创建的 NotificationHub 的 ApnsCredential ApnsCredential
authorizationRules 创建的 NotificationHub 的 AuthorizationRules SharedAccessAuthorizationRuleProperties[]
baiduCredential 创建的 NotificationHub 的百度Credential 百度Credential
gcmCredential 创建的 NotificationHub 的 GcmCredential GcmCredential
mpnsCredential 创建的 NotificationHub 的 MpnsCredential MpnsCredential
name NotificationHub 名称。 字符串
registrationTtl 创建的 NotificationHub 的 RegistrationTtl 字符串
wnsCredential 创建的 NotificationHub 的 WnsCredential WnsCredential

AdmCredential

名称 说明
properties NotificationHub AdmCredential 的属性。 AdmCredentialProperties

AdmCredentialProperties

名称 说明
authTokenUrl 授权令牌的 URL。 字符串
clientId 客户端标识符。 字符串
clientSecret 凭据机密访问密钥。 字符串

ApnsCredential

名称 说明
properties NotificationHub ApnsCredential 的属性。 ApnsCredentialProperties

ApnsCredentialProperties

名称 说明
apnsCertificate APNS 证书。 字符串
certificateKey 证书密钥。 字符串
endpoint 此凭据的终结点。 字符串
thumbprint APNS 证书指纹 字符串

SharedAccessAuthorizationRuleProperties

名称 说明
权限 与规则关联的权限。 包含任意项的字符串数组:
“Listen”
“管理”
“Send”

百度Credential

名称 说明
properties NotificationHub BaiduCredential 的属性。 BaiduCredentialProperties

BaiduCredentialProperties

名称 说明
baiduApiKey 百度 API 密钥。 字符串
baiduEndPoint 百度终结点。 字符串
baiduSecretKey 百度密钥 字符串

GcmCredential

名称 说明
properties NotificationHub GcmCredential 的属性。 GcmCredentialProperties

GcmCredentialProperties

名称 说明
gcmEndpoint GCM 终结点。 字符串
googleApiKey Google API 密钥。 字符串

MpnsCredential

名称 说明
properties NotificationHub MpnsCredential 的属性。 MpnsCredentialProperties

MpnsCredentialProperties

名称 说明
certificateKey 此凭据的证书密钥。 字符串
mpnsCertificate MPNS 证书。 字符串
thumbprint MPNS 证书指纹 字符串

WnsCredential

名称 说明
properties NotificationHub WnsCredential 的属性。 WnsCredentialProperties

WnsCredentialProperties

名称 说明
packageSid 此凭据的包 ID。 字符串
secretKey 密钥。 字符串
windowsLiveEndpoint Windows Live 终结点。 字符串

SKU

名称 说明
容量 资源的容量 int
family SKU 系列 字符串
name 通知中心 SKU 的名称 "Basic"
"Free"
“标准” (必需)
大小 SKU 大小 字符串
特定 SKU 的层 字符串