Cmdlets for Elasticsearch

Build 20.0.7654

接続の確立

CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でElasticsearch Cmdlets を使用する例を示します。

インストールおよび接続

PSGet がある場合は、PowerShell Gallery から次のコマンドを使ってcmdlet をインストールできます。CData サイトからセットアップを取得することもできます。

Install-Module ElasticsearchCmdlets

プロファイルに以下を追加すると、次のセッションでcmdlet がロードされます。

Import-Module ElasticsearchCmdlets;

Connect-Elasticsearch cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。

$conn = Connect-Elasticsearch -Server '127.0.0.1' -Port 9200

アクセスキーの取得

IAM ユーザーの資格情報を取得するには、以下の手順に従ってください。

  1. IAM コンソールにサインインします。
  2. ナビゲーションペインで[ユーザー]を選択します。
  3. ユーザーのアクセスキーを作成または管理するには、ユーザーを選択してから[セキュリティ認証情報]タブを選択します。

AWS ルートアカウントの資格情報を取得するには、以下の手順に従ってください。

  1. ルートアカウントの資格情報を使用してAWS 管理コンソールにサインインします。
  2. アカウント名または番号を選択し、表示されたメニューで[My Security Credentials]を選択します。
  3. [Continue to Security Credentials]をクリックし、[Access Keys]セクションを展開して、ルートアカウントのアクセスキーを管理または作成します。

標準認証を使用した認証

認証には、UserPassword プロパティ、PKI(public key infrastructure)、またはその両方を設定します。本製品 が接続されると、X-Pack では、設定したリルムをベースにユーザー認証およびロールの許可が実施されます。

PKI を使用するには、SSLClientCertSSLClientCertTypeSSLClientCertSubject、およびSSLClientCertPassword プロパティを設定します。

Note: PKI を使用するためには、TLS/SSL およびクライアント認証はX-Pack 上で有効化されていなければなりません。

Elasticsearch 接続の確保

本製品 においてTLS/SSL を有効化するには、Server 値に'https://' を接頭します。

Root 資格情報による認証

アカウントのルート資格情報で認証するには、次を設定します。

  • AuthSchemeAwsRootKeys に設定。
  • AWSAccessKey:AWS ルートアカウントに紐づいているアクセスキー。
  • AWSSecretKey:AWS ルートアカウントに紐づいているシークレットキー。

Note: この認証スキームの使用は、簡単なテスト以外ではAmazon では推奨されていません。アカウントのルート資格情報はユーザーの完全な権限を持つため、これが最も安全性の低い認証方法になります。

一時的認証情報による認証

一時的認証情報で認証するには、次を設定します。

  • AuthSchemeTemporaryCredentials に設定。
  • AWSAccessKey:ロールを担うIAM ユーザーのアクセスキー。
  • AWSSecretKey:ロールを担うIAM ユーザーのシークレットキー。
  • AWSSessionToken:AWS のセッショントークン。これは一時的認証情報とともに提供されます。詳しくは、this link を参照してください。

本製品 は、一時的認証情報の有効期間中、長期的な認証情報(IAM ユーザー認証情報など)によって提供されるものと同じ権限を使用してリソースをリクエストできるようになりました。

認証にIAM ロールも使用している場合は、さらに以下を指定する必要があります。

  • AWSRoleARN:認証したいロールのRole ARN を指定。これにより、本製品 は指定されたロールの資格情報を 取得しようと試みます。
  • AWSExternalId:別のアカウントでロールを引き受ける場合にのみ必要です。

AWS ロールとして認証

多くの場合、認証にはAWS ルートユーザーのダイレクトなセキュリティ認証情報ではなく、IAM ロールを使用することをお勧めします。

AWS ロールとして認証するには、次を設定します。

  • AuthSchemeAwsIAMRoles に設定。
  • AWSRoleARN:認証したいロールのRole ARN を指定。これにより、本製品 は指定されたロールの資格情報を 取得しようと試みます。
  • AWSExternalId: Only if required when you assume a role in another account.
(すでにEC2 インスタンスなどで接続されているのではなく)AWS に接続している場合は、追加で以下を指定する必要があります。
  • AWSAccessKey:ロールを担うIAM ユーザーのアクセスキー。
  • AWSSecretKey:ロールを担うIAM ユーザーのシークレットキー。

Note: AWS ルートユーザーのAWSAccessKey およびAWSSecretKey を指定する場合、ロールは使用できません。

Elasticsearch サービスへの接続

< 本製品 を希望する認証方法に設定したら、以下を設定してデータにアクセスできます。

  • Server はAmazon ES インスタンスのエンドポイントURL に設定する必要があります。
  • Port は443に設定します。
  • AWSRegion はElasticsearch インスタンスがホストされているAmazon AWS リージョンに設定する必要があります(本製品 はServer 値に基づいて自動的にリージョンを識別しようとします)。

本製品 は、認証とTLS/SSL 暗号化にX-Pack Security を使用しています。

Note: リクエストはAWS 署名バージョン 4 を使用して署名されています。

データの取得

Select-Elasticsearch cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。

$results = Select-Elasticsearch -Connection $conn -Table "Account" -Columns @("Id, Name") -Where "Industry='Floppy Disks'"
Invoke-Elasticsearch cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。

Select-Elasticsearch -Connection $conn -Table Account -Where "Industry = 'Floppy Disks'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myAccountData.csv -NoTypeInformation

Select-Elasticsearch からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。

ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。

 
PS C:\> $conn  = Connect-Elasticsearch -Server '127.0.0.1' -Port 9200
PS C:\> $row = Select-Elasticsearch -Connection $conn -Table "Account" -Columns (Id, Name) -Where "Industry = 'Floppy Disks'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Account",
  "Columns":  [

  ],
  "Id":  "MyId",
  "Name":  "MyName"
} 

データの削除

以下は、抽出条件に合うあらゆるレコードを削除します。

Select-Elasticsearch -Connection $conn -Table Account -Where "Industry = 'Floppy Disks'" | Remove-Elasticsearch

データの更新

cmdlet はデータクレンジング同様、データの変換を容易にします。次の例は、レコードがすでに存在するかどうか、挿入する前に更新が必要かどうかをチェックしてから、CSV ファイルのデータをElasticsearch にロードします。

Import-Csv -Path C:\MyAccountUpdates.csv | %{
  $record = Select-Elasticsearch -Connection $conn -Table Account -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Elasticsearch -Connection $conn -Table Account -Columns @("Id","Name") -Values @($_.Id, $_.Name) -Where "Id  = `'$_.Id`'"
  }else{
    Add-Elasticsearch -Connection $conn -Table Account -Columns @("Id","Name") -Values @($_.Id, $_.Name)
  }
}

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7654