Azure Pipelines を使用してカスタムポリシーをデプロイする

[アーティクル]
01/11/2024

Azure Pipelines では、継続的インテグレーション (CI) と継続的デリバリー (CD) がサポートされており、コードが継続的に一貫してテストおよびビルドされて、ターゲットに出荷されます。この記事では、Azure Pipelines を使用して、Azure Active Directory B2C (Azure AD B2C) カスタムポリシーのデプロイプロセスを自動化する方法について説明します。

重要

Azure Pipelines を使用した Azure AD B2C カスタムポリシーの管理では、現在、Microsoft Graph API /beta エンドポイントで利用できるプレビュー操作を使用します。実稼働アプリケーションにおけるこれらの API の使用はサポートされていません。詳細については、「Microsoft Graph REST API ベータ版のエンドポイントリファレンス」を参照してください。

前提条件

「Active Directory B2C でのカスタムポリシーの概要」にある手順を完了する。
DevOps 組織を作成していない場合は、Azure DevOps へのサインアップとサインインに関するページの手順に従って新規作成する。

管理タスクのためにアプリケーションを登録する

Azure AD B2C ポリシーをデプロイするには、PowerShell スクリプトを使用します。 PowerShell スクリプトが Microsoft Graph API と対話できるようにするには、事前に Azure AD B2C テナントにアプリケーションの登録を作成します。まだ行っていない場合は、Microsoft Graph アプリケーションを登録します。

PowerShell スクリプトから MS Graph のデータにアクセスするには、関連するアプリケーションのアクセス許可を登録されているアプリケーションに付与します。アプリ登録の [API のアクセス許可] 内で [Microsoft Graph]>[ポリシー]>[Policy.ReadWrite.TrustFramework] アクセス許可を付与します。

Azure リポジトリを構成する

Microsoft Graph アプリケーションを登録すると、ポリシーファイル用のリポジトリを構成する準備が整います。

Azure DevOps 組織にサインインします。
新しいプロジェクトを作成するか、既存のプロジェクトを選択します。
プロジェクト内で [リポジトリ] に移動し、 [ファイル] を選択します。
既存のレポジトリを選択するか、新規に作成します。
リポジトリのルートディレクトリに、B2CAssets という名前のフォルダーを作成します。 Azure AD B2C カスタムポリシーファイルを B2CAssets フォルダーに追加します。
リポジトリのルート　ディレクトリに、Scripts　という名前のフォルダーを作成します。 PowerShell ファイル DeployToB2C.ps1 を作成します。次の PowerShell スクリプトを DeployToB2C.ps1 に貼り付けます。
変更をコミットしてプッシュします。

次のスクリプトは、Microsoft Entra ID からアクセストークンを取得します。このトークンを使用して、スクリプトは MS Graph API を呼び出して、B2CAssets フォルダーにポリシーをアップロードします。ポリシーをアップロードする前に、その内容を変更することもできます。たとえば、tenant-name.onmicrosoft.com を実際のテナント名に置き換えます。

[Cmdletbinding()]
Param(
    [Parameter(Mandatory = $true)][string]$ClientID,
    [Parameter(Mandatory = $true)][string]$ClientSecret,
    [Parameter(Mandatory = $true)][string]$TenantId,
    [Parameter(Mandatory = $true)][string]$Folder,
    [Parameter(Mandatory = $true)][string]$Files
)

try {
    $body = @{grant_type = "client_credentials"; scope = "https://graph.microsoft.com/.default"; client_id = $ClientID; client_secret = $ClientSecret }

    $response = Invoke-RestMethod -Uri https://login.microsoftonline.com/$TenantId/oauth2/v2.0/token -Method Post -Body $body
    $token = $response.access_token

    $headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
    $headers.Add("Content-Type", 'application/xml')
    $headers.Add("Authorization", 'Bearer ' + $token)

    # Get the list of files to upload
    $filesArray = $Files.Split(",")

    Foreach ($file in $filesArray) {

        $filePath = $Folder + $file.Trim()

        # Check if file exists
        $FileExists = Test-Path -Path $filePath -PathType Leaf

        if ($FileExists) {
            $policycontent = Get-Content $filePath -Encoding UTF8

            # Optional: Change the content of the policy. For example, replace the tenant-name with your tenant name.
            # $policycontent = $policycontent.Replace("your-tenant.onmicrosoft.com", "contoso.onmicrosoft.com")     
    
    
            # Get the policy name from the XML document
            $match = Select-String -InputObject $policycontent  -Pattern '(?<=\bPolicyId=")[^"]*'
    
            If ($match.matches.groups.count -ge 1) {
                $PolicyId = $match.matches.groups[0].value
    
                Write-Host "Uploading the" $PolicyId "policy..."
    
                $graphuri = 'https://graph.microsoft.com/beta/trustframework/policies/' + $PolicyId + '/$value'
                $content = [System.Text.Encoding]::UTF8.GetBytes($policycontent)
                $response = Invoke-RestMethod -Uri $graphuri -Method Put -Body $content -Headers $headers -ContentType "application/xml; charset=utf-8"
    
                Write-Host "Policy" $PolicyId "uploaded successfully."
            }
        }
        else {
            $warning = "File " + $filePath + " couldn't be not found."
            Write-Warning -Message $warning
        }
    }
}
catch {
    Write-Host "StatusCode:" $_.Exception.Response.StatusCode.value__

    $_

    $streamReader = [System.IO.StreamReader]::new($_.Exception.Response.GetResponseStream())
    $streamReader.BaseStream.Position = 0
    $streamReader.DiscardBufferedData()
    $errResp = $streamReader.ReadToEnd()
    $streamReader.Close()

    $ErrResp

    exit 1
}

