APIを使用してGit統合を自動化する

2025-04-04

Microsoft Fabric のGit 統合ツールを使うと、チームが共同作業をするためにソース管理を使用して、Fabric コンテンツのための効率的で再利用可能なリリースプロセスを構築できます。

Microsoft Fabric REST API を使用すると、Fabric の手順とプロセスを自動化して、タスクをより迅速かつ、より少ないエラーで完了できます。この効率は、コスト削減と生産性の向上につながります。

この記事では、Git integration REST API を使用して Microsoft Fabric での Git 統合を自動化する方法について説明します。

前提条件

Fabric Git API を使用するには、以下が必要です:

UI で Git 統合を使用するための前提条件と同じです。
Fabric サービス用の Microsoft Entra トークン。 API 呼び出しの承認ヘッダーでそのトークンを使用します。トークンを取得する方法については、「Fabric API のクイックスタート」を参照してください。
GitHub サービスプリンシパルを使用している場合は、ユーザープリンシパルと同じアクセス許可が必要です。

PowerShell なしで REST API を使用できますが、この記事のスクリプトでは PowerShell を使用します。スクリプトを実行するには、次の手順を実行します。

PowerShell をインストールします。
Azure PowerShell Az モジュールをインストールします。

Git 統合 API 関数

Git integration REST API は、コンテンツの継続的インテグレーションと継続的デリバリー (CI/CD) を実現するのに役立ちます。 API を使用して実行できることの例をいくつか次に示します。

特定のワークスペースを Git リポジトリおよびそれに接続されているブランチに接続および切断します。 (Connect には、Git プロバイダーの資格情報の connectionId が必要です)。
指定されたワークスペースの接続の詳細を取得します。
Git プロバイダーの資格情報接続を取得または作成します。
Git 資格情報を更新して、Git 資格情報の構成の詳細を更新します。 Git プロバイダーの資格情報の connectionId が必要です。
Git 資格情報を取得して、Git 資格情報の構成の詳細を取得します。
Git に接続されているワークスペースの 接続を初期化 します。
受信した変更がある項目と、Git Status API を使用してまだ Git にコミットされていない変更がある項目を確認します。
ワークスペースで行われた変更を、接続されたリモートブランチにコミットします。
接続されたブランチにプッシュされたコミットでワークスペースを更新します。

例

以下の PowerShell Scriptを使って、いくつかの共通の自動化プロセスを実行する方法を理解します。 PowerShell サンプルのテキストを表示またはコピーするには、このセクションのリンクを使用します。 Fabric Git 統合サンプル GitHub リポジトリですべての例を確認することもできます。

接続して更新する

このセクションでは、Git でワークスペースに接続して更新するときの手順について説明します。

完全なスクリプトについては、Git からの接続と更新に関するページをご覧ください。 (スクリプトの互換性は PowerShell 5.1 です)

Azure アカウントに接続してアクセストークンを取得 する - ユーザーとして Fabric にサインインします (または、GitHub を使用している場合は、ユーザーまたはサービスプリンシパル)。 Connect-AzAccount コマンドを使用して接続します。アクセストークンを取得するには、Get-AzAccessToken コマンドを使用し、セキュリティで保護された文字列トークンをプレーンテキストに変換します

コードは次のようになります。

ユーザープリンシパル
サービスプリンシパル (GitHub のみ)

 $global:resourceUrl = "https://api.fabric.microsoft.com"

 $global:fabricHeaders = @{}

 function SetFabricHeaders() {

    #Login to Azure
    Connect-AzAccount | Out-Null

    # Get authentication
    $secureFabricToken = (Get-AzAccessToken -AsSecureString -ResourceUrl $global:resourceUrl).Token

    # Convert secure string to plain test
    $ssPtr = [System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($secureFabricToken)
    try {
        $fabricToken = [System.Runtime.InteropServices.Marshal]::PtrToStringBSTR($ssPtr)
    } finally {
        [System.Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ssPtr)
   }

  $global:fabricHeaders = @{
     'Content-Type' = "application/json"
     'Authorization' = "Bearer {0}" -f $fabricToken
 }
}

$global:resourceUrl = "https://api.fabric.microsoft.com"
$global:fabricHeaders = @{}

function SetFabricHeaders() {

   $clientId = "<CLIENT ID>"
   $tenantId = "<TENANT ID>"
   $secret = "<SECRET VALUE>"

   $secureSecret  = ConvertTo-SecureString -String $secret -AsPlainText -Force
   $credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $clientId, $secureSecret

   #Login to Azure using service principal
   Connect-AzAccount -ServicePrincipal -TenantId $tenantId -Credential $credential | Out-Null

   # Get authentication
   $secureFabricToken = (Get-AzAccessToken -AsSecureString -ResourceUrl $global:resourceUrl).Token

   # Convert secure string to plain text
   $ssPtr = [System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($secureFabricToken)
   try {
       $fabricToken = [System.Runtime.InteropServices.Marshal]::PtrToStringBSTR($ssPtr)
   } finally {
      [System.Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ssPtr)
   }

  $global:fabricHeaders = @{
     'Content-Type' = "application/json"
     'Authorization' = "Bearer {0}" -f $fabricToken
  }
}

接続 API を呼び出して、ワークスペースを Git リポジトリとブランチに接続します。 (最初に接続を確立する必要がある場合があります)

Azure DevOps (ユーザープリンシパル)
GitHub (ユーザーまたはサービスプリンシパル)

$global:baseUrl = "https://api.fabric.microsoft.com/v1"
$workspaceName = "<WORKSPACE NAME>"
$getWorkspacesUrl = "{0}/workspaces" -f $global:baseUrl 
$workspaces = (Invoke-RestMethod -Headers $global:fabricHeaders -Uri $getWorkspacesUrl -Method GET).value

# Find the workspace by display name
$workspace = $workspaces | Where-Object {$_.DisplayName -eq $workspaceName}

# Connect to Git
Write-Host "Connecting the workspace '$workspaceName' to Git."

$connectUrl = "{0}/workspaces/{1}/git/connect" -f $global:baseUrl, $workspace.Id

# AzureDevOps details
$azureDevOpsDetails = @{
    gitProviderType = "AzureDevOps"
    organizationName = "<ORGANIZATION NAME>"
    projectName = "<PROJECT NAME>"
    repositoryName = "<REPOSITORY NAME>"
    branchName = "<BRANCH NAME>"
    directoryName = "<DIRECTORY NAME>"
}

$connectToGitBody = @{
    gitProviderDetails = $azureDevOpsDetails
} | ConvertTo-Json

Invoke-RestMethod -Headers $global:fabricHeaders -Uri $connectUrl -Method POST -Body $connectToGitBody

接続 ID を取得する方法については、「 Git プロバイダーの資格情報の接続を取得または作成する」を参照してください。

$global:baseUrl = "https://api.fabric.microsoft.com/v1"
$workspaceName = "<WORKSPACE NAME>"
$getWorkspacesUrl = "{0}/workspaces" -f $global:baseUrl 
$workspaces = (Invoke-RestMethod -Headers $global:fabricHeaders -Uri $getWorkspacesUrl -Method GET).value

# Find the workspace by display name
$workspace = $workspaces | Where-Object {$_.DisplayName -eq $workspaceName}

# Connect to Git
Write-Host "Connecting the workspace '$workspaceName' to Git."

$connectUrl = "{0}/workspaces/{1}/git/connect" -f $global:baseUrl, $workspace.Id

# GitHub details
$gitHubDetails = @{
    gitProviderType = "GitHub"
    ownerName = "<OWNER NAME>"
    repositoryName = "<REPOSITORY NAME>"
    branchName = "<BRANCH NAME>"
    directoryName = "<DIRECTORY NAME>"
}

$connectionName = "<CONNECTION Name>"

# Get connections 
$getConnectionsUrl = "$global:baseUrl/connections"
$connections = (Invoke-RestMethod -Headers $global:fabricHeaders -Uri $getConnectionsUrl -Method GET).value

# Find the connection by name
$connection = $connections | Where-Object {$_.DisplayName -eq $connectionName}

$connectToGitBody = @{
    gitProviderDetails = $gitHubDetails
    myGitCredentials = @{
        source = "ConfiguredConnection"
        connectionId = $connection.id
    }
} | ConvertTo-Json

Invoke-RestMethod -Headers $global:fabricHeaders -Uri $connectUrl -Method POST -Body $connectToGitBody

Initialize Connection APIを呼び出して、ワークスペースとGitリポジトリ/ブランチの間の接続を初期化します。

# Initialize Connection

Write-Host "Initializing Git connection for workspace '$workspaceName'."

$initializeConnectionUrl = "{0}/workspaces/{1}/git/initializeConnection" -f $global:baseUrl, $workspace.Id
$initializeConnectionResponse = Invoke-RestMethod -Headers $global:fabricHeaders -Uri $initializeConnectionUrl -Method POST -Body "{}"

Initialize Connection API からの応答に基づいて、Update From Git API を呼び出して更新を完了するか、アクションが必要ない場合は何も行いません。

次のスクリプトは、更新を行って進行状況を監視します。

if ($initializeConnectionResponse.RequiredAction -eq "UpdateFromGit") {

    # Update from Git
    Write-Host "Updating the workspace '$workspaceName' from Git."

    $updateFromGitUrl = "{0}/workspaces/{1}/git/updateFromGit" -f $global:baseUrl, $workspace.Id

    $updateFromGitBody = @{ 
        remoteCommitHash = $initializeConnectionResponse.RemoteCommitHash
  workspaceHead = $initializeConnectionResponse.WorkspaceHead
    } | ConvertTo-Json

    $updateFromGitResponse = Invoke-WebRequest -Headers $global:fabricHeaders -Uri $updateFromGitUrl -Method POST -Body $updateFromGitBody

    $operationId = $updateFromGitResponse.Headers['x-ms-operation-id']
    $retryAfter = $updateFromGitResponse.Headers['Retry-After']
    Write-Host "Long Running Operation ID: '$operationId' has been scheduled for updating the workspace '$workspaceName' from Git with a retry-after time of '$retryAfter' seconds." -ForegroundColor Green

    # Poll Long Running Operation
    $getOperationState = "{0}/operations/{1}" -f $global:baseUrl, $operationId
    do
    {
        $operationState = Invoke-RestMethod -Headers $global:fabricHeaders -Uri $getOperationState -Method GET

        Write-Host "Update from Git operation status: $($operationState.Status)"

        if ($operationState.Status -in @("NotStarted", "Running")) {
            Start-Sleep -Seconds $retryAfter
        }
    } while($operationState.Status -in @("NotStarted", "Running"))
}

Git から更新する

このセクションでは、Git からの変更を使用してワークスペースを更新する手順について説明します。このScriptでは、Git からの変更でワークスペース項目を更新しますが、Git リポジトリは変更されません。

完全なスクリプトについては、「Git からワークスペースを更新する」を参照してください。

Git にログインして認証を取得します。
Get Status API を呼び出して、Git 要求本文から更新をビルドします。
Update From Git API を呼び出して、接続されたブランチにプッシュされたコミットでワークスペースを更新します。

すべてコミットする

このセクションでは、ワークスペースから Git にすべての変更をプログラムでコミットする方法について詳しく説明します。

完全なスクリプトについては、「すべての変更を Git にコミットする」を参照してください。

Git にログインして認証を取得します。
ワークスペースへ接続します。
Commit to Git REST API を呼び出します。
操作の状態をポーリングするための、実行時間の長い OperationId を取得します。

選択的コミット

このセクションでは、ワークスペースから Git に特定の変更のみをコミットする手順について説明します。

完全なスクリプトは、「Git への変更のコミット選択」を参照してください。

Git にログインして認証を取得します。
ワークスペースへ接続します。
Get status API を呼び出して、変更された項目ワークスペースを確認します。
コミットする特定の項目を選択します。
Commit to Git API を呼び出して、選択した変更をワークスペースから接続されたリモートブランチにコミットします。

長期間実行する操作の進行状況を監視する

完全なスクリプトについては、「実行時間の長い操作のポーリング」を参照してください。

Update From Git または Commit to Git スクリプトから operationId を取得します。
指定された間隔 (秒単位) で Get LRO Status API を呼び出して、状態を出力します。

Git プロバイダーの資格情報接続を取得または作成する

Git リポジトリに接続したり、Git 資格情報を更新したりするには、 connectionId を指定する必要があります。 connectionId は、作成した新しい接続または既存の接続から取得できます。

Git プロバイダーの資格情報を使用して新しい接続を作成する
アクセス許可がある既存の接続を使用します。

GitHub 資格情報を格納する新しい接続を作成する

個人用アクセストークン (PAT) を使用して GitHub 接続を作成します。

特定のリポジトリの名前を指定した場合、接続のスコープはそのリポジトリに設定されます。リポジトリの名前を指定しない場合は、アクセス許可を持っているすべてのリポジトリにアクセスできます。

GitHub 資格情報を格納する接続を作成するには、次の要求本文で接続の作成 API を呼び出します。 parameters セクションは省略可能であり、接続のスコープを特定のリポジトリにする場合にのみ必要です。

要求のサンプル

POST https://api.fabric.microsoft.com/v1/connections

{
 "connectivityType": "ShareableCloud",
 "displayName": "MyGitHubPAT",
 "connectionDetails": {
  "type": "GitHubSourceControl",
  "creationMethod": "GitHubSourceControl.Contents",
  "parameters": [
   {
    "dataType": "Text",
    "name": "url",
    "value": "https://github.com/OrganizationName/RepositoryName"
   }
  ]
 },
 "credentialDetails": {
  "credentials": {
   "credentialType": "Key",
   "key": "*********"  //Enter your GitHub Personal Access Token
  }
 }
}

サンプルの応答:

{
  "id": "3aba8f7f-d1ba-42b1-bb41-980029d5a1c1",
   "connectionDetails": {
       "path": "https://github.com/OrganizationName/RepositoryName",
       "type": "GitHubSourceControl"
   },
   "connectivityType": "ShareableCloud",
   "credentialDetails": {
       "connectionEncryption": "NotEncrypted",
       "credentialType": "Key",
       "singleSignOnType": "None",
       "skipTestConnection": false
   },
   "displayName": "MyGitHubPAT",
   "gatewayId": null,
   "privacyLevel": "Organizational"
}

ID をコピーし、 Git - Connect または Git - Update My Git Credentials API で使用します。

既存の接続の一覧を取得する

List connections API を使用して、アクセス許可を持つ既存の接続とそのプロパティの一覧を取得します。

サンプルリクエスト

GET https://api.fabric.microsoft.com/v1/connections

サンプル応答

{
 "value": [
  {
   "id": "e3607d15-6b41-4d11-b8f4-57cdcb19ffc8",
   "displayName": "MyGitHubPAT1",
   "gatewayId": null,
   "connectivityType": "ShareableCloud",
   "connectionDetails": {
    "path": "https://github.com",
    "type": "GitHubSourceControl"
   },
   "privacyLevel": "Organizational",
   "credentialDetails": {
    "credentialType": "Key",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
   }
  },
  {
   "id": "3aba8f7f-d1ba-42b1-bb41-980029d5a1c1",
   "displayName": "MyGitHubPAT2",
   "gatewayId": null,
   "connectivityType": "ShareableCloud",
   "connectionDetails": {
    "path": "https://github.com/OrganizationName/RepositoryName",
    "type": "GitHubSourceControl"
   },
   "privacyLevel": "Organizational",
   "credentialDetails": {
    "credentialType": "Key",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
   }
  }
 ]
}

目的の接続の ID をコピーし、 Git - Connect または Git - Update My Git Credentials API で使用します。

考慮事項と制限事項

API を使用した Git 統合には、Git 統合ユーザーインターフェイスと同じ制限があります。
サービスプリンシパルは GitHub でのみサポートされています。
拡張更新 API を使ってセマンティックモデルを更新すると、更新のたびに Git diff が行われます。