AzureResourceGroupDeployment@2 - Azure リソース グループのデプロイ v2 タスク

Azure Resource Manager (ARM) テンプレートをリソース グループにデプロイし、仮想マシンを管理します。

構文

# Azure resource group deployment v2
# Deploy an Azure Resource Manager (ARM) template to a resource group and manage virtual machines.
- task: AzureResourceGroupDeployment@2
  inputs:
  # Azure Details
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    action: 'Create Or Update Resource Group' # 'Create Or Update Resource Group' | 'Select Resource Group' | 'Start' | 'Stop' | 'StopWithDeallocate' | 'Restart' | 'Delete' | 'DeleteRG'. Required. Action. Default: Create Or Update Resource Group.
    resourceGroupName: # string. Required. Resource group. 
    #location: # string. Required when action = Create Or Update Resource Group. Location. 
  # Template
    #templateLocation: 'Linked artifact' # 'Linked artifact' | 'URL of the file'. Required when action = Create Or Update Resource Group. Template location. Default: Linked artifact.
    #csmFileLink: # string. Required when templateLocation = URL of the file && action = Create Or Update Resource Group. Template link. 
    #csmParametersFileLink: # string. Optional. Use when templateLocation = URL of the file && action = Create Or Update Resource Group. Template parameters link. 
    #csmFile: # string. Required when templateLocation = Linked artifact && action = Create Or Update Resource Group. Template. 
    #csmParametersFile: # string. Optional. Use when templateLocation = Linked artifact && action = Create Or Update Resource Group. Template parameters. 
    #overrideParameters: # string. Optional. Use when action = Create Or Update Resource Group. Override template parameters. 
    #deploymentMode: 'Incremental' # 'Incremental' | 'Complete' | 'Validation'. Required when action = Create Or Update Resource Group. Deployment mode. Default: Incremental.
  # Advanced deployment options for virtual machines
    #enableDeploymentPrerequisites: 'None' # 'None' | 'ConfigureVMwithWinRM' | 'ConfigureVMWithDGAgent'. Optional. Use when action = Create Or Update Resource Group || action = Select Resource Group. Enable prerequisites. Default: None.
    #teamServicesConnection: # string. Alias: deploymentGroupEndpoint. Required when (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Azure Pipelines service connection. 
    #teamProject: # string. Alias: project. Required when (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Team project. 
    #deploymentGroupName: # string. Required when (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Deployment Group. 
    #copyAzureVMTags: true # boolean. Optional. Use when (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Copy Azure VM tags to agents. Default: true.
    #runAgentServiceAsUser: false # boolean. Optional. Use when (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgent. Run agent service as a user. Default: false.
    #userName: # string. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true. User name. 
    #password: # string. Optional. Use when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true. Password. 
    #outputVariable: # string. Optional. Use when (action = Create Or Update Resource Group || action = Select Resource Group) && (enableDeploymentPrerequisites = ConfigureVMwithWinRM || enableDeploymentPrerequisites = None). VM details for WinRM. 
  # Advanced
    #deploymentName: # string. Optional. Use when action = Create Or Update Resource Group. Deployment name. 
    #deploymentOutputs: # string. Optional. Use when action = Create Or Update Resource Group. Deployment outputs. 
    #addSpnToEnvironment: false # boolean. Optional. Use when action = Create Or Update Resource Group. Access service principal details in override parameters. Default: false.
    #useWithoutJSON: false # boolean. Optional. Use when action = Create Or Update Resource Group. Use individual output values without JSON.Stringify applied. Default: false.

入力

Azure サブスクリプションを azureSubscription - する
入力エイリアス: ConnectedServiceName。 string. 必須。

デプロイ用の Azure サブスクリプションを含むサービス接続を選択します。

action - アクションの
string. 必須。 使用できる値: Create Or Update Resource Group、Select Resource Group (仮想マシンのデプロイ オプションの構成)、Start (仮想マシンの起動)、Stop (仮想マシンの停止)、StopWithDeallocate (仮想マシンの停止と割り当て解除)、Restart (仮想マシンの再起動)、Delete (仮想マシンの削除)、DeleteRG (リソース グループの削除)。 既定値: Create Or Update Resource Group.

