Cmdlets for Azure DevOps

Build 23.0.8839

接続の確立

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

インストールおよび接続

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

Install-Module AzureDevOpsCmdlets

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

Import-Module AzureDevOpsCmdlets;

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

$conn = Connect-AzureDevOps - AuthScheme="Basic" Organization="MyAzureDevOpsOrganization" ProjectId="MyProjectId"

Azure DevOps への接続

To connect to your Azure DevOps account, specify Organization, the name of your Organization in the account, by navigating to Profile > Organizations.

For example, Organization=MyAzureDevOpsOrganization;

NOTE : Along with Organization you must provide ProjectId when connecting to Analytics schema.

Azure DevOps への認証

Basic

You can connect to your Azure DevOps account by providing the Organization and PersonalAccessToken. To generate a perosonal access token, log in to your Azure DevOps Organization account and navigate to Profile > Personal Access Tokens > New Token. The generated token is displayed.

Azure AD

Azure AD is a connection type that leverages OAuth to authenticate. OAuth requires the authenticating user to interact with Azure DevOps using an internet browser. The 本製品 facilitates this in several ways as described below. Set AuthScheme to AzureAD and Organization to the name of your Azure DevOps organization. The rest of the AzureAD flows assume that you set these two properties.

Desktop Applications

CData provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See カスタムOAuth アプリケーションの作成 for information about creating custom applications and reasons for doing so.

For authentication, the only difference between the two methods is that you must set two additional connection properties when using custom OAuth applications.

After setting the following connection properties, you are ready to connect:

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • OAuthClientId: (custom applications only) Set this to the client Id in your application settings.
  • OAuthClientSecret: (custom applications only) Set this to the client secret in your application settings.
  • CallbackURL: Set this to the Redirect URL in your application settings.

When you connect the 本製品 opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The 本製品 then completes the OAuth process:

  1. Extracts the access token from the callback URL and authenticates requests.
  2. Obtains a new access token when the old one expires.
  3. Saves OAuth values in OAuthSettingsLocation that persist across connections.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

  1. Choose one of these two options:

    • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
    • Option 2: Install the 本製品 on another machine and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.

  2. Then configure the 本製品 to automatically refresh the access token from the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

  1. Choose one of these options:

    • If you are using the Embedded OAuth Application click Azure DevOps OAuth endpoint to open the endpoint in your browser.
    • If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
      • InitiateOAuth: Set to OFF.
      • OAuthClientId: Set to the client Id assigned when you registered your application.
      • OAuthClientSecret: Set to the client secret assigned when you registered your application.
      Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.

  2. Log in and grant permissions to the 本製品. You are then redirected to the callback URL, which contains the verifier code.
  3. Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.
Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens. Set the following properties:

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthVerifier: Set this to the verifier code.
  • OAuthClientId: (custom applications only) Set this to the client Id in your custom OAuth application settings.
  • OAuthClientSecret: (custom applications only) Set this to the client secret in the custom OAuth application settings.
  • OAuthSettingsLocation: Set this to the location of the file where the driver saves the OAuth token values that persist across connections.

After the OAuth settings file is generated, you need to re-set the following properties to connect:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
  • OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
  • OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location grants read and write permissions to the 本製品 to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to create and install a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
  • OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
  • OAuthSettingsLocation: Set this to the location of your OAuth settings file. Make sure this location gives read and write permissions to the 本製品 to enable the automatic refreshing of the access token.

データの取得

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

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

cmdlet 出力のパイプ処理

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

Select-AzureDevOps -Connection $conn -Table WorkItems -Where "Reason = 'Manual'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myWorkItemsData.csv -NoTypeInformation

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

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

 
PS C:\> $conn  = Connect-AzureDevOps - AuthScheme="Basic" Organization="MyAzureDevOpsOrganization" ProjectId="MyProjectId"
PS C:\> $row = Select-AzureDevOps -Connection $conn -Table "WorkItems" -Columns (Id, BuildNumber) -Where "Reason = 'Manual'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "WorkItems",
  "Columns":  [

  ],
  "Id":  "MyId",
  "BuildNumber":  "MyBuildNumber"
}

データの削除

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

Select-AzureDevOps -Connection $conn -Table WorkItems -Where "Reason = 'Manual'" | Remove-AzureDevOps

データの変更

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

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

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