Bicep リソース定義
名前空間のリソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.NotificationHubs/namespaces リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.NotificationHubs/namespaces@2023-10-01-preview' = {
scope: resourceSymbolicName or scope
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'
}
}
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'
}
tags: {
{customized property}: 'string'
}
}
プロパティ値
Microsoft.NotificationHubs/名前空間
| 名前 | 形容 | 価値 |
|---|---|---|
| 位置 | リソースが存在する地理的な場所 | string (必須) |
| 名前 | リソース名 | 糸 制約: 最小長 = 1 最大長 = 50 パターン = ^[a-zA-Z][a-zA-Z0-9-]*$ (必須) |
| プロパティ | 名前空間のプロパティを表します。 | NamespaceProperties の |
| スコープ | デプロイ スコープとは異なるスコープでリソースを作成するときに使用します。 | このプロパティをリソースのシンボリック名に設定して、拡張リソースを適用します。 |
| エスケーユー | 名前空間の SKU の説明 | SKU (必須) |
| タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
AdmCredential (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub AdmCredential の説明。 | AdmCredentialProperties の |
AdmCredentialProperties (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| authTokenUrl | 承認トークンの URL を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| クライアントID | クライアント識別子を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| クライアントシークレット | 資格情報シークレット アクセス キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
ApnsCredential (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub ApnsCredential の説明。 | ApnsCredentialProperties (必須) |
ApnsCredentialProperties の
| 名前 | 形容 | 価値 |
|---|---|---|
| apns証明書 | APNS 証明書を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| アプリID | 発行者 (iss) 登録済み要求キーを取得または設定します。値は です。 開発者アカウントから取得した 10 文字のチーム ID |
糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| アプリ名 | アプリケーションの名前を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| certificateキー | 証明書キーを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| エンドポイント | この資格情報のエンドポイントを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| キーID | 取得またはから取得した 10 文字のキー識別子 (kid) キーを設定します。 開発者アカウント |
糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| サムプリント | APNS 証明書の拇印を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| トークン | プロバイダー認証トークンを取得または設定します。 開発者アカウント |
糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
バイドゥクレデンシャル
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub BaiduCredential の説明。 | BaiduCredentialProperties (必須) |
BaiduCredentialProperties(バイドゥクレデンシャルプロパティ)
| 名前 | 形容 | 価値 |
|---|---|---|
| バイドゥアピキー | baidu Api キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| バイドゥエンドポイント | baidu Endpoint を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| バイドゥシークレットキー | baidu 秘密鍵を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
ブラウザ資格情報
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub BrowserCredential の説明。 | BrowserCredentialProperties (必須) |
BrowserCredentialProperties (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| 件名 | Web プッシュの件名を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| vapidプライベートキー | VAPID 秘密キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| vapidPublicKey | VAPID 公開キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
FcmV1クレデンシャル
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub FcmV1Credential の説明。 | FcmV1CredentialProperties (必須) |
FcmV1CredentialProperties (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| クライアントEメール | クライアント 電子メールを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| プライベートキー | 秘密キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| プロジェクトID | プロジェクト ID を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
GcmCredential (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub GcmCredential の説明。 | GcmCredentialProperties (必須) |
GcmCredentialProperties(英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| gcmエンドポイント | GCM エンドポイントを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| googleApiKey | Google API キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
Ipルール
| 名前 | 形容 | 価値 |
|---|---|---|
| イップマスク | IP マスク。 | 糸 制約: 最小長 = 1 (必須) |
| 権利 | アクセス権の一覧。 | 次のいずれかを含む文字列配列: 「聞く」 '管理' 'Send' (必須) |
MpnsCredential (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub MpnsCredential の説明。 | MpnsCredentialProperties (必須) |
MpnsCredentialProperties の
| 名前 | 形容 | 価値 |
|---|---|---|
| certificateキー | この資格情報の証明書キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| mpns証明書 | MPNS 証明書を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| サムプリント | MPNS 証明書の拇印を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
名前空間プロパティ
| 名前 | 形容 | 価値 |
|---|---|---|
| データセンター | 廃止。 | 文字列 |
| 名前空間タイプ | NamespaceType の値を定義します。 | 「メッセージング」 「通知ハブ」 |
| ネットワークACL | ネットワーク承認規則のコレクション。 | ネットワークACL |
| pns資格情報 | Notification Hub または Notification Hub 名前空間 PNS 資格情報のコレクション。 | PnsCredentials の |
| プロビジョニング状態 | OperationProvisioningState の値を定義します。 | 「キャンセル」 「無効」 「失敗しました」 「インプログレス」 「保留中」 「成功しました」 「不明」 |
| publicNetworkAccess (パブリックネットワークアクセス) | パブリック ネットワーク アクセスの種類。 | 「無効」 「有効」 |
| レプリケーションリージョン | 許可されるレプリケーション リージョン | 「オーストラリア東部」 「ブラジル南部」 デフォルト 「なし」 「北ヨーロッパ」 「南アフリカ北部」 「東南アジア」 「ウエストアス2」 |
| スケールユニット | 名前空間が作成される scaleUnit を取得または設定します。 | 文字列 |
| 状態 | 名前空間の状態。 | 「作成済み」 「創造する」 '削除中' 「一時停止」 |
| ゾーン冗長性 | 名前空間 SKU 名。 | 「無効」 「有効」 |
ネットワークACL
| 名前 | 形容 | 価値 |
|---|---|---|
| ipルール | IP 規則の一覧。 | Ipルール[] |
| publicNetworkRule (パブリックネットワークルール) | 既定の (パブリック インターネット) ネットワーク承認規則。他のネットワーク規則が一致しない場合は権限が含まれます。 | PublicInternetAuthorizationRule |
PnsCredentialsの
| 名前 | 形容 | 価値 |
|---|---|---|
| admCredential (英語) | NotificationHub AdmCredential の説明。 | AdmCredential の |
| apnsクレデンシャル | NotificationHub ApnsCredential の説明。 | ApnsCredential の |
| 百度クレデンシャル | NotificationHub BaiduCredential の説明。 | バイドゥクレデンシャル |
| browserCredential (英語) | NotificationHub BrowserCredential の説明。 | ブラウザ資格情報 |
| fcmV1クレデンシャル | NotificationHub FcmV1Credential の説明。 | FcmV1クレデンシャル |
| gcmクレデンシャル | NotificationHub GcmCredential の説明。 | GcmCredential (英語) |
| mpnsクレデンシャル | NotificationHub MpnsCredential の説明。 | MpnsCredential (英語) |
| wnsクレデンシャル | NotificationHub WnsCredential の説明。 | WnsCredential を |
| xiaomiクレデンシャル | NotificationHubXiaomiCredential の説明。 | Xiaomiクレデンシャル |
PublicInternetAuthorizationRule
| 名前 | 形容 | 価値 |
|---|---|---|
| 権利 | アクセス権の一覧。 | 次のいずれかを含む文字列配列: 「聞く」 '管理' 'Send' (必須) |
SKU
| 名前 | 形容 | 価値 |
|---|---|---|
| キャパシティ | リソースの容量を取得または設定します。 | 整数 (int) |
| 家族 | Sku ファミリを取得または設定します。 | 文字列 |
| 名前 | 名前空間 SKU 名。 | 「ベーシック」 「無料」 'Standard' (必須) |
| 大きさ | SKU サイズを取得または設定します。 | 文字列 |
| レベル | 特定の SKU のレベルを取得または設定します。 | 文字列 |
追跡リソースタグ
| 名前 | 形容 | 価値 |
|---|
Wnsクレデンシャル
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub WnsCredential の説明。 | WnsCredentialProperties (必須) |
WnsCredentialProperties (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| certificateキー | WNS 証明書キーを設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| パッケージSid | この資格情報のパッケージ ID を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| シークレットキー | 秘密鍵を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| windowsLiveエンドポイント | Windows Live エンドポイントを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| wns証明書 | WNS 証明書を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
Xiaomiクレデンシャル
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHubXiaomiCredentialProperties の説明。 | XiaomiCredentialProperties (必須) |
XiaomiCredentialProperties(シャオミクレデンシャルプロパティ)
| 名前 | 形容 | 価値 |
|---|---|---|
| appSecret(アプリシークレット) | アプリ シークレットを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| エンドポイント | xiaomi サービス エンドポイントを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
使用例
Azure クイック スタートのサンプル
次 Azure クイック スタート テンプレート、このリソースの種類をデプロイするための Bicep サンプルが含まれています。
| Bicep ファイル | 形容 |
|---|---|
| Azure Notification Hub の作成 |
最初に John Downs によって作成された Azure Notification Hub テンプレートを作成します。 |
ARM テンプレート リソース定義
名前空間のリソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.NotificationHubs/namespaces リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.NotificationHubs/namespaces",
"apiVersion": "2023-10-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"
}
},
"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"
},
"tags": {
"{customized property}": "string"
}
}
プロパティ値
Microsoft.NotificationHubs/名前空間
| 名前 | 形容 | 価値 |
|---|---|---|
| apiVersion (英語) | API のバージョン | 「2023-10-01-プレビュー」 |
| 位置 | リソースが存在する地理的な場所 | string (必須) |
| 名前 | リソース名 | 糸 制約: 最小長 = 1 最大長 = 50 パターン = ^[a-zA-Z][a-zA-Z0-9-]*$ (必須) |
| プロパティ | 名前空間のプロパティを表します。 | NamespaceProperties の |
| エスケーユー | 名前空間の SKU の説明 | SKU (必須) |
| タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
| 型 | リソースの種類 | 'Microsoft.NotificationHubs/名前空間' |
AdmCredential (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub AdmCredential の説明。 | AdmCredentialProperties の |
AdmCredentialProperties (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| authTokenUrl | 承認トークンの URL を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| クライアントID | クライアント識別子を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| クライアントシークレット | 資格情報シークレット アクセス キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
ApnsCredential (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub ApnsCredential の説明。 | ApnsCredentialProperties (必須) |
ApnsCredentialProperties の
| 名前 | 形容 | 価値 |
|---|---|---|
| apns証明書 | APNS 証明書を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| アプリID | 発行者 (iss) 登録済み要求キーを取得または設定します。値は です。 開発者アカウントから取得した 10 文字のチーム ID |
糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| アプリ名 | アプリケーションの名前を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| certificateキー | 証明書キーを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| エンドポイント | この資格情報のエンドポイントを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| キーID | 取得またはから取得した 10 文字のキー識別子 (kid) キーを設定します。 開発者アカウント |
糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| サムプリント | APNS 証明書の拇印を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| トークン | プロバイダー認証トークンを取得または設定します。 開発者アカウント |
糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
バイドゥクレデンシャル
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub BaiduCredential の説明。 | BaiduCredentialProperties (必須) |
BaiduCredentialProperties(バイドゥクレデンシャルプロパティ)
| 名前 | 形容 | 価値 |
|---|---|---|
| バイドゥアピキー | baidu Api キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| バイドゥエンドポイント | baidu Endpoint を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| バイドゥシークレットキー | baidu 秘密鍵を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
ブラウザ資格情報
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub BrowserCredential の説明。 | BrowserCredentialProperties (必須) |
BrowserCredentialProperties (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| 件名 | Web プッシュの件名を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| vapidプライベートキー | VAPID 秘密キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| vapidPublicKey | VAPID 公開キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
FcmV1クレデンシャル
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub FcmV1Credential の説明。 | FcmV1CredentialProperties (必須) |
FcmV1CredentialProperties (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| クライアントEメール | クライアント 電子メールを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| プライベートキー | 秘密キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| プロジェクトID | プロジェクト ID を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
GcmCredential (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub GcmCredential の説明。 | GcmCredentialProperties (必須) |
GcmCredentialProperties(英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| gcmエンドポイント | GCM エンドポイントを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| googleApiKey | Google API キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
Ipルール
| 名前 | 形容 | 価値 |
|---|---|---|
| イップマスク | IP マスク。 | 糸 制約: 最小長 = 1 (必須) |
| 権利 | アクセス権の一覧。 | 次のいずれかを含む文字列配列: 「聞く」 '管理' 'Send' (必須) |
MpnsCredential (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub MpnsCredential の説明。 | MpnsCredentialProperties (必須) |
MpnsCredentialProperties の
| 名前 | 形容 | 価値 |
|---|---|---|
| certificateキー | この資格情報の証明書キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| mpns証明書 | MPNS 証明書を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| サムプリント | MPNS 証明書の拇印を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
名前空間プロパティ
| 名前 | 形容 | 価値 |
|---|---|---|
| データセンター | 廃止。 | 文字列 |
| 名前空間タイプ | NamespaceType の値を定義します。 | 「メッセージング」 「通知ハブ」 |
| ネットワークACL | ネットワーク承認規則のコレクション。 | ネットワークACL |
| pns資格情報 | Notification Hub または Notification Hub 名前空間 PNS 資格情報のコレクション。 | PnsCredentials の |
| プロビジョニング状態 | OperationProvisioningState の値を定義します。 | 「キャンセル」 「無効」 「失敗しました」 「インプログレス」 「保留中」 「成功しました」 「不明」 |
| publicNetworkAccess (パブリックネットワークアクセス) | パブリック ネットワーク アクセスの種類。 | 「無効」 「有効」 |
| レプリケーションリージョン | 許可されるレプリケーション リージョン | 「オーストラリア東部」 「ブラジル南部」 デフォルト 「なし」 「北ヨーロッパ」 「南アフリカ北部」 「東南アジア」 「ウエストアス2」 |
| スケールユニット | 名前空間が作成される scaleUnit を取得または設定します。 | 文字列 |
| 状態 | 名前空間の状態。 | 「作成済み」 「創造する」 '削除中' 「一時停止」 |
| ゾーン冗長性 | 名前空間 SKU 名。 | 「無効」 「有効」 |
ネットワークACL
| 名前 | 形容 | 価値 |
|---|---|---|
| ipルール | IP 規則の一覧。 | Ipルール[] |
| publicNetworkRule (パブリックネットワークルール) | 既定の (パブリック インターネット) ネットワーク承認規則。他のネットワーク規則が一致しない場合は権限が含まれます。 | PublicInternetAuthorizationRule |
PnsCredentialsの
| 名前 | 形容 | 価値 |
|---|---|---|
| admCredential (英語) | NotificationHub AdmCredential の説明。 | AdmCredential の |
| apnsクレデンシャル | NotificationHub ApnsCredential の説明。 | ApnsCredential の |
| 百度クレデンシャル | NotificationHub BaiduCredential の説明。 | バイドゥクレデンシャル |
| browserCredential (英語) | NotificationHub BrowserCredential の説明。 | ブラウザ資格情報 |
| fcmV1クレデンシャル | NotificationHub FcmV1Credential の説明。 | FcmV1クレデンシャル |
| gcmクレデンシャル | NotificationHub GcmCredential の説明。 | GcmCredential (英語) |
| mpnsクレデンシャル | NotificationHub MpnsCredential の説明。 | MpnsCredential (英語) |
| wnsクレデンシャル | NotificationHub WnsCredential の説明。 | WnsCredential を |
| xiaomiクレデンシャル | NotificationHubXiaomiCredential の説明。 | Xiaomiクレデンシャル |
PublicInternetAuthorizationRule
| 名前 | 形容 | 価値 |
|---|---|---|
| 権利 | アクセス権の一覧。 | 次のいずれかを含む文字列配列: 「聞く」 '管理' 'Send' (必須) |
SKU
| 名前 | 形容 | 価値 |
|---|---|---|
| キャパシティ | リソースの容量を取得または設定します。 | 整数 (int) |
| 家族 | Sku ファミリを取得または設定します。 | 文字列 |
| 名前 | 名前空間 SKU 名。 | 「ベーシック」 「無料」 'Standard' (必須) |
| 大きさ | SKU サイズを取得または設定します。 | 文字列 |
| レベル | 特定の SKU のレベルを取得または設定します。 | 文字列 |
追跡リソースタグ
| 名前 | 形容 | 価値 |
|---|
Wnsクレデンシャル
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub WnsCredential の説明。 | WnsCredentialProperties (必須) |
WnsCredentialProperties (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| certificateキー | WNS 証明書キーを設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| パッケージSid | この資格情報のパッケージ ID を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| シークレットキー | 秘密鍵を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| windowsLiveエンドポイント | Windows Live エンドポイントを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| wns証明書 | WNS 証明書を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
Xiaomiクレデンシャル
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHubXiaomiCredentialProperties の説明。 | XiaomiCredentialProperties (必須) |
XiaomiCredentialProperties(シャオミクレデンシャルプロパティ)
| 名前 | 形容 | 価値 |
|---|---|---|
| appSecret(アプリシークレット) | アプリ シークレットを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| エンドポイント | xiaomi サービス エンドポイントを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
使用例
Azure クイック スタート テンプレート
このリソースの種類 デプロイする Azure クイック スタート テンプレート 次に示します。
| テンプレート | 形容 |
|---|---|
| Azure Notification Hub の作成 Azure |
最初に John Downs によって作成された Azure Notification Hub テンプレートを作成します。 |
|
SQL Database を使用してモバイル アプリをプロビジョニングする Azure にデプロイする |
このテンプレートは、モバイル アプリ、SQL Database、および Notification Hub をプロビジョニングします。 データベースと通知ハブのモバイル アプリで接続文字列を構成します。 |
Terraform (AzAPI プロバイダー) リソース定義
名前空間のリソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.NotificationHubs/namespaces リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.NotificationHubs/namespaces@2023-10-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
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/名前空間
| 名前 | 形容 | 価値 |
|---|---|---|
| 位置 | リソースが存在する地理的な場所 | string (必須) |
| 名前 | リソース名 | 糸 制約: 最小長 = 1 最大長 = 50 パターン = ^[a-zA-Z][a-zA-Z0-9-]*$ (必須) |
| parent_id | この拡張リソースを適用するリソースの ID。 | string (必須) |
| プロパティ | 名前空間のプロパティを表します。 | NamespaceProperties の |
| エスケーユー | 名前空間の SKU の説明 | SKU (必須) |
| タグ | リソース タグ | タグ名と値のディクショナリ。 |
| 型 | リソースの種類 | "Microsoft.NotificationHubs/namespaces@2023-10-01-preview" (英語) |
AdmCredential (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub AdmCredential の説明。 | AdmCredentialProperties の |
AdmCredentialProperties (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| authTokenUrl | 承認トークンの URL を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| クライアントID | クライアント識別子を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| クライアントシークレット | 資格情報シークレット アクセス キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
ApnsCredential (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub ApnsCredential の説明。 | ApnsCredentialProperties (必須) |
ApnsCredentialProperties の
| 名前 | 形容 | 価値 |
|---|---|---|
| apns証明書 | APNS 証明書を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| アプリID | 発行者 (iss) 登録済み要求キーを取得または設定します。値は です。 開発者アカウントから取得した 10 文字のチーム ID |
糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| アプリ名 | アプリケーションの名前を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| certificateキー | 証明書キーを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| エンドポイント | この資格情報のエンドポイントを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| キーID | 取得またはから取得した 10 文字のキー識別子 (kid) キーを設定します。 開発者アカウント |
糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| サムプリント | APNS 証明書の拇印を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| トークン | プロバイダー認証トークンを取得または設定します。 開発者アカウント |
糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
バイドゥクレデンシャル
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub BaiduCredential の説明。 | BaiduCredentialProperties (必須) |
BaiduCredentialProperties(バイドゥクレデンシャルプロパティ)
| 名前 | 形容 | 価値 |
|---|---|---|
| バイドゥアピキー | baidu Api キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| バイドゥエンドポイント | baidu Endpoint を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| バイドゥシークレットキー | baidu 秘密鍵を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
ブラウザ資格情報
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub BrowserCredential の説明。 | BrowserCredentialProperties (必須) |
BrowserCredentialProperties (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| 件名 | Web プッシュの件名を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| vapidプライベートキー | VAPID 秘密キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| vapidPublicKey | VAPID 公開キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
FcmV1クレデンシャル
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub FcmV1Credential の説明。 | FcmV1CredentialProperties (必須) |
FcmV1CredentialProperties (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| クライアントEメール | クライアント 電子メールを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| プライベートキー | 秘密キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| プロジェクトID | プロジェクト ID を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
GcmCredential (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub GcmCredential の説明。 | GcmCredentialProperties (必須) |
GcmCredentialProperties(英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| gcmエンドポイント | GCM エンドポイントを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| googleApiKey | Google API キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
Ipルール
| 名前 | 形容 | 価値 |
|---|---|---|
| イップマスク | IP マスク。 | 糸 制約: 最小長 = 1 (必須) |
| 権利 | アクセス権の一覧。 | 次のいずれかを含む文字列配列: 「聞く」 '管理' 'Send' (必須) |
MpnsCredential (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub MpnsCredential の説明。 | MpnsCredentialProperties (必須) |
MpnsCredentialProperties の
| 名前 | 形容 | 価値 |
|---|---|---|
| certificateキー | この資格情報の証明書キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| mpns証明書 | MPNS 証明書を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
| サムプリント | MPNS 証明書の拇印を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
名前空間プロパティ
| 名前 | 形容 | 価値 |
|---|---|---|
| データセンター | 廃止。 | 文字列 |
| 名前空間タイプ | NamespaceType の値を定義します。 | 「メッセージング」 「通知ハブ」 |
| ネットワークACL | ネットワーク承認規則のコレクション。 | ネットワークACL |
| pns資格情報 | Notification Hub または Notification Hub 名前空間 PNS 資格情報のコレクション。 | PnsCredentials の |
| プロビジョニング状態 | OperationProvisioningState の値を定義します。 | 「キャンセル」 「無効」 「失敗しました」 「インプログレス」 「保留中」 「成功しました」 「不明」 |
| publicNetworkAccess (パブリックネットワークアクセス) | パブリック ネットワーク アクセスの種類。 | 「無効」 「有効」 |
| レプリケーションリージョン | 許可されるレプリケーション リージョン | 「オーストラリア東部」 「ブラジル南部」 デフォルト 「なし」 「北ヨーロッパ」 「南アフリカ北部」 「東南アジア」 「ウエストアス2」 |
| スケールユニット | 名前空間が作成される scaleUnit を取得または設定します。 | 文字列 |
| 状態 | 名前空間の状態。 | 「作成済み」 「創造する」 '削除中' 「一時停止」 |
| ゾーン冗長性 | 名前空間 SKU 名。 | 「無効」 「有効」 |
ネットワークACL
| 名前 | 形容 | 価値 |
|---|---|---|
| ipルール | IP 規則の一覧。 | Ipルール[] |
| publicNetworkRule (パブリックネットワークルール) | 既定の (パブリック インターネット) ネットワーク承認規則。他のネットワーク規則が一致しない場合は権限が含まれます。 | PublicInternetAuthorizationRule |
PnsCredentialsの
| 名前 | 形容 | 価値 |
|---|---|---|
| admCredential (英語) | NotificationHub AdmCredential の説明。 | AdmCredential の |
| apnsクレデンシャル | NotificationHub ApnsCredential の説明。 | ApnsCredential の |
| 百度クレデンシャル | NotificationHub BaiduCredential の説明。 | バイドゥクレデンシャル |
| browserCredential (英語) | NotificationHub BrowserCredential の説明。 | ブラウザ資格情報 |
| fcmV1クレデンシャル | NotificationHub FcmV1Credential の説明。 | FcmV1クレデンシャル |
| gcmクレデンシャル | NotificationHub GcmCredential の説明。 | GcmCredential (英語) |
| mpnsクレデンシャル | NotificationHub MpnsCredential の説明。 | MpnsCredential (英語) |
| wnsクレデンシャル | NotificationHub WnsCredential の説明。 | WnsCredential を |
| xiaomiクレデンシャル | NotificationHubXiaomiCredential の説明。 | Xiaomiクレデンシャル |
PublicInternetAuthorizationRule
| 名前 | 形容 | 価値 |
|---|---|---|
| 権利 | アクセス権の一覧。 | 次のいずれかを含む文字列配列: 「聞く」 '管理' 'Send' (必須) |
SKU
| 名前 | 形容 | 価値 |
|---|---|---|
| キャパシティ | リソースの容量を取得または設定します。 | 整数 (int) |
| 家族 | Sku ファミリを取得または設定します。 | 文字列 |
| 名前 | 名前空間 SKU 名。 | 「ベーシック」 「無料」 'Standard' (必須) |
| 大きさ | SKU サイズを取得または設定します。 | 文字列 |
| レベル | 特定の SKU のレベルを取得または設定します。 | 文字列 |
追跡リソースタグ
| 名前 | 形容 | 価値 |
|---|
Wnsクレデンシャル
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHub WnsCredential の説明。 | WnsCredentialProperties (必須) |
WnsCredentialProperties (英語)
| 名前 | 形容 | 価値 |
|---|---|---|
| certificateキー | WNS 証明書キーを設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| パッケージSid | この資格情報のパッケージ ID を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| シークレットキー | 秘密鍵を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| windowsLiveエンドポイント | Windows Live エンドポイントを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| wns証明書 | WNS 証明書を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
Xiaomiクレデンシャル
| 名前 | 形容 | 価値 |
|---|---|---|
| プロパティ | NotificationHubXiaomiCredentialProperties の説明。 | XiaomiCredentialProperties (必須) |
XiaomiCredentialProperties(シャオミクレデンシャルプロパティ)
| 名前 | 形容 | 価値 |
|---|---|---|
| appSecret(アプリシークレット) | アプリ シークレットを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
| エンドポイント | xiaomi サービス エンドポイントを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
使用例
Terraformサンプル
Notification Hub 名前空間のデプロイの基本的な例。
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "namespace" {
type = "Microsoft.NotificationHubs/namespaces@2017-04-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
enabled = true
namespaceType = "NotificationHub"
region = "westeurope"
}
sku = {
name = "Free"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}