exit 0

Azure Pipelines を構成する

リポジトリが初期化され、カスタムポリシーファイルが設定されたら、リリースパイプラインをセットアップする準備が整います。パイプラインを作成するには、次の手順に従います。

プロジェクトで、 [パイプライン]>[リリース]>[新しいパイプライン] の順に選択します。
[テンプレートの選択] で、 [空のジョブ] を選択し、 [適用] を選択します。
ステージ名 (たとえば、DeployCustomPolicies) を入力し、ペインを閉じます。
[Add an artifact](成果物の追加) を選択し、 [ソースの種類] で [Azure リポジトリ] を選択します。
1. [プロジェクト] で、自分のプロジェクトを選択します。
2. Scripts フォルダーを含む ソース (リポジトリ) を選択します。
3. 規定のブランチ (たとえば、master) を選択します。
4. [既定のバージョン] の設定は、 [既定のブランチからの最新バージョン] のままにします。
5. リポジトリのソースエイリアスを入力します。たとえば、"policyRepo" などです。
[追加] を選択します。
目的に合わせてパイプラインの名前を変更します。たとえば、"Deploy Custom Policy Pipeline" などです。
[保存] を選択して、パイプライン構成を保存します。

パイプライン変数を構成する

パイプライン変数を使用すると、パイプラインのさまざまな部分に重要なデータを簡単に取り込むことができます。以下の変数は、Azure AD B2C 環境に関する情報を提供します。

Name	値
`clientId`	前に登録したアプリケーションのアプリケーション (クライアント) ID。
`clientSecret`	前に作成したクライアントシークレットの値。変数の型をシークレットに変更します (ロックアイコンを選択)。
`tenantId`	`your-b2c-tenant.onmicrosoft.com`。ここで、your-b2c-tenant は Azure AD B2C テナントの名前です。

パイプライン変数を追加するには、次の手順に従います。

パイプラインで、 [変数] タブを選択します。
[パイプライン変数] で、値を指定して上記の変数を追加します。
[保存] を選択して変数を保存します。

パイプラインタスクを追加する

パイプラインタスクは、アクションを実行する事前パッケージされたスクリプトです。 DeployToB2C.ps1 PowerShell スクリプトを呼び出すタスクを追加します。

作成したパイプラインで、 [タスク] タブを選択します。
[エージェントジョブ] を選択し、プラス記号 ( + ) を選択してエージェントジョブにタスクを追加します。
「PowerShell」を検索して選択します。 "Azure PowerShell"、"ターゲットマシンでの PowerShell"、または別の PowerShell エントリを選択しないでください。
新しく追加された PowerShell スクリプト タスクを選択します。
PowerShell Script タスクに対して次の値を入力します。
- タスクのバージョン: 2.*
- 表示名:このタスクでアップロードするポリシーの名前。たとえば、B2C_1A_TrustFrameworkBase。
- [種類] :ファイルパス
- スクリプトのパス: 省略記号 (...) を選択し、Scripts フォルダーに移動して、DeployToB2C.ps1 ファイルを選択します。
- 引数: 次の PowerShell スクリプトを入力します。
```
-ClientID $(clientId) -ClientSecret $(clientSecret) -TenantId $(tenantId) -Folder $(System.DefaultWorkingDirectory)/policyRepo/B2CAssets/ -Files "TrustFrameworkBase.xml,TrustFrameworkLocalization.xml,TrustFrameworkExtensions.xml,SignUpOrSignin.xml,ProfileEdit.xml,PasswordReset.xml"
```
  -Files パラメーターは、デプロイするポリシーファイルのカンマ区切りリストです。ポリシーファイルを使用してリストを更新します。
  
  重要
  
  ポリシーが正しい順序でアップロードされることを確認します。まず、基本ポリシー、拡張機能ポリシー、証明書利用者ポリシーの順です。たとえば、「 TrustFrameworkBase.xml,TrustFrameworkLocalization.xml,TrustFrameworkExtensions.xml,SignUpOrSignin.xml 」のように入力します。
[保存] を選択して、エージェントジョブを保存します。

パイプラインをテストする

リリースパイプラインをテストするには、次のようにします。

[パイプライン] 、 [リリース] の順に選択します。
前に作成したパイプラインを選択します。たとえば、DeployCustomPolicies などです。
[リリースの作成] を選択し、次に [作成] を選択してリリースをキューに入れます。

リリースがキューに入れられたことを示す通知バナーが表示されます。その状態を表示するには、通知バナー内のリンクを選択するか、 [リリース] タブの一覧から選択します。

次のステップ

各項目の詳細情報

Azure Pipelines を使用してカスタム ポリシーをデプロイする