Microsoft.NotificationHubs 命名空間 2023-01-01-preview
Bicep 資源定義
命名空間資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.NotificationHubs/namespaces 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.NotificationHubs/namespaces@2023-01-01-preview' = {
location: 'string'
name: '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'
}
}
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'
}
tags: {
{customized property}: 'string'
}
}
屬性值
AdmCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub AdmCredential 的描述。 | AdmCredentialProperties （必要） |
AdmCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| authTokenUrl | 取得或設定授權令牌的 URL。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| clientId | 取得或設定用戶端識別碼。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| clientSecret | 取得或設定認證秘密存取金鑰。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
ApnsCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub ApnsCredential 的描述。 | ApnsCredentialProperties （必要） |
ApnsCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| apnsCertificate | 取得或設定APNS憑證。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| appId | 取得或設定簽發者 （iss） 已註冊的宣告金鑰，其值為 您從開發人員帳戶取得的 10 個字元小組識別碼 |
字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| appName | 取得或設定應用程式的名稱 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| certificateKey | 取得或設定憑證金鑰。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| 端點 | 取得或設定這個認證的端點。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| keyId | 取得或設定從取得的 10 個字元金鑰識別碼 （kid） 金鑰 您的開發人員帳戶 |
字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| 指紋 | 取得或設定APNS憑證指紋 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| 令牌 | 取得或設定透過您取得的提供者驗證令牌 開發人員帳戶 |
字串 約束： 敏感性值。 以安全參數的形式傳入。 |
百度Credential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub BaiduCredential 的描述。 | 百度CredentialProperties （必要） |
BaiduCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| baiduApiKey | 取得或設定百度 API 金鑰。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| baiduEndPoint | 取得或設定百度端點。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| baiduSecretKey | 取得或設定百度秘密金鑰 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
BrowserCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub BrowserCredential 的描述。 | BrowserCredentialProperties （必要） |
BrowserCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 主題 | 取得或設定 Web 推送主旨。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| vapidPrivateKey | 取得或設定 VAPID 私鑰。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| vapidPublicKey | 取得或設定 VAPID 公鑰。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
GcmCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub GcmCredential 的描述。 | GcmCredentialProperties （必要） |
GcmCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| gcmEndpoint | 取得或設定 GCM 端點。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| googleApiKey | 取得或設定Google API 金鑰。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
IpRule
| 名字 | 描述 | 價值 |
|---|---|---|
| ipMask | IP 遮罩。 | 字串 約束： 最小長度 = 1 （必要） |
| 權利 | 訪問許可權清單。 | 包含任何的字串數組： 'Listen' 'Manage' 'Send' （必要） |
Microsoft.NotificationHubs/namespaces
| 名字 | 描述 | 價值 |
|---|---|---|
| 位置 | 資源所在的地理位置 | 字串 （必要） |
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^[a-zA-Z][a-zA-Z0-9-]*$ （必要） |
| 性能 | 表示命名空間屬性。 | NamespaceProperties |
| sku | 命名空間的 Sku 描述 | Sku （必要） |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
MpnsCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub MpnsCredential 的描述。 | MpnsCredentialProperties （必要） |
MpnsCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| certificateKey | 取得或設定此認證的憑證金鑰。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| mpnsCertificate | 取得或設定 MPNS 憑證。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| 指紋 | 取得或設定 MPNS 憑證指紋 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
NamespaceProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| dataCenter | 荒廢的。 | 字串 |
| namespaceType | 定義 NamespaceType 的值。 | 'Messaging' 'NotificationHub' |
| networkAcls | 網路授權規則的集合。 | NetworkAcls |
| pnsCredentials | 通知中樞或通知中樞命名空間 PNS 認證的集合。 | PnsCredentials |
| provisioningState | 定義 OperationProvisioningState 的值。 | 'Canceled' 'Disabled' 'Failed' 'InProgress' 'Pending' 'Succeeded' 'Unknown' |
| publicNetworkAccess | 公用網路存取的類型。 | 'Disabled' 'Enabled' |
| replicationRegion | 允許的復寫區域 | 'AustraliaEast' 'BrazilSouth' 'Default' 'None' 'NorthEurope' 'SouthAfricaNorth' 'SouthEastAsia' 'WestUs2' |
| scaleUnit | 取得或設定建立命名空間的 scaleUnit | 字串 |
| 地位 | 命名空間狀態。 | 'Created' 'Creating' '刪除' 'Suspended' |
| zoneRedundancy | 命名空間 SKU 名稱。 | 'Disabled' 'Enabled' |
NetworkAcls
| 名字 | 描述 | 價值 |
|---|---|---|
| ipRules | IP 規則清單。 | IpRule[] |
| publicNetworkRule | 默認（公用因特網）網路授權規則，如果沒有任何其他網路規則相符，則包含許可權。 | PublicInternetAuthorizationRule |
PnsCredentials
| 名字 | 描述 | 價值 |
|---|---|---|
| admCredential | NotificationHub AdmCredential 的描述。 | AdmCredential |
| apnsCredential | NotificationHub ApnsCredential 的描述。 | ApnsCredential |
| baiduCredential | NotificationHub BaiduCredential 的描述。 | 百度Credential |
| browserCredential | NotificationHub BrowserCredential 的描述。 | BrowserCredential |
| gcmCredential | NotificationHub GcmCredential 的描述。 | GcmCredential |
| mpnsCredential | NotificationHub MpnsCredential 的描述。 | MpnsCredential |
| wnsCredential | NotificationHub WnsCredential 的描述。 | WnsCredential |
| xiaomiCredential | NotificationHub 小米Credential 的描述。 | 小米Credential |
PublicInternetAuthorizationRule
| 名字 | 描述 | 價值 |
|---|---|---|
| 權利 | 訪問許可權清單。 | 包含任何的字串數組： 'Listen' 'Manage' 'Send' （必要） |
Sku
| 名字 | 描述 | 價值 |
|---|---|---|
| 能力 | 取得或設定資源的容量 | int |
| 家庭 | 取得或設定 Sku 系列 | 字串 |
| 名字 | 命名空間 SKU 名稱。 | 'Basic' 'Free' 'Standard' （必要） |
| 大小 | 取得或設定 Sku 大小 | 字串 |
| 層 | 取得或設定特定 SKU 的階層 | 字串 |
TrackedResourceTags
| 名字 | 描述 | 價值 |
|---|
WnsCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub WnsCredential 的描述。 | WnsCredentialProperties （必要） |
WnsCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| certificateKey | Ges 或設定 WNS 憑證金鑰。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| packageSid | 取得或設定這個認證的套件標識碼。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| secretKey | 取得或設定秘密金鑰。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| windowsLiveEndpoint | 取得或設定 Windows Live 端點。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| wnsCertificate | 取得或設定 WNS 憑證。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
小米Credential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub 小米CredentialProperties 的描述。 | 小米CredentialProperties （必要） |
XiaomiCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| appSecret | 取得或設定應用程式秘密。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| 端點 | 取得或設定小米服務端點。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
快速入門範例
下列快速入門範例會部署此資源類型。
| Bicep 檔案 | 描述 |
|---|---|
| 建立 Azure 通知中樞 | 建立最初由John Downs 撰寫的 Azure 通知中樞範本。 |
ARM 樣本資源定義
命名空間資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.NotificationHubs/namespaces 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.NotificationHubs/namespaces",
"apiVersion": "2023-01-01-preview",
"name": "string",
"location": "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"
}
},
"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"
},
"tags": {
"{customized property}": "string"
}
}
屬性值
AdmCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub AdmCredential 的描述。 | AdmCredentialProperties （必要） |
AdmCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| authTokenUrl | 取得或設定授權令牌的 URL。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| clientId | 取得或設定用戶端識別碼。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| clientSecret | 取得或設定認證秘密存取金鑰。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
ApnsCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub ApnsCredential 的描述。 | ApnsCredentialProperties （必要） |
ApnsCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| apnsCertificate | 取得或設定APNS憑證。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| appId | 取得或設定簽發者 （iss） 已註冊的宣告金鑰，其值為 您從開發人員帳戶取得的 10 個字元小組識別碼 |
字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| appName | 取得或設定應用程式的名稱 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| certificateKey | 取得或設定憑證金鑰。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| 端點 | 取得或設定這個認證的端點。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| keyId | 取得或設定從取得的 10 個字元金鑰識別碼 （kid） 金鑰 您的開發人員帳戶 |
字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| 指紋 | 取得或設定APNS憑證指紋 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| 令牌 | 取得或設定透過您取得的提供者驗證令牌 開發人員帳戶 |
字串 約束： 敏感性值。 以安全參數的形式傳入。 |
百度Credential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub BaiduCredential 的描述。 | 百度CredentialProperties （必要） |
BaiduCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| baiduApiKey | 取得或設定百度 API 金鑰。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| baiduEndPoint | 取得或設定百度端點。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| baiduSecretKey | 取得或設定百度秘密金鑰 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
BrowserCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub BrowserCredential 的描述。 | BrowserCredentialProperties （必要） |
BrowserCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 主題 | 取得或設定 Web 推送主旨。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| vapidPrivateKey | 取得或設定 VAPID 私鑰。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| vapidPublicKey | 取得或設定 VAPID 公鑰。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
GcmCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub GcmCredential 的描述。 | GcmCredentialProperties （必要） |
GcmCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| gcmEndpoint | 取得或設定 GCM 端點。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| googleApiKey | 取得或設定Google API 金鑰。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
IpRule
| 名字 | 描述 | 價值 |
|---|---|---|
| ipMask | IP 遮罩。 | 字串 約束： 最小長度 = 1 （必要） |
| 權利 | 訪問許可權清單。 | 包含任何的字串數組： 'Listen' 'Manage' 'Send' （必要） |
Microsoft.NotificationHubs/namespaces
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2023-01-01-preview' |
| 位置 | 資源所在的地理位置 | 字串 （必要） |
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^[a-zA-Z][a-zA-Z0-9-]*$ （必要） |
| 性能 | 表示命名空間屬性。 | NamespaceProperties |
| sku | 命名空間的 Sku 描述 | Sku （必要） |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
| 類型 | 資源類型 | 'Microsoft.NotificationHubs/namespaces' |
MpnsCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub MpnsCredential 的描述。 | MpnsCredentialProperties （必要） |
MpnsCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| certificateKey | 取得或設定此認證的憑證金鑰。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| mpnsCertificate | 取得或設定 MPNS 憑證。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| 指紋 | 取得或設定 MPNS 憑證指紋 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
NamespaceProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| dataCenter | 荒廢的。 | 字串 |
| namespaceType | 定義 NamespaceType 的值。 | 'Messaging' 'NotificationHub' |
| networkAcls | 網路授權規則的集合。 | NetworkAcls |
| pnsCredentials | 通知中樞或通知中樞命名空間 PNS 認證的集合。 | PnsCredentials |
| provisioningState | 定義 OperationProvisioningState 的值。 | 'Canceled' 'Disabled' 'Failed' 'InProgress' 'Pending' 'Succeeded' 'Unknown' |
| publicNetworkAccess | 公用網路存取的類型。 | 'Disabled' 'Enabled' |
| replicationRegion | 允許的復寫區域 | 'AustraliaEast' 'BrazilSouth' 'Default' 'None' 'NorthEurope' 'SouthAfricaNorth' 'SouthEastAsia' 'WestUs2' |
| scaleUnit | 取得或設定建立命名空間的 scaleUnit | 字串 |
| 地位 | 命名空間狀態。 | 'Created' 'Creating' '刪除' 'Suspended' |
| zoneRedundancy | 命名空間 SKU 名稱。 | 'Disabled' 'Enabled' |
NetworkAcls
| 名字 | 描述 | 價值 |
|---|---|---|
| ipRules | IP 規則清單。 | IpRule[] |
| publicNetworkRule | 默認（公用因特網）網路授權規則，如果沒有任何其他網路規則相符，則包含許可權。 | PublicInternetAuthorizationRule |
PnsCredentials
| 名字 | 描述 | 價值 |
|---|---|---|
| admCredential | NotificationHub AdmCredential 的描述。 | AdmCredential |
| apnsCredential | NotificationHub ApnsCredential 的描述。 | ApnsCredential |
| baiduCredential | NotificationHub BaiduCredential 的描述。 | 百度Credential |
| browserCredential | NotificationHub BrowserCredential 的描述。 | BrowserCredential |
| gcmCredential | NotificationHub GcmCredential 的描述。 | GcmCredential |
| mpnsCredential | NotificationHub MpnsCredential 的描述。 | MpnsCredential |
| wnsCredential | NotificationHub WnsCredential 的描述。 | WnsCredential |
| xiaomiCredential | NotificationHub 小米Credential 的描述。 | 小米Credential |
PublicInternetAuthorizationRule
| 名字 | 描述 | 價值 |
|---|---|---|
| 權利 | 訪問許可權清單。 | 包含任何的字串數組： 'Listen' 'Manage' 'Send' （必要） |
Sku
| 名字 | 描述 | 價值 |
|---|---|---|
| 能力 | 取得或設定資源的容量 | int |
| 家庭 | 取得或設定 Sku 系列 | 字串 |
| 名字 | 命名空間 SKU 名稱。 | 'Basic' 'Free' 'Standard' （必要） |
| 大小 | 取得或設定 Sku 大小 | 字串 |
| 層 | 取得或設定特定 SKU 的階層 | 字串 |
TrackedResourceTags
| 名字 | 描述 | 價值 |
|---|
WnsCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub WnsCredential 的描述。 | WnsCredentialProperties （必要） |
WnsCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| certificateKey | Ges 或設定 WNS 憑證金鑰。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| packageSid | 取得或設定這個認證的套件標識碼。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| secretKey | 取得或設定秘密金鑰。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| windowsLiveEndpoint | 取得或設定 Windows Live 端點。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| wnsCertificate | 取得或設定 WNS 憑證。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
小米Credential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub 小米CredentialProperties 的描述。 | 小米CredentialProperties （必要） |
XiaomiCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| appSecret | 取得或設定應用程式秘密。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| 端點 | 取得或設定小米服務端點。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
建立 Azure 通知中樞
|
建立最初由John Downs 撰寫的 Azure 通知中樞範本。 |
|
使用 SQL Database 布建行動應用程式
|
此範本會布建行動應用程式、SQL Database 和通知中樞。 它會在資料庫和通知中樞的行動應用程式中設定連接字串。 |
Terraform （AzAPI 提供者） 資源定義
命名空間資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.NotificationHubs/namespaces 資源，請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.NotificationHubs/namespaces@2023-01-01-preview"
name = "string"
location = "string"
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
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"
}
}
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"
}
})
}
屬性值
AdmCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub AdmCredential 的描述。 | AdmCredentialProperties （必要） |
AdmCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| authTokenUrl | 取得或設定授權令牌的 URL。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| clientId | 取得或設定用戶端識別碼。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| clientSecret | 取得或設定認證秘密存取金鑰。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
ApnsCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub ApnsCredential 的描述。 | ApnsCredentialProperties （必要） |
ApnsCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| apnsCertificate | 取得或設定APNS憑證。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| appId | 取得或設定簽發者 （iss） 已註冊的宣告金鑰，其值為 您從開發人員帳戶取得的 10 個字元小組識別碼 |
字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| appName | 取得或設定應用程式的名稱 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| certificateKey | 取得或設定憑證金鑰。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| 端點 | 取得或設定這個認證的端點。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| keyId | 取得或設定從取得的 10 個字元金鑰識別碼 （kid） 金鑰 您的開發人員帳戶 |
字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| 指紋 | 取得或設定APNS憑證指紋 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| 令牌 | 取得或設定透過您取得的提供者驗證令牌 開發人員帳戶 |
字串 約束： 敏感性值。 以安全參數的形式傳入。 |
百度Credential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub BaiduCredential 的描述。 | 百度CredentialProperties （必要） |
BaiduCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| baiduApiKey | 取得或設定百度 API 金鑰。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| baiduEndPoint | 取得或設定百度端點。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| baiduSecretKey | 取得或設定百度秘密金鑰 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
BrowserCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub BrowserCredential 的描述。 | BrowserCredentialProperties （必要） |
BrowserCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 主題 | 取得或設定 Web 推送主旨。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| vapidPrivateKey | 取得或設定 VAPID 私鑰。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| vapidPublicKey | 取得或設定 VAPID 公鑰。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
GcmCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub GcmCredential 的描述。 | GcmCredentialProperties （必要） |
GcmCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| gcmEndpoint | 取得或設定 GCM 端點。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| googleApiKey | 取得或設定Google API 金鑰。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
IpRule
| 名字 | 描述 | 價值 |
|---|---|---|
| ipMask | IP 遮罩。 | 字串 約束： 最小長度 = 1 （必要） |
| 權利 | 訪問許可權清單。 | 包含任何的字串數組： 'Listen' 'Manage' 'Send' （必要） |
Microsoft.NotificationHubs/namespaces
| 名字 | 描述 | 價值 |
|---|---|---|
| 位置 | 資源所在的地理位置 | 字串 （必要） |
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^[a-zA-Z][a-zA-Z0-9-]*$ （必要） |
| 性能 | 表示命名空間屬性。 | NamespaceProperties |
| sku | 命名空間的 Sku 描述 | Sku （必要） |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 |
| 類型 | 資源類型 | “Microsoft.NotificationHubs/namespaces@2023-01-01-preview” |
MpnsCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub MpnsCredential 的描述。 | MpnsCredentialProperties （必要） |
MpnsCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| certificateKey | 取得或設定此認證的憑證金鑰。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| mpnsCertificate | 取得或設定 MPNS 憑證。 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
| 指紋 | 取得或設定 MPNS 憑證指紋 | 字串 約束： 最小長度 = 1 敏感性值。 以安全參數的形式傳入。 （必要） |
NamespaceProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| dataCenter | 荒廢的。 | 字串 |
| namespaceType | 定義 NamespaceType 的值。 | 'Messaging' 'NotificationHub' |
| networkAcls | 網路授權規則的集合。 | NetworkAcls |
| pnsCredentials | 通知中樞或通知中樞命名空間 PNS 認證的集合。 | PnsCredentials |
| provisioningState | 定義 OperationProvisioningState 的值。 | 'Canceled' 'Disabled' 'Failed' 'InProgress' 'Pending' 'Succeeded' 'Unknown' |
| publicNetworkAccess | 公用網路存取的類型。 | 'Disabled' 'Enabled' |
| replicationRegion | 允許的復寫區域 | 'AustraliaEast' 'BrazilSouth' 'Default' 'None' 'NorthEurope' 'SouthAfricaNorth' 'SouthEastAsia' 'WestUs2' |
| scaleUnit | 取得或設定建立命名空間的 scaleUnit | 字串 |
| 地位 | 命名空間狀態。 | 'Created' 'Creating' '刪除' 'Suspended' |
| zoneRedundancy | 命名空間 SKU 名稱。 | 'Disabled' 'Enabled' |
NetworkAcls
| 名字 | 描述 | 價值 |
|---|---|---|
| ipRules | IP 規則清單。 | IpRule[] |
| publicNetworkRule | 默認（公用因特網）網路授權規則，如果沒有任何其他網路規則相符，則包含許可權。 | PublicInternetAuthorizationRule |
PnsCredentials
| 名字 | 描述 | 價值 |
|---|---|---|
| admCredential | NotificationHub AdmCredential 的描述。 | AdmCredential |
| apnsCredential | NotificationHub ApnsCredential 的描述。 | ApnsCredential |
| baiduCredential | NotificationHub BaiduCredential 的描述。 | 百度Credential |
| browserCredential | NotificationHub BrowserCredential 的描述。 | BrowserCredential |
| gcmCredential | NotificationHub GcmCredential 的描述。 | GcmCredential |
| mpnsCredential | NotificationHub MpnsCredential 的描述。 | MpnsCredential |
| wnsCredential | NotificationHub WnsCredential 的描述。 | WnsCredential |
| xiaomiCredential | NotificationHub 小米Credential 的描述。 | 小米Credential |
PublicInternetAuthorizationRule
| 名字 | 描述 | 價值 |
|---|---|---|
| 權利 | 訪問許可權清單。 | 包含任何的字串數組： 'Listen' 'Manage' 'Send' （必要） |
Sku
| 名字 | 描述 | 價值 |
|---|---|---|
| 能力 | 取得或設定資源的容量 | int |
| 家庭 | 取得或設定 Sku 系列 | 字串 |
| 名字 | 命名空間 SKU 名稱。 | 'Basic' 'Free' 'Standard' （必要） |
| 大小 | 取得或設定 Sku 大小 | 字串 |
| 層 | 取得或設定特定 SKU 的階層 | 字串 |
TrackedResourceTags
| 名字 | 描述 | 價值 |
|---|
WnsCredential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub WnsCredential 的描述。 | WnsCredentialProperties （必要） |
WnsCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| certificateKey | Ges 或設定 WNS 憑證金鑰。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| packageSid | 取得或設定這個認證的套件標識碼。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| secretKey | 取得或設定秘密金鑰。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| windowsLiveEndpoint | 取得或設定 Windows Live 端點。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| wnsCertificate | 取得或設定 WNS 憑證。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
小米Credential
| 名字 | 描述 | 價值 |
|---|---|---|
| 性能 | NotificationHub 小米CredentialProperties 的描述。 | 小米CredentialProperties （必要） |
XiaomiCredentialProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| appSecret | 取得或設定應用程式秘密。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |
| 端點 | 取得或設定小米服務端點。 | 字串 約束： 敏感性值。 以安全參數的形式傳入。 |