Skip To Content

Automate ArcGIS Enterprise deployments to Microsoft Azure using Cloud Builder artifacts

Esri supports several automation options for ArcGIS Enterprise on Microsoft Azure for efficiency and repeatability. When you run ArcGIS Enterprise Cloud Builder for Microsoft Azure, you can generate a template to use in popular deployment tools to automate subsequent repeated deployments.

If you are an advanced user, you can modify and extend templates to suit your needs and specifications. The resources required to perform automated deployments differ depending on your automation platform.

1. Generate automation artifacts from Cloud Builder

You must first create a deployment using ArcGIS Enterprise Cloud Builder for Microsoft Azure, and save a file containing the automation artifacts from the builder. On the summary step of the completed deployment, click the Save Automation Artifacts button. On the dialog box, browse to the desired storage location. Provide a name for the .zip file to be generated, select the automation option targets, and click generate.

Once ArcGIS Enterprise Cloud Builder for Microsoft Azure finishes generating the artifacts, browse to the storage location and extract the .zip file. You can use the artifact files in subsequent automation operations.

The exact automation artifact files generated in the .zip file will depend on the target options you select on the dialog box. The following files will always be generated regardless of the targets you select:

Artifact file pathArtifact description

azuredeploy.json

A Microsoft Azure Resource Manager (ARM) template that models the entire deployment as run by Cloud Builder.

azuredeploy.parameters.json

An ARM template parameters file populated with the values you specified in Cloud Builder.

DSC.zip

The automation artifacts used to configure ArcGIS components on the virtual machine.

<licenses>.prvc

The license files for ArcGIS Server and (optionally) Portal for ArcGIS specified during the Cloud Builder setup.

<sslCertificate>.pfx

The SSL certificate (CA-signed or self-signed) specified during the Cloud Builder setup. If using a self-signed certificate, a wildcard certificate is generated with the name wildcard_<region>_cloudapp_azure_com.pfx for use in any deployment within the specified Azure region.

Deploy-AzureResourceGroup.ps1

An entry point script for automation used by Visual Studio and PowerShell.

The following additional artifacts are generated when the Visual Studio option is selected:

Artifact file pathArtifact description

DeployArcGIS.sln

A Visual Studio solution file.

DeployArcGIS.deployproj

A Visual Studio deployment project file.

The following additional artifact is generated when the PowerShell option is selected:

Artifact file pathArtifact description

Deploy-ArcGISSite.ps1

A PowerShell script for automation.

The following additional artifact is generated when the CLI option is selected:

Artifact file pathArtifact description

deployArcGISSite.sh

A Bash script for automation.

2. Automate additional deployments

Use one of the artifacts that were generated with one of the following to automate repeated deployments:

ArcGIS Enterprise on Microsoft Azure can also be integrated with continuous integration and continuous deployment (CI/CD) tools such as Jenkins, Octopus Deploy, and Travis CI.

Tip:

See Automation solutions for your portal to learn more about automation with ArcGIS Enterprise.

Deploy using Microsoft Visual Studio

Before you begin, ensure that you have the following:

  • Visual Studio 2022 or later
  • Azure Resource Manager Tools for Visual Studio
  • Azure PowerShell for Windows

To automate a deployment of ArcGIS Enterprise on Microsoft Azure using Visual Studio, complete the following steps:

  1. Click the DeployArcGIS.sln file from the generated automation artifacts to open the Visual Studio Solution file.

    The Visual Studio Deployment Project file (.deployproj) opens if you have the required Azure Resource Manager Tools for Visual Studio installed.

  2. Right-click the project in the Solution Explorer window of Visual Studio and click Deploy > New.

    The Deploy to Resource Group dialog box appears.

  3. For Resource group, choose an existing resource group or create one for the deployment.

    The Deployment template and Template parameters file text boxes are populated automatically.

  4. To change any of the parameters of the deployment, click Edit Parameters.
  5. If you change any parameters, click Save to close the dialog box.
  6. When you are ready, click Deploy.

    A PowerShell console opens.

  7. Provide your administrator password in the console when prompted.

The deployed resources will be available in the resource group you specified once the deployment is complete.

Deploy using Azure PowerShell for Windows

If you have not already done so, install Azure PowerShell for Windows from the Microsoft website.

To automate a deployment of ArcGIS Enterprise on Microsoft Azure using Azure PowerShell for Windows, complete the following steps:

  1. Open a PowerShell console and browse to the extracted automation artifacts folder.
  2. Run the Deploy-ArcGISSite.ps1 script.
  3. If prompted, sign in to Microsoft Azure.

    Once authenticated, the deployment uses the parameters you previously provided in ArcGIS Enterprise Cloud Builder for Microsoft Azure to create an identical deployment.

Deploy using the Azure CLI on Bash

You can use the Azure CLI to launch deployments of ArcGIS Enterprise on Microsoft Azure from machines running Windows, Linux, or macOS. Install Azure CLI 2.x from the Microsoft website if you haven't done so already. If the original automation artifacts folder was generated on a Windows machine and you want to run the CLI on a macOS or Linux machine, copy the folder to the client computer before beginning.

To automate a deployment of ArcGIS Enterprise on Microsoft Azure using the Azure CLI on Bash, complete the following steps:

  1. Open a Bash shell and change directories to access the extracted automation artifacts folder.
  2. To change any parameters in the deployment, use a text editing program to edit the azuredeploy.parameters.json file, and save your changes.
  3. Run the deployArcGISSite.sh script.
  4. If prompted, sign in to Microsoft Azure.

    Once authenticated, the deployment uses the parameters you previously provided in ArcGIS Enterprise Cloud Builder for Microsoft Azure.

Deploy using Azure Resource Manager

You can download Azure Resource Manager from GitHub to deploy ArcGIS Enterprise, stand-alone and federated ArcGIS Server sites, and ArcGIS Pro on Azure instances. You can use these templates to automate deployments without needing to generate files from Cloud Builder.