11.5.2 導入(Azure連携ツール(JP1/IM REST対応版))
- 〈この項の構成〉
(1) 事前準備
(a) Azure Monitorへのログ送信
Azure Monitorへのログ送信は,Azure連携ツール(JP1イベント登録コマンド対応版)と同じです。「11.4.2(1)(a) Azure Monitorへのログ送信」を参照してください。
(b) アラートルールの作成
アラートルールの作成は,Azure連携ツール(JP1イベント登録コマンド対応版)と同じです。「11.4.2(1)(b) アラートルールの作成」を参照してください。
(c) 関数アプリの作成
関数アプリの作成は,Azure連携ツール(JP1イベント登録コマンド対応版)と同じです。「11.4.2(1)(c) 関数アプリの作成」を参照してください。
なお,その際「sendevent」は「sendevent_im2」に読み替えてください。
(d) Azure Blob Storageの作成
Azure Blob Storageの作成は,Azure連携ツール(JP1イベント登録コマンド対応版)と同じです。
「11.4.2(1)(e) Azure Blob Storageの作成」を参照してください。
(e) Service Bus Queueの作成
Azure連携ツール(JP1/IM REST対応版)で使用するService Bus Queueを作成します。
-
JP1イベント情報を格納するService Bus Queueを作成します。
詳細については,Azureのドキュメントを参照してください。
■Azure portalを使用してService Bus名前空間とキューを作成する
- <必要な作業>
-
・すべて
- 重要
-
上記URLでは既定値のままで作成していますが,Azure連携ツール(JP1/IM REST対応版)で名前空間・キューを作成する際は,次の値を設定してください。
-
セッションを有効にするキューを作成するため,名前空間の作成時の価格レベルを「Standard」以上を設定する。
-
重複したメッセージを有効とするため,「重複データ検出を有効にする」をチェックしない。
-
順序性を保つため,「セッションを有効にする」をチェックする。
-
(f) キーコンテナーの作成
キーコンテナーの作成は,Azure連携ツール(JP1イベント登録コマンド対応版)と同じです。「11.4.2(1)(g) キーコンテナーの作成」を参照してください。
(g) キーコンテナーへのシークレットの追加
Azure連携ツール(JP1/IM REST対応版)で利用する機密情報を「11.5.2(1)(f) キーコンテナーの作成」で作成したキーコンテナーへ追加します。
- 設定項目
-
-
シークレットへAzure Blob Storage接続文字列の追加
-
シークレットへService Bus Queue接続文字列の追加
-
シークレットへJP1/IMの認証情報の追加
-
-
ブラウザーからAzure Portalにログインします。
-
Azureサービスから「キーコンテナー」を選択します。
-
「11.4.2(1)(g) キーコンテナーの作成」で作成したコンテナーを選択します。
-
「設定」項目の「シークレット」を選択します。
-
「+生成/インポート」をクリックします。Azure Blob Storage接続文字列を追加するため,次の情報を入力します。「作成」をクリックします。
表11‒67 シークレットへのAzure Blob Storage接続文字列の設定値 項番
項目※1
設定値
備考
1
アップロードオプション
手動
デフォルト設定値
2
名前
任意のシークレット名を指定します。
指定できるのは,英数字と「-(ハイフン)だけです。
3
値
「11.4.2(1)(e) Azure Blob Storageの作成」で作成したBLOB Storageの接続文字列※2を指定します。
4
コンテンツの種類(省略可能)
任意
5
アクティブ化する日を設定しますか?
必要に応じて値を構成してください。
6
有効期限を設定しますか?
必要に応じて値を構成してください。
7
有効ですか?
はい
- 注※1
-
詳細については,Azureのドキュメントを参照してください。
■クイックスタート:Azure portalを使用してAzure Key Vaultとの間でシークレットの設定と取得を行う
<必要な作業>
・Key Vaultにシークレットを追加する
- 注※2
-
Service Bus Queue接続文字列の表示方法の詳細については,Azureのドキュメントを参照してください。
■Azure portal を使用して Service Bus 名前空間とキューを作成する
<必要な作業>
・接続文字列を取得する
-
「シークレット」画面で,指定したシークレット名が表示されていることを確認してください。
-
「+生成/インポート」をクリックします。Service Bus Queue接続文字列を追加するため,次の情報を入力します。「作成」をクリックします。
表11‒68 シークレットへのService Bus Queue 接続文字列の設定値 項番
項目※1
設定値
備考
1
アップロードオプション
手動
デフォルト設定値
2
名前
任意のシークレット名を指定します。
指定できるのは,英数字と「-(ハイフン)だけです。
3
値
「11.5.2(1)(e) Service Bus Queueの作成」で作成したService Busの接続文字列を指定します。※2
4
コンテンツの種類(省略可能)
任意
5
アクティブ化する日を設定しますか?
チェックなし
デフォルト設定値
6
有効期限を設定しますか?
チェックなし
デフォルト設定値
7
有効ですか?
はい
デフォルト設定値
- 注※1
-
詳細については,Azureのドキュメントを参照してください。
■クイックスタート:Azure portalを使用してAzure Key Vaultとの間でシークレットの設定と取得を行う。
<必要な作業>
・Key Vaultにシークレットを追加する
- 注※2
-
Service Bus Queue接続文字列の表示方法の詳細については,Azureのドキュメントを参照してください。
■Azure portalを使用してService Bus名前空間とキューを作成する。
<必要な作業>
・接続文字列を取得する
-
「シークレット」画面で,指定したシークレット名が表示されていることを確認してください。
-
「+生成/インポート」をクリックします。JP1/IMの認証情報(パスワード)を追加するため,次の情報を入力します。「作成」をクリックします。
表11‒69 シークレットへのJP1/IMの認証情報(ユーザー名)の設定値 項番
項目※1
設定値
備考
1
アップロードオプション
手動
デフォルト設定値
2
名前
任意のシークレット名を指定します。
指定できるのは,英数字と「-(ハイフン)だけです。
3
値
ユーザー名を指定します。
4
コンテンツの種類(省略可能)
任意
5
アクティブ化する日を設定しますか?
チェックなし
デフォルト設定値
6
有効期限を設定しますか?
チェックなし
デフォルト設定値
7
有効ですか?
はい
デフォルト設定値
- 注※1
-
詳細については,Azureのドキュメントを参照してください。
■クイックスタート:Azure portalを使用してAzure Key Vaultとの間でシークレットの設定と取得を行う。
<必要な作業>
・Key Vaultにシークレットを追加する
-
「シークレット」画面で,指定したシークレット名が表示されていることを確認してください。
-
「+生成/インポート」をクリックします。Service Bus Queue接続文字列を追加するため,次の情報を入力します。「作成」をクリックします。
表11‒70 シークレットへのJP1/IMの認証情報(パスワード)の設定値 項番
項目※1
設定値
備考
1
アップロードオプション
手動
デフォルト設定値
2
名前
任意のシークレット名を指定します。
指定できるのは,英数字と「-(ハイフン)だけです。
3
値
上記ユーザー名に対するパスワードを指定します。
4
コンテンツの種類(省略可能)
任意
5
アクティブ化する日を設定しますか?
チェックなし
デフォルト設定値
6
有効期限を設定しますか?
チェックなし
デフォルト設定値
7
有効ですか?
はい
デフォルト設定値
- 注※1
-
詳細については,Azureのドキュメントを参照してください。
■クイックスタート:Azure portalを使用してAzure Key Vaultとの間でシークレットの設定と取得を行う。
<必要な作業>
・Key Vaultにシークレットを追加する
-
「シークレット」画面で,指定したシークレット名が表示されていることを確認してください。
(h) キーコンテナーへのアクセスポリシーの設定
シークレットから情報を取得するために,アクセスポリシーを設定します。
- 設定項目
-
-
アクセスポリシーの追加(マネージドID)
-
アクセスポリシーの追加(サービスプリンシパル)
-
-
ブラウザーからAzure Portalにログインします。
-
Azureサービスから「キーコンテナー」を選択します。
-
「11.4.2(1)(g) キーコンテナーの作成」で作成したコンテナーを選択します。
-
「設定」項目の「アクセスポリシー」を選択します。
-
「+アクセスポリシーの追加」リンクをクリックします。「11.4.2(1)(c) 関数アプリの作成」で作成したAzure連携ツール(JP1/IM REST対応版)にアクセス権を付与するため,次の情報を入力します。「追加」をクリックします。
表11‒71 Azure連携ツール(JP1/IM REST対応版) アクセスポリシー追加設定値 項番
項目
設定値
備考
1
テンプレートからの構成(省略可能)
−
デフォルト設定値
2
キーのアクセス許可
0項目が選択されました
デフォルト設定値
3
シークレットのアクセス許可
「取得」と「一覧」を選択する。
したあとは,「2項目が選択されました」となります。
4
証明証のアクセス許可
0項目が選択されました
デフォルト設定値
5
プリンシパルの選択
「11.4.2(1)(c) 関数アプリの作成」で作成した関数名「sendevent-sbq-im2」を指定します。
6
承認されているアプリケーション
−
デフォルト設定値
-
「アクセスポリシー」画面で,追加した「sendevent-sbq-im2」が表示されていることを確認します。「保存」をクリックしてください。
(j) JP1/IMのインストール
Azure連携ツール(JP1/IM REST対応版)のJP1イベント情報送信からJP1イベントを送信するために,JP1を導入するサーバーにJP1/IMをインストールします。
Azure連携ツール(JP1/IM REST対応版)では,インテリジェント統合管理基盤の機能を利用するため,インテリジェント統合管理基盤を有効にする必要があります。
JP1/IMのインストールについては,マニュアル「JP1/Integrated Management 3 - Manager 構築ガイド」の「1. インストールとセットアップ(Windowsの場合)」および「2. インストールとセットアップ(UNIXの場合)」を参照してください。
(2) インストール
(a) 提供ファイルの構成
Azure連携ツール(JP1/IM REST対応版)の提供ファイルの構成を次の表に示します。
|
項番 |
ディレクトリ構成 |
説明 |
備考 |
|||
|---|---|---|---|---|---|---|
|
1 |
sendevent_im2 |
Azure連携ツール(JP1/IM REST対応版)ディレクトリ |
||||
|
2 |
app |
関数アプリディレクトリ |
||||
|
3 |
sendevent-sbq |
Azure連携ツール(JP1/IM REST対応版)のJP1イベント情報生成の関数アプリ |
Azure連携ツール(JP1/IM REST対応版)のJP1イベント情報生成 |
|||
|
4 |
__init__.py |
Azure連携ツール(JP1/IM REST対応版)のJP1イベント情報生成のスクリプト |
||||
|
5 |
function.json |
function.jsonファイル |
||||
|
6 |
sendevent-im2 |
Azure連携ツール(JP1/IM REST対応版)のJP1イベント情報送信の関数アプリ |
Azure連携ツール(JP1/IM REST対応版)のJP1イベント情報送信 |
|||
|
7 |
__init__.py |
Azure連携ツール(JP1/IM REST対応版)のJP1イベント情報生成のスクリプト |
||||
|
8 |
function.json |
function.jsonファイル |
||||
|
9 |
host.json |
host.jsonファイル |
||||
|
10 |
requirements.txt |
requirements.txtファイル |
||||
|
11 |
conf |
設定ファイルディレクトリ |
||||
|
12 |
eventconf.json |
イベント定義ファイル |
||||
|
13 |
eventignore.json |
イベント除外ファイル |
||||
|
14 |
eventexattrs.json |
イベント拡張属性定義ファイル |
||||
(b) デプロイ
Azure連携ツール(JP1/IM REST対応版)をデプロイする手順を次に示します。
-
提供ファイルをデプロイ環境に配置
-
Azure連携ツール(JP1/IM REST対応版)のログレベルの設定
-
Azure連携ツール(JP1/IM REST対応版)のJP1イベント情報送信の関数アプリのfunction.jsonの更新
-
Azure連携ツール(JP1/IM REST対応版)のデプロイ
-
提供ファイル(sendevent_im2)をデプロイ環境の適当な場所へコピーします。
-
「11.4.2(3)(e) ログレベルの設定(host.json)」の「手順1.」を実施します。
-
Azure連携ツール(JP1/IM REST対応版)JP1イベント情報送信の関数アプリ(sendevent_im2/app/sendevent-im2)のfunction.jsonをテキストエディターで開き,5行目に「11.5.2(1)(e) Service Bus Queueの作成」で作成したキュー名を設定します。
1: { 2: "scriptFile": "__init__.py", 3: "bindings": [ 4: { 5: "queueName": "作成したキュー名", 6: "connection": "SERVICE_BUS_CONNECTION_STRING", 7: "name": "msg", 8: "type": "serviceBusTrigger", 9: "direction": "in", 10: "isSessionsEnabled": "true" 11: } 12: ] 13:} -
「11.4.2(1)(j) デプロイ環境の作成」で作成したVMから「11.4.2(1)(c) 関数アプリの作成」で作成した関数アプリにAzure連携ツール(JP1/IM REST対応版)※をデプロイします。
注※ 提供ファイルの「sendevent_im2/app」です。
デプロイ手順の詳細については,Azureのドキュメントを参照してください。
■クイックスタート:コマンドラインからAzureにPython関数を作成する。
- <必要な作業>
-
・Azureに関数プロジェクトをデプロイする。
- 重要
-
-
コマンドによるAzureへのサインインが必要となりますので,サインインしていない場合は,上記URLの「関数用の関連Azureリソースを作成する」に記載されている,項番1を参考にコマンドを実行してください。
-
コンソールでコマンドを実行する際は,「提供ファイル格納ディレクトリ/sendevent_im2/app」にカレントディレクトリを移動してから,デプロイを実行してください。
-
上記URLで記載されている<APP_NAME>は「sendevent-sbq-im2」を指定してください。
-
出力結果に「Deployment successful.」,「Remote build succeeded!」が出力されていれば,デプロイ完了となります。
-
-
デプロイのあと,「関数アプリ」−「sendevent-sbq-im2」−「関数」配下に次の関数が登録されていることを確認します。
表11‒73 関数一覧 項番
関数名
関数説明
備考
1
sendevent-sbq
JP1イベント情報生成関数
デプロイした時点ではトリガー起動ではありません。アクショングループの設定が必要となります。詳細については,「11.4.2(3)(f) アクショングループの設定」を参照してください。
2
sendevent-im2
JP1イベント情報送信関数
デプロイした時点で,Service Bus Queueにメッセージが登録されると起動します。
(3) セットアップ
(a) イベント定義ファイル(eventconf.json)
Azure連携ツール(JP1/IM REST対応版)のJP1イベント情報生成で登録するJP1イベントの設定手順は,「Azure連携ツール(JP1イベント登録コマンド対応版)」と同じです。「11.4.2(3)(a) イベント定義ファイル(eventconf.json)」を参照してください。
なお,その際「sendevent/conf」は「sendevent_im2/conf」に読み替えてください。また,コンテナーの選択では,「11.5.2(1)(d) Azure Blob Storageの作成」で作成したコンテナーを選択してください。
(b) イベント除外ファイル(eventignore.json)
Azure連携ツール(JP1/IM REST対応版)のJP1イベント情報生成で除外するJP1イベントの設定手順は,「Azure連携ツール(JP1イベント登録コマンド対応版)」と同じです。「11.4.2(3)(a) イベント定義ファイル(eventconf.json)」を参照してください。
なお,その際「sendevent/conf」は「sendevent_im2/conf」に読み替えてください。また,コンテナーの選択では,「11.5.2(1)(d) Azure Blob Storageの作成」で作成したコンテナーを選択してください。
(c) イベント拡張属性定義ファイル(eventexattrs.json)
Azure連携ツール(JP1/IM REST対応版)のJP1イベント情報生成で定義する,共通のイベント拡張属性の設定手順は,「Azure連携ツール(JP1イベント登録コマンド対応版)」と同じです。「11.4.2(3)(a) イベント定義ファイル(eventconf.json)」を参照してください。
なお,その際「sendevent/conf」は「sendevent_im2/conf」に読み替えてください。また,コンテナーの選択では,「11.5.2(1)(d) Azure Blob Storageの作成」で作成したコンテナーを選択してください。
(d) アプリケーション環境変数の設定
Azure連携ツール(JP1/IM REST対応版)で利用する,アプリケーション環境変数の設定手順を説明します。
- 設定項目
-
-
BLOB Storage接続文字列
-
BLOB Storageコンテナー名
-
Service Bus接続文字列
-
Service Busキュー名
-
JP1/IMのRESTベースURL
-
JP1/IMの認証情報のユーザー名
-
JP1/IMの認証情報のパスワード
-
-
ブラウザーからAzure Portalにログインします。
-
サービスから「関数アプリ」−「sendevent-sbq-im2」を選択します。
-
「設定」項目の「構成」をクリックします。
-
「+新しいアプリケーション設定」をクリックし,次の内容を設定します。
表11‒74 イベント情報生成の環境変数 項番
名前
値
1
BLOB_STORAGE_CONNECTION_STRING
KeyVault参照形式で指定します。※1
シークレット識別子の指定は,「11.5.2(1)(g) キーコンテナーへのシークレットの追加」で追加したBlob Storageの接続文字列のシークレット識別子を指定します。
2
BLOB_STORAGE_CONTAINER
「11.4.2(1)(e) Azure Blob Storageの作成」で作成したBlob Storageのコンテナー名を指定します。
3
SERVICE_BUS_CONNECTION_STRING
KeyVault参照形式で指定します。※1
シークレット識別子の指定は,「11.4.2(1)(h) キーコンテナーへのシークレットの追加」で追加したService Busの接続文字列のシークレット識別子を指定します。
4
SERVICE_BUS_QUEUE_NAME
「11.4.2(1)(e) Azure Blob Storageの作成」で設定したキュー名を指定します。
5
IM2_REST_BASE_URL
イベント情報を送信するJP1/IMのRESTのベースURL※2を指定します。
6
IM2_REST_LOGIN_USER
KeyVault参照形式で指定します。※1
シークレット識別子の指定は,「11.4.2(1)(h) キーコンテナーへのシークレットの追加」で追加したJP1/IMの認証情報(ユーザー名)のシークレット識別子を指定します。
7
IM2_REST_LOGIN_PASSWORD
KeyVault参照形式で指定します。※1
シークレット識別子の指定は,「11.4.2(1)(h) キーコンテナーへのシークレットの追加」で追加したJP1/IMの認証情報(パスワード)のシークレット識別子を指定します。
- 注※1 KeyVault参照形式は次の内容で指定します。
-
@Microsoft.KeyVault(SecretUri=<シークレット識別子>)
なお,シークレット識別子は次の手順で確認できます。
1. ブラウザーからAzure Portalにログインします。
2. Azureサービスから「キーコンテナー」を選択します。
3. 「11.4.2(1)(g) キーコンテナーの作成」で作成したコンテナーを選択します。
4. 設定の「シークレット」を選択します。
5. 該当のシークレットを選択します。
6. 現在のバージョンを選択すると,シークレット識別子が表示されます。
- 注※2 ベースURLは次の内容で指定します。
-
プロトコル://ホスト名またはIPアドレス:ポート番号/
プロトコル:「http」(SSL通信を使用する場合は,「https」)
ホスト名またはIPアドレス:JP1/IMのインテリジェント統合管理基盤サービスでHTTP通信を受け付けるIPアドレスまたはそのIPアドレスが設定されているホスト名
ポート番号:JP1/IMのインテリジェント統合管理基盤サービスでHTTP通信を受け付けるポート番号(デフォルト:20703)
<指定例>http://192.168.0.1:20703/
-
「アプリケーション設定の追加/編集」画面の「OK」をクリックします。
-
「保存」をクリックします。
-
「変更の保存」で「続行」をクリックします。
「続行」ボタンをクリックしたあと,アプリケーションが再起動されます。
(e) ログレベルの設定(host.json)
Azure連携ツール(JP1/IM REST対応版)のログレベルの設定は,「Azure連携ツール(JP1イベント登録コマンド対応版)」と同じです。「11.4.2(3)(e) ログレベルの設定(host.json)」を参照してください。
なお,その際「sendevent/app」は「sendevent_im2/app」に読み替えてください。
(f) アクショングループの設定
Azure連携ツール(JP1/IM REST対応版)のアクショングループの設定は,「Azure連携ツール(JP1イベント登録コマンド対応版)」と同じです。「11.4.2(3)(f) アクショングループの設定」を参照してください。
(4) アンインストール
Azure連携ツール(JP1/IM REST対応版)のJP1イベント情報生成をアンインストールする手順を説明します。
-
アラートルールの削除
-
アクショングループの削除
-
シークレットの削除
-
アクセスポリシーの削除
-
関数アプリの削除
-
定義ファイルの削除
(a) アラートルールの削除
-
ブラウザーからAzure Portalにログインします。
-
Azureサービスから「モニター」を選択します。
-
「アラート」の「アラートルールの管理」を選択します。
-
対象のアラートを選択したあと,「削除」をクリックします。
(b) アクショングループの削除
-
ブラウザーからAzure Portalにログインします。
-
Azureサービスから「モニター」を選択します。
-
「アラート」の「アクションの管理」を選択し,「11.4.2(3)(f) アクショングループの設定」で設定したアクションをしたあと,「アクショングループの削除」をクリックします。
(c) シークレットの削除/アクセスポリシーの削除
-
ブラウザーからAzure Portalにログインします。
-
Azureサービスから「キーコンテナー」を選択し,「11.5.2(1)(f) キーコンテナーの作成」で作成したコンテナーを選択します。
-
設定の「シークレット」を選択し,「11.5.2(1)(g) キーコンテナーへのシークレットの追加」で追加した,Azure Blob Storageの接続文字列のシークレット名をクリックします。
-
「削除」をクリックし,確認画面で「はい」をクリックします。
-
「11.5.2(1)(g) キーコンテナーへのシークレットの追加」で追加した,Service Busの接続文字列のシークレット名をクリックします。
-
「削除」をクリックし,確認画面で「はい」をクリックします。
-
シークレットの削除に続き,設定の「アクセスポリシー」を選択し,「11.5.2(1)(h) キーコンテナーへのアクセスポリシーの設定」で追加したアクセスポリシーをアクション列の「削除」をクリックして削除,その後,「保存」をクリックします。
(d) 関数アプリの削除
-
ブラウザーからAzure Portalにログインします。
-
Azureサービスから「関数アプリ」を選択します。
-
「sendevent」を選択し,「削除」をクリックします。
(e) 定義ファイルの削除
-
Azureサービスから「ストレージアカウント」を選択します。
-
「11.5.2(1)(d) Azure Blob Storageの作成」で作成したコンテナーを選択します。
-
次のファイルを選択し,「削除」をクリックします。
-
eventconf.json
-
eventignore.json
-
eventexattrs.json
-