Microsoft.NotificationHubs 名前空間/notificationHubs 2017-04-01

[アーティクル]
04/14/2024

Bicep リソース定義

名前空間/notificationHubs リソースの種類は、次を対象とする操作でデプロイできます。

リソースグループ - リソースグループのデプロイコマンドを参照してください

各 API バージョンの変更されたプロパティの一覧については、「変更ログ」を参照してください。

リソース形式

Microsoft.NotificationHubs/namespaces/notificationHubs リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.NotificationHubs/namespaces/notificationHubs@2017-04-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  parent: resourceSymbolicName
  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'
      }
    }
  }
}

プロパティ値

namespaces/notificationHubs

名前	説明	値
name	リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。	string (必須) 文字制限: 1 から 260 有効な文字: 英数字、ピリオド、ハイフン、およびアンダースコア。英数字で開始します。
location	リソースの場所	string
tags	リソースタグ	タグの名前と値のディクショナリ。「テンプレート内のタグ」を参照してください
sku	作成された名前空間の SKU	SKU
parent	Bicep では、子リソースの親リソースを指定できます。このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。詳細については、「親リソースの外部の子リソース」を参照してください。	型のリソースのシンボル名: 名前空間
properties	NotificationHub のプロパティ。	NotificationHubProperties (必須)

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
name	NotificationHub 名。	string
registrationTtl	作成された NotificationHub の RegistrationTtl	string
wnsCredential	作成された NotificationHub の WnsCredential	WnsCredential

AdmCredential

名前	説明	値
properties	NotificationHub AdmCredential のプロパティ。	AdmCredentialProperties

AdmCredentialProperties

名前	説明	値
authTokenUrl	承認トークンの URL。	string
clientId	The client identifier. (クライアント識別子。)	string
clientSecret	資格情報シークレットアクセスキー。	string

ApnsCredential

名前	説明	値
properties	NotificationHub ApnsCredential のプロパティ。	ApnsCredentialProperties

ApnsCredentialProperties

名前	説明	値
apnsCertificate	APNS 証明書。証明書認証モードを使用するかどうかを指定します。	string
appId	発行者 (iss) に登録されている要求キー。値は、開発者アカウントから取得した 10 文字の TeamId です。トークン認証モードを使用するかどうかを指定します。	string
appName	アプリケーションまたは BundleId の名前。トークン認証モードを使用するかどうかを指定します。	string
certificateKey	APNS 証明書のパスワード (存在する場合)。	string
endpoint	この資格情報の 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指定する場合。	string
keyId	開発者アカウントから取得した 10 文字のキー識別子 (kid) キー。トークン認証モードを使用するかどうかを指定します。	string
thumbprint	APNS 証明書の拇印。証明書認証モードを使用するかどうかを指定します。	string
token	開発者アカウントを介して取得されたプロバイダー認証トークン。トークン認証モードを使用するかどうかを指定します。	string

SharedAccessAuthorizationRuleProperties

名前	説明	値
権限	ルールに関連付けられている権限。	次のいずれかを含む文字列配列: 'Listen' '管理' 'Send'

BaiduCredential

名前	説明	値
properties	NotificationHub BaiduCredential のプロパティ。	BaiduCredentialProperties

BaiduCredentialProperties

名前	説明	値
baiduApiKey	Baidu Api キー。	string
baiduEndPoint	Baidu エンドポイント。	string
baiduSecretKey	Baidu シークレットキー	string

GcmCredential

名前	説明	値
properties	NotificationHub GcmCredential のプロパティ。	GcmCredentialProperties

GcmCredentialProperties

名前	説明	値
gcmEndpoint	FCM レガシエンドポイント。既定値は 'https://fcm.googleapis.com/fcm/send' です	string
googleApiKey	Google API キー。	string

MpnsCredential

名前	説明	値
properties	NotificationHub MpnsCredential のプロパティ。	MpnsCredentialProperties

MpnsCredentialProperties

名前	説明	値
certificateKey	この資格情報の証明書キー。	string
mpnsCertificate	MPNS 証明書。	string
thumbprint	MPNS 証明書の拇印	string

