次の方法で共有


Microsoft.NotificationHubs 名前空間 2023-10-01-preview

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

プロパティ値

namespaces

名前 説明
name リソース名 string (必須)

文字数制限: 6 から 50

有効な文字:
英数字とハイフン

文字で開始します。 末尾には英数文字を使用します。

リソース名は、Azure 全体で一意である必要があります。
location リソースが保存されている地理的な場所 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
sku 名前空間の Sku の説明 Sku (必須)
properties 名前空間のプロパティを表します。 NamespaceProperties

NamespaceProperties

名前 説明
センター 非推奨になりました。 string
namespaceType NamespaceType の値を定義します。 'メッセージング'
'NotificationHub'
networkAcls ネットワーク承認規則のコレクション。 NetworkAcls
pnsCredentials Notification Hub または Notification Hub 名前空間 PNS 資格情報のコレクション。 PnsCredentials
provisioningState OperationProvisioningState の値を定義します。 'Canceled'
'Disabled'
'Failed'
'InProgress'
'保留中'
'Succeeded'
'不明'
publicNetworkAccess パブリック ネットワーク アクセスの種類。 'Disabled'
'Enabled'
replicationRegion 許可されているレプリケーション リージョン 'AustraliaEast'
'BrazilSouth'
'Default'
'None'
'NorthEurope'
'SouthAfricaNorth'
'SouthEastAsia'
'WestUs2'
scaleUnit 名前空間が作成される scaleUnit を取得または設定します。 string
status 名前空間の状態。 'Created'
'Creating'
'削除中'
'Suspended'
zoneRedundancy 名前空間 SKU 名。 'Disabled'
'Enabled'

NetworkAcls

名前 説明
ipRules IP 規則の一覧。 IpRule[]
publicNetworkRule 既定の (パブリック インターネット) ネットワーク承認規則。他のネットワーク規則が一致しない場合は権限が含まれます。 PublicInternetAuthorizationRule

IpRule

名前 説明
ipMask IP マスク。 string (必須)

制約:
最小長 = 1
権限 アクセス権の一覧。 次のいずれかを含む文字列配列:
'Listen'
'管理'
'Send' (必須)

PublicInternetAuthorizationRule

名前 説明
権限 アクセス権の一覧。 次のいずれかを含む文字列配列:
'Listen'
'管理'
'Send' (必須)

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 NotificationHub XiaomiCredential の説明。 XiaomiCredential

AdmCredential

名前 説明
properties NotificationHub AdmCredential の説明。 AdmCredentialProperties (必須)

AdmCredentialProperties

名前 説明
authTokenUrl 承認トークンの URL を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
clientId クライアント識別子を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
clientSecret 資格情報シークレット アクセス キーを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。

ApnsCredential

名前 説明
properties NotificationHub ApnsCredential の説明。 ApnsCredentialProperties (必須)

ApnsCredentialProperties

名前 説明
apnsCertificate APNS 証明書を取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
appId 発行者 (iss) の登録された要求キーを取得または設定します。その値は です。
開発者アカウントから取得した 10 文字のチーム ID
string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
appName アプリケーションの名前を取得または設定します string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
certificateKey 証明書キーを取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
endpoint この資格情報のエンドポイントを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
keyId から取得した 10 文字のキー識別子 (kid) キーを取得または設定します
開発者アカウント
string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
thumbprint APNS 証明書の拇印を取得または設定します string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
token プロバイダー認証トークンを取得または設定します。
開発者アカウント
string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。

BaiduCredential

名前 説明
properties NotificationHub BaiduCredential の説明。 BaiduCredentialProperties (必須)

BaiduCredentialProperties

名前 説明
baiduApiKey baidu Api Key を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
baiduEndPoint baidu Endpoint を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
baiduSecretKey baidu シークレット キーを取得または設定します string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。

BrowserCredential

名前 説明
properties NotificationHub BrowserCredential の説明。 BrowserCredentialProperties (必須)

BrowserCredentialProperties

名前 説明
subject Web プッシュの件名を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
vapidPrivateKey VAPID 秘密キーを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
vapidPublicKey VAPID 公開キーを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。

FcmV1Credential

名前 説明
properties NotificationHub FcmV1Credential の説明。 FcmV1CredentialProperties (必須)

FcmV1CredentialProperties

名前 説明
clientEmail クライアント電子メールを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
privateKey 秘密キーを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
projectId プロジェクト ID を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。

GcmCredential

名前 説明
properties NotificationHub GcmCredential の説明。 GcmCredentialProperties (必須)

GcmCredentialProperties

名前 説明
gcmEndpoint GCM エンドポイントを取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
googleApiKey Google API キーを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。

