接続の確立

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

Domino への接続

次のプロパティを設定し、Domino データに接続します。

URL：Domino データベースをホスティングしているサーバーのホスト名またはIP アドレス。Domino データベースをホスティングしているサーバーのポートを含めます。例：http://sampleserver:1234/
DatabaseScope：Domino Web UI でのスコープ名。本製品は、指定されたスコープに適合するスキーマのフォームとビューを公開します。Domino Admin UI で、サイドバーのScopes メニューを選択します。このプロパティを既存のスコープ名に設定します。

Domino への認証

Domino は、ログインクレデンシャル（OAuthPassword）またはMicrosoft Entra ID（AzureAD）のいずれかによる認証をサポートしています。

ログインクレデンシャル

次のプロパティを設定します。

AuthScheme：OAuthPassword。
User：認証するDomino ユーザーのログイン。
Password：認証するDomino ユーザーのパスワード。

本製品は、ログインクレデンシャルを使用して、OAuthトークン交換を自動で実行します。

Microsoft Entra ID（Azure AD）

Note：Microsoft はAzure AD をEntra ID にリブランドしました。ユーザーがEntra ID 管理サイトを操作する必要があるトピックでは、Microsoft が使用している名称と同じものを使用します。ただし、名前または値が"Azure AD" を参照しているCData 接続プロパティは、依然として存在します。

この認証方法では、Azure Active Directory をID プロバイダー（IdP）として使用し、JWT トークンを取得します。ユーザーがAzure AD 経由で認証する前に、管理者権限を持つユーザーは、カスタムEntra ID（Azure AD）アプリケーションの作成で説明するように、Azure Active Directory でカスタムAzure AD OAuth アプリケーションを作成し、IdP として設定する必要があります。

カスタムAzure AD アプリケーションが完成したら、次のプロパティを設定します。

AuthScheme：AzureAD。
OAuthClientId：カスタムAzure AD アプリケーションの作成時に取得したクライアントID。
OAuthClientSecret：カスタムAzure AD アプリケーションの作成時に取得したクライアントシークレット。
CallbackURL：カスタムAzure AD アプリケーションの登録時に指定されたリダイレクトURI。例えば、https://localhost:33333。
AzureTenant：データにアクセスするために使用されるMicrosoft Online テナント。テナントID、またはcompanyname.microsoft.com 形式の値を指定します。
（テナントID は、Azure ポータルのAzure Active Directory -> プロパティページに表示されるディレクトリID と同じものです。）

接続オブジェクトの作成

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

$conn = Connect-Domino -URL "http://dominoserver:3002/" -DatabaseScope "names" -TableTypes "Tables" -AuthScheme "OAuthPassword" -User "MyUser" -Password "MyPassword"

データの取得

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

$results = Select-Domino -Connection $conn -Table "Person" -Columns @("unid, FirstName") -Where "City='Miami'"

Invoke-Domino cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

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

Select-Domino -Connection $conn -Table Person -Where "City = 'Miami'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myPersonData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-Domino -URL "http://dominoserver:3002/" -DatabaseScope "names" -TableTypes "Tables" -AuthScheme "OAuthPassword" -User "MyUser" -Password "MyPassword"
PS C:\> $row = Select-Domino -Connection $conn -Table "Person" -Columns (unid, FirstName) -Where "City = 'Miami'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Person",
  "Columns":  [

  ],
  "unid":  "Myunid",
  "FirstName":  "MyFirstName"
}

Cmdlets for Domino