WnsCredential

名前	説明	値
properties	NotificationHub WnsCredential のプロパティ。	WnsCredentialProperties

WnsCredentialProperties

名前	説明	値
packageSid	この資格情報のパッケージ ID。	string
secretKey	秘密キー。	string
windowsLiveEndpoint	Windows Live エンドポイント。	string

Sku

名前	説明	値
capacity	リソースの容量	INT
family	Sku ファミリ	string
name	通知ハブ SKU の名前	'Basic' 'Free' 'Standard' (必須)
size	Sku のサイズ	string
レベル	特定の SKU のレベル	string

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

Template	説明
Azure Notification Hub を作成する	John Downs によって最初に作成された Azure Notification Hub テンプレートを作成します。
SQL Databaseを使用してモバイルアプリをプロビジョニングする	このテンプレートは、モバイルアプリ、SQL Database、および通知ハブをプロビジョニングします。データベースと通知ハブのモバイルアプリで接続文字列を構成します。

ARM テンプレートリソース定義

名前空間/notificationHubs リソースの種類は、次を対象とする操作でデプロイできます。

リソースグループ - リソースグループのデプロイコマンドを参照してください

各 API バージョンの変更されたプロパティの一覧については、「変更ログ」を参照してください。

リソース形式

Microsoft.NotificationHubs/namespaces/notificationHubs リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.NotificationHubs/namespaces/notificationHubs",
  "apiVersion": "2017-04-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "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"
      }
    }
  }
}

プロパティ値

namespaces/notificationHubs

名前	説明	値
type	リソースの種類	'Microsoft.NotificationHubs/namespaces/notificationHubs'
apiVersion	リソース API のバージョン	'2017-04-01'
name	リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。	string (必須) 文字制限: 1 から 260 有効な文字: 英数字、ピリオド、ハイフン、およびアンダースコア。英数字で開始します。
location	リソースの場所	string
tags	リソースタグ	タグの名前と値のディクショナリ。「テンプレート内のタグ」を参照してください
sku	作成された名前空間の SKU	SKU
properties	NotificationHub のプロパティ。	NotificationHubProperties (必須)

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
name	NotificationHub 名。	string
registrationTtl	作成された NotificationHub の RegistrationTtl	string
wnsCredential	作成された NotificationHub の WnsCredential	WnsCredential

AdmCredential

名前	説明	値
properties	NotificationHub AdmCredential のプロパティ。	AdmCredentialProperties

AdmCredentialProperties

名前	説明	値
authTokenUrl	承認トークンの URL。	string
clientId	The client identifier. (クライアント識別子。)	string
clientSecret	資格情報シークレットアクセスキー。	string

ApnsCredential

名前	説明	値
properties	NotificationHub ApnsCredential のプロパティ。	ApnsCredentialProperties

ApnsCredentialProperties

名前	説明	値
apnsCertificate	APNS 証明書。証明書認証モードを使用するかどうかを指定します。	string
appId	発行者 (iss) によって登録された要求キー。値は、開発者アカウントから取得した 10 文字の TeamId です。トークン認証モードを使用するかどうかを指定します。	string
appName	アプリケーションまたは BundleId の名前。トークン認証モードを使用するかどうかを指定します。	string
certificateKey	APNS 証明書のパスワード (存在する場合)。	string
endpoint	この資格情報の 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指定します。	string
keyId	開発者アカウントから取得した 10 文字のキー識別子 (kid) キー。トークン認証モードを使用するかどうかを指定します。	string
thumbprint	APNS 証明書の拇印。証明書認証モードを使用するかどうかを指定します。	string
token	プロバイダー認証トークン。開発者アカウントを通じて取得されます。トークン認証モードを使用するかどうかを指定します。	string

SharedAccessAuthorizationRuleProperties

名前	説明	値
権限	ルールに関連付けられている権限。	次のいずれかを含む文字列配列: 'Listen' '管理' 'Send'

BaiduCredential

名前	説明	値
properties	NotificationHub BaiduCredential のプロパティ。	BaiduCredentialProperties

