共用方式為


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'
  }
}

屬性值

命名空間

名稱 描述
NAME 資源名稱 需要字串 ()

字元限制:6-50

合法字元:
英數字元和連字號

以字母開頭。 以英數字元結尾。

資源名稱在整個 Azure 中必須是唯一的。
location 資源所在的地理位置 需要字串 ()
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標籤
sku 命名空間的 Sku 描述 需要sku ()
properties 表示命名空間屬性。 NamespaceProperties

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 字串
status 命名空間狀態。 'Created'
'Creating'
'刪除'
'Suspended'
zoneRedundancy 命名空間 SKU 名稱。 'Disabled'
'Enabled'

NetworkAcls

名稱 描述
ipRules IP 規則清單。 IpRule[]
publicNetworkRule 默認 (公用因特網) 網路授權規則,其中包含沒有其他網路規則相符的許可權。 PublicInternetAuthorizationRule

IpRule

名稱 描述
ipMask IP 遮罩。 需要字串 ()

約束:
最小長度 = 1
權限 訪問許可權清單。 包含任何項目的字串數組:
'Listen'
'Manage'
需要 『Send』 ()

PublicInternetAuthorizationRule

名稱 描述
權限 訪問許可權清單。 包含任何項目的字串數組:
'Listen'
'Manage'
需要 『Send』 ()

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
一元元 NotificationHub 一層的 DescriptionmiCredential。 一體式

AdmCredential

名稱 描述
properties NotificationHub AdmCredential 的描述。 必要) AdmCredentialProperties (

AdmCredentialProperties

名稱 描述
authTokenUrl 取得或設定授權令牌的 URL。 需要字串 ()

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
clientId 取得或設定用戶端識別碼。 需要字串 ()

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
clientSecret 取得或設定認證秘密存取金鑰。 需要字串 ()

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。

ApnsCredential

名稱 描述
properties NotificationHub ApnsCredential 的描述。 ApnsCredentialProperties (必要)

ApnsCredentialProperties

名稱 描述
apnsCertificate 取得或設定APNS憑證。 字串

約束:
敏感性值。 以安全參數的形式傳入。
appId 取得或設定簽發者 (是) 註冊的宣告密鑰,其值為
從開發人員帳戶取得的10個字元小組標識碼
字串

約束:
敏感性值。 以安全參數的形式傳入。
appName 取得或設定應用程式的名稱 字串

約束:
敏感性值。 以安全參數的形式傳入。
certificateKey 取得或設定憑證金鑰。 字串

約束:
敏感性值。 以安全參數的形式傳入。
端點 取得或設定這個認證的端點。 需要字串 ()

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
keyId 取得或設定從取得的 10 個字元金鑰標識碼, (兒童) 金鑰
您的開發人員帳戶
字串

約束:
敏感性值。 以安全參數的形式傳入。
thumbprint 取得或設定APNS憑證指紋 字串

約束:
敏感性值。 以安全參數的形式傳入。
token 取得或設定透過您的取得的提供者驗證令牌
開發人員帳戶
字串

約束:
敏感性值。 以安全參數的形式傳入。

百度Credential

名稱 描述
properties NotificationHub BaiduCredential 的描述。 需要百度CredentialProperties ()

百度CredentialProperties

名稱 描述
百度ApiKey 取得或設定百度 API 金鑰。 需要字串 ()

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
百度EndPoint 取得或設定百度端點。 需要字串 ()

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
baiduSecretKey 取得或設定百度秘密金鑰 需要字串 ()

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。

BrowserCredential

名稱 描述
properties NotificationHub BrowserCredential 的描述。 BrowserCredentialProperties (必要)

BrowserCredentialProperties

名稱 描述
主旨 取得或設定 Web 推送主旨。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
vapidPrivateKey 取得或設定 VAPID 私鑰。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
vapidPublicKey 取得或設定 VAPID 公鑰。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。

FcmV1Credential

名稱 描述
properties NotificationHub FcmV1Credential 的描述。 FcmV1CredentialProperties (必要)

FcmV1CredentialProperties

名稱 描述
clientEmail 取得或設定用戶端電子郵件。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
privateKey 取得或設定私鑰。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
projectId 取得或設定專案標識碼。 字串 (必要)

約束:
最小長度 = 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 取得或設定此認證的套件識別碼。 字串

約束:
敏感性值。 以安全參數的形式傳入。
secretKey 取得或設定秘密金鑰。 字串

約束:
敏感性值。 以安全參數的形式傳入。
windowsLiveEndpoint 取得或設定 Windows Live 端點。 字串

約束:
敏感性值。 以安全參數的形式傳入。
wnsCertificate 取得或設定 WNS 憑證。 字串

約束:
敏感性值。 以安全參數的形式傳入。

一體式

名稱 描述
properties NotificationHub ExplorermiCredentialProperties 的描述。 ) 所需的 (, (

StructuremiCredentialProperties

名稱 描述
appSecret 取得或設定應用程式秘密。 字串

約束:
敏感性值。 以安全參數的形式傳入。
端點 取得或設定程式碼服務端點。 字串

約束:
敏感性值。 以安全參數的形式傳入。

SKU

名稱 描述
處理能力 取得或設定資源的容量 int
family 取得或設定 Sku 系列 字串
NAME 命名空間 SKU 名稱。 'Basic'
'Free'
必要) 的「標準」 (
{1}size{2} 取得或設定 SKU 大小 字串
tier 取得或設定特定 SKU 的層 字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
建立 Azure 通知中樞

部署至 Azure
建立最初由John Downs 撰寫的 Azure 通知中樞範本。
使用 SQL Database 布建行動應用程式

部署至 Azure
此範本會布建行動應用程式、SQL Database和通知中樞。 它會在資料庫和通知中樞的行動應用程式中設定 連接字串。

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"
  }
}

