Installing the data broker in Azure Edit on GitHub Request doc changes

Contributors netapp-bcammett

When you create a sync relationship, choose the Azure Data Broker option to deploy the data broker software on a new virtual machine in a VNet. Cloud Sync guides you through the installation process, but the requirements and steps are repeated on this page to help you prepare for installation.

You also have the option to install the data broker on an existing Linux host in the cloud or on your premises. Learn more.

Supported Azure regions

All regions are supported except for the China, US Gov, and US DoD regions.

Networking requirements

  • The data broker needs an outbound internet connection so it can poll the Cloud Sync service for tasks over port 443.

    When Cloud Sync deploys the data broker in Azure, it creates a security group that enables the required outbound communication.

    If you need to limit outbound connectivity, see the list of endpoints that the data broker contacts.

  • NetApp recommends configuring the source, target, and data broker to use a Network Time Protocol (NTP) service. The time difference between the three components should not exceed 5 minutes.

Installing the data broker

You can install a data broker in Azure when you create a sync relationship.

  1. Click Create New Sync Relationship.

  2. On the Define Sync Relationship page, choose a source and target and click Continue.

    Complete the pages until you reach the Data Broker page.

  3. On the Data Broker page, click Azure Data Broker.

    If you already have a data broker, you’ll need to click the A screenshot if the plus icon icon first.

    A screenshot of the Data Broker page that enables you to choose between an AWS

  4. Enter a name for the data broker and click Continue.

    The instructions load in a separate browser tab.

  5. Follow the instructions to install the data broker in Azure. The instructions are repeated here for your convenience.

    1. Open an Azure PowerShell session.

    2. Log in to your Azure account:


    3. Set the current Azure subscription:

      Select-AzureRmSubscription -subscriptionName <SB_NAME>

    4. Create a new resource group:

      New-AzureRmResourceGroup -Name <RG_NAME> -Location <LOCATION>

    5. Set up a new virtual network:

      $subnet = New-AzureRmVirtualNetworkSubnetConfig -Name <SUBNET_NAME> -AddressPrefix <SUBNET_CIDR>

      New-AzureRmVirtualNetwork -Name <VNET_NAME> -ResourceGroupName <RG_NAME> -Location <LOCATION> -AddressPrefix <VNET_CIDR_PREFIX> -Subnet $subnet

    6. Deploy the data broker in the resource group:

      New-AzureRmResourceGroupDeployment -Name <DEPLOYMENT_NAME> -ResourceGroupName <RG_NAME> -TemplateUri <URI> -StorageAccountType 'Standard_GRS' -subnetName <SUBNET_NAME> -adminPublicKey <KEY> -virtualMachineName <VM_NAME> -virtualNetworkName <VNET_NAME> -storageAccountName <SA_NAME>

      For help with this cmdlet, refer to Azure PowerShell documentation. Note the following about two of the parameters:


      Cloud Sync displays the URI of the JSON template file when you follow the prompts to deploy the Azure Data Broker. That URI isn’t repeated here because the link is generated dynamically and can be used only once. Follow steps 1-4 to obtain the URI from Cloud Sync.


      Specify an RSA public key to use when connecting to the data broker virtual machine with SSH. Specify the key using single-line format (starting with "ssh-rsa") or the multi-line PEM format. You would typically connect to the virtual machine for debugging purposes only. For help with the key pair, refer to Azure documentation: Create and use an SSH public-private key pair for Linux VMs in Azure.

      Password-based authentication is not available with the Azure Data Broker option. If you need to use password-based authentication with a data broker that resides in Azure, then you should use the On-Prem Data Broker option.

  6. In Cloud Sync, click Continue once the data broker is available.

    The virtual machine takes approximately 5 to 10 minutes to deploy. You can monitor the progress from the Cloud Sync service, which automatically refreshes when the virtual machine is available.

  7. Complete the pages in the wizard to create the new sync relationship.


You have deployed a data broker in Azure and created a new sync relationship. You can use this data broker with additional sync relationships.