Azure リソースまたはリソース グループに対して実行されるアクション。

resourceGroupName - リソース グループの
string. 必須。

リソース グループの名前を提供します。

location - 場所の
string. action = Create Or Update Resource Groupする場合に必要です。

リソース グループをデプロイする場所。 リソース グループがサブスクリプションに既に存在する場合、この値は無視されます。

templateLocation - テンプレートの場所の
string. action = Create Or Update Resource Groupする場合に必要です。 使用できる値: Linked artifact、URL of the file。 既定値: Linked artifact.

ファイル リンクされた成果物 またはURL を選択します。

csmFileLink - テンプレート リンク
string. templateLocation = URL of the file && action = Create Or Update Resource Groupする場合に必要です。

テンプレート ファイルの URL を指定します。 URL の例: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.json

プライベート ストレージ アカウントに格納されているテンプレートをデプロイするには、テンプレートの URL に Shared Access Signature (SAS) トークンを取得して含めます。 例: <blob_storage_url>/template.json?<SAStoken>

テンプレート ファイル (またはリンクされたテンプレート) をストレージ アカウントにアップロードして SAS トークンを生成するには、Azure ファイル コピー タスクを使用するか、PowerShell を使用するか、Azure CLI をする手順に従います。

テンプレート パラメーターをグリッドで表示するには、[テンプレート パラメーターのオーバーライド] テキスト ボックスの横にある ... をクリックします。 この機能を使用するには、ソースで CORS ルールが有効になっている必要があります。 テンプレートが Azure ストレージ BLOB 内にある場合は、CORS を有効にする CORS 要求の概要に関するページを参照してください。

csmParametersFileLink - テンプレート パラメーター リンク
string. 随意。 templateLocation = URL of the file && action = Create Or Update Resource Groupするときに使用します。

パラメーター ファイルの URL を指定します。 例: https://raw.githubusercontent.com/Azure/...

プライベート ストレージ アカウントに格納されているファイルを使用するには、テンプレートの URL に Shared Access Signature (SAS) トークンを取得して含めます。 例: <blob_storage_url>/template.json?<SAStoken> ストレージ アカウントにパラメーター ファイルをアップロードして SAS トークンを生成するには、Azure ファイル コピー タスク 使用するか、PowerShell を使用するか、Azure CLI をする手順に従います。

テンプレート パラメーターをグリッドで表示するには、[テンプレート パラメーターのオーバーライド] テキスト ボックスの横にある ... をクリックします。 この機能を使用するには、ソースで CORS ルールが有効になっている必要があります。 テンプレートが Azure ストレージ BLOB 内にある場合は、CORS を有効にする CORS 要求の概要に関するページを参照してください。

csmFile - テンプレートの
string. templateLocation = Linked artifact && action = Create Or Update Resource Groupする場合に必要です。

Azure Resource Manager テンプレートを指すパスまたはパターンを指定します。 Azure Resource Manager テンプレート の詳細を確認します。 すぐに開始するには、このサンプル テンプレート 使用します。

csmParametersFile - テンプレート パラメーターの
string. 随意。 templateLocation = Linked artifact && action = Create Or Update Resource Groupするときに使用します。

パラメーター ファイルの URL を指定します。 URL の例: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.parameters.json

プライベート ストレージ アカウントに格納されているファイルを使用するには、テンプレートの URL に Shared Access Signature (SAS) トークンを取得して含めます。 例: <blob_storage_url>/template.json?<SAStoken> ストレージ アカウントにパラメーター ファイルをアップロードして SAS トークンを生成するには、Azure ファイル コピー タスクを使用するか、PowerShell を使用するか、Azure CLI をする手順に従います。

テンプレート パラメーターをグリッドで表示するには、[テンプレート パラメーターのオーバーライド] テキスト ボックスの横にある ... をクリックします。 この機能を使用するには、ソースで CORS ルールが有効になっている必要があります。 テンプレートが Azure ストレージ BLOB 内にある場合は、CORS を有効にする CORS 要求の概要に関するページを参照してください。

overrideParameters - テンプレート パラメーター をオーバーライドする
string. 随意。 action = Create Or Update Resource Groupするときに使用します。

オーバーライドするテンプレート パラメーターを指定します。

