Share via

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

  • [アーティクル]

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

Azure リソース マネージャー (ARM) テンプレートをリソース グループにデプロイします。 リソース グループ内のすべてのVirtual Machines (VM) を開始、停止、削除、割り当て解除することもできます。

構文

# 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 enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Azure Pipelines service connection. 
    #teamProject: # string. Alias: project. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Team project. 
    #deploymentGroupName: # string. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Deployment Group. 
    #copyAzureVMTags: true # boolean. Optional. Use when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Copy Azure VM tags to agents. Default: true.
    #runAgentServiceAsUser: false # boolean. Optional. Use when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Run agent service as a user. Default: false.
    #userName: # string. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true && action = Create Or Update Resource Group || action = Select Resource Group. User name. 
    #password: # string. Optional. Use when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true && action = Create Or Update Resource Group || action = Select Resource Group. Password. 
    #outputVariable: # string. Optional. Use when enableDeploymentPrerequisites = ConfigureVMwithWinRM || enableDeploymentPrerequisites = None && action = Create Or Update Resource Group || action = Select Resource Group. 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 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 enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Azure Pipelines service connection. 
    #teamProject: # string. Alias: project. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Team project. 
    #deploymentGroupName: # string. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Deployment Group. 
    #copyAzureVMTags: true # boolean. Optional. Use when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Copy Azure VM tags to agents. Default: true.
    #runAgentServiceAsUser: false # boolean. Optional. Use when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Run agent service as a user. Default: false.
    #userName: # string. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true && action = Create Or Update Resource Group || action = Select Resource Group. User name. 
    #password: # string. Optional. Use when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true && action = Create Or Update Resource Group || action = Select Resource Group. Password. 
    #outputVariable: # string. Optional. Use when enableDeploymentPrerequisites = ConfigureVMwithWinRM || enableDeploymentPrerequisites = None && action = Create Or Update Resource Group || action = Select Resource Group. 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.

# Azure Resource Group Deployment v2
# Deploy an Azure resource manager (ARM) template to a resource group. You can also start, stop, delete, deallocate all Virtual Machines (VM) in a resource group.
- 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 enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Azure Pipelines/TFS service connection. 
    #teamProject: # string. Alias: project. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Team project. 
    #deploymentGroupName: # string. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Deployment Group. 
    #copyAzureVMTags: true # boolean. Optional. Use when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Copy Azure VM tags to agents. Default: true.
    #runAgentServiceAsUser: false # boolean. Optional. Use when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group. Run agent service as a user. Default: false.
    #userName: # string. Required when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true && action = Create Or Update Resource Group || action = Select Resource Group. User name. 
    #password: # string. Optional. Use when enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true && action = Create Or Update Resource Group || action = Select Resource Group. Password. 
    #outputVariable: # string. Optional. Use when enableDeploymentPrerequisites = ConfigureVMwithWinRM || enableDeploymentPrerequisites = None && action = Create Or Update Resource Group || action = Select Resource Group. VM details for WinRM. 
  # Outputs
    #deploymentOutputs: # string. Optional. Use when action = Create Or Update Resource Group. Deployment outputs.

入力

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

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


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

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

プライベート ストレージ アカウントに格納されているファイルを使用するには、Shared Access Signature (SAS) トークンを取得してテンプレートの URL に含めます。 例: <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

プライベート ストレージ アカウントに格納されているファイルを使用するには、Shared Access Signature (SAS) トークンを取得してテンプレートの URL に含めます。 例: <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 ストレージ 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、、 CompleteValidation (検証のみ)。 既定値: 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 規則が構成されていることを確認します。


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

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

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


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

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

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


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

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


deploymentGroupName - デプロイ グループ
string. enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Group の場合に必要です。

エージェントを登録する展開グループを指定します。 デプロイ グループの詳細については、こちらを参照してください。


copyAzureVMTags - Azure VM タグをエージェントにコピーする
boolean. 省略可能。 の場合は enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Groupを使用します。 既定値: true。

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

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

Azure リソースにタグを使用する方法の詳細については、こちらを参照してください。


runAgentServiceAsUser - エージェント サービスをユーザーとして実行する
boolean. 省略可能。 の場合は enableDeploymentPrerequisites = ConfigureVMWithDGAgent && action = Create Or Update Resource Group || action = Select Resource Groupを使用します。 既定値: false。

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

既定のユーザーは Windows NT AUTHORITY\\SYSTEM と root Linux です。


userName - ユーザー名
string. enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true && action = Create Or Update Resource Group || action = Select Resource Group の場合に必要です。

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

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

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


password - パスワード
string. 省略可能。 の場合は enableDeploymentPrerequisites = ConfigureVMWithDGAgent && runAgentServiceAsUser = true && action = Create Or Update Resource Group || action = Select Resource Groupを使用します。

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

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

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

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


outputVariable - WinRM の VM の詳細
string. 省略可能。 の場合は enableDeploymentPrerequisites = ConfigureVMwithWinRM || enableDeploymentPrerequisites = None && action = Create Or Update Resource Group || action = Select Resource Groupを使用します。

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

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


deploymentName - デプロイ名
string. 省略可能。 の場合は action = Create Or Update Resource Groupを使用します。

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


deploymentOutputs - デプロイの出力
string. 省略可能。 の場合は action = Create Or Update Resource Groupを使用します。

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


addSpnToEnvironment - オーバーライド パラメーターのサービス プリンシパルの詳細にアクセスする
boolean. 省略可能。 の場合は action = Create Or Update Resource Groupを使用します。 既定値: false。

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


useWithoutJSON - JSON を使用せずに個々の出力値を使用します。Stringify が適用されました
boolean. 省略可能。 の場合は action = Create Or Update Resource Groupを使用します。 既定値: false。

個々の出力値は JSON 経由で変換されます。既定では Stringify。 出力値をそのまま使用する場合は、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 サービスのいずれかが、デプロイしようとしているリージョンでメンテナンス中です。 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 エージェントにある場合は、YAML でキーとしての timeoutInMinutes を 0 に設定することで、タイムアウトを延長できます。 詳細については、「パイプラインでのジョブの指定」を参照してください。

ポータルのデプロイ

エラーの原因が Azure portal にあるかどうかを特定する方法については、ドキュメント「Azure Resource Manager でのデプロイ履歴の表示」を参照してください。

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

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

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

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

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

また、ARM テンプレートの構造と構文に関する記事「ARM テンプレートの構造と構文について」も参照してください。

要件

要件 説明
パイプラインの種類 YAML、クラシック ビルド、クラシック リリース
上で実行 エージェント、DeploymentGroup
確認要求 なし
Capabilities このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限 Any
設定可能な変数 Any
エージェントのバージョン 2.119.1 以降
タスクのカテゴリ 配置