MpnsCredential

名前 説明
properties NotificationHub MpnsCredential の説明。 MpnsCredentialProperties (必須)

MpnsCredentialProperties

名前 説明
certificateKey この資格情報の証明書キーを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
mpnsCertificate MPNS 証明書を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
thumbprint MPNS 証明書の拇印を取得または設定します string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。

WnsCredential

名前 説明
properties NotificationHub WnsCredential の説明。 WnsCredentialProperties (必須)

WnsCredentialProperties

名前 説明
certificateKey WNS 証明書キーを設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
packageSid この資格情報のパッケージ ID を取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
secretKey 秘密キーを取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
windowsLiveEndpoint Windows Live エンドポイントを取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
wnsCertificate WNS 証明書を取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。

XiaomiCredential

名前 説明
properties NotificationHub XiaomiCredentialProperties の説明。 XiaomiCredentialProperties (必須)

XiaomiCredentialProperties

名前 説明
appSecret アプリ シークレットを取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
endpoint xiaomi サービス エンドポイントを取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。

Sku

名前 説明
capacity リソースの容量を取得または設定します INT
family Sku ファミリを取得または設定します string
name 名前空間 SKU 名。 'Basic'
'Free'
'Standard' (必須)
size Sku サイズを取得または設定します string
レベル 特定の SKU のレベルを取得または設定します string

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

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

Template 説明
Azure Notification Hub を作成する

Azure にデプロイする
最初に John Downs によって作成された Azure Notification Hub テンプレートを作成します。
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"
  }
}

プロパティ値

namespaces

名前 説明
type リソースの種類 'Microsoft.NotificationHubs/namespaces'
apiVersion リソース API のバージョン '2023-10-01-preview'
name リソース名 string (必須)

文字数制限: 6 から 50

有効な文字:
英数字とハイフン

文字で開始します。 末尾には英数文字を使用します。

リソース名は、Azure 全体で一意である必要があります。
location リソースが保存されている地理的な場所 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
sku 名前空間の Sku の説明 Sku (必須)
properties 名前空間のプロパティを表します。 NamespaceProperties

NamespaceProperties

名前 説明
センター 非推奨になりました。 string
namespaceType NamespaceType の値を定義します。 'メッセージング'
'NotificationHub'
networkAcls ネットワーク承認規則のコレクション。 NetworkAcls
pnsCredentials Notification Hub または Notification Hub 名前空間 PNS 資格情報のコレクション。 PnsCredentials
provisioningState OperationProvisioningState の値を定義します。 'Canceled'
'Disabled'
'Failed'
'InProgress'
'保留中'
'Succeeded'
'不明'
publicNetworkAccess パブリック ネットワーク アクセスの種類。 'Disabled'
'Enabled'
replicationRegion 許可されているレプリケーション リージョン 'AustraliaEast'
'BrazilSouth'
'Default'
'None'
'NorthEurope'
'SouthAfricaNorth'
'SouthEastAsia'
'WestUs2'
scaleUnit 名前空間が作成される scaleUnit を取得または設定します。 string
status 名前空間の状態。 'Created'
'Creating'
'削除中'
'Suspended'
zoneRedundancy 名前空間 SKU 名。 'Disabled'
'Enabled'

NetworkAcls

名前 説明
ipRules IP 規則の一覧。 IpRule[]
publicNetworkRule 既定の (パブリック インターネット) ネットワーク承認規則。他のネットワーク規則が一致しない場合は権限が含まれます。 PublicInternetAuthorizationRule

IpRule

名前 説明
ipMask IP マスク。 string (必須)

制約:
最小長 = 1
権限 アクセス権の一覧。 次のいずれかを含む文字列配列:
'Listen'
'管理'
'Send' (必須)

PublicInternetAuthorizationRule

名前 説明
権限 アクセス権の一覧。 次のいずれかを含む文字列配列:
'Listen'
'管理'
'Send' (必須)

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 NotificationHub XiaomiCredential の説明。 XiaomiCredential

AdmCredential

名前 説明
properties NotificationHub AdmCredential の説明。 AdmCredentialProperties (必須)

AdmCredentialProperties

名前 説明
authTokenUrl 承認トークンの URL を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
clientId クライアント識別子を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
clientSecret 資格情報シークレット アクセス キーを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。

ApnsCredential

名前 説明
properties NotificationHub ApnsCredential の説明。 ApnsCredentialProperties (必須)

ApnsCredentialProperties