BaiduCredentialProperties

名前	説明	値
baiduApiKey	Baidu Api キー。	string
baiduEndPoint	Baidu エンドポイント。	string
baiduSecretKey	Baidu シークレットキー	string

GcmCredential

名前	説明	値
properties	NotificationHub GcmCredential のプロパティ。	GcmCredentialProperties

GcmCredentialProperties

名前	説明	値
gcmEndpoint	FCM レガシエンドポイント。既定値は 'https://fcm.googleapis.com/fcm/send' です	string
googleApiKey	Google API キー。	string

MpnsCredential

名前	説明	値
properties	NotificationHub MpnsCredential のプロパティ。	MpnsCredentialProperties

MpnsCredentialProperties

名前	説明	値
certificateKey	この資格情報の証明書キー。	string
mpnsCertificate	MPNS 証明書。	string
thumbprint	MPNS 証明書の拇印	string

WnsCredential

名前	説明	値
properties	NotificationHub WnsCredential のプロパティ。	WnsCredentialProperties

WnsCredentialProperties

名前	説明	値
packageSid	この資格情報のパッケージ ID。	string
secretKey	秘密キー。	string
windowsLiveEndpoint	Windows Live エンドポイント。	string

Sku

名前	説明	値
capacity	リソースの容量	INT
family	Sku ファミリ	string
name	通知ハブ SKU の名前	'Basic' 'Free' 'Standard' (必須)
size	Sku のサイズ	string
レベル	特定の SKU のレベル	string

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

Template	説明
Azure Notification Hub を作成する	John Downs によって最初に作成された Azure Notification Hub テンプレートを作成します。
SQL Databaseを使用してモバイルアプリをプロビジョニングする	このテンプレートは、モバイルアプリ、SQL Database、および通知ハブをプロビジョニングします。データベースと通知ハブのモバイルアプリで接続文字列を構成します。

Terraform (AzAPI プロバイダー) リソース定義

名前空間/notificationHubs リソースの種類は、次を対象とする操作でデプロイできます。

リソースグループ

各 API バージョンの変更されたプロパティの一覧については、「変更ログ」を参照してください。

リソース形式

Microsoft.NotificationHubs/namespaces/notificationHubs リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NotificationHubs/namespaces/notificationHubs@2017-04-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  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"
        }
      }
    }
    sku = {
      capacity = int
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
  })
}

プロパティ値

namespaces/notificationHubs

名前	説明	値
type	リソースの種類	"Microsoft.NotificationHubs/namespaces/notificationHubs@2017-04-01"
name	リソース名	string (必須) 文字制限: 1 から 260 有効な文字: 英数字、ピリオド、ハイフン、およびアンダースコア。英数字で開始します。
location	リソースの場所	string
parent_id	このリソースの親であるリソースの ID。	型のリソースの ID: 名前空間
tags	リソースタグ	タグの名前と値のディクショナリ。
sku	作成された名前空間の SKU	SKU
properties	NotificationHub のプロパティ。	NotificationHubProperties (必須)

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
name	NotificationHub 名。	string
registrationTtl	作成された NotificationHub の RegistrationTtl	string
wnsCredential	作成された NotificationHub の WnsCredential	WnsCredential

AdmCredential

名前	説明	値
properties	NotificationHub AdmCredential のプロパティ。	AdmCredentialProperties

AdmCredentialProperties

名前	説明	値
authTokenUrl	承認トークンの URL。	string
clientId	The client identifier. (クライアント識別子。)	string
clientSecret	資格情報シークレットアクセスキー。	string

ApnsCredential

名前	説明	値
properties	NotificationHub ApnsCredential のプロパティ。	ApnsCredentialProperties

ApnsCredentialProperties

