Cmdlets for Jira Assets

Build 24.0.9062

接続の確立

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

インストールおよび接続

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

Install-Module JiraAssetsCmdlets

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

Import-Module JiraAssetsCmdlets;

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

$conn = Connect-JiraAssets -User 'MyUser' -APIToken '123abc' -Url 'https://yoursitename.atlassian.net'

Jira Assets への接続および認証

Jira Assets は、APIToken 経由での接続と認証をサポートしています。

API トークンを生成するには:

  1. Atlassian アカウントにログインします。
  2. セキュリティ設定 -> API トークン -> API トークンを作成するをクリックします。
Atlassian がAPI トークンを生成して表示します。

API トークンを生成したら、以下のパラメータをセットします。

  • AuthSchemeAPIToken
  • User:認証するユーザーのログイン名。
  • APIToken:生成したAPI トークン。
これでJira Assets に接続して認証する準備が整いました。

データの取得

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

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

cmdlet 出力のパイプ処理

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

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

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

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

 
PS C:\> $conn  = Connect-JiraAssets -User 'MyUser' -APIToken '123abc' -Url 'https://yoursitename.atlassian.net'
PS C:\> $row = Select-JiraAssets -Connection $conn -Table "Objects" -Columns (Id, Name) -Where "Column2 = 'Bob'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Objects",
  "Columns":  [

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

データの削除

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

Select-JiraAssets -Connection $conn -Table Objects -Where "Column2 = 'Bob'" | Remove-JiraAssets

データの変更

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

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

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