名前 説明
apnsCertificate APNS 証明書を取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
appId 発行者 (iss) の登録された要求キーを取得または設定します。その値は です。
開発者アカウントから取得した 10 文字のチーム ID
string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
appName アプリケーションの名前を取得または設定します string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
certificateKey 証明書キーを取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
endpoint この資格情報のエンドポイントを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
keyId から取得した 10 文字のキー識別子 (kid) キーを取得または設定します
開発者アカウント
string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
thumbprint APNS 証明書の拇印を取得または設定します string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
token プロバイダー認証トークンを取得または設定します。
開発者アカウント
string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。

BaiduCredential

名前 説明
properties NotificationHub BaiduCredential の説明。 BaiduCredentialProperties (必須)

BaiduCredentialProperties

名前 説明
baiduApiKey baidu Api Key を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
baiduEndPoint baidu エンドポイントを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
baiduSecretKey baidu 秘密鍵を取得または設定します string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。

BrowserCredential

名前 説明
properties NotificationHub BrowserCredential の説明。 BrowserCredentialProperties (必須)

BrowserCredentialProperties

名前 説明
subject Web プッシュの件名を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
vapidPrivateKey VAPID 秘密キーを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
vapidPublicKey VAPID 公開キーを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。

FcmV1Credential

名前 説明
properties NotificationHub FcmV1Credential の説明。 FcmV1CredentialProperties (必須)

FcmV1CredentialProperties

名前 説明
clientEmail クライアント電子メールを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
privateKey 秘密キーを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
projectId プロジェクト ID を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。

GcmCredential

名前 説明
properties NotificationHub GcmCredential の説明。 GcmCredentialProperties (必須)

GcmCredentialProperties

名前 説明
gcmEndpoint GCM エンドポイントを取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
googleApiKey Google API キーを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。

MpnsCredential

名前 説明
properties NotificationHub MpnsCredential の説明。 MpnsCredentialProperties (必須)

MpnsCredentialProperties

名前 説明
certificateKey この資格情報の証明書キーを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
mpnsCertificate MPNS 証明書を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
thumbprint MPNS 証明書の拇印を取得または設定します string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。

WnsCredential

名前 説明
properties NotificationHub WnsCredential の説明。 WnsCredentialProperties (必須)

WnsCredentialProperties

名前 説明
certificateKey WNS 証明書キーを設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
packageSid この資格情報のパッケージ ID を取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
secretKey 秘密キーを取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
windowsLiveEndpoint Windows Live エンドポイントを取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
wnsCertificate WNS 証明書を取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。

XiaomiCredential

名前 説明
properties NotificationHub XiaomiCredentialProperties の説明。 XiaomiCredentialProperties (必須)

XiaomiCredentialProperties

名前 説明
appSecret アプリ シークレットを取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
endpoint xiaomi サービス エンドポイントを取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。

Sku

名前 説明
capacity リソースの容量を取得または設定します INT
family Sku ファミリを取得または設定します string
name 名前空間 SKU 名。 'Basic'
'Free'
'Standard' (必須)
size Sku サイズを取得または設定します string
レベル 特定の SKU のレベルを取得または設定します string

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

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

Template 説明
Azure Notification Hub を作成する

Azure にデプロイする
John Downs によって最初に作成された Azure Notification Hub テンプレートを作成します。
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"
    }
  })
}

プロパティ値

namespaces

名前 説明
type リソースの種類 "Microsoft.NotificationHubs/namespaces@2023-10-01-preview"
name リソース名 string (必須)

文字制限: 6 から 50

有効な文字:
英数字とハイフン

文字で開始します。 末尾には英数文字を使用します。

リソース名は、Azure 全体で一意である必要があります。
location リソースが保存されている地理的な場所 string (必須)
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags リソース タグ。 タグの名前と値のディクショナリ。
sku 名前空間の Sku の説明 Sku (必須)
properties 名前空間のプロパティを表します。 NamespaceProperties

NamespaceProperties

名前 説明
センター 非推奨になりました。 string
namespaceType NamespaceType の値を定義します。 "メッセージング"
"NotificationHub"
networkAcls ネットワーク承認規則のコレクション。 NetworkAcls
pnsCredentials Notification Hub または Notification Hub 名前空間 PNS 資格情報のコレクション。 PnsCredentials
provisioningState OperationProvisioningState の値を定義します。 "キャンセル済み"
"無効"
"Failed"
"InProgress"
"保留中"
"Succeeded"
"Unknown"
publicNetworkAccess パブリック ネットワーク アクセスの種類。 "無効"
"有効"
replicationRegion 許可されるレプリケーション リージョン "AustraliaEast"
"BrazilSouth"
"Default"
"None"
"NorthEurope"
"SouthAfricaNorth"
"SouthEastAsia"
"WestUs2"
scaleUnit 名前空間が作成される scaleUnit を取得または設定します string
status 名前空間の状態。 "作成済み"
"作成中"
"削除中"
"Suspended"
zoneRedundancy 名前空間 SKU 名。 "無効"
"有効"