名前	説明	値
apnsCertificate	APNS 証明書。証明書認証モードを使用するかどうかを指定します。	string
appId	発行者 (iss) に登録されている要求キー。値は、開発者アカウントから取得した 10 文字の TeamId です。トークン認証モードを使用するかどうかを指定します。	string
appName	アプリケーションまたは BundleId の名前。トークン認証モードを使用するかどうかを指定します。	string
certificateKey	APNS 証明書のパスワード (存在する場合)。	string
endpoint	この資格情報の 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指定する場合。	string
keyId	開発者アカウントから取得した 10 文字のキー識別子 (kid) キー。トークン認証モードを使用するかどうかを指定します。	string
thumbprint	APNS 証明書の拇印。証明書認証モードを使用するかどうかを指定します。	string
token	開発者アカウントを介して取得されたプロバイダー認証トークン。トークン認証モードを使用するかどうかを指定します。	string

SharedAccessAuthorizationRuleProperties

名前	説明	値
権限	ルールに関連付けられている権限。	次のいずれかを含む文字列配列: "Listen" "管理" "送信"

BaiduCredential

名前	説明	値
properties	NotificationHub BaiduCredential のプロパティ。	BaiduCredentialProperties

BaiduCredentialProperties

名前	説明	値
baiduApiKey	Baidu Api キー。	string
baiduEndPoint	Baidu エンドポイント。	string
baiduSecretKey	Baidu シークレットキー	string

GcmCredential

名前	説明	値
properties	NotificationHub GcmCredential のプロパティ。	GcmCredentialProperties

GcmCredentialProperties

名前	説明	値
gcmEndpoint	FCM レガシエンドポイント。既定値は 'https://fcm.googleapis.com/fcm/send' です	string
googleApiKey	Google API キー。	string

MpnsCredential

名前	説明	値
properties	NotificationHub MpnsCredential のプロパティ。	MpnsCredentialProperties

MpnsCredentialProperties

名前	説明	値
certificateKey	この資格情報の証明書キー。	string
mpnsCertificate	MPNS 証明書。	string
thumbprint	MPNS 証明書の拇印	string

WnsCredential

名前	説明	値
properties	NotificationHub WnsCredential のプロパティ。	WnsCredentialProperties

WnsCredentialProperties

名前	説明	値
packageSid	この資格情報のパッケージ ID。	string
secretKey	秘密キー。	string
windowsLiveEndpoint	Windows Live エンドポイント。	string

Sku

名前	説明	値
capacity	リソースの容量	INT
family	Sku ファミリ	string
name	通知ハブ SKU の名前	"Basic" "Free" "Standard" (必須)
size	Sku のサイズ	string
レベル	特定の SKU のレベル	string

次の方法で共有

Microsoft.NotificationHubs 名前空間/notificationHubs 2017-04-01

Bicep リソース定義

リソース形式

プロパティ値

namespaces/notificationHubs

NotificationHubProperties

AdmCredential

AdmCredentialProperties

ApnsCredential

ApnsCredentialProperties

SharedAccessAuthorizationRuleProperties

BaiduCredential

BaiduCredentialProperties

GcmCredential

GcmCredentialProperties

MpnsCredential

MpnsCredentialProperties

WnsCredential

WnsCredentialProperties

Sku

クイック スタート テンプレート

ARM テンプレート リソース定義

リソース形式

プロパティ値

namespaces/notificationHubs

NotificationHubProperties

AdmCredential

AdmCredentialProperties

ApnsCredential

ApnsCredentialProperties

SharedAccessAuthorizationRuleProperties

BaiduCredential

BaiduCredentialProperties

GcmCredential

GcmCredentialProperties

MpnsCredential

MpnsCredentialProperties

WnsCredential

WnsCredentialProperties

Sku

クイック スタート テンプレート

Terraform (AzAPI プロバイダー) リソース定義

リソース形式

プロパティ値

namespaces/notificationHubs

NotificationHubProperties

AdmCredential

AdmCredentialProperties

ApnsCredential

ApnsCredentialProperties

SharedAccessAuthorizationRuleProperties

BaiduCredential

BaiduCredentialProperties

GcmCredential

GcmCredentialProperties

MpnsCredential

MpnsCredentialProperties

WnsCredential

WnsCredentialProperties

Sku

フィードバック

フィードバック

その他のリソース

クイックスタートテンプレート

ARM テンプレートリソース定義

クイックスタートテンプレート