グリッド内のテンプレート パラメーターを表示するには、[オーバーライド パラメーター] ボックスの横にある ... をクリックします。 この機能を使用するには、ソースで CORS ルールが有効になっている必要があります。 テンプレートが Azure Storage BLOB 内にある場合は、この文字列を参照して CORS を有効にするか、テキスト ボックスにオーバーライドするテンプレート パラメーターを入力します。

例: -storageName fabrikam -adminUsername $(vmusername) -adminPassword (ConvertTo-SecureString -String '$(password)' -AsPlainText -Force) -azureKeyVaultName $(fabrikamFibre).

パラメーター値に複数の単語がある場合は、変数を使用して値を渡す場合でも、単語を引用符で囲みます。 たとえば、-name "parameter value" -name2 "$(var)"します。 オブジェクト型パラメーターをオーバーライドするには、文字列化された JSON オブジェクトを使用します。 たとえば、-options ["option1"] -map {"key1": "value1" }します。

deploymentMode - 展開モードの
string. action = Create Or Update Resource Groupする場合に必要です。 使用できる値: Incremental、Complete、Validation (検証のみ)。 既定値: Incremental.

Incremental モードでは、デプロイがリソース グループの増分更新として処理されます。 リソース グループに存在するが、テンプレートでは指定されていない変更されていないリソースは残ります。

Complete モードでは、テンプレートに含まれていないリソースが削除されます。 完全モードは、増分モードよりも比較的時間がかかります。 タスクがタイムアウトになった場合は、タイムアウトを増やすか、Incremental モードに変更することを検討してください。

警告

完全モードでは、テンプレートで指定されていないリソース グループ内の既存のリソースがすべて削除されます。 デプロイするリソース グループに、テンプレートで指定されていない必要なリソースが含まれていないかどうかを確認します。

Validate モードでは、実際のリソースを作成する前に、テンプレートに関する問題を見つけることができます。

手記

Validate モードでは、リソースがデプロイされていない場合でも、常にリソース グループが作成されます。

展開モードの詳細については、を参照してください。

enableDeploymentPrerequisites - 前提条件の を有効にする
string. 随意。 action = Create Or Update Resource Group || action = Select Resource Groupするときに使用します。 使用できる値: None、ConfigureVMwithWinRM (WinRM エージェントを使用した構成)、ConfigureVMWithDGAgent (展開グループ エージェントを使用した構成)。 既定値: None.

リソース グループに仮想マシンが含まれている場合にのみ適用されます。

[デプロイ グループ] オプションを選択すると、各仮想マシンにデプロイ グループ エージェントが構成されます。

WinRM オプションを選択すると、自己署名証明書を使用して、ポート 5986 の HTTPS プロトコル経由で Windows リモート管理 (WinRM) リスナーが構成されます。 この構成は、Azure マシンでデプロイ操作を実行するために必要です。 ターゲット仮想マシンがロード バランサーによってサポートされている場合は、ターゲット ポート (5986) に対して受信 NAT 規則が構成されていることを確認します。

Azure Pipelines サービス接続の teamServicesConnection -
入力エイリアス: deploymentGroupEndpoint。 string. (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgentする場合に必要です。

エージェント登録のために Azure DevOps 組織またはコレクションに接続するためのサービス接続を指定します。

+New を使用してサービス接続を作成し、Token-based authenticationを選択できます。 サービス接続をセットアップするには、個人用アクセス トークン (PAT) が必要です。 [Manage] をクリックして、サービス接続の詳細を更新します。

teamProject - チーム プロジェクトの
入力エイリアス: project。 string. (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgentする場合に必要です。

展開グループを定義するチーム プロジェクトを指定します。

deploymentGroupName - 展開グループの
string. (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgentする場合に必要です。

エージェントを登録する展開グループを指定します。 展開グループ 詳細を確認します。

copyAzureVMTags - Azure VM タグをエージェント にコピーする
boolean. 随意。 (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgentするときに使用します。 既定値: true.

Azure VM で構成されているタグを、対応するデプロイ グループ エージェントにコピーする必要があるかどうかを選択します。

既定では、すべての Azure タグは次の形式でコピーされます: Key: Value。 例: Role : Web Azure タグがエージェント コンピューターに as-is コピーされます。

Azure リソース のタグを使用したの詳細について説明します。

runAgentServiceAsUser - エージェント サービスをユーザー として実行する
boolean. 随意。 (action = Create Or Update Resource Group || action = Select Resource Group) && enableDeploymentPrerequisites = ConfigureVMWithDGAgentするときに使用します。 既定値: false.

値が trueに設定されている場合は、エージェント サービスを既定のユーザー以外のユーザーとして実行します。

既定のユーザーは Windows で NT AUTHORITY\\SYSTEM され、Linux では root されます。

userName - ユーザー名の
string. enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = trueする場合に必要です。

仮想マシンでエージェント サービスを実行するユーザー名。

ドメイン ユーザーの場合は、値を domain\username または username@domain.comとして指定します。 ローカル ユーザーの場合は、usernameを指定します。

リソース グループ内のすべての仮想マシンに、同じドメイン ユーザーまたは同じ名前のローカル ユーザーが存在することを前提としています。

password - パスワード
string. 随意。 enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = trueするときに使用します。

ユーザーが Windows VM でエージェント サービスを実行するためのパスワード。

パスワードは、すべての VM で指定されたユーザーに対して同じであると見なされます。

ビルド パイプラインまたはリリース パイプラインで定義されている変数を $(passwordVariable)として受け取ることができます。 変数をセキュリティで保護するために secret としてマークできます。

Linux VM の場合、パスワードは必要なく、無視されます。

WinRMの VM の詳細を outputVariable - する
string. 随意。 (action = Create Or Update Resource Group || action = Select Resource Group) && (enableDeploymentPrerequisites = ConfigureVMwithWinRM || enableDeploymentPrerequisites = None)するときに使用します。

既存のリソース グループが選択されている場合に必要です。 リソース グループ変数の名前を提供します。 この変数は、アプリケーションをデプロイするためのターゲット マシンの PowerShell タスクなど、後続のタスクでリソース グループを参照する $(variableName) として使用できます。

選択したアクションが Create、Update、または Selectされている場合にのみ有効です。

deploymentName - 展開名の
string. 随意。 action = Create Or Update Resource Groupするときに使用します。

作成するリソース グループデプロイの名前を指定します。

deploymentOutputs - デプロイの出力
string. 随意。 action = Create Or Update Resource Groupするときに使用します。

出力変数の名前を指定します。この変数には、現在の配置オブジェクトの outputs セクションが文字列形式で含まれています。 ConvertFrom-Json PowerShell コマンドレットを使用して JSON オブジェクトを解析し、個々の出力値にアクセスします。

addSpnToEnvironment - オーバーライド パラメーターのサービス プリンシパルの詳細
boolean. 随意。 action = Create Or Update Resource Groupするときに使用します。 既定値: false.

スクリプトの実行環境として選択された Azure エンドポイントのサービス プリンシパル ID とキーを追加します。 変数 $servicePrincipalId と $servicePrincipalKey は、-key $servicePrincipalKeyなどのオーバーライド パラメーターに含めることができます。

useWithoutJSON - JSON なしで個々の出力値を使用します。stringify applied
boolean. 随意。 action = Create Or Update Resource Groupするときに使用します。 既定値: false.

個々の出力値は JSON 経由で変換されます。既定では文字列化されます。 JSON 経由で変換せずに出力値をそのまま使用する場合。Stringify、このオプションを有効にします。 詳細については、この 参照してください。

タスク コントロールのオプション

すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「コントロール オプションと一般的なタスク プロパティを参照してください。

出力変数

何一つ。

備考

このタスクの新しいバージョンは、AzureResourceManagerTemplateDeployment@3 - ARM テンプレートデプロイ v3 タスクで使用できます。

タスク バージョン 2 の新機能

• クロスプラットフォーム エージェント (Linux、macOS、または Windows) で動作します
• パブリックにアクセスできる http/https URL にあるテンプレート JSON をサポートします。
• オーバーライド パラメーターの UX が強化され、グリッドで表示/編集できるようになりました。
• ロード バランサーによってサポートされる VM の NAT 規則マッピング。
• "リソース グループ" フィールドの名前が "WinRM の VM の詳細" に変更され、「仮想マシンの高度なデプロイ オプション」セクションに含まれるようになりました。
• 制限：
  • クラシック サブスクリプションはサポートされません。 ARM サブスクリプションのみがサポートされています。
  • タスクが node.js ベースになったため、PowerShell 構文はサポートされません。 テンプレート パラメーターをオーバーライドするときに、パラメーター名の大文字と小文字の区別が一致していることを確認します。 また、バージョン 1.0 からバージョン 2.0 に移行する場合は、"ConvertTo-SecureString" などの PowerShell コマンドレットを削除します。

トラブルシューティング

エラー: 内部サーバー エラー

これらの問題は、本質的にほとんど一時的なものです。 発生する可能性がある理由は複数あります。

• デプロイしようとしている Azure サービスの 1 つは、デプロイしようとしているリージョンでメンテナンスが行われます。 https://status.azure.com/ に注意して、Azure サービスのダウンタイムを確認します。
• Azure Pipelines サービス自体はメンテナンスを行っています。 ダウンタイムの https://status.dev.azure.com/ に注意してください。

ただし、デプロイしようとしている Azure サービスがリソースに対して選択したリージョンをサポートしていないなど、ARM テンプレートのエラーが原因であるインスタンスがいくつか見られました。

エラー: タイムアウト

タイムアウトの問題は、次の 2 つの場所から発生する可能性があります。

• Azure Pipelines エージェント
• ポータルの展開

タイムアウトがポータルからかどうかを確認するには、タスク ログに含まれるポータルのデプロイ リンクを確認します。 リンクがない場合は、Azure Pipelines エージェントが原因である可能性があります。 リンクがある場合は、リンクに従って、ポータルのデプロイでタイムアウトが発生したかどうかを確認します。

エラー: パラメーターのオーバーライド中に CORS ルールを有効にする

テンプレート ファイルが BLOB から参照されている場合、パイプラインのパラメーターをオーバーライドしているときに、次の警告メッセージが表示されることがあります。

Warning: Failed to download the file from template path.

この機能を使用するには、ソースで CORS ルールを有効にする必要があります。 テンプレートが Azure Storage BLOB にある場合は、CORS を有効にする クロスオリジン リソース共有のサポート を参照してください。

CORS を有効にするだけでなく、テンプレートのリンクで指定された SAS トークンが "srt-sco" であることを確認します。 このトークンは、ファイルをダウンロードして続行するために必要です。

Azure Pipelines エージェント

問題が Azure Pipelines エージェントから発生している場合は、timeoutInMinutes を YAML のキーとして 0 に設定することで、タイムアウトを増やすことができます。 詳細については、「パイプラインでジョブを指定する」を参照してください。

ポータルの展開

Azure portal からエラーが発生したかどうかを確認する方法については、次のドキュメントを参照してください。Azure Resource Managerを使用してデプロイ履歴を表示します。

ポータルのデプロイの場合は、ARM テンプレートの "timeoutInMinutes" を "0" に設定してみてください。 指定しない場合、想定される値は 60 分です。 0 を指定すると、デプロイが成功できる限り実行されます。

これは、システムの一時的な問題が原因で発生する可能性もあります。 azure Pipelines サービスにダウンタイムがあるかどうかを確認するには、https://status.dev.azure.com/ に注意してください。

エラー: Azure Resource Manager (ARM) テンプレートの検証に失敗しました

この問題は主に、サポートされていない SKU やリージョンなど、ARM テンプレートの無効なパラメーターが原因で発生します。 検証が失敗した場合は、エラー メッセージを確認します。 無効なリソースとパラメーターを指定する必要があります。

この問題は、複数行の文字列が原因で発生する可能性もあります。 現時点では、Azure リソース グループのデプロイ タスクでは、ARM テンプレートまたはパラメーター JSON ファイル内の複数行文字列はサポートされていません。

さらに、ARM テンプレートの構造と構文については、この記事を参照してください。ARM テンプレートの構造と構文について説明します。

必要条件

要件	形容
パイプラインの種類	YAML、クラシック ビルド、クラシック リリース
実行日	エージェント、DeploymentGroup
の需要	何一つ
機能の	このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限	任意
設定可能な変数	任意
エージェントのバージョン	2.119.1 以上
タスク カテゴリ	展開