Microsoft.NotificationHubs 名前空間/notificationHubs 2017-04-01
- [アーティクル]
-
-
Bicep リソース定義
名前空間/notificationHubs リソースの種類は、次を対象とする操作でデプロイできます。
-
リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.NotificationHubs/namespaces/notificationHubs リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.NotificationHubs/namespaces/notificationHubs@2017-04-01' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
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'
}
}
authorizationRules: [
{
rights: [
'string'
]
}
]
baiduCredential: {
properties: {
baiduApiKey: 'string'
baiduEndPoint: 'string'
baiduSecretKey: 'string'
}
}
gcmCredential: {
properties: {
gcmEndpoint: 'string'
googleApiKey: 'string'
}
}
mpnsCredential: {
properties: {
certificateKey: 'string'
mpnsCertificate: 'string'
thumbprint: 'string'
}
}
name: 'string'
registrationTtl: 'string'
wnsCredential: {
properties: {
packageSid: 'string'
secretKey: 'string'
windowsLiveEndpoint: 'string'
}
}
}
sku: {
capacity: int
family: 'string'
name: 'string'
size: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
プロパティ値
AdmCredential
| 名前 |
形容 |
価値 |
| プロパティ |
NotificationHub AdmCredential のプロパティ。 |
AdmCredentialProperties の |
AdmCredentialProperties
| 名前 |
形容 |
価値 |
| authTokenUrl |
承認トークンの URL。 |
糸 |
| clientId |
クライアント識別子。 |
糸 |
| clientSecret |
資格情報シークレット アクセス キー。 |
糸 |
ApnsCredential
| 名前 |
形容 |
価値 |
| プロパティ |
NotificationHub ApnsCredential のプロパティ。 |
ApnsCredentialProperties の |
ApnsCredentialProperties
| 名前 |
形容 |
価値 |
| apnsCertificate |
APNS 証明書。 証明書認証モードを使用するかどうかを指定します。 |
糸 |
| appId |
発行者 (iss) 登録済み要求キー。 値は、開発者アカウントから取得した 10 文字の TeamId です。 トークン認証モードを使用するかどうかを指定します。 |
糸 |
| appName |
アプリケーションまたは BundleId の名前。 トークン認証モードを使用するかどうかを指定します。 |
糸 |
| certificateKey |
APNS 証明書のパスワード (存在する場合)。 |
糸 |
| エンドポイント |
この資格情報の APNS エンドポイント。 証明書認証モードとサンドボックスを使用する場合は、"gateway.sandbox.push.apple.com" を指定します。 証明書認証モードと運用環境を使用する場合は、"gateway.push.apple.com" を指定します。 トークン認証モードとサンドボックスを使用する場合は、'https://api.development.push.apple.com:443/3/device'を指定します。 トークン認証モードと運用モードを使用する場合は、'https://api.push.apple.com:443/3/device'を指定します。 |
糸 |
| keyId |
開発者アカウントから取得した 10 文字のキー識別子 (kid) キー。 トークン認証モードを使用するかどうかを指定します。 |
糸 |
| 拇印 |
APNS 証明書の拇印。 証明書認証モードを使用するかどうかを指定します。 |
糸 |
| トークン |
開発者アカウントを介して取得されたプロバイダー認証トークン。 トークン認証モードを使用するかどうかを指定します。 |
糸 |
BaiduCredential
| 名前 |
形容 |
価値 |
| プロパティ |
NotificationHub BaiduCredential のプロパティ。 |
BaiduCredentialProperties の |
BaiduCredentialProperties
| 名前 |
形容 |
価値 |
| baiduApiKey |
Baidu Api キー。 |
糸 |
| baiduEndPoint |
Baidu エンドポイント。 |
糸 |
| baiduSecretKey |
Baidu 秘密鍵 |
糸 |
GcmCredential
GcmCredentialProperties
| 名前 |
形容 |
価値 |
| gcmEndpoint |
FCM レガシ エンドポイント。 既定値は 'https://fcm.googleapis.com/fcm/send' です |
糸 |
| googleApiKey |
Google API キー。 |
糸 |
Microsoft.NotificationHubs/namespaces/notificationHubs
| 名前 |
形容 |
価値 |
| 場所 |
リソースの場所 |
糸 |
| 名前 |
リソース名 |
string (必須) |
| 親 |
Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。
詳細については、「親リソースの外部 子リソース」を参照してください。 |
種類のリソースのシンボリック名: 名前空間 |
| プロパティ |
NotificationHub のプロパティ。 |
NotificationHubProperties (必須) |
| sku |
作成された名前空間の SKU |
SKU |
| タグ |
リソース タグ |
タグ名と値のディクショナリ。 テンプレート の タグを参照してください |
MpnsCredential
MpnsCredentialProperties
| 名前 |
形容 |
価値 |
| certificateKey |
この資格情報の証明書キー。 |
糸 |
| mpnsCertificate |
MPNS 証明書。 |
糸 |
| 拇印 |
MPNS 証明書の拇印 |
糸 |
NotificationHubProperties
| 名前 |
形容 |
価値 |
| admCredential |
作成された NotificationHub の AdmCredential |
AdmCredential の |
| apnsCredential |
作成された NotificationHub の ApnsCredential |
ApnsCredential の |
| authorizationRules |
作成された NotificationHub の AuthorizationRules |
SharedAccessAuthorizationRuleProperties[] |
| baiduCredential |
作成された NotificationHub の BaiduCredential |
BaiduCredential |
| gcmCredential |
作成された NotificationHub の GcmCredential |
GcmCredential |
| mpnsCredential |
作成された NotificationHub の MpnsCredential |
MpnsCredential |
| 名前 |
NotificationHub 名。 |
糸 |
| registrationTtl |
作成された NotificationHub の RegistrationTtl |
糸 |
| wnsCredential |
作成された NotificationHub の WnsCredential |
WnsCredential を する |
SharedAccessAuthorizationRuleProperties
| 名前 |
形容 |
価値 |
| 権利 |
ルールに関連付けられている権限。 |
次のいずれかを含む文字列配列:
'Listen'
'管理'
'Send' |
SKU
| 名前 |
形容 |
価値 |
| 能力 |
リソースの容量 |
int |
| 家族 |
Sku ファミリ |
糸 |
| 名前 |
通知ハブ SKU の名前 |
'Basic'
'Free'
'Standard' (必須) |
| 大きさ |
SKU のサイズ |
糸 |
| 層 |
特定の SKU のレベル |
糸 |
WnsCredential
| 名前 |
形容 |
価値 |
| プロパティ |
NotificationHub WnsCredential のプロパティ。 |
WnsCredentialProperties の |
WnsCredentialProperties
| 名前 |
形容 |
価値 |
| packageSid |
この資格情報のパッケージ ID。 |
糸 |
| secretKey |
秘密鍵。 |
糸 |
| windowsLiveEndpoint |
Windows Live エンドポイント。 |
糸 |
クイック スタートのサンプル
次のクイック スタート サンプルでは、このリソースの種類をデプロイします。
| Bicep ファイル |
形容 |
| Azure Notification Hub の作成 |
最初に John Downs によって作成された Azure Notification Hub テンプレートを作成します。 |
ARM テンプレート リソース定義
名前空間/notificationHubs リソースの種類は、次を対象とする操作でデプロイできます。
-
リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.NotificationHubs/namespaces/notificationHubs リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.NotificationHubs/namespaces/notificationHubs",
"apiVersion": "2017-04-01",
"name": "string",
"location": "string",
"properties": {
"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"
}
},
"authorizationRules": [
{
"rights": [ "string" ]
}
],
"baiduCredential": {
"properties": {
"baiduApiKey": "string",
"baiduEndPoint": "string",
"baiduSecretKey": "string"
}
},
"gcmCredential": {
"properties": {
"gcmEndpoint": "string",
"googleApiKey": "string"
}
},
"mpnsCredential": {
"properties": {
"certificateKey": "string",
"mpnsCertificate": "string",
"thumbprint": "string"
}
},
"name": "string",
"registrationTtl": "string",
"wnsCredential": {
"properties": {
"packageSid": "string",
"secretKey": "string",
"windowsLiveEndpoint": "string"
}
}
},
"sku": {
"capacity": "int",
"family": "string",
"name": "string",
"size": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
プロパティ値
AdmCredential
| 名前 |
形容 |
価値 |
| プロパティ |
NotificationHub AdmCredential のプロパティ。 |
AdmCredentialProperties の |
AdmCredentialProperties
| 名前 |
形容 |
価値 |
| authTokenUrl |
承認トークンの URL。 |
糸 |
| clientId |
クライアント識別子。 |
糸 |
| clientSecret |
資格情報シークレット アクセス キー。 |
糸 |
ApnsCredential
| 名前 |
形容 |
価値 |
| プロパティ |
NotificationHub ApnsCredential のプロパティ。 |
ApnsCredentialProperties の |
ApnsCredentialProperties
| 名前 |
形容 |
価値 |
| apnsCertificate |
APNS 証明書。 証明書認証モードを使用するかどうかを指定します。 |
糸 |
| appId |
発行者 (iss) 登録済み要求キー。 値は、開発者アカウントから取得した 10 文字の TeamId です。 トークン認証モードを使用するかどうかを指定します。 |
糸 |
| appName |
アプリケーションまたは BundleId の名前。 トークン認証モードを使用するかどうかを指定します。 |
糸 |
| certificateKey |
APNS 証明書のパスワード (存在する場合)。 |
糸 |
| エンドポイント |
この資格情報の APNS エンドポイント。 証明書認証モードとサンドボックスを使用する場合は、"gateway.sandbox.push.apple.com" を指定します。 証明書認証モードと運用環境を使用する場合は、"gateway.push.apple.com" を指定します。 トークン認証モードとサンドボックスを使用する場合は、'https://api.development.push.apple.com:443/3/device'を指定します。 トークン認証モードと運用モードを使用する場合は、'https://api.push.apple.com:443/3/device'を指定します。 |
糸 |
| keyId |
開発者アカウントから取得した 10 文字のキー識別子 (kid) キー。 トークン認証モードを使用するかどうかを指定します。 |
糸 |
| 拇印 |
APNS 証明書の拇印。 証明書認証モードを使用するかどうかを指定します。 |
糸 |
| トークン |
開発者アカウントを介して取得されたプロバイダー認証トークン。 トークン認証モードを使用するかどうかを指定します。 |
糸 |
BaiduCredential
| 名前 |
形容 |
価値 |
| プロパティ |
NotificationHub BaiduCredential のプロパティ。 |
BaiduCredentialProperties の |
BaiduCredentialProperties
| 名前 |
形容 |
価値 |
| baiduApiKey |
Baidu Api キー。 |
糸 |
| baiduEndPoint |
Baidu エンドポイント。 |
糸 |
| baiduSecretKey |
Baidu 秘密鍵 |
糸 |
GcmCredential
GcmCredentialProperties
| 名前 |
形容 |
価値 |
| gcmEndpoint |
FCM レガシ エンドポイント。 既定値は 'https://fcm.googleapis.com/fcm/send' です |
糸 |
| googleApiKey |
Google API キー。 |
糸 |
Microsoft.NotificationHubs/namespaces/notificationHubs
| 名前 |
形容 |
価値 |
| apiVersion |
API のバージョン |
'2017-04-01' |
| 場所 |
リソースの場所 |
糸 |
| 名前 |
リソース名 |
string (必須) |
| プロパティ |
NotificationHub のプロパティ。 |
NotificationHubProperties (必須) |
| sku |
作成された名前空間の SKU |
SKU |
| タグ |
リソース タグ |
タグ名と値のディクショナリ。 テンプレート の タグを参照してください |
| 種類 |
リソースの種類 |
'Microsoft.NotificationHubs/namespaces/notificationHubs' |
MpnsCredential
MpnsCredentialProperties
| 名前 |
形容 |
価値 |
| certificateKey |
この資格情報の証明書キー。 |
糸 |
| mpnsCertificate |
MPNS 証明書。 |
糸 |
| 拇印 |
MPNS 証明書の拇印 |
糸 |
NotificationHubProperties
| 名前 |
形容 |
価値 |
| admCredential |
作成された NotificationHub の AdmCredential |
AdmCredential の |
| apnsCredential |
作成された NotificationHub の ApnsCredential |
ApnsCredential の |
| authorizationRules |
作成された NotificationHub の AuthorizationRules |
SharedAccessAuthorizationRuleProperties[] |
| baiduCredential |
作成された NotificationHub の BaiduCredential |
BaiduCredential |
| gcmCredential |
作成された NotificationHub の GcmCredential |
GcmCredential |
| mpnsCredential |
作成された NotificationHub の MpnsCredential |
MpnsCredential |
| 名前 |
NotificationHub 名。 |
糸 |
| registrationTtl |
作成された NotificationHub の RegistrationTtl |
糸 |
| wnsCredential |
作成された NotificationHub の WnsCredential |
WnsCredential を する |
SharedAccessAuthorizationRuleProperties
| 名前 |
形容 |
価値 |
| 権利 |
ルールに関連付けられている権限。 |
次のいずれかを含む文字列配列:
'Listen'
'管理'
'Send' |
SKU
| 名前 |
形容 |
価値 |
| 能力 |
リソースの容量 |
int |
| 家族 |
Sku ファミリ |
糸 |
| 名前 |
通知ハブ SKU の名前 |
'Basic'
'Free'
'Standard' (必須) |
| 大きさ |
SKU のサイズ |
糸 |
| 層 |
特定の SKU のレベル |
糸 |
WnsCredential
| 名前 |
形容 |
価値 |
| プロパティ |
NotificationHub WnsCredential のプロパティ。 |
WnsCredentialProperties の |
WnsCredentialProperties
| 名前 |
形容 |
価値 |
| packageSid |
この資格情報のパッケージ ID。 |
糸 |
| secretKey |
秘密鍵。 |
糸 |
| windowsLiveEndpoint |
Windows Live エンドポイント。 |
糸 |
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
| テンプレート |
形容 |
Azure Notification Hub の作成
Azure にデプロイする |
最初に John Downs によって作成された Azure Notification Hub テンプレートを作成します。 |
SQL Database を使用してモバイル アプリをプロビジョニングする
Azure にデプロイする |
このテンプレートは、モバイル アプリ、SQL Database、および Notification Hub をプロビジョニングします。 データベースと通知ハブのモバイル アプリで接続文字列を構成します。 |
名前空間/notificationHubs リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.NotificationHubs/namespaces/notificationHubs リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.NotificationHubs/namespaces/notificationHubs@2017-04-01"
name = "string"
location = "string"
sku = {
capacity = int
family = "string"
name = "string"
size = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
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"
}
}
authorizationRules = [
{
rights = [
"string"
]
}
]
baiduCredential = {
properties = {
baiduApiKey = "string"
baiduEndPoint = "string"
baiduSecretKey = "string"
}
}
gcmCredential = {
properties = {
gcmEndpoint = "string"
googleApiKey = "string"
}
}
mpnsCredential = {
properties = {
certificateKey = "string"
mpnsCertificate = "string"
thumbprint = "string"
}
}
name = "string"
registrationTtl = "string"
wnsCredential = {
properties = {
packageSid = "string"
secretKey = "string"
windowsLiveEndpoint = "string"
}
}
}
})
}
プロパティ値
AdmCredential
| 名前 |
形容 |
価値 |
| プロパティ |
NotificationHub AdmCredential のプロパティ。 |
AdmCredentialProperties の |
AdmCredentialProperties
| 名前 |
形容 |
価値 |
| authTokenUrl |
承認トークンの URL。 |
糸 |
| clientId |
クライアント識別子。 |
糸 |
| clientSecret |
資格情報シークレット アクセス キー。 |
糸 |
ApnsCredential
| 名前 |
形容 |
価値 |
| プロパティ |
NotificationHub ApnsCredential のプロパティ。 |
ApnsCredentialProperties の |
ApnsCredentialProperties
| 名前 |
形容 |
価値 |
| apnsCertificate |
APNS 証明書。 証明書認証モードを使用するかどうかを指定します。 |
糸 |
| appId |
発行者 (iss) 登録済み要求キー。 値は、開発者アカウントから取得した 10 文字の TeamId です。 トークン認証モードを使用するかどうかを指定します。 |
糸 |
| appName |
アプリケーションまたは BundleId の名前。 トークン認証モードを使用するかどうかを指定します。 |
糸 |
| certificateKey |
APNS 証明書のパスワード (存在する場合)。 |
糸 |
| エンドポイント |
この資格情報の APNS エンドポイント。 証明書認証モードとサンドボックスを使用する場合は、"gateway.sandbox.push.apple.com" を指定します。 証明書認証モードと運用環境を使用する場合は、"gateway.push.apple.com" を指定します。 トークン認証モードとサンドボックスを使用する場合は、'https://api.development.push.apple.com:443/3/device'を指定します。 トークン認証モードと運用モードを使用する場合は、'https://api.push.apple.com:443/3/device'を指定します。 |
糸 |
| keyId |
開発者アカウントから取得した 10 文字のキー識別子 (kid) キー。 トークン認証モードを使用するかどうかを指定します。 |
糸 |
| 拇印 |
APNS 証明書の拇印。 証明書認証モードを使用するかどうかを指定します。 |
糸 |
| トークン |
開発者アカウントを介して取得されたプロバイダー認証トークン。 トークン認証モードを使用するかどうかを指定します。 |
糸 |
BaiduCredential
| 名前 |
形容 |
価値 |
| プロパティ |
NotificationHub BaiduCredential のプロパティ。 |
BaiduCredentialProperties の |
BaiduCredentialProperties
| 名前 |
形容 |
価値 |
| baiduApiKey |
Baidu Api キー。 |
糸 |
| baiduEndPoint |
Baidu エンドポイント。 |
糸 |
| baiduSecretKey |
Baidu 秘密鍵 |
糸 |
GcmCredential
GcmCredentialProperties
| 名前 |
形容 |
価値 |
| gcmEndpoint |
FCM レガシ エンドポイント。 既定値は 'https://fcm.googleapis.com/fcm/send' です |
糸 |
| googleApiKey |
Google API キー。 |
糸 |
Microsoft.NotificationHubs/namespaces/notificationHubs
| 名前 |
形容 |
価値 |
| 場所 |
リソースの場所 |
糸 |
| 名前 |
リソース名 |
string (必須) |
| parent_id |
このリソースの親であるリソースの ID。 |
種類のリソースの ID: 名前空間 |
| プロパティ |
NotificationHub のプロパティ。 |
NotificationHubProperties (必須) |
| sku |
作成された名前空間の SKU |
SKU |
| タグ |
リソース タグ |
タグ名と値のディクショナリ。 |
| 種類 |
リソースの種類 |
"Microsoft.NotificationHubs/namespaces/notificationHubs@2017-04-01" |
MpnsCredential
MpnsCredentialProperties
| 名前 |
形容 |
価値 |
| certificateKey |
この資格情報の証明書キー。 |
糸 |
| mpnsCertificate |
MPNS 証明書。 |
糸 |
| 拇印 |
MPNS 証明書の拇印 |
糸 |
NotificationHubProperties
| 名前 |
形容 |
価値 |
| admCredential |
作成された NotificationHub の AdmCredential |
AdmCredential の |
| apnsCredential |
作成された NotificationHub の ApnsCredential |
ApnsCredential の |
| authorizationRules |
作成された NotificationHub の AuthorizationRules |
SharedAccessAuthorizationRuleProperties[] |
| baiduCredential |
作成された NotificationHub の BaiduCredential |
BaiduCredential |
| gcmCredential |
作成された NotificationHub の GcmCredential |
GcmCredential |
| mpnsCredential |
作成された NotificationHub の MpnsCredential |
MpnsCredential |
| 名前 |
NotificationHub 名。 |
糸 |
| registrationTtl |
作成された NotificationHub の RegistrationTtl |
糸 |
| wnsCredential |
作成された NotificationHub の WnsCredential |
WnsCredential を する |
SharedAccessAuthorizationRuleProperties
| 名前 |
形容 |
価値 |
| 権利 |
ルールに関連付けられている権限。 |
次のいずれかを含む文字列配列:
'Listen'
'管理'
'Send' |
SKU
| 名前 |
形容 |
価値 |
| 能力 |
リソースの容量 |
int |
| 家族 |
Sku ファミリ |
糸 |
| 名前 |
通知ハブ SKU の名前 |
'Basic'
'Free'
'Standard' (必須) |
| 大きさ |
SKU のサイズ |
糸 |
| 層 |
特定の SKU のレベル |
糸 |
WnsCredential
| 名前 |
形容 |
価値 |
| プロパティ |
NotificationHub WnsCredential のプロパティ。 |
WnsCredentialProperties の |
WnsCredentialProperties
| 名前 |
形容 |
価値 |
| packageSid |
この資格情報のパッケージ ID。 |
糸 |
| secretKey |
秘密鍵。 |
糸 |
| windowsLiveEndpoint |
Windows Live エンドポイント。 |
糸 |