屬性值

命名空間

名稱 描述
類型 資源類型 'Microsoft.NotificationHubs/namespaces'
apiVersion 資源 API 版本 '2023-10-01-preview'
NAME 資源名稱 需要字串 ()

字元限制:6-50

合法字元:
英數字元和連字號

以字母開頭。 以英數字元結尾。

資源名稱在整個 Azure 中必須是唯一的。
location 資源所在的地理位置 需要字串 ()
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標籤
sku 命名空間的 Sku 描述 需要sku ()
properties 表示命名空間屬性。 NamespaceProperties

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 字串
status 命名空間狀態。 'Created'
'Creating'
'刪除'
'Suspended'
zoneRedundancy 命名空間 SKU 名稱。 'Disabled'
'Enabled'

NetworkAcls

名稱 描述
ipRules IP 規則清單。 IpRule[]
publicNetworkRule 默認 (公用因特網) 網路授權規則,其中包含沒有其他網路規則相符的許可權。 PublicInternetAuthorizationRule

IpRule

名稱 描述
ipMask IP 遮罩。 需要字串 ()

約束:
最小長度 = 1
權限 訪問許可權清單。 包含任何項目的字串數組:
'Listen'
'Manage'
需要 『Send』 ()

PublicInternetAuthorizationRule

名稱 描述
權限 訪問許可權清單。 包含任何項目的字串數組:
'Listen'
'Manage'
需要 『Send』 ()

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
一元元 NotificationHub 一層的 DescriptionmiCredential。 一體式

AdmCredential

名稱 描述
properties NotificationHub AdmCredential 的描述。 必要) AdmCredentialProperties (

AdmCredentialProperties

名稱 描述
authTokenUrl 取得或設定授權令牌的 URL。 需要字串 ()

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
clientId 取得或設定用戶端識別碼。 需要字串 ()

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
clientSecret 取得或設定認證秘密存取金鑰。 需要字串 ()

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。

ApnsCredential

名稱 描述
properties NotificationHub ApnsCredential 的描述。 ApnsCredentialProperties (必要)

ApnsCredentialProperties

名稱 描述
apnsCertificate 取得或設定APNS憑證。 字串

約束:
敏感性值。 以安全參數的形式傳入。
appId 取得或設定簽發者 () 註冊的宣告密鑰,其值為
從開發人員帳戶取得的10個字元小組標識碼
字串

約束:
敏感性值。 以安全參數的形式傳入。
appName 取得或設定應用程式的名稱 字串

約束:
敏感性值。 以安全參數的形式傳入。
certificateKey 取得或設定憑證金鑰。 字串

約束:
敏感性值。 以安全參數的形式傳入。
端點 取得或設定這個認證的端點。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
keyId 取得或設定從取得 (兒童) 金鑰的 10 個字元金鑰標識碼
您的開發人員帳戶
字串

約束:
敏感性值。 以安全參數的形式傳入。
thumbprint 取得或設定APNS憑證指紋 字串

約束:
敏感性值。 以安全參數的形式傳入。
token 取得或設定透過您的取得提供者驗證令牌
開發人員帳戶
字串

約束:
敏感性值。 以安全參數的形式傳入。

百度Credential

名稱 描述
properties NotificationHub BaiduCredential 的描述。 需要百度CredentialProperties ()

百度CredentialProperties

名稱 描述
baiduApiKey 取得或設定百度 API 金鑰。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
baiduEndPoint 取得或設定百度端點。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
baiduSecretKey 取得或設定百度秘密金鑰 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。

BrowserCredential

名稱 描述
properties NotificationHub BrowserCredential 的描述。 BrowserCredentialProperties (必要)

BrowserCredentialProperties

名稱 描述
主旨 取得或設定 Web 推送主旨。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
vapidPrivateKey 取得或設定 VAPID 私鑰。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
vapidPublicKey 取得或設定 VAPID 公鑰。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。

FcmV1Credential

名稱 描述
properties NotificationHub FcmV1Credential 的描述。 FcmV1CredentialProperties (必要)

FcmV1CredentialProperties

名稱 描述
clientEmail 取得或設定用戶端電子郵件。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
privateKey 取得或設定私鑰。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
projectId 取得或設定專案標識碼。 字串 (必要)

約束:
最小長度 = 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 取得或設定此認證的封裝標識碼。 字串

約束:
敏感性值。 以安全參數的形式傳入。
secretKey 取得或設定秘密金鑰。 字串

約束:
敏感性值。 以安全參數的形式傳入。
windowsLiveEndpoint 取得或設定 Windows Live 端點。 字串

約束:
敏感性值。 以安全參數的形式傳入。
wnsCertificate 取得或設定 WNS 憑證。 字串

約束:
敏感性值。 以安全參數的形式傳入。

一體式

名稱 描述
properties NotificationHub 一個通知中樞的一個描述CredentialProperties。 RequiredmiCredentialProperties (必要)

一元二元屬性

名稱 描述
appSecret 取得或設定應用程式秘密。 字串

約束:
敏感性值。 以安全參數的形式傳入。
端點 取得或設定程式碼服務端點。 字串

約束:
敏感性值。 以安全參數的形式傳入。

SKU

名稱 描述
處理能力 取得或設定資源的容量 int
family 取得或設定 Sku 系列 字串
NAME 命名空間 SKU 名稱。 'Basic'
'Free'
「標準」 (必要)
{1}size{2} 取得或設定 Sku 大小 字串
tier 取得或設定特定 SKU 的階層 字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
建立 Azure 通知中樞

部署至 Azure
建立最初由John Downs 撰寫的 Azure 通知中樞範本。
使用 SQL Database 布建行動應用程式

部署至 Azure
此範本會布建行動應用程式、SQL Database和通知中樞。 它會在資料庫和通知中樞的行動應用程式中設定 連接字串。

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"
    }
  })
}

屬性值

命名空間

名稱 描述
類型 資源類型 “Microsoft.NotificationHubs/namespaces@2023-10-01-preview”
NAME 資源名稱 字串 (必要)

字元限制:6-50

合法字元:
英數字元和連字號

以字母開頭。 以英數字元結尾。

資源名稱在 Azure 中必須是唯一的。
location 資源所在的地理位置 字串 (必要)
parent_id 若要部署至資源群組,請使用該資源群組的標識碼。 字串 (必要)
tags 資源標籤。 標記名稱和值的字典。
sku 命名空間的 SKU 描述 需要sku ()
properties 表示命名空間屬性。 NamespaceProperties

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 字串
status 命名空間狀態。 “Created”
“建立”
“刪除”
“Suspended”
zoneRedundancy 命名空間 SKU 名稱。 “Disabled”
“Enabled”

NetworkAcls

名稱 描述
ipRules IP 規則清單。 IpRule[]
publicNetworkRule 默認 (公用因特網) 網路授權規則,其中包含沒有其他網路規則相符的許可權。 PublicInternetAuthorizationRule

IpRule

名稱 描述
ipMask IP 遮罩。 需要字串 ()

約束:
最小長度 = 1
權限 訪問許可權清單。 包含任何項目的字串數組:
“Listen”
“管理”
“Send” (必要)