NetworkAcls

名前 説明
ipRules IP 規則の一覧。 IpRule[]
publicNetworkRule 既定の (パブリック インターネット) ネットワーク承認規則。他のネットワーク規則が一致しない場合は権限が含まれます。 PublicInternetAuthorizationRule

IpRule

名前 説明
ipMask IP マスク。 string (必須)

制約:
最小長 = 1
権限 アクセス権の一覧。 次のいずれかを含む文字列配列:
"Listen"
"管理"
"送信" (必須)

PublicInternetAuthorizationRule

名前 説明
権限 アクセス権の一覧。 次のいずれかを含む文字列配列:
"Listen"
"管理"
"送信" (必須)

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 NotificationHub XiaomiCredential の説明。 XiaomiCredential

AdmCredential

名前 説明
properties NotificationHub AdmCredential の説明。 AdmCredentialProperties (必須)

AdmCredentialProperties

名前 説明
authTokenUrl 承認トークンの URL を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
clientId クライアント識別子を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
clientSecret 資格情報シークレット アクセス キーを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。

ApnsCredential

名前 説明
properties NotificationHub ApnsCredential の説明。 ApnsCredentialProperties (必須)

ApnsCredentialProperties

名前 説明
apnsCertificate APNS 証明書を取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
appId 発行者 (iss) の登録された要求キーを取得または設定します。その値は です。
開発者アカウントから取得した 10 文字のチーム ID
string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
appName アプリケーションの名前を取得または設定します string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
certificateKey 証明書キーを取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
endpoint この資格情報のエンドポイントを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
keyId から取得した 10 文字のキー識別子 (kid) キーを取得または設定します
開発者アカウント
string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
thumbprint APNS 証明書の拇印を取得または設定します string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
token プロバイダー認証トークンを取得または設定します。
開発者アカウント
string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。

BaiduCredential

名前 説明
properties NotificationHub BaiduCredential の説明。 BaiduCredentialProperties (必須)

BaiduCredentialProperties

名前 説明
baiduApiKey baidu Api Key を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
baiduEndPoint baidu Endpoint を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
baiduSecretKey baidu シークレット キーを取得または設定します string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。

BrowserCredential

名前 説明
properties NotificationHub BrowserCredential の説明。 BrowserCredentialProperties (必須)

BrowserCredentialProperties

名前 説明
subject Web プッシュの件名を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
vapidPrivateKey VAPID 秘密キーを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
vapidPublicKey VAPID 公開キーを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。

FcmV1Credential

名前 説明
properties NotificationHub FcmV1Credential の説明。 FcmV1CredentialProperties (必須)

FcmV1CredentialProperties

名前 説明
clientEmail クライアント電子メールを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
privateKey 秘密キーを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
projectId プロジェクト ID を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。

GcmCredential

名前 説明
properties NotificationHub GcmCredential の説明。 GcmCredentialProperties (必須)

GcmCredentialProperties

名前 説明
gcmEndpoint GCM エンドポイントを取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
googleApiKey Google API キーを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。

MpnsCredential

名前 説明
properties NotificationHub MpnsCredential の説明。 MpnsCredentialProperties (必須)

MpnsCredentialProperties

名前 説明
certificateKey この資格情報の証明書キーを取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。
mpnsCertificate MPNS 証明書を取得または設定します。 string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
thumbprint MPNS 証明書の拇印を取得または設定します string (必須)

制約:
最小長 = 1
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。

WnsCredential

名前 説明
properties NotificationHub WnsCredential の説明。 WnsCredentialProperties (必須)

WnsCredentialProperties

名前 説明
certificateKey WNS 証明書キーを設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
packageSid この資格情報のパッケージ ID を取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
secretKey 秘密キーを取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
windowsLiveEndpoint Windows Live エンドポイントを取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
wnsCertificate WNS 証明書を取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。

XiaomiCredential

名前 説明
properties NotificationHub XiaomiCredentialProperties の説明。 XiaomiCredentialProperties (必須)

XiaomiCredentialProperties

名前 説明
appSecret アプリ シークレットを取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。
endpoint xiaomi サービス エンドポイントを取得または設定します。 string

制約:
機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。

Sku

名前 説明
capacity リソースの容量を取得または設定します INT
family Sku ファミリを取得または設定します string
name 名前空間 SKU 名。 "Basic"
"Free"
"Standard" (必須)
size Sku サイズを取得または設定します string
レベル 特定の SKU のレベルを取得または設定します string