Skip navigation

Deploy Darktrace vSensors

Last updated: 2/02/2022

This template allows you to deploy one or more stand-alone Darktrace vSensors

This Azure Resource Manager template was created by a member of the community and not by Microsoft. Each Resource Manager template is licensed to you under a licence agreement by its owner, not Microsoft. Microsoft is not responsible for Resource Manager templates provided and licensed by community members and does not screen for security, compatibility, or performance. Community Resource Manager templates are not supported under any Microsoft support programme or service, and are made available AS IS without warranty of any kind.


Parameter Name Description
location Location for all resources. The default is the Resource Group location.
virtualNetworkResourceGroupName Name of the Virtual Network Resource Group.
virtualNetworkName Name of the Virtual Network, should be in the above Location.
subnet1Name Name of the Subnet in the Virtual Network.
networkSecurityGroupName Name for the Network Security Group that the template will create. Note that a pre-existing Network Security Group with the same name will be replaced.
MgmtSourceAddressOrRange Provide an address range using CIDR notation (e.g., or an IP address (e.g. for Management access via ssh (port 22/TCP). You can also provide a comma-separated list of IP addresses and/or address ranges (a valid comma-separated list is, To allow access from any IP you can use
vsensorName The name of the vSensor.
numberOfVsensors Number of vSensors to be deployed, max is 4.
diskSize The vSensor disk size in GB between 30 and 1024. Check the Darktrace customer portal for more information.
virtualMachineSize The VM size. Check the Darktrace customer portal for more information about the vSensor Virtual Hardware requirements.
adminUsername Username to be created when the vSensor is spun up. Note that password authentication over ssh for newly created VMs is disabled.
adminPublicKey Public key for the adminUsername user to ssh the vSensor.
applianceHostName The FQDN or the IP of the Darktrace master instance (virtual/physical).
appliancePort Darktrace master instance connection port.
updateKey Darktrace Update Key needed to install the vSensor package. Contact your Darktrace representative for more information.
pushToken The push token that vSensor will use to connect and register on the Darktrace master instance. Should be generated on the Darktrace master instance.
osSensorHMACToken TThe osSensor HMAC Token.

Use the template


New-AzResourceGroup -Name <resource-group-name> -Location <resource-group-location> #use this command when you need to create a new resource group for your deployment
New-AzResourceGroupDeployment -ResourceGroupName <resource-group-name> -TemplateUri
Install and configure Azure PowerShell

Command line

az group create --name <resource-group-name> --location <resource-group-location> #use this command when you need to create a new resource group for your deployment
az group deployment create --resource-group <my-resource-group> --template-uri
Install and Configure the Azure Cross-Platform Command-Line Interface