PublicInternetAuthorizationRule

名稱 描述
權限 訪問許可權清單。 包含任何項目的字串數組:
“Listen”
“管理”
“Send” (必要)

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
一元元 NotificationHub 一層的 DescriptionmiCredential。 一體式

AdmCredential

名稱 描述
properties NotificationHub AdmCredential 的描述。 必要) AdmCredentialProperties (

AdmCredentialProperties

名稱 描述
authTokenUrl 取得或設定授權令牌的 URL。 需要字串 ()

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
clientId 取得或設定用戶端識別碼。 需要字串 ()

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
clientSecret 取得或設定認證秘密存取金鑰。 需要字串 ()

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。

ApnsCredential

名稱 描述
properties NotificationHub ApnsCredential 的描述。 ApnsCredentialProperties (必要)

ApnsCredentialProperties

名稱 描述
apnsCertificate 取得或設定APNS憑證。 字串

約束:
敏感性值。 以安全參數的形式傳入。
appId 取得或設定簽發者 () 註冊的宣告密鑰,其值為
從開發人員帳戶取得的10個字元小組標識碼
字串

約束:
敏感性值。 以安全參數的形式傳入。
appName 取得或設定應用程式的名稱 字串

約束:
敏感性值。 以安全參數的形式傳入。
certificateKey 取得或設定憑證金鑰。 字串

約束:
敏感性值。 以安全參數的形式傳入。
端點 取得或設定這個認證的端點。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
keyId 取得或設定從取得 (兒童) 金鑰的 10 個字元金鑰標識碼
您的開發人員帳戶
字串

約束:
敏感性值。 以安全參數的形式傳入。
thumbprint 取得或設定APNS憑證指紋 字串

約束:
敏感性值。 以安全參數的形式傳入。
token 取得或設定透過您的取得提供者驗證令牌
開發人員帳戶
字串

約束:
敏感性值。 以安全參數的形式傳入。

百度Credential

名稱 描述
properties NotificationHub BaiduCredential 的描述。 需要百度CredentialProperties ()

百度CredentialProperties

名稱 描述
baiduApiKey 取得或設定百度 API 金鑰。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
baiduEndPoint 取得或設定百度端點。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
baiduSecretKey 取得或設定百度秘密金鑰 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。

BrowserCredential

名稱 描述
properties NotificationHub BrowserCredential 的描述。 BrowserCredentialProperties (必要)

BrowserCredentialProperties

名稱 描述
主旨 取得或設定 Web 推送主旨。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
vapidPrivateKey 取得或設定 VAPID 私鑰。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
vapidPublicKey 取得或設定 VAPID 公鑰。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。

FcmV1Credential

名稱 描述
properties NotificationHub FcmV1Credential 的描述。 FcmV1CredentialProperties (必要)

FcmV1CredentialProperties

名稱 描述
clientEmail 取得或設定用戶端電子郵件。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
privateKey 取得或設定私鑰。 字串 (必要)

約束:
最小長度 = 1
敏感性值。 以安全參數的形式傳入。
projectId 取得或設定專案標識碼。 字串 (必要)

約束:
最小長度 = 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 取得或設定此認證的套件識別碼。 字串

約束:
敏感性值。 以安全參數的形式傳入。
secretKey 取得或設定秘密金鑰。 字串

約束:
敏感性值。 以安全參數的形式傳入。
windowsLiveEndpoint 取得或設定 Windows Live 端點。 字串

約束:
敏感性值。 以安全參數的形式傳入。
wnsCertificate 取得或設定 WNS 憑證。 字串

約束:
敏感性值。 以安全參數的形式傳入。

一體式

名稱 描述
properties NotificationHub ExplorermiCredentialProperties 的描述。 ) 所需的 (, (

StructuremiCredentialProperties

名稱 描述
appSecret 取得或設定應用程式秘密。 字串

約束:
敏感性值。 以安全參數的形式傳入。
端點 取得或設定程式碼服務端點。 字串

約束:
敏感性值。 以安全參數的形式傳入。

SKU

名稱 描述
處理能力 取得或設定資源的容量 int
family 取得或設定 Sku 系列 字串
NAME 命名空間 SKU 名稱。 "Basic"
“Free”
「標準」 (必要)
{1}size{2} 取得或設定 SKU 大小 字串
tier 取得或設定特定 SKU 的層 字串