Cmdlets for Box

Build 24.0.9062

接続の確立

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

インストールおよび接続

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

Install-Module BoxCmdlets

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

Import-Module BoxCmdlets;

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

$conn = Connect-Box

Box への接続

本製品 は、Box テーブルおよびフォルダへのアクセスを実現します。なお、本製品 はBox に格納されているファイルの内容を更新したり、ファイルの内容をテーブルやカラムとしてモデル化したりはできません。

Box への認証

本製品 は、OAuth 認証標準を使用して、ユーザーアカウントまたはサービスアカウントからBox に接続します。

Box は埋め込みOAuth クレデンシャルを提供しており、デスクトップアプリケーション またはヘッドレスマシンからの接続を簡単にします。Web アプリケーションから接続するには、カスタムOAuth アプリケーションの作成 で説明するようにカスタムOAuth アプリケーションを作成する必要があります。

以下のサブセクションでは、利用可能なOAuth フローでのBox への認証について詳しく説明します。 カスタムOAuth アプリケーションの作成についての情報と、すでに埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成 を参照してください。

Box で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

ユーザーアカウント（OAuth）

AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。

デスクトップアプリケーション

CData は、OAuth デスクトップ認証を簡略化する埋め込みOAuth アプリケーションを提供します。 または、カスタムOAuth アプリケーションを作成して接続することも可能です。カスタムOAuth アプリケーションについて、詳しくはカスタムOAuth アプリケーションの作成 を参照してください。

OAuth アクセストークンの取得およびリフレッシュ

以下を設定して、接続してください。

  • カスタムアプリケーションのみ：
    • OAuthClientId：アプリの登録時に割り当てられたクライアントId。
    • OAuthClientSecret：アプリの登録時に割り当てられたクライアントシークレット。
    • CallbackURL：アプリの登録時に定義されたリダイレクトURI。次に例を示します。 https://localhost:3333
接続すると、本製品 はデフォルトブラウザでBox のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。 本製品 はアクセストークンの期限が切れると自動的にリフレッシュします。

ヘッドレスマシン

ヘッドレスマシンのユーザーアカウントでOAuth を使用するようにドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。

  1. 以下のオプションから選択します。
    • オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
    • オプション2：インターネットブラウザに対応したマシンに本製品 をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。
  2. 次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品 を設定します。

オプション1：Verifier code を取得および交換

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

  1. 以下のオプションから選択します。
    • 埋め込みOAuth アプリケーションを使用する場合は、GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
    • カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定します。
      • InitiateOAuth：OFF。
      • OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
      • OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
      次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
  2. ログインして、本製品 にアクセス許可を与えます。リダイレクトURI にリダイレクトされます。 リダイレクトURI にcode というパラメータが付加されることに注意してください。このパラメータの値を控えておきます。OAuthVerifier 接続プロパティを設定するために使用されます。

次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。

ヘッドレスマシンでは、OAuth 認証値を取得するには次のプロパティを設定します。

  • InitiateOAuth：REFRESH。
  • OAuthVerifier：控えておいたverifier code（リダイレクトURI のcode パラメータの値）。
  • OAuthSettingsLocation：暗号化されたOAuth 認証値を指定された場所に永続化。
  • カスタムアプリケーションのみ：
    • OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
    • OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。

接続をテストしてOAuth 設定ファイルを生成し、以下のプロパティを再設定して接続します。

  • InitiateOAuth：REFRESH。
  • OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。
  • カスタムアプリケーションのみ：
    • OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
    • OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。

オプション2：OAuth 設定を転送

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続をインストールし、作成する必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続をテストしてOAuth 設定ファイルを生成し、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

  • InitiateOAuth：REFRESH。
  • OAuthSettingsLocation：ブラウザでマシンからコピーしたOAuth 設定ファイルの場所。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。
  • カスタムアプリケーションのみ：
    • OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
    • OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。

サービスアカウント（OAuthJWT）

サービスアカウントには、ブラウザによるユーザー認証が不要なサイレント認証があります。また、サービスアカウントを使用して、エンタープライズ全体のアクセススコープを本製品 に委任することもできます。

サービスアカウントを使用するには、カスタムOAuth アプリケーションの作成 で説明するように、カスタムOAuth アプリケーションの作成と認可が必要です。 これでサービスアカウントにアクセス権があるBox データに接続できます。

次の接続プロパティを設定して、接続してください。

  • AuthScheme：OAuthJWT。
  • OAuthClientId：カスタムOAuth アプリケーションの設定で指定したクライアントId。
  • OAuthClientSecret：カスタムOAuth アプリケーションの設定で指定したクライアントシークレット。
  • OAuthJWTCertType：PEMKEY_FILE。
  • OAuthJWTCert：生成した.pem ファイルのパス。
  • OAuthJWTCertPassword：.pem ファイルのパスワード。
  • OAuthJWTCertSubject：証明書のサブジェクト。証明書ストアの1番目の証明書を選択するには、*（アスタリスク）を設定します。
  • OAuthJWTSubjectType：Application Access Values で指定した値と同じで、"enterprise" または"user" のいずれか。 この接続プロパティのデフォルト値は"enterprise" です。
  • OAuthJWTSubject：サブジェクトタイプがenterprise に設定されている場合は、これをエンタープライズID に設定します。 サブジェクトタイプがuser に設定されている場合は、アプリケーションのユーザーID に設定します。
  • OAuthJWTPublicKeyId：アプリケーション設定の公開キーID。

接続すると、本製品 はサービスアカウントでのOAuth フローを完了します。

BOXJSON OAuthJWTCertType

サービスアカウントおよびBOXJSON OauthJWTCertType を使用して認証するには、以下のプロパティを設定します。

  • AuthScheme：OAuthJWT。
  • InitiateOAuth：GETANDREFRESH。
  • OAuthJWTCertType：BOXJSON。 OAuthJWTCert：Box が提供するJSON ファイルへのパス。

システム内のファイルを使用するのが難しい場合は、JSON ファイルの内容を接続文字列に直接コピーすることができます。 次のプロパティを設定します。

  • AuthScheme：OAuthJWT。
  • InitiateOAuth：GETANDREFRESH。
  • OAuthJWTCertType：BOXJSONBLOB。
  • OAuthJWTCert：Box が提供するJSON ファイルの内容。

データの取得

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

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

cmdlet 出力のパイプ処理

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

Select-Box -Connection $conn -Table Files -Where "Id = '123'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myFilesData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-Box
PS C:\> $row = Select-Box -Connection $conn -Table "Files" -Columns (Id, Name) -Where "Id = '123'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Files",
  "Columns":  [

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

データの削除

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

Select-Box -Connection $conn -Table Files -Where "Id = '123'" | Remove-Box

データの変更

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

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

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