Microsoft.NotificationHubs 名前空間
Bicep リソース定義
名前空間のリソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.NotificationHubs/namespaces リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.NotificationHubs/namespaces@2023-10-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'
}
}
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'
}
}
プロパティ値
AdmCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub AdmCredential の説明。 | AdmCredentialProperties の |
AdmCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
authTokenUrl | 承認トークンの URL を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
clientId | クライアント識別子を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
clientSecret | 資格情報シークレット アクセス キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
ApnsCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub ApnsCredential の説明。 | ApnsCredentialProperties (必須) |
ApnsCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
apnsCertificate | APNS 証明書を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
appId | 発行者 (iss) 登録済み要求キーを取得または設定します。値は です。 開発者アカウントから取得した 10 文字のチーム ID |
糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
appName | アプリケーションの名前を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
certificateKey | 証明書キーを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
エンドポイント | この資格情報のエンドポイントを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
keyId | 取得またはから取得した 10 文字のキー識別子 (kid) キーを設定します。 開発者アカウント |
糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
拇印 | APNS 証明書の拇印を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
トークン | プロバイダー認証トークンを取得または設定します。 開発者アカウント |
糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
BaiduCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub BaiduCredential の説明。 | BaiduCredentialProperties (必須) |
BaiduCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
baiduApiKey | baidu Api キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
baiduEndPoint | baidu Endpoint を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
baiduSecretKey | baidu 秘密鍵を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
BrowserCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub BrowserCredential の説明。 | BrowserCredentialProperties (必須) |
BrowserCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
件名 | Web プッシュの件名を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
vapidPrivateKey | VAPID 秘密キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
vapidPublicKey | VAPID 公開キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
FcmV1Credential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub FcmV1Credential の説明。 | FcmV1CredentialProperties (必須) |
FcmV1CredentialProperties
名前 | 形容 | 価値 |
---|---|---|
clientEmail | クライアント 電子メールを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
privateKey | 秘密キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
projectId | プロジェクト ID を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
GcmCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub GcmCredential の説明。 | GcmCredentialProperties (必須) |
GcmCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
gcmEndpoint | GCM エンドポイントを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
googleApiKey | Google API キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
IpRule
名前 | 形容 | 価値 |
---|---|---|
ipMask | IP マスク。 | 糸 制約: 最小長 = 1 (必須) |
権利 | アクセス権の一覧。 | 次のいずれかを含む文字列配列: 'Listen' '管理' 'Send' (必須) |
Microsoft.NotificationHubs/namespaces
名前 | 形容 | 価値 |
---|---|---|
場所 | リソースが存在する地理的な場所 | string (必須) |
名前 | リソース名 | 糸 制約: 最小長 = 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 | Notification Hub または Notification Hub 名前空間 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 の説明。 | BaiduCredential |
browserCredential | NotificationHub BrowserCredential の説明。 | BrowserCredential |
fcmV1Credential | NotificationHub FcmV1Credential の説明。 | FcmV1Credential |
gcmCredential | NotificationHub GcmCredential の説明。 | GcmCredential |
mpnsCredential | NotificationHub MpnsCredential の説明。 | MpnsCredential |
wnsCredential | NotificationHub WnsCredential の説明。 | WnsCredential を |
xiaomiCredential | NotificationHubXiaomiCredential の説明。 | XiaomiCredential |
PublicInternetAuthorizationRule
名前 | 形容 | 価値 |
---|---|---|
権利 | アクセス権の一覧。 | 次のいずれかを含む文字列配列: 'Listen' '管理' 'Send' (必須) |
SKU
名前 | 形容 | 価値 |
---|---|---|
能力 | リソースの容量を取得または設定します。 | int |
家族 | Sku ファミリを取得または設定します。 | 糸 |
名前 | 名前空間 SKU 名。 | 'Basic' 'Free' 'Standard' (必須) |
大きさ | SKU サイズを取得または設定します。 | 糸 |
層 | 特定の SKU のレベルを取得または設定します。 | 糸 |
TrackedResourceTags
名前 | 形容 | 価値 |
---|
WnsCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub WnsCredential の説明。 | WnsCredentialProperties (必須) |
WnsCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
certificateKey | WNS 証明書キーを設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
packageSid | この資格情報のパッケージ ID を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
secretKey | 秘密鍵を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
windowsLiveEndpoint | Windows Live エンドポイントを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
wnsCertificate | WNS 証明書を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
XiaomiCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHubXiaomiCredentialProperties の説明。 | XiaomiCredentialProperties (必須) |
XiaomiCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
appSecret | アプリ シークレットを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
エンドポイント | xiaomi サービス エンドポイントを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
クイック スタートのサンプル
次のクイック スタート サンプルでは、このリソースの種類をデプロイします。
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"
}
}
プロパティ値
AdmCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub AdmCredential の説明。 | AdmCredentialProperties の |
AdmCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
authTokenUrl | 承認トークンの URL を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
clientId | クライアント識別子を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
clientSecret | 資格情報シークレット アクセス キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
ApnsCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub ApnsCredential の説明。 | ApnsCredentialProperties (必須) |
ApnsCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
apnsCertificate | APNS 証明書を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
appId | 発行者 (iss) 登録済み要求キーを取得または設定します。値は です。 開発者アカウントから取得した 10 文字のチーム ID |
糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
appName | アプリケーションの名前を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
certificateKey | 証明書キーを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
エンドポイント | この資格情報のエンドポイントを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
keyId | 取得またはから取得した 10 文字のキー識別子 (kid) キーを設定します。 開発者アカウント |
糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
拇印 | APNS 証明書の拇印を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
トークン | プロバイダー認証トークンを取得または設定します。 開発者アカウント |
糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
BaiduCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub BaiduCredential の説明。 | BaiduCredentialProperties (必須) |
BaiduCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
baiduApiKey | baidu Api キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
baiduEndPoint | baidu Endpoint を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
baiduSecretKey | baidu 秘密鍵を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
BrowserCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub BrowserCredential の説明。 | BrowserCredentialProperties (必須) |
BrowserCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
件名 | Web プッシュの件名を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
vapidPrivateKey | VAPID 秘密キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
vapidPublicKey | VAPID 公開キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
FcmV1Credential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub FcmV1Credential の説明。 | FcmV1CredentialProperties (必須) |
FcmV1CredentialProperties
名前 | 形容 | 価値 |
---|---|---|
clientEmail | クライアント 電子メールを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
privateKey | 秘密キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
projectId | プロジェクト ID を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
GcmCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub GcmCredential の説明。 | GcmCredentialProperties (必須) |
GcmCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
gcmEndpoint | GCM エンドポイントを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
googleApiKey | Google API キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
IpRule
名前 | 形容 | 価値 |
---|---|---|
ipMask | IP マスク。 | 糸 制約: 最小長 = 1 (必須) |
権利 | アクセス権の一覧。 | 次のいずれかを含む文字列配列: 'Listen' '管理' 'Send' (必須) |
Microsoft.NotificationHubs/namespaces
名前 | 形容 | 価値 |
---|---|---|
apiVersion | API のバージョン | '2023-10-01-preview' |
場所 | リソースが存在する地理的な場所 | string (必須) |
名前 | リソース名 | 糸 制約: 最小長 = 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 | Notification Hub または Notification Hub 名前空間 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 の説明。 | BaiduCredential |
browserCredential | NotificationHub BrowserCredential の説明。 | BrowserCredential |
fcmV1Credential | NotificationHub FcmV1Credential の説明。 | FcmV1Credential |
gcmCredential | NotificationHub GcmCredential の説明。 | GcmCredential |
mpnsCredential | NotificationHub MpnsCredential の説明。 | MpnsCredential |
wnsCredential | NotificationHub WnsCredential の説明。 | WnsCredential を |
xiaomiCredential | NotificationHubXiaomiCredential の説明。 | XiaomiCredential |
PublicInternetAuthorizationRule
名前 | 形容 | 価値 |
---|---|---|
権利 | アクセス権の一覧。 | 次のいずれかを含む文字列配列: 'Listen' '管理' 'Send' (必須) |
SKU
名前 | 形容 | 価値 |
---|---|---|
能力 | リソースの容量を取得または設定します。 | int |
家族 | Sku ファミリを取得または設定します。 | 糸 |
名前 | 名前空間 SKU 名。 | 'Basic' 'Free' 'Standard' (必須) |
大きさ | SKU サイズを取得または設定します。 | 糸 |
層 | 特定の SKU のレベルを取得または設定します。 | 糸 |
TrackedResourceTags
名前 | 形容 | 価値 |
---|
WnsCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub WnsCredential の説明。 | WnsCredentialProperties (必須) |
WnsCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
certificateKey | WNS 証明書キーを設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
packageSid | この資格情報のパッケージ ID を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
secretKey | 秘密鍵を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
windowsLiveEndpoint | Windows Live エンドポイントを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
wnsCertificate | WNS 証明書を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
XiaomiCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHubXiaomiCredentialProperties の説明。 | XiaomiCredentialProperties (必須) |
XiaomiCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
appSecret | アプリ シークレットを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
エンドポイント | xiaomi サービス エンドポイントを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
テンプレート | 形容 |
---|---|
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"
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"
}
}
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"
}
})
}
プロパティ値
AdmCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub AdmCredential の説明。 | AdmCredentialProperties の |
AdmCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
authTokenUrl | 承認トークンの URL を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
clientId | クライアント識別子を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
clientSecret | 資格情報シークレット アクセス キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
ApnsCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub ApnsCredential の説明。 | ApnsCredentialProperties (必須) |
ApnsCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
apnsCertificate | APNS 証明書を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
appId | 発行者 (iss) 登録済み要求キーを取得または設定します。値は です。 開発者アカウントから取得した 10 文字のチーム ID |
糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
appName | アプリケーションの名前を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
certificateKey | 証明書キーを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
エンドポイント | この資格情報のエンドポイントを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
keyId | 取得またはから取得した 10 文字のキー識別子 (kid) キーを設定します。 開発者アカウント |
糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
拇印 | APNS 証明書の拇印を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
トークン | プロバイダー認証トークンを取得または設定します。 開発者アカウント |
糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
BaiduCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub BaiduCredential の説明。 | BaiduCredentialProperties (必須) |
BaiduCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
baiduApiKey | baidu Api キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
baiduEndPoint | baidu Endpoint を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
baiduSecretKey | baidu 秘密鍵を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
BrowserCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub BrowserCredential の説明。 | BrowserCredentialProperties (必須) |
BrowserCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
件名 | Web プッシュの件名を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
vapidPrivateKey | VAPID 秘密キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
vapidPublicKey | VAPID 公開キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
FcmV1Credential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub FcmV1Credential の説明。 | FcmV1CredentialProperties (必須) |
FcmV1CredentialProperties
名前 | 形容 | 価値 |
---|---|---|
clientEmail | クライアント 電子メールを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
privateKey | 秘密キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
projectId | プロジェクト ID を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
GcmCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub GcmCredential の説明。 | GcmCredentialProperties (必須) |
GcmCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
gcmEndpoint | GCM エンドポイントを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
googleApiKey | Google API キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
IpRule
名前 | 形容 | 価値 |
---|---|---|
ipMask | IP マスク。 | 糸 制約: 最小長 = 1 (必須) |
権利 | アクセス権の一覧。 | 次のいずれかを含む文字列配列: 'Listen' '管理' 'Send' (必須) |
Microsoft.NotificationHubs/namespaces
名前 | 形容 | 価値 |
---|---|---|
場所 | リソースが存在する地理的な場所 | string (必須) |
名前 | リソース名 | 糸 制約: 最小長 = 1 最大長 = 1 パターン = ^[a-zA-Z][a-zA-Z0-9-]*$ (必須) |
プロパティ | 名前空間のプロパティを表します。 | NamespaceProperties の |
sku | 名前空間の SKU の説明 | SKU (必須) |
タグ | リソース タグ | タグ名と値のディクショナリ。 |
種類 | リソースの種類 | "Microsoft.NotificationHubs/namespaces@2023-10-01-preview" |
MpnsCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub MpnsCredential の説明。 | MpnsCredentialProperties (必須) |
MpnsCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
certificateKey | この資格情報の証明書キーを取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
mpnsCertificate | MPNS 証明書を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
拇印 | MPNS 証明書の拇印を取得または設定します。 | 糸 制約: 最小長 = 1 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 (必須) |
NamespaceProperties
名前 | 形容 | 価値 |
---|---|---|
dataCenter | 廃止。 | 糸 |
namespaceType | NamespaceType の値を定義します。 | 'Messaging' 'NotificationHub' |
networkAcls | ネットワーク承認規則のコレクション。 | NetworkAcls |
pnsCredentials | Notification Hub または Notification Hub 名前空間 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 の説明。 | BaiduCredential |
browserCredential | NotificationHub BrowserCredential の説明。 | BrowserCredential |
fcmV1Credential | NotificationHub FcmV1Credential の説明。 | FcmV1Credential |
gcmCredential | NotificationHub GcmCredential の説明。 | GcmCredential |
mpnsCredential | NotificationHub MpnsCredential の説明。 | MpnsCredential |
wnsCredential | NotificationHub WnsCredential の説明。 | WnsCredential を |
xiaomiCredential | NotificationHubXiaomiCredential の説明。 | XiaomiCredential |
PublicInternetAuthorizationRule
名前 | 形容 | 価値 |
---|---|---|
権利 | アクセス権の一覧。 | 次のいずれかを含む文字列配列: 'Listen' '管理' 'Send' (必須) |
SKU
名前 | 形容 | 価値 |
---|---|---|
能力 | リソースの容量を取得または設定します。 | int |
家族 | Sku ファミリを取得または設定します。 | 糸 |
名前 | 名前空間 SKU 名。 | 'Basic' 'Free' 'Standard' (必須) |
大きさ | SKU サイズを取得または設定します。 | 糸 |
層 | 特定の SKU のレベルを取得または設定します。 | 糸 |
TrackedResourceTags
名前 | 形容 | 価値 |
---|
WnsCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHub WnsCredential の説明。 | WnsCredentialProperties (必須) |
WnsCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
certificateKey | WNS 証明書キーを設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
packageSid | この資格情報のパッケージ ID を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
secretKey | 秘密鍵を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
windowsLiveEndpoint | Windows Live エンドポイントを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
wnsCertificate | WNS 証明書を取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
XiaomiCredential
名前 | 形容 | 価値 |
---|---|---|
プロパティ | NotificationHubXiaomiCredentialProperties の説明。 | XiaomiCredentialProperties (必須) |
XiaomiCredentialProperties
名前 | 形容 | 価値 |
---|---|---|
appSecret | アプリ シークレットを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
エンドポイント | xiaomi サービス エンドポイントを取得または設定します。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |