Cmdlets for Microsoft Excel Online

Build 24.0.9062

接続の確立

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

インストールおよび接続

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

Install-Module ExcelOnlineCmdlets

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

Import-Module ExcelOnlineCmdlets;

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

$conn = Connect-ExcelOnline

Microsoft Excel Online への接続

Microsoft Excel Online データソースへの接続に使用できる認証方法は2つあります。

  • OAuth 2.0 ベースの方法：Microsoft Excel Online は、Azure AD およびAzure サービスプリンシパルの両方でOAuth 2.0 ベースの認証を提供します。
    • Azure AD 認証の場合は、AuthScheme をAzureAD に設定します。
    • Azure サービスプリンシパル認証の場合は、AuthScheme をAzureServicePrincipal に設定します。
  • マネージドサービスID（MSI）認証。この方法を使用するには、AuthScheme をAzureMSI に設定します。

Azure AD

Azure AD は、ユーザーベースの認証です。Azure AD をデスクトップアプリケーション経由でMicrosoft Excel Onlineに接続するために認証情報が提供されます。埋め込みクレデンシャルを認証に使用するには、OAuth クレデンシャル（OAuthClientId およびOAuthClientSecret）を空白のままにします。

Web アプリケーション経由で接続する場合は、カスタムOAuth Azure AD アプリケーションを作成する必要があります。カスタムAzure AD アプリケーションの作成により、OAuth 認証情報のOAuthClientId およびOAuthClientSecret が作成されます。 カスタムAzure AD アプリケーションを作成する方法、およびWeb アプリケーション経由で接続しない場合でアプリケーションを作成した方が有利な場合については、Azure AD アプリケーションの作成 を参照してください。

Azure サービスプリンシパル

Azure サービスプリンシパルとしての認証は、OAuth クライアントクレデンシャルフローを介して処理されます。直接のユーザー認証は行われません。代わりに、クレデンシャルはアプリケーション自体のためだけに作成されます。アプリで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。

AzureAD アプリとAzure サービスプリンシパルの作成

Azure サービスプリンシパルを使用して認証する場合、Azure AD テナントにAzure AD アプリケーションを作成して登録する必要があります。詳しくは、Azure AD アプリケーションの作成 を参照してください。

portal.azure.com の［アプリの登録］で［API のアクセス許可］に移動し、Microsoft Graph アクセス許可を選択します。アクセス許可には2つの異なるアクセス許可セットがあります。委任されたアクセス許可とアプリケーションの許可です。クライアントの資格情報認証時に使用されるアクセス許可は、［アプリケーションの許可］の下にあります。

アプリケーションへのロールの割り当て

サブスクリプションのリソースにアクセスするには、アプリケーションにロールを割り当てる必要があります。

  1. 検索バーでサブスクリプションサービスを検索・選択して、サブスクリプションページを開きます。
  2. アプリケーションを割り当てるサブスクリプションを選択します。
  3. アクセス制御 (IAM)を開き、追加 -> ロール割り当ての追加 を選択してロール割り当ての追加ページを開きます。
  4. 作成したAzure AD アプリに割り当てるロールとして、所有者を選択します。
認証の完了 クライアントシークレットと証明書のどちらを使用するかを選択し、以下の該当する手順に従ってください。

クライアントシークレット

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

  • AuthScheme：クライアントシークレットを使用する場合はAzureServicePrincipal。
  • InitiateOAuth： GETANDREFRESH。InitiateOAuth を使えば、繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要はなくなります。
  • AzureTenant：接続するテナント。
  • OAuthClientId：アプリケーション設定のクライアントId。
  • OAuthClientSecret：アプリケーション設定のクライアントシークレット。

証明書

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

  • AuthScheme：証明書を使用する場合はAzureServicePrincipalCert。
  • InitiateOAuth： GETANDREFRESH。InitiateOAuth を使えば、繰り返しOAuth 交換を行ったり、手動でOAuthAccessToken を設定する必要はなくなります。
  • AzureTenant：接続するテナント。
  • OAuthJWTCert：JWT 証明書のストア。
  • OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類。

