Azure DevOps
Azure DevOps コネクタを使用すると、Azure DevOps データに対して、挿入、削除、更新、読み取りオペレーションを実行できます。
サポート対象のバージョン
このコネクタは、次の Azure DevOps バージョンをサポートしています。
- Azure DevOps 2022、2020、2019
- Team Foundation Server 2018
始める前に
Google Cloud プロジェクトで次のタスクを行います。
- ネットワーク接続が設定されていることを確認します。ネットワーク パターンの詳細については、Network Connectivity をご覧ください。
- コネクタを構成するユーザーに roles/connectors.admin IAM ロールを付与します。
- コネクタに使用するサービス アカウントに、
roles/secretmanager.viewer
とroles/secretmanager.secretAccessor
の IAM ロールを付与します。 - 次のサービスを有効にします。
secretmanager.googleapis.com
(Secret Manager API)connectors.googleapis.com
(Connectors API)
サービスを有効にする方法については、サービスを有効にするをご覧ください。以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときに有効にするよう求められます。
コネクタを構成する
接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。
- Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
- [+ 新規作成] をクリックして [接続の作成] ページを開きます。
- [ロケーション] セクションで、接続のロケーションを選択します。
- リージョン: プルダウン リストからロケーションを選択します
サポートされているすべてのリージョンのリストについては、ロケーションをご覧ください。
- [NEXT] をクリックします。
- リージョン: プルダウン リストからロケーションを選択します
- [接続の詳細] セクションで、次の操作を行います。
- コネクタ: 使用可能なコネクタのプルダウン リストから [Azure DevOps] を選択します。
- コネクタのバージョン: 使用可能なバージョンのプルダウン リストからコネクタのバージョンを選択します。
- [接続名] フィールドに、接続インスタンスの名前を入力します。
接続名は次の条件を満たす必要があります。
- 接続名には英字、数字、ハイフンを使用できます。
- 文字は小文字のみを使用できます。
- 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
- 接続名は 49 文字以内で指定してください。
- 必要に応じて、接続インスタンスの [説明] を入力します。
- 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは
Error
に設定されています。 - サービス アカウント: 必要なロールを持つサービス アカウントを選択します。
- 必要に応じて、接続ノードの設定を構成します。
- ノードの最小数: 接続ノードの最小数を入力します。
- ノードの最大数: 接続ノードの最大数を入力します。
ノードは、トランザクションを処理する接続の単位(またはレプリカ)です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され(可用性を高めるため)、最大ノード数は 50 に設定されます。
- Azure Tenant: Azure DevOps テナントの名前または ID を指定します。
- 組織: Azure DevOps を使用する組織またはコレクションの名前を指定します。
- スキーマ: スキーマ(information、project など)を入力します。
- カタログ: カタログの名前を入力します。
- 変換を適用: 変換のカンマ区切りリストを入力します。
- Azure DevOps Edition: Azure DevOps のエディションを入力します。
- Azure DevOps Service API: Azure DevOps の Rest API バージョンを入力します。
- URL: Azure DevOps インスタンスの URL を指定します。
- カスタム フィールドを含める: 列のリストにカスタム フィールドを含めるには、このオプションを選択します。
- 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
- [NEXT] をクリックします。
- [宛先] セクションに、接続するリモートホスト(バックエンド システム)の詳細を入力します。
- 宛先の種類: 宛先の種類を選択します。
- 宛先のホスト名または IP アドレスを指定するには、[ホストアドレス] を選択し、[ホスト 1] フィールドにアドレスを入力します。
- プライベート接続を確立するには、[エンドポイント アタッチメント] を選択し、[エンドポイント アタッチメント] リストから必要なアタッチメントを選択します。
セキュリティをさらに強化してバックエンドシステムへのパブリック接続を確立する場合は、接続用の静的アウトバウンド IP アドレスの構成を検討してから、特定の静的 IP アドレスのみを許可リストに登録するようファイアウォール ルールを構成します。
他の宛先を入力するには、[+ 宛先を追加] をクリックします。
- [NEXT] をクリックします。
- 宛先の種類: 宛先の種類を選択します。
-
[認証] セクションで、認証の詳細を入力します。
- [認証タイプ] を選択し、関連する詳細を入力します。
Azure DevOps 接続でサポートされる認証タイプは次のとおりです。
- AzureAD
- 基本
- [NEXT] をクリックします。
これらの認証タイプの構成方法については、認証を構成するをご覧ください。
- [認証タイプ] を選択し、関連する詳細を入力します。
- Review: 接続と認証の詳細を確認します。
- [作成] をクリックします。
認証を構成する
使用する認証に基づいて詳細を入力します。
-
AzureAD
- ClientID: 作成したアプリのクライアント ID を入力します。
- スコープ: 読み取り、書き込みなど、すべてのスコープをカンマで区切って指定します。
- クライアント シークレット: 作成した接続されているアプリのクライアント シークレットを含む Secret Manager のシークレットを入力します。
- シークレット バージョン: 上で選択したシークレットのシークレット バージョンを選択します。
- 承認 URL: クライアントの承認 URL を指定します。
-
ベーシック
- 個人用アクセス トークン: 生成された個人用アクセス トークンを入力します。
- シークレットのバージョン: 入力したシークレットのシークレット バージョンを選択します。
接続構成のサンプル
このセクションでは、接続の作成時に構成するさまざまなフィールドのサンプル値を示します。
Azure DevOps では、さまざまなデータスキーマを使用して、プロジェクトのさまざまな側面を整理および管理します。各スキーマは特定の種類のデータに焦点を当て、プロジェクトのニーズに基づいて情報を効果的に構造化します。
- プロジェクト データモデル: Azure DevOps 内でアイテム、リポジトリ、パイプライン、チームなどのプロジェクト関連データがどのように整理、リンク、管理されるかを定義するスキーマ。
- 情報データモデル: Azure DevOps プロジェクト全体でドキュメント、メタデータ、コミュニケーション アーティファクトの構造化、保存、アクセス方法を定義するスキーマ。
- リポジトリ データモデル: Azure DevOps 内でコード リポジトリ、ブランチ、コミット、pull リクエスト、関連するメタデータを編成して管理する方法を定義するスキーマ。
- 分析データモデル: レポート、ダッシュボード、高度な分析のために Azure DevOps からの履歴データとリアルタイム データを取得して整理するスキーマ。
- すべてのデータモデル: 1 つの接続で、すべてのデータモデルにアクセスできる単一の接続。
フィールド名 | 情報モデル | プロジェクト モデル | リポジトリ モデル | 分析モデル | すべてのモデル | AzureAD 接続 |
---|---|---|---|---|---|---|
場所 | europe-west1 | europe-west1 | europe-west1 | europe-west1 | asia-east1 | europe-west1 |
コネクタ | Azure DevOps | Azure DevOps | Azure DevOps | Azure DevOps | Azure DevOps | Azure DevOps |
コネクタのバージョン | 1 | 1 | 1 | 1 | 1 | 1 |
接続名 | azuredevops-informationmodel | azuredevops-projectmodel | azuredevops-repositorymodel | azuredevops-analyticsmodel | DevOps | azuredevops-oauth |
Cloud Logging を有効にする | ○ | はい | はい | はい | はい | ○ |
ログレベル | デバッグ | デバッグ | デバッグ | デバッグ | デバッグ | デバッグ |
サービス アカウント | Your_Project_Number@serviceaccount | Your_Project_Number@serviceaccount | Your_Project_Number@serviceaccount | Your_Project_Number@serviceaccount | Your_Project_Number@serviceaccount | Your_Project_Number@serviceaccount |
Azure テナント | Tenant_Id | Tenant_Id | Tenant_Id | Tenant_Id | Tenant_Id | Tenant_Id |
組織 | Organization_Name | Organization_Name | Organization_Name | Organization_Name | Organization_Name | Organization_Name |
スキーマ | 情報 | プロジェクト | Repository__RepositoryId | アナリティクス | プロジェクト | |
カタログ | DevOps | Project_ProjectId | Project_ProjectId | Project_ProjectId | Project_ProjectId | |
Azure Dev Ops エディション | AzureDevOps Online | AzureDevOps Online | AzureDevOps Online | AzureDevOps Online | AzureDevOps Online | AzureDevOps Online |
Azure Dev Ops Service API | 6.0 | 6.0 | 6.0 | 6.0 | 6.0 | 6.0 |
カスタム フィールドを含める | ○ | はい | はい | はい | はい | ○ |
CustomizedDefaultCatalogName | CustomizedDefaultCatalogName=Google | CustomizedDefaultCatalogName=Google | ||||
ノードの最小数 | 2 | 2 | 2 | 2 | 2 | 2 |
ノードの最大数 | 50 | 50 | 50 | 50 | 50 | 50 |
認証 | ○ | はい | はい | はい | はい | ○ |
基本 | ○ | はい | はい | はい | ○ | |
API トークン | アプリから提供された API トークン | アプリから提供された API トークン | アプリから提供された API トークン | アプリから提供された API トークン | アプリから提供された API トークン | |
シークレットのバージョン | 1 | 1 | 1 | 1 | 1 | 1 |
AzureAD | ○ | |||||
クライアント ID | Client_Id | |||||
クライアント シークレットの値 | クライアント シークレットの値 | |||||
スコープ | user_impersonation | |||||
認証 URL | https://login.microsoftonline.com/c6f32d0e-6725-4007-81c2-951e853061a6/oauth2/authorize |
次の接続プロパティを使用して、Azure DevOps から取得したデータを管理できます。
カタログ
このプロパティは、接続するプロジェクトの名前または ID を指定します。プロジェクト ID と名前のリストを取得するには、Projects テーブルに対して SELECT
クエリを実行します。
- 特定のプロジェクトのデータをクエリするには、カタログをプロジェクト名またはその ID(Project_projectname の形式)に設定します。
プロジェクト名が dev で、ID が2ee729d6-804d-4ece-84af-d5befa94abe8
の場合、Catalog をProject_dev
またはProject_2ee729d6-804d-4ece-84af-d5befa94abe8
に設定します。 - 特定のプロジェクトに依存しないデータをクエリするには、[カタログ] を [Devops] に設定します。カタログ名が Devops の場合は、Devops の代わりに任意の名前を使用できます。
スキーマ
このプロパティは使用するスキーマを指定します。使用可能なスキーマは、指定されたリポジトリによって異なります。リポジトリ ID と名前のリストを取得するには、Repositories テーブルに対して SELECT
クエリを実行します。
- 接続構成で [カタログ] と [スキーマ] を
INFORMATION
に設定すると、Information Data Model スキーマにのみアクセスできます。他のプロジェクト カタログやスキーマは公開されません。 - [カタログ] がプロジェクト カタログに設定されている場合は、[スキーマ] を
Analytics
、Project
、またはリポジトリ スキーマのいずれかに設定できます。適切なスキーマを選択すると、特定のリポジトリ内のデータをクエリできます。
ID が3ee729d6-804d-4ece-84af-d5befa94abe8
のリポジトリからデータをクエリするには、[カタログ] をRepository_3ee729d6-804d-4ece-84af-d5befa94abe8
に設定します。
Azure Portal/MS Entra でアプリケーションを作成し、Azure AD 接続レベルで作成したアプリケーションのすべてのパラメータを利用するには、クイックスタート: Microsoft ID プラットフォームにアプリケーションを登録すると Microsoft Entra ID にクライアント アプリケーションを登録するをご覧ください。
システムの上限
Azure DevOps コネクタは、ノードごとに 1 秒あたり最大 6 件のトランザクションを処理し、この上限を超えるトランザクションをスロットル調整します。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます(可用性を高めるため)。
Integration Connectors に適用される上限の詳細については、上限をご覧ください。
統合で Azure DevOps 接続を使用する
接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。
- Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
- Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
操作
このセクションでは、コネクタでサポートされているアクションを一覧表示します。アクションの構成方法については、アクションの例をご覧ください。
CreateWorkItem アクション
このアクションにより、作業項目が作成されます。
CreateWorkItem アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | ○ | Azure DevOps プロジェクトの ID。 |
タイプ | 文字列 | ○ | 作成する作業項目のタイプ。 |
変革前 | 文字列 | いいえ | コピーまたは移動オペレーションの送信元パス。 |
Op | 文字列 | ○ | 作業項目を変更するパッチ オペレーション(追加、コピー、移動、削除、置換、テストなど)。 |
パス | 文字列 | ○ | オペレーションのパス。 |
値 | 文字列 | ○ | オペレーションの値。 |
CreateWorkItem
アクションの構成例については、例をご覧ください。
UpdateWorkItem アクション
UpdateWorkItem アクションの入力パラメータ
このアクションは、作業項目を更新します。
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | ○ | Azure DevOps プロジェクトの ID。 |
WorkItemId | 文字列 | ○ | 作業項目の ID。 |
変革前 | 文字列 | いいえ | コピーまたは移動オペレーションの送信元パス。 |
Op | 文字列 | ○ | 作業項目を変更するパッチ オペレーション(追加、コピー、移動、削除、置換、テストなど)。 |
パス | 文字列 | ○ | オペレーションのパス。 |
値 | 文字列 | ○ | オペレーションの値。 |
UpdateWorkItem
アクションの構成例については、例をご覧ください。
GetPullRequestCommits アクション
このアクションは、指定された pull リクエストの commit を取得します。
GetPullRequestCommits アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | ○ | Azure DevOps プロジェクトの ID。 |
RepositoryId | 文字列 | ○ | リポジトリの ID または名前。ProjectId が設定されていない場合は、RepositoryId を設定する必要があります。 |
PullRequestId | 文字列 | ○ | pull リクエストの ID。 |
GetPullRequestCommits アクションの出力パラメータ
GetPullRequestCommits
アクションの構成例については、例をご覧ください。
PushChanges アクション
このアクションにより、Azure DevOps インスタンスのリポジトリに変更が push されます。
PushChanges アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | ○ | Azure DevOps プロジェクトの ID。 |
RepositoryId | 文字列 | ○ | リポジトリの ID または名前。ProjectId が設定されていない場合は、RepositoryId を設定する必要があります。 |
BranchRefName | 文字列 | ○ | git ブランチの名前。 |
OldObjectId | 文字列 | ○ | ブランチの現在のオブジェクト ID。 |
CommitComment | 文字列 | ○ | コミットに含まれるコメントを指定します。 |
ChangesAggregate | 文字列 | ○ | コミット内の各変更の詳細を含む集計オブジェクト。 |
PushChanges
アクションの構成例については、例をご覧ください。
DownloadReleaseLogs アクション
このアクションでは、特定のリリースのログをダウンロードします。
DownloadReleaseLogs アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | ○ | Azure DevOps プロジェクトの ID。 |
ReleaseId | Integer | ○ | リリースの ID。 |
FileLocation | 文字列 | いいえ | ファイルの場所。 |
エンコード | 文字列 | × | FileData 入力のエンコード タイプ。 指定できる値は NONE と BASE64 です。デフォルト値は BASE64 です。 |
FileStream | 文字列 | いいえ | ファイルデータが書き込まれる出力ストリームのインスタンス。FileLocation が指定されていない場合にのみ使用されます。 |
DownloadReleaseLogs
アクションの構成例については、例をご覧ください。
DownloadTestAttachment アクション
このアクションでは、テスト結果/実行の添付ファイルをダウンロードします。
DownloadTestAttachment アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | ○ | Azure DevOps プロジェクトの ID。 |
ResultId | Integer | いいえ | テスト結果の ID。 |
RunId | Integer | ○ | テスト実行の ID。 |
AttachmentId | 文字列 | いいえ | 添付ファイルの ID。 |
FileLocation | 文字列 | いいえ | ファイルの場所。 |
エンコード | 文字列 | × | FileData 入力のエンコード タイプ。 指定できる値は NONE と BASE64 です。デフォルト値は BASE64 です。 |
FileStream | 文字列 | × | ファイルデータが書き込まれる出力ストリームのインスタンス。FileLocation が指定されていない場合にのみ使用されます。 |
DownloadTestAttachment
アクションの構成例については、例をご覧ください。
SetProjectProperties アクション
このアクションでは、チーム プロジェクトのプロパティを作成、更新、削除できます。
SetProjectProperties アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | ○ | Azure DevOps プロジェクトの ID。 |
変革前 | 文字列 | いいえ | 移動またはコピー オペレーションの送信元パス。 |
Op | 文字列 | ○ | プロジェクトのプロパティを変更するパッチ オペレーション(追加、コピー、移動、削除、置換、テストなど)。 |
パス | 文字列 | ○ | オペレーションのパス。 |
値 | 文字列 | ○ | オペレーションの値。 |
SetProjectProperties
アクションの構成例については、例をご覧ください。
DeleteTestCase アクション
この操作を行うと、テストケースが削除されます。
DeleteTestCase アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | ○ | Azure DevOps プロジェクトの ID。 |
TestcaseId | Integer | ○ | テストケースの ID。 |
DeleteTestCase
アクションの構成例については、例をご覧ください。
RunPipeline アクション
このアクションは、指定された構成でパイプラインを実行します。
RunPipeline アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | ○ | Azure DevOps プロジェクトの ID。 |
PipelineId | Integer | ○ | パイプラインの ID。 |
PipelineVersion | Integer | いいえ | 実行するパイプラインのバージョン。 |
リソース | 文字列 | ○ | 実行に必要なリソース。 |
変数 | 文字列 | いいえ | パイプラインの実行中に使用する変数と値のリスト。 |
StagesToSkip | 文字列 | いいえ | スキップするステージ名の配列。 |
TemplateParameters | 文字列 | いいえ | パイプラインの実行中に使用されるパラメータの Key-Value マップ。 |
RunPipeline
アクションの構成例については、例をご覧ください。
CreatePullRequest アクション
このアクションは、指定された構成で pull リクエストを作成します。
CreatePullRequest アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | ○ | Azure DevOps プロジェクトの ID。 |
RepositoryId | 文字列 | ○ | リポジトリの ID。 |
タイトル | 文字列 | ○ | pull リクエストのタイトル。 |
説明 | 文字列 | いいえ | pull リクエストの説明。 |
SourceRefName | 文字列 | ○ | プルリクエストのソースブランチの名前。 |
TargetRefName | 文字列 | ○ | pull リクエストのターゲット ブランチの名前。 |
CompletionOptions | 文字列 | いいえ | pull リクエストが完了したときにどのようにマージされるかに影響するオプション。 |
IsDraft | ブール値 | いいえ | 下書き / WIP の pull リクエスト。 |
ラベル | 文字列 | いいえ | pull リクエストに関連付けられたラベル。 |
MergeOptions | 文字列 | いいえ | pull リクエストのマージ実行時に使用されるオプション。 |
審査担当者 | 文字列 | いいえ | pull リクエストの審査者のリスト。 |
WorkItemRefs | 文字列 | いいえ | この pull リクエストに関連付けられている作業項目の参照。 |
CreatePullRequest
アクションの構成例については、例をご覧ください。
UpdatePullRequest アクション
このアクションは、指定された構成で pull リクエストを更新します。
UpdatePullRequest アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | ○ | Azure DevOps プロジェクトの ID。 |
RepositoryId | 文字列 | ○ | リポジトリの ID。 |
PullRequestId | 文字列 | ○ | pull リクエストの ID。 |
タイトル | 文字列 | いいえ | pull リクエストのタイトル。 |
説明 | 文字列 | いいえ | pull リクエストの説明。 |
ステータス | 文字列 | いいえ | プルリクエストのステータス。 |
TargetRefName | 文字列 | いいえ | pull リクエストのターゲット ブランチの名前。広報リターゲティング機能が有効になっている場合にのみ使用できます。 |
CompletionOptions | 文字列 | いいえ | pull リクエストが完了したときにどのようにマージされるかに影響するオプション。 |
MergeOptions | 文字列 | いいえ | pull リクエストのマージ実行時に使用されるオプション。 |
AutoCompleteSetById | 文字列 | いいえ | オートコンプリートを有効にしたユーザーの ID。 |
UpdatePullRequest
アクションの構成例については、例をご覧ください。
GetPullRequestCommits アクション
このアクションは、指定された構成で指定された pull リクエストの commit を取得します。
GetPullRequestCommits アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | ○ | Azure DevOps プロジェクトの ID。 |
RepositoryId | 文字列 | ○ | リポジトリの ID。 |
PullRequestId | 文字列 | ○ | pull リクエストの ID。 |
GetPullRequestCommits
アクションの構成例については、例をご覧ください。
AddBuildTag アクション
このアクションは、ビルドにタグを追加します。
AddBuildTag アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | ○ | Azure DevOps プロジェクトの ID。 |
BuildId | 文字列 | ○ | ビルドの ID。 |
タグ | 文字列 | ○ | ビルドに追加するタグ。 |
AddBuildTag
アクションの構成例については、例をご覧ください。
DeleteBuildTag アクション
このアクションにより、ビルドからタグが削除されます。
DeleteBuildTag アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | ○ | Azure DevOps プロジェクトの ID。 |
BuildId | 文字列 | ○ | ビルドの ID。 |
タグ | 文字列 | ○ | ビルドから削除するタグ。 |
DeleteBuildTag
アクションの構成例については、例をご覧ください。
DownloadBuildReports アクション
このアクションでは、ビルドレポートをダウンロードします。
DownloadBuildReports アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | ○ | Azure DevOps プロジェクトの ID。 |
BuildId | Integer | ○ | ビルドの ID。 |
FileLocation | 文字列 | いいえ | ファイルの場所。 |
エンコード | 文字列 | いいえ | FileData 入力のエンコード タイプ。指定できる値は NONE と BASE64 です。デフォルト値は BASE64 です。 |
FileStream | 文字列 | × | ファイルデータが書き込まれる出力ストリームのインスタンス。FileLocation が指定されていない場合にのみ使用されます。 |
DownloadBuildReports
アクションの構成例については、例をご覧ください。
DownloadBuildLogs アクション
このアクションは、ビルドログをダウンロードします。
DownloadBuildLogs アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | ○ | Azure DevOps プロジェクトの ID。 |
BuildId | Integer | ○ | ビルドの ID。 |
LogId | Integer | ○ | ログの ID。 |
StartLine | Integer | いいえ | ビルドの開始行。 |
EndLine | Integer | いいえ | ビルドの終了行。 |
FileLocation | 文字列 | いいえ | ファイルの場所。 |
エンコード | 文字列 | いいえ | FileData 入力のエンコード タイプ。指定できる値は NONE と BASE64 です。デフォルト値は BASE64 です。 |
FileStream | 文字列 | × | ファイルデータが書き込まれる出力ストリームのインスタンス。FileLocation が指定されていない場合にのみ使用されます。 |
DownloadBuildLogs
アクションの構成例については、例をご覧ください。
UpdateUser アクション
このアクションは、ユーザーの詳細を更新します。
UpdateUser アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
UserId | 文字列 | ○ | ユーザーの ID。 |
変革前 | 文字列 | いいえ | 移動またはコピー オペレーションの送信元パス。 |
Op | 文字列 | ○ | ユーザーを変更するパッチ オペレーション(追加、コピー、移動、削除、置換、テストなど)。 |
パス | 文字列 | いいえ | オペレーションのパス。 |
値 | 文字列 | いいえ | オペレーションの値。 |
UpdateUser
アクションの構成例については、例をご覧ください。
CloneTestPlan アクション
このアクションにより、テストプランが複製されます。
CloneTestPlan アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | いいえ | Azure DevOps プロジェクトの ID。 |
DeepClone | ブール値 | いいえ | 関連するテストケースもすべて複製します。 |
CloneRequirements | ブール値 | いいえ | true に設定すると、要件が複製されます。デフォルト値は false です。 |
CopyAllSuites | ブール値 | いいえ | ソースプランからすべてのスイートをコピーします。 |
CopyAncestorHierarchy | ブール値 | いいえ | 祖先の階層をコピーします。 |
DestinationWorkItemType | 文字列 | いいえ | クローンの作業項目タイプの名前。 |
OverrideParameters | 文字列 | いいえ | 各キーの値が指定された値でオーバーライドされる Key-Value ペア。 |
RelatedLinkComment | 文字列 | いいえ | 複製されたテストプランにコメントを追加します。 |
DestinationPlanAreaPath | 文字列 | いいえ | テストプランの領域。 |
DestinationPlanBuildId | 文字列 | いいえ | テスト対象のビルド。 |
DestinationPlanDescription | 文字列 | いいえ | テストプランの説明。 |
DestinationPlanEndDate | 文字列 | いいえ | テストプランの終了日。 |
DestinationPlanIteration | 文字列 | いいえ | テストプランのイテレーション パス。 |
DestinationPlanName | 文字列 | ○ | テストプランの名前。 |
DestinationPlanOwnerId | 文字列 | いいえ | テストプランのオーナーのユーザー ID。 |
DestinationPlanProject | 文字列 | いいえ | 宛先のプロジェクト名。 |
DestinationPlanStartDate | 文字列 | いいえ | テストプランの開始日。 |
DestinationPlanState | 文字列 | いいえ | テストプランの状態。 |
DestinationPlanSync | ブール値 | いいえ | テストプラン内のスイート間で重複するテストの動作を指定します。 |
SourceTestPlanId | Integer | ○ | 移行元のテストプランの ID。 |
SourceTestPlanSuiteId | Integer | いいえ | ソース テストプラン内で複製するテストスイート ID のカンマ区切りのリスト。 |
CloneTestPlan
アクションの構成例については、例をご覧ください。
CloneTestSuite アクション
このアクションは、テストスイートの詳細を複製します。
CloneTestSuite アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | いいえ | Azure DevOps プロジェクトの ID。 |
DeepClone | ブール値 | いいえ | 関連するすべてのテストケースを複製します。 |
CloneRequirements | ブール値 | いいえ | true に設定すると、要件が複製されます。デフォルト値は false です。 |
CopyAllSuites | ブール値 | いいえ | ソースプランからすべてのスイートをコピーします。 |
CopyAncestorHierarchy | ブール値 | いいえ | 祖先の階層をコピーします。 |
DestinationWorkItemType | 文字列 | いいえ | クローンの作業項目タイプの名前。 |
OverrideParameters | 文字列 | いいえ | 各キーの値が指定された値でオーバーライドされる Key-Value ペア。 |
RelatedLinkComment | 文字列 | いいえ | 複製されたテストスイートにコメントを追加します。 |
DestinationTestSuiteId | Integer | ○ | 移行先のテストスイートの ID。 |
DestinationProjectName | 文字列 | いいえ | 宛先のプロジェクト名。 |
SourceTestSuiteId | Integer | ○ | 移行元のテストスイートの ID。 |
CloneTestSuite
アクションの構成例については、例をご覧ください。
CloneTestCase アクション
このアクションは、テストケースの詳細を複製します。
CloneTestCase アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | いいえ | Azure DevOps プロジェクトの ID。 |
IncludeAttachments | ブール値 | いいえ | true に設定されている場合はテストケースの添付ファイルを含みます。デフォルト値は false に設定されています。 |
IncludeLinks | ブール値 | いいえ | true に設定すると、リンクが含まれます。デフォルト値は false です。 |
RelatedLinkComment | 文字列 | いいえ | 複製されたテストケースにコメントを追加します。 |
DestinationTestPlanId | Integer | ○ | 移行先のテストプランの ID。 |
DestinationTestSuiteId | Integer | ○ | 移行先のテストスイートの ID。 |
SourceTestPlanId | Integer | ○ | 移行元のテストプランの ID。 |
SourceTestSuiteId | Integer | ○ | 移行元のテストスイートの ID。 |
TestCaseId | Integer | ○ | 複製するテストケース ID のカンマ区切りのリスト。 |
CloneTestCase
アクションの構成例については、例をご覧ください。
DeletePullRequestAttachment アクション
このアクションは、pull リクエストの添付ファイルの詳細を削除します。
DeletePullRequestAttachment アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ProjectId | 文字列 | いいえ | Azure DevOps プロジェクトの ID。 |
RepositoryId | 文字列 | ○ | リポジトリの ID。 |
PullRequestId | Integer | ○ | pull リクエストの ID。 |
FileName | 文字列 | ○ | 添付ファイルの名前。 |
DeletePullRequestAttachment
アクションの構成例については、例をご覧ください。
アクションの例
例 - 作業項目を作成する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
CreateWorkItem
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "Type": "Bug", "Value": "Googlecloud_Testing_Bug_M", "Op": "add", "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc", "Path": "/fields/System.Title" }
アクションが成功すると、
CreateWorkItem
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[{ "Success": "True" }]
タスク、エピック、ユーザー ストーリー、テストケース、機能、問題などのさまざまなエンティティを作成するには、入力ペイロードの [Type] フィールドの値を変更するだけです。
タイプをエピックに設定するには、"Type": "Epic"
を設定します。同様に、「Type」: 「Task」、「Type」: 「User Story」、「Type」: 「Test Case」、「Type」: 「Feature」、「Type」: 「Issue」に値を変更して、それぞれのエンティティを作成できます。
例 - 作業項目を更新する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
UpdateWorkItem
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "WorkItemId": "35", "Value": "Update Workitem", "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc", "Op": "replace", "Path": "/fields/System.Title" }
アクションが成功すると、UpdateWorkItem
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[{ "Success": "True" }]
例 - コミットの pull リクエストを取得する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
GetPullRequestCommits
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "PullRequestId": "2", "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc", "RepositoryId": "e848b49e-704f-4df3-94ce-4f23176715b6" }
アクションが成功すると、GetPullRequestCommits
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[ { "CommitId": "7299b6623d7d146751d8cf280af301f9a345ff05", "AuthorName": "jeffersonloveshi.k", "AuthorEmail": "jeffersonloveshiking@gmail.com", "AuthoredDate": "2024-08-12 11:25:23.0", "CommitterName": "lakshminarayana.k", "CommitterEmail": "jeffersonloveshiking@gmail.com", "CommittedDate": "2024-08-12 11:25:23.0", "Comment": "Added sample.txt", "CommentTruncated": null, "Url": "https://dev.azure.com/charliecruz/64058663-6419-4b11-8ef0-2ebf985949bc/_apis/git/repositories/e848b49e-704f-4df3-94ce-4f23176715b6/commits/7299b6623d7d146751d8cf280af301f9a345ff05" } ]
例 - リポジトリに変更を push する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
PushChanges
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "RepositoryId": "89f79340-8659-4927-9d9f-e8836c19af55", "BranchRefName": "refs/heads/US_Googlecloud_Push1", "OldObjectId": "4d66aafb75efda2bbdda7a2b609b152b1b715b7e", "CommitComment": "Googlecloud PUSH Changes", "ChangesAggregate": "{\n \"changeType\": \"edit\",\n \"item\": {\n \"path\": \"/tasks.md\"\n },\n \"newContent\": {\n \"content\": \"# Tasks\\n\\n* Item 1\\n* Item 2\",\n \"contentType\": \"rawtext\"\n }\n }" }
アクションが成功すると、PushChanges
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[ { "NewObjectId": "949e4710336bc5bdc779ca6b334e029c2f50a029", "CommitId": "949e4710336bc5bdc779ca6b334e029c2f50a029", "CommitTreeId": "7e7394dcfc5b4d4cf2c8c21d70a96fe34f8eaf3e", "AuthorName": "Charlie Cruz", "AuthorEmail": "baklavainthebalkans@gmail.onmicrosoft.com", "AuthoredDate": "2024-11-19 07:04:42.0", "CommitterName": "Charlie Cruz", "CommitterEmail": "baklavainthebalkans@gmail.onmicrosoft.com", "CommittedDate": "2024-11-19 07:04:42.0", "CommitUrl": "https://dev.azure.com/charliecruz/64058663-6419-4b11-8ef0-2ebf985949bc/_apis/git/repositories/89f79340-8659-4927-9d9f-e8836c19af55/commits/949e4710336bc5bdc779ca6b334e029c2f50a029", "RepositoryId": "89f79340-8659-4927-9d9f-e8836c19af55", "RepositoryName": "refs/heads/US_Googlecloud_Push1", "PushId": "193", "PushDate": "2024-11-19T07:04:42.5793751Z", "PushURL": "https://dev.azure.com/charliecruz/64058663-6419-4b11-8ef0-2ebf985949bc/_apis/git/repositories/89f79340-8659-4927-9d9f-e8836c19af55/pushes/193" } ]
例 - リリースのログをダウンロードする
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
DownloadReleaseLogs
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc", "ReleaseId": 2 }
アクションが成功すると、DownloadReleaseLogs
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[ { "Status": "Success", "FileData": "{Base64encodedvalue}]
例 - テスト結果/実行の添付ファイルをダウンロードする
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
DownloadTestAttachment
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc", "RunId": 50, "AttachmentId": "2" }
アクションが成功すると、DownloadTestAttachment
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[ { "Status": "Success", "FileData": "iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAIAAABvFaqvAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAABlSURBVDhP7cxBCsAgDERR739pG/CnGJI0FopQ8O2cjNP6R85QbeNQU7wT1dkijaQ3vkZoWElaoTeJojW01cYh0jwfgiFBV/lEjOZtacijN/nLkOBHhIaVDgn+Wdycp6FXzlCl9wt0Y0cAzHo/zgAAAABJRU5ErkJggg==" } ]
例 - プロジェクト プロパティを設定する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
SetProjectProperties
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc", "Op": "add", "Path": "/Alias", "Value": "Google CLoud Properties" }
アクションが成功すると、SetProjectProperties
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[ { "Status": "Success" } ]
例 - テストケースを削除する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
DeleteTestCase
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "TestCaseId": 22255, "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc" }
アクションが成功すると、DeleteTestCase
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[ { "Status": "Success" } ]
例 - プロジェクトのパイプラインを実行する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
RunPipeline
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc", "PipelineId": 7, "Resources": "{\n \"repositories\": {\n \"self\": {\n \"refName\": \"refs/heads/main\" // Specify the branch or tag\n }\n }\n }" }
アクションが成功すると、
RunPipeline
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[ { "State": "inProgress", "RunId": "16", "RunName": "20241113.2", "RunHref": "https://dev.azure.com/charliecruz/64058663-6419-4b11-8ef0-2ebf985949bc/_apis/pipelines/7/runs/16", "CreatedDate": "2024-11-13 12:07:38.9237296" } ]
例 - pull リクエストを更新する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
UpdatePullRequest
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc", "RepositoryId": "e848b49e-704f-4df3-94ce-4f23176715b6", "PullRequestId": "26", "Description": "updated pull req", "Title": "Googlecloud M pull request" }
アクションが成功すると、UpdatePullRequest
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[ { "Status": "Success", "PullRequestId": 26 } ]
例 - pull リクエストを作成する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
CreatePullRequest
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc", "RepositoryId": "e848b49e-704f-4df3-94ce-4f23176715b6", "Title": "Googlecloud M pull request", "SourceRefName": "refs/heads/Test_Branch", "TargetRefName": "refs/heads/main" }
アクションが成功すると、CreatePullRequest
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[ { "Status": "Success", "PullRequestId": 26 } ]
例 - pull リクエストの commit を取得する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
GetPullRequestCommits
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "PullRequestId": "23", "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc", "RepositoryId": "e848b49e-704f-4df3-94ce-4f23176715b6" }
アクションが成功すると、GetPullRequestCommits
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[ { "CommitId": "ebb720c5b93c52341cb86ccfb42258bb562a8406", "AuthorName": "dani.dana", "AuthorEmail": "baklavainthebalkans@gmail.com", "AuthoredDate": "2024-11-26 11:24:19.0", "CommitterName": "dani.dana", "CommitterEmail": "baklavainthebalkans@gmail.com", "CommittedDate": "2024-11-26 11:24:19.0", "Comment": "Updated sample.txt", "CommentTruncated": null, "Url": "https://dev.azure.com/charliecruz/64058663-6419-4b11-8ef0-2ebf985949bc/_apis/git/repositories/e848b49e-704f-4df3-94ce-4f23176715b6/commits/ebb720c5b93c52341cb86ccfb42258bb562a8406" }, { "CommitId": "353f74b48ada83111449b922f4660a338e058989", "AuthorName": "dani.dana", "AuthorEmail": "baklavainthebalkans@gmail.com", "AuthoredDate": "2024-11-26 11:23:01.0", "CommitterName": "dani.dana", "CommitterEmail": "baklavainthebalkans@gmail.com", "CommittedDate": "2024-11-26 11:23:01.0", "Comment": "Updated bcd", "CommentTruncated": null, "Url": "https://dev.azure.com/charliecruz/64058663-6419-4b11-8ef0-2ebf985949bc/_apis/git/repositories/e848b49e-704f-4df3-94ce-4f23176715b6/commits/353f74b48ada83111449b922f4660a338e058989" }, { "CommitId": "50a74dee46f8bcad4637d730994144f944c7d589", "AuthorName": "dani.dana", "AuthorEmail": "baklavainthebalkans@gmail.com", "AuthoredDate": "2024-11-26 11:21:59.0", "CommitterName": "dani.dana", "CommitterEmail": "baklavainthebalkans@gmail.com", "CommittedDate": "2024-11-26 11:21:59.0", "Comment": "Added bcd", "CommentTruncated": null, "Url": "https://dev.azure.com/charliecruz/64058663-6419-4b11-8ef0-2ebf985949bc/_apis/git/repositories/e848b49e-704f-4df3-94ce-4f23176715b6/commits/50a74dee46f8bcad4637d730994144f944c7d589" }, { "CommitId": "9813f562b0548144006f773314704db274c757c4", "AuthorName": "Alex amal", "AuthorEmail": "cloudysanfrancisco@gmail.com", "AuthoredDate": "2024-11-26 11:19:29.0", "CommitterName": "Alex amal", "CommitterEmail": "cloudysanfrancisco@gmail.com", "CommittedDate": "2024-11-26 11:19:29.0", "Comment": "hello", "CommentTruncated": null, "Url": "https://dev.azure.com/charliecruz/64058663-6419-4b11-8ef0-2ebf985949bc/_apis/git/repositories/e848b49e-704f-4df3-94ce-4f23176715b6/commits/9813f562b0548144006f773314704db274c757c4" } ]
例 - ビルドタグを追加する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
AddBuildTag
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc","BuildId": "14","Tag": "AddGooglecloud_Tag" }
アクションが成功すると、AddBuildTag
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[{ "Status": "Success" }]
例 - ビルドタグを削除する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
DeleteBuildTag
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc","BuildId": "14","Tag": "AddGooglecloud_Tag"}
アクションが成功すると、DeleteBuildTag
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[{ "Status": "Success" }]
例 - ビルドレポートをダウンロードする
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
DownloadBuildReports
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc", "BuildId": 16 }
アクションが成功すると、DownloadBuildReports
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[ { "Status": "Success", "FileData": "Base64-format data" } ]
例 - ビルドログをダウンロードする
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
DownloadBuildLogs
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "BuildId": 16, "LogId": 1, "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc" }
アクションが成功すると、DownloadBuildLogs
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[ { "Status": "Success", "FileData": "Base64-format data" } ]
例 - ユーザーを更新する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
UpdateUser
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "UserId": "088a8c28-1b83-4538-9c74-b7ca97eb4ef2", "Op": "add", "Path": "/projectEntitlements/50fac9d4-37aa-4a13-a81a-887d12be7b9f", "Value": "{ \"projectRef\": {\n \"id\": \"50fac9d4-37aa-4a13-a81a-887d12be7b9f\",\n \"name\": \"Postman_Testing_Project\"\n }, \n \"group\": {\n \"groupType\": \"projectContributor\"\n }}" }
アクションが成功すると、Update User
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[ { "Status": "Success" } ]
例 - テストプランを複製する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
CloneTestPlan
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "CloneRequirements": true, "CopyAllSuites": true, "RelatedLinkComment": "Cloned from existing test plan googlecloud", "DestinationPlanName": "TestPlan 2", "DestinationPlanAreaPath": "GCPTesting_New_Project", "DestinationPlanIteration": "GCPTesting_New_Project", "DestinationPlanProject": "GCPTesting_New_Project", "SourceTestPlanId": 1, "CopyAncestorHierarchy": true }
アクションが成功すると、CloneTestPlan
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[ { "CloneOperationId": null, "CloneOperationState": "queued", "sourcetestplan_project_id": "ea4270d3-d335-4ef1-b1af-37a7591880cf", "sourcetestplan_project_name": "GCPTesting_New_Project", "sourcetestplan_project_state": "unchanged", "sourcetestplan_project_visibility": "unchanged", "sourcetestplan_project_lastupdatetime": "0001-01-01T00:00:00", "sourcetestplan_id": "1", "sourcetestplan_name": "Test Plan 1", "destinationtestplan_id": "15", "destinationtestplan_project_id": "ea4270d3-d335-4ef1-b1af-37a7591880cf", "destinationtestplan_project_name": "GCPTesting_New_Project", "destinationtestplan_project_state": "unchanged", "destinationtestplan_project_visibility": "unchanged", "destinationtestplan_project_lastupdatetime": "0001-01-01T00:00:00", "destinationtestplan_updateddate": "2025-01-07T14:02:31.247Z", "destinationtestplan_updatedby_displayname": "Charlie Cruz", "destinationtestplan_updatedby_url": "https://spsprodcin1.vssps.visualstudio.com/A0f5fd5e8-7721-4842-b504-2a8ddb8efeb0/_apis/Identities/df102a0c-59d2-6d69-aecd-556086d6d8d6", "destinationtestplan_updatedby__links_avatar_href": "https://dev.azure.com/sunitavenkata2024/_apis/GraphProfile/MemberAvatars/msa.ZGYxMDJhMGMtNTlkMi03ZDY5LWFlY2QtNTU2MDg2ZDZkOGQ2", "destinationtestplan_updatedby_id": "df102a0c-59d2-6d69-aecd-556086d6d8d6", "destinationtestplan_updatedby_uniquename": "sunitavenkata2024@outlook.com", "destinationtestplan_updatedby_imageurl": "https://dev.azure.com/sunitavenkata2024/_apis/GraphProfile/MemberAvatars/msa.ZGYxMDJhMGMtNTlkMi03ZDY5LWFlY2QtNTU2MDg2ZDZkOGQ2", "destinationtestplan_updatedby_descriptor": "msa.ZGYxMDJhMGMtNTlkMi03ZDY5LWFlY2QtNTU2MDg2ZDZkOGQ2", "destinationtestplan_rootsuite_id": "16", "destinationtestplan_rootsuite_name": "TestPlan 2", "destinationtestplan__links__self_href": "https://dev.azure.com/sunitavenkata2024/GCPTesting_New_Project/_apis/testplan/Plans/15", "destinationtestplan__links_clienturl_href": "mtms://dev.azure.com:443/sunitavenkata2024/p:GCPTesting_New_Project/Testing/testplan/connect?id=15", "destinationtestplan__links_rootsuite_href": "https://dev.azure.com/sunitavenkata2024/GCPTesting_New_Project/_apis/testplan/Plans/15/Suites/16", "destinationtestplan_revision": "1", "destinationtestplan_name": "TestPlan 2", "destinationtestplan_areapath": "GCPTesting_New_Project", "destinationtestplan_startdate": "2025-01-07T14:02:31.0878913Z", "destinationtestplan_enddate": "2025-01-14T14:02:31.0878913Z", "destinationtestplan_iteration": "GCPTesting_New_Project", "destinationtestplan_owner_displayname": "sunita m V", "destinationtestplan_owner_url": "https://spsprodcin1.vssps.visualstudio.com/A0f5fd5e8-7721-4842-b504-2a8ddb8efeb0/_apis/Identities/df102a0c-59d2-6d69-aecd-556086d6d8d6", "destinationtestplan_owner__links_avatar_href": "https://dev.azure.com/sunitavenkata2024/_apis/GraphProfile/MemberAvatars/msa.ZGYxMDJhMGMtNTlkMi03ZDY5LWFlY2QtNTU2MDg2ZDZkOGQ2", "destinationtestplan_owner_id": "df102a0c-59d2-6d69-aecd-556086d6d8d6", "destinationtestplan_owner_uniquename": "sunitavenkata2024@outlook.com", "destinationtestplan_owner_imageurl": "https://dev.azure.com/sunitavenkata2024/_apis/GraphProfile/MemberAvatars/msa.ZGYxMDJhMGMtNTlkMi03ZDY5LWFlY2QtNTU2MDg2ZDZkOGQ2", "destinationtestplan_owner_descriptor": "msa.ZGYxMDJhMGMtNTlkMi03ZDY5LWFlY2QtNTU2MDg2ZDZkOGQ2", "destinationtestplan_state": "Active", "destinationtestplan_testoutcomesettings_syncoutcomeacrosssuites": "false", "cloneoptions_relatedlinkcomment": "Cloned from existing test plan gcp", "cloneoptions_copyallsuites": "true", "cloneoptions_copyancestorhierarchy": "true", "cloneoptions_clonerequirements": "true", "cloneoperationresponse_state": "queued", "cloneoperationresponse_links__self_href": "https://dev.azure.com/sunitavenkata2024/GCPTesting_New_Project/_apis/testplan/Plans/CloneOperation/0" } ]
例 - テストスイートのクローンを作成する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
CloneTestSuite
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "SourceTestSuiteId": 18, "CopyAllSuites": true, "CopyAncestorHierarchy": true, "DestinationTestSuiteId": 2 }
アクションが成功すると、
CloneTestSuite
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[ { "CloneOperationId": 2, "CloneOperationState": "queued", "sourcetestsuite_project_id": "ea4270d3-d335-4ef1-b1af-37a7591880cf", "sourcetestsuite_project_name": "GCPTesting_New_Project", "sourcetestsuite_project_state": "unchanged", "sourcetestsuite_project_visibility": "unchanged", "sourcetestsuite_project_lastupdatetime": "0001-01-01T00:00:00", "sourcetestsuite_id": "18", "sourcetestsuite_name": "Test Plan 3", "destinationtestsuite_project_id": "ea4270d3-d335-4ef1-b1af-37a7591880cf", "destinationtestsuite_project_name": "GCPTesting_New_Project", "destinationtestsuite_project_state": "unchanged", "destinationtestsuite_project_visibility": "unchanged", "destinationtestsuite_project_lastupdatetime": "0001-01-01T00:00:00", "destinationtestsuite_id": "2", "destinationtestsuite_name": "Test Plan 1", "cloneoptions_copyallsuites": "true", "cloneoptions_copyancestorhierarchy": "true", "cloneoptions_clonerequirements": "false", "cloneoperationresponse_opid": "2", "cloneoperationresponse_state": "queued", "cloneoperationresponse_links__self_href": "https://dev.azure.com/sunitavenkata2024/GCPTesting_New_Project/_apis/testplan/Suites/CloneOperation/2" } ]
例 - テストケースのクローンを作成する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
CloneTestCase
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "SourceTestPlanId": 1, "DestinationTestPlanId": 20, "SourceTestSuiteId": 2, "DestinationTestSuiteId": 21, "TestCaseId": 3 }
アクションが成功すると、CloneTestCase
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[ { "CloneOperationId": 3, "CloneOperationState": "queued", "sourcetestsuite_project_id": "ea4270d3-d335-4ef1-b1af-37a7591880cf", "sourcetestsuite_project_name": "GCPTesting_New_Project", "sourcetestsuite_project_state": "unchanged", "sourcetestsuite_project_visibility": "unchanged", "sourcetestsuite_project_lastupdatetime": "0001-01-01T00:00:00", "sourcetestsuite_testcaseids": "3", "sourcetestsuite_id": "2", "sourcetestsuite_name": "Test Plan 1", "destinationtestsuite_project_id": "ea4270d3-d335-4ef1-b1af-37a7591880cf", "destinationtestsuite_project_name": "GCPTesting_New_Project", "destinationtestsuite_project_state": "unchanged", "destinationtestsuite_project_visibility": "unchanged", "destinationtestsuite_project_lastupdatetime": "0001-01-01T00:00:00", "destinationtestsuite_id": "21", "destinationtestsuite_name": "Test Plan 4", "cloneoptions_includelinks": "false", "cloneoptions_includeattachments": "false", "cloneoperationresponse_opid": "3", "cloneoperationresponse_state": "queued", "cloneoperationresponse_links__self_href": "https://dev.azure.com/sunitavenkata2024/GCPTesting_New_Project/_apis/testplan/Plans/CloneOperation/3" } ]
例 - pull リクエストの添付ファイルを削除する
- [
Configure connector task
] ダイアログで、[Actions
] をクリックします。 - [
DeletePullRequestAttachment
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc", "RepositoryId": "e848b49e-704f-4df3-94ce-4f23176715b6", "PullRequestId": 26, "FileName": "Company.jpg" }
このアクションは、DeletePullRequestAttachment の確認メッセージを返します。アクションが成功すると、
DeletePullRequestAttachment
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[ { "Status": "Success" } ]
エンティティ オペレーションの例
プロジェクト内のすべてのダッシュボードを取得する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からDashboards
を選択します。- [
List
] オペレーションを選択し、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、お客様の要件に応じて filterClause を設定できます。下記の注のセクションをご確認ください。
filterClause の値は、常にこの形式で単一引用符(')で囲んで渡す必要があります。
filterClause を使用すると、任意の列に基づいて特定のレコードセットをフィルタリングできます。
例 - ID を使用して単一のダッシュボードを取得する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からDashboards
を選択します。- [
Get
] オペレーションを選択し、[完了] をクリックします。 - エンティティ ID を「2f671e29-e48f-4d26-8869-859e154b5f20」に設定します。これは渡されるキーです。エンティティ ID を設定するには、[データ マッピング] の [データ マッパー] セクションで [データ マッピング エディタを開く] をクリックし、[入力値] フィールドに
"2f671e29-e48f-4d26-8869-859e154b5f20"
を入力し、EntityId をローカル変数として選択します。エンティティ ID の値は直接渡す必要があります(「2f671e29-e48f-4d26-8869-859e154b5f20」など)。ここで、「2f671e29-e48f-4d26-8869-859e154b5f20」は渡される一意の主キー値です。
エンティティに 2 つの複合キーがあるため、単一のエンティティ ID を渡すとエラーが発生することがあります。このような場合は、filterClause を使用して、id='2f671e29-e48f-4d26-8869-859e154b5f20' などの値を渡すことができます。
例 - ID を使用してダッシュボードを削除する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からDashboards
を選択します。- [
Delete
] オペレーションを選択し、[完了] をクリックします。 - エンティティ ID を「2f671e29-e48f-4d26-8869-859e154b5f20」に設定します。これは渡されるキーです。エンティティ ID を設定するには、[データ マッピング] の [データ マッパー] セクションで [データ マッピング エディタを開く] をクリックし、[入力値] フィールドに
"2f671e29-e48f-4d26-8869-859e154b5f20"
を入力し、EntityId をローカル変数として選択します。エンティティに 2 つの複合ビジネスキーまたは主キーがある場合、entityId を指定する代わりに、filterClause を
id='2f671e29-e48f-4d26-8869-859e154b5f20'
に設定できます。
例 - プロジェクトに新しいダッシュボードを作成する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からDashboard
を選択します。- [
Create
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データ マッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。{ "Name": "TestingGooglecloud09", "TeamId": "9f2e4d3c-ed57-474f-bab1-3de5727e60a1" }
統合が成功すると、コネクタタスクの
connectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id": "a2402c49-6c17-43a9-bfc4-3701d07bcfee" }
例 - プロジェクトで新しいユーザー利用資格を作成する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からUsers
を選択します。- [
Create
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データ マッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。{ "UserPrincipalName": "jeffersonloveshiking@gmail.com", "UserSubjectKind": "user", "AccessLevelAccountLicenseType": "Stakeholder", "UserOriginId": "e3d3e130-51dc-48c5-a510-cce7a9df63af" }
統合が成功すると、コネクタタスクの
connectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id": "5e373a81-073d-4d64-a2c5-23d0b6cc287f" }
例 - プロジェクトで新しいクエリを作成する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からQueries
を選択します。- [
Create
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データ マッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。{ "Name": "New Queries Googlecloud", "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc", "IsFolder": true, "Wiql": "SELECT [System.Id], [System.Title], [System.State] FROM WorkItems WHERE [System.WorkItemType] = 'Bug' AND [System.State] = 'New' ORDER BY [System.ChangedDate] DESC", "ParentQueryId": "df947cf9-dbbe-43bc-93a4-3e4d7287adb8" }
統合が成功すると、コネクタタスクの
connectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id": "cf4a25e8-d2d2-48b7-a483-dd901c78293b" }
例 - プロジェクトで新しいパイプラインを作成する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からPipelines
を選択します。- [
Create
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データ マッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。{ "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc", "Name": "Googlecloud pipeline", "Folder": "\\\\", "ConfigurationPath": "build-deploy.yml", "ConfigurationRepositoryId": "957b9cd1-f7f1-45d4-8665-ed7120021da9", "ConfigurationRepositoryType": "azureReposGit", "ConfigurationType": "yaml" }
統合が成功すると、コネクタタスクの
connectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id": 9 }
例 - プロジェクトにデプロイ グループを作成する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からDeploymentGroups
を選択します。- [
Create
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データ マッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。{ "Name": "Deployment group 2 Googlecloud" }
統合が成功すると、コネクタタスクの
connectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id": 139 }
例 - プロジェクトで新しいテスト構成を作成する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からTestPlan
を選択します。- [
Create
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データ マッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。{ "Name": "Googlecloud_TestPlan" }
統合が成功すると、コネクタタスクの
connectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id": 106 }
例 - プロジェクトにテストスイートを作成する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からTestSuite
を選択します。- [
Create
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データ マッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。{ "Name": "Googlecloud_Suite", "PlanId": 106, "SuiteType": "staticTestSuite", "ParentSuiteId": 108, "InheritDefaultConfigurations": false }
統合が成功すると、コネクタタスクの
connectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id": 22264 }
例 - プロジェクトでテスト実行を作成する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からTestRun
を選択します。- [
Create
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データ マッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。{ "Name": "TestRun_Googlecloud1"}
統合が成功すると、コネクタタスクの
connectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id": 46 }
例 - 新しいプロジェクトを作成する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からProjects
を選択します。- [
Create
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データ マッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。{ "Name": "project from Googlecloud test 4", "Description": "This is new project", "CapabilitiesVersionControlType": "Git\n", "CapabilitiesProcessTemplateTypeId": "6b724908-ef14-45cf-84f8-768b5384da45" }
アクションが成功すると、
Projects
タスクのconnectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id": "c1a8e7f4-9afa-47a8-9862-b56229e134a9" }
プロジェクトに対して作成オペレーションを実行した後に生成される ID は、実際のプロジェクト ID ではありません。
プロジェクトの詳細を取得するには、プロジェクト名をフィルタ条件として使用して List オペレーションを実行する必要があります(例: Name= 'Google Project Integration')。
例 - プロジェクトにチームを作成する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からTeams
を選択します。- [
Create
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データ マッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。{ "Name": "M new team"}
統合が成功すると、コネクタタスクの
connectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id": "5285fb98-a1bc-42e1-9668-3c2780061367" }
例 - プロジェクトに環境を作成する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からEnvironments
を選択します。- [
Create
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データ マッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。{ "Name": "Google CLoud Env M", "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc", "Description": "Google Cloud created environment" }
統合が成功すると、コネクタタスクの
connectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id": "9" }
例 - ダッシュボードに新しいウィジェットを作成する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からWidgets
を選択します。- [
Create
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データ マッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。{ "Name": "Widget 2", "DashboardId": "6cb82f8d-393c-422e-b4e3-563d5e34fc31", "TeamId": "9f2e4d3c-ed57-474f-bab1-3de5727e60a1", "RowPosition": 4, "ColumnPosition": 4, "RowSpanSize": 1, "ColumnSpanSize": 2, "ContributionId": "ms.vss-dashboards-web.Microsoft.VisualStudioOnline.Dashboards.OtherLinksWidget" }
この例では、ウィジェットを追加する方法を示します。統合が成功すると、コネクタタスクの
connectorOutputPayload
レスポンス パラメータには次に似た値が含まれます。{ "Id": "7d049ae2-d995-4b3e-9ebd-662d94a53cc8" }
例 - リポジトリの pull リクエストに審査担当者を追加する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からPullRequestReviewers
を選択します。- [
Create
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データ マッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。{ "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc", "RepositoryId": "e848b49e-704f-4df3-94ce-4f23176715b6", "PullRequestId": 22, "Id": "38b14cd8-d8f2-4d79-9204-19adbcb62c81", "Vote": 0 }
統合が成功すると、コネクタタスクの
connectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id": "38b14cd8-d8f2-4d79-9204-19adbcb62c81", "PullRequestId": null }
例 - プロジェクトに変数グループを作成する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からVariableGroups
を選択します。- [
Create
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データ マッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。{ "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc", "Type": "Vsts", "Variables": "{\n \"SampleVariableName1\": {\n \"value\": \"SampleValue1\"\n },\n \"SampleVariableName2\": {\n \"value\": \"SampleValue2\"\n }\n }", "VariableGroupProjectRefs": "[\n {\n \"description\": \"SampleDescription\",\n \"name\": \"Variable Group new test\",\n \"projectReference\": {\n \"id\": \"64058663-6419-4b11-8ef0-2ebf985949bc\",\n \"name\": \"Googlecloud-Demo-Project\"\n }\n }\n ]", "Name": "Variable Group new test" }
統合が成功すると、コネクタタスクの
connectorOutputPayload
レスポンス パラメータの値は次のようになります。{"Id": "12"}
例 - リポジトリに新しいビルド定義を作成する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からBuildDefinition
を選択します。- [
Create
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データ マッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。{"Name": "New Build definition from googlecloud test 11","RepositoryType": "TfsGit","ProcessYamlFilename": "data.txt","RepositoryId": "e848b49e-704f-4df3-94ce-4f23176715b6","Tags": "1"}
統合が成功すると、コネクタタスクの
connectorOutputPayload
レスポンス パラメータの値は次のようになります。{"Id": "25"}
例 - プロジェクトでリリースを作成する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からReleases
を選択します。- [
Create
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データ マッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。{ "ProjectId": "64058663-6419-4b11-8ef0-2ebf985949bc", "Reason": "manual", "Description": "This is a googlecloud release", "ReleaseDefinitionId": 1 }
統合が成功すると、コネクタタスクの
connectorOutputPayload
レスポンス パラメータの値は次のようになります。{ "Id": "13" }
例 - プロジェクトでチームの名前または説明を更新する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からTeams
を選択します。- [
Update
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データマッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。{ "Name": "M new team update" }
- データ マッパーで Teams のエンティティにエンティティ ID を設定します。エンティティ ID を設定するには、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。[entityId] を指定する代わりに、[filterClause] を
5285fb98-a1bc-42e1-9668-3c2780061367
に設定することもできます。この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "Id": "5285fb98-a1bc-42e1-9668-3c2780061367" }
例 - プロジェクト内のクエリを更新する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からQueries
を選択します。- [
Update
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データマッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。{ "Name": "Update Queries" }
- データ マッパーでエンティティ ID をクエリのエンティティに設定します。エンティティ ID を設定するには、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。[entityId] を指定する代わりに、[filterClause] を
81797017-624d-4967-bc85-842a817bff48
に設定することもできます。この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "Id": "81797017-624d-4967-bc85-842a817bff48" }
例 - プロジェクトのダッシュボードを更新する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からDashboard
を選択します。- [
Update
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データマッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。{ "Name": " update from googlecloud" }
- データ マッパーでエンティティ ID をダッシュボードのエンティティに設定します。エンティティ ID を設定するには、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。[entityId] を指定する代わりに、[filterClause] を
139
に設定することもできます。この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "Id": "139" }
例 - プロジェクト内のテストスイートを更新する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からTestSuite
を選択します。- [
Update
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データマッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。{ "Name": "UPdated_Suite", "ParentSuiteId": 108 }
- データ マッパーでエンティティ ID を TestSuite のエンティティに設定します。エンティティ ID を設定するには、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。[entityId] を指定する代わりに、[filterClause] を
22264
に設定することもできます。この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "Id": "22264" }
例 - プロジェクトのデプロイ グループを更新する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からDeploymentGroups
を選択します。- [
Update
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データマッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。{ "Name": "Deployment" }
- データ マッパーでエンティティ ID を DeploymentGroups のエンティティに設定します。エンティティ ID を設定するには、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。[entityId] を指定する代わりに、[filterClause] を
138
に設定することもできます。この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "Id": "138" }
例 - プロジェクトのテスト計画を更新する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からTestPlan
を選択します。- [
Update
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データマッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。{ "Name": "TestPlan_Update" }
- データ マッパーでエンティティ ID を TestPlan のエンティティに設定します。エンティティ ID を設定するには、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。[entityId] を指定する代わりに、[filterClause] を
104
に設定することもできます。この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "Id": "104" }
例 - プロジェクトのテスト実行を更新する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からTestRuns
を選択します。- [
Update
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データマッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。{ "Name": "Update Test Run", "Comment": "Google cloud has updated the test run use case." }
- データ マッパーでエンティティ ID を TestRuns のエンティティに設定します。エンティティ ID を設定するには、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。[entityId] を指定する代わりに、[filterClause] を
46
に設定することもできます。この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "Id": "46" }
例 - プロジェクトを更新する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からProjects
を選択します。- [
Update
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データマッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。{ "Name": "Projects Update" }
- データ マッパーでエンティティ ID をプロジェクトのエンティティに設定します。エンティティ ID を設定するには、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。[entityId] を指定する代わりに、[filterClause] を
{ "Id": "1677d4b0-eaf6-47c2-88ee-78819b00977d" }
に設定することもできます。この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "Id": "1677d4b0-eaf6-47c2-88ee-78819b00977d" }
例 - プロジェクトの環境を更新する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からEnvironments
を選択します。- [
Update
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データマッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。{ "Name": "Environment Update M", "Description": "Update environment " }
- データ マッパーでエンティティ ID を環境のエンティティに設定します。エンティティ ID を設定するには、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。[entityId] を指定する代わりに、[filterClause] を
{ "Id": "9" }
に設定することもできます。この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "Id": 9 }
例 - プロジェクト内の変数グループを更新する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からVariableGroups
を選択します。- [
Update
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データマッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。{ "VariableGroupProjectRefs": "[\n {\n \"description\": \"SampleDescription\",\n \"name\": \"New VariableGroup googlecloud updated\",\n \"projectReference\": {\n \"id\": \"64058663-6419-4b11-8ef0-2ebf985949bc\",\n \"name\": \"GoogleCloud-Demo-Project\"\n }\n }\n ]", "Variables": "{\n \"SampleVariableName1\": {\n \"value\": \"SampleValue1\"\n },\n \"SampleVariableName2\": {\n \"value\": \"SampleValue2\"\n }\n }", "Name": "Variable Group new test updated" }
- データ マッパーでエンティティ ID を VariableGroups のエンティティに設定します。エンティティ ID を設定するには、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。[entityId] を指定する代わりに、[filterClause] を
{ "Id": "12" }
に設定することもできます。この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "Id": 12 }
例 - プロジェクトのビルド定義を更新する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からBuildDefinition
を選択します。- [
Update
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データマッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。{ "Name": "Build definition update 25","RepositoryId": "e848b49e-704f-4df3-94ce-4f23176715b6","RepositoryType": "TfsGit","ProcessYamlFilename": "data.txt","Revision": 1 }
- データマッパーでエンティティ ID を BuildDefinition のエンティティに設定します。エンティティ ID を設定するには、[
Open Data Mapping Editor
] をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。[entityId] を指定する代わりに、[filterClause] を
{ ProjectId='64058663-6419-4b11-8ef0-2ebf985949bc' and Id='25'}
に設定することもできます。この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "Id": 25 }
例 - プロジェクトのプルリクエストのレビュー担当者を更新する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からPullRequestReviewers
を選択します。- [
Update
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データマッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。{"isFlagged": true}
- データマッパーでエンティティ ID を PullRequestReviewers のエンティティに設定します。エンティティ ID を設定するには、[
Open Data Mapping Editor
] をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。[entityId] を指定する代わりに、[filterClause] を
{ ProjectId='64058663-6419-4b11-8ef0-2ebf985949bc' and RepositoryId='e848b49e-704f-4df3-94ce-4f23176715b6' and PullRequestId='22' and Id='38b14cd8-d8f2-4d79-9204-19adbcb62c81'}
に設定することもできます。この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{ "Id": "38b14cd8-d8f2-4d79-9204-19adbcb62c81","PullRequestId": null}
例 - プロジェクトのリリースを更新する
- [
Configure connector task
] ダイアログで、[Entities
] をクリックします。 Entity
からReleases
を選択します。- [
Update
] オペレーションを選択し、[完了] をクリックします。 - [データ マッピング] タスクの [データマッパー] セクションで、
Open Data Mapping Editor
をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。{ "Description": "Update Release Description googlecloud","Name": "Update release googlecloud"}
- データマッパーでエンティティ ID をリリースのエンティティに設定します。エンティティ ID を設定するには、[
Open Data Mapping Editor
] をクリックし、[Input Value
] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。[entityId] を指定する代わりに、[filterClause] を
{"Id": 13}
に設定することもできます。この例を実行すると、コネクタ タスクの
connectorOutputPayload
出力変数で次のようなレスポンスが返されます。{"Id": 13 }
Google Cloud コミュニティの助けを借りる
Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。次のステップ
- 接続を一時停止して再開する方法を確認する。
- コネクタの使用状況をモニタリングする方法を確認する。
- コネクタログを表示する方法を確認する。