これで接続する準備が整いました。クライアント資格情報での認証は、他の接続同様に自動的に行われますが、ユーザーにプロンプトするウィンドウは表示されません。ユーザーコンテキストがないため、ブラウザのポップアップは必要ないからです。接続が行われ、内部的に処理されます。

Managed Service Identity (MSI)

Azure VM 上でMicrosoft Excel Online を実行しており、MSI を利用して接続したい場合は、AuthScheme をAzureMSI に設定します。

User-Managed Identities

マネージドID のトークンを取得するには、OAuthClientId プロパティを使用してマネージドID の"client_id" を指定します。

VM に複数のユーザーが割り当てられたマネージドID がある場合は、OAuthClientId も指定する必要があります。

ワークブックへの接続

本製品 は、マイクロソフトアカウントで指定したドライブからワークブックとワークシートを公開します。ワークブックに接続するには、Excel Online への認証を提供し、以下のプロパティのいずれかを設定します。

検出されるドライブを制御するには：

  • Drive：特定のドライブのID。Drives およびSharePointSites ビューを使用して、アクセス可能なすべてのサイトおよびドライブを表示できます。
  • SharepointURL：SharePoint サイトのブラウザURL。ドライバーは、サイト下のすべてのドライブを公開します。
  • OAuthClientId：AuthScheme がAzureServicePrincipal に、またはOAuthGrantType がCLIENT に設定されている場合は、OAuth アプリに関連付られているドライブが公開されます。

上記のいずれも指定されていない場合は、アクセスは認証ユーザーの個人用ドライブに制限されます。

どのワークブックとワークシートが公開されるか、またはどのドライブが公開されるかを制御するには：

  • Workbook：ワークブックの名前またはId。認証されたユーザーは、Workbooks ビューに対してクエリを実行することで利用可能なワークブックに関する情報のリストを表示できます。
  • UseSandbox：Sandbox アカウントでワークブックに接続している場合はTrue、そうでない場合は空白。
  • BrowsableSchemas：公開するドライブ名のリスト。
  • Tables：公開するテーブル名のリスト。

ワークシートデータに対するSQL の実行

ワークシートと範囲へのデータ操作SQL を実行する方法は、以下を参照してください。

本製品 がワークシートとセルをテーブルとカラムにモデル化する方法について詳しくは、データモデル を参照してください。

SharePoint のExcel ファイルからデータを取得

SharePoint のExcel ファイルからデータを取得するには、SharepointURL 接続プロパティを自身のSharepoint サイトのURL に設定します。次に例を示します。 
 SharepointURL=https://mysite.sharepoint.com/
ドライバーは自動的にSharePoint にある各ドキュメントライブラリを検索し、スキーマとしてリストします。個々のExcel ワークブックとワークシートは、対応するドキュメントライブラリの下にWorkbook_Worksheet の形式でテーブルとしてリストされます。これは、SharepointURL が設定されていない場合に、自身の個人的なExcel ドキュメントをリストするのと同じように機能します。

データの取得

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

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

cmdlet 出力のパイプ処理

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

Select-ExcelOnline -Connection $conn -Table Test_xlsx_Sheet1 -Where "Column2 = 'Bob'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myTest_xlsx_Sheet1Data.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-ExcelOnline
PS C:\> $row = Select-ExcelOnline -Connection $conn -Table "Test_xlsx_Sheet1" -Columns (Id, Column1) -Where "Column2 = 'Bob'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Test_xlsx_Sheet1",
  "Columns":  [

  ],
  "Id":  "MyId",
  "Column1":  "MyColumn1"
}

データの削除

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

Select-ExcelOnline -Connection $conn -Table Test_xlsx_Sheet1 -Where "Column2 = 'Bob'" | Remove-ExcelOnline

データの変更

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

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

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062