This page provides the specific steps to launch Azure Canaries. If you're looking for additional information on how Azure Canaries work, see this page.
Step 1: Confirm that Azure Cloud Canaries are enabled for your account
Browse to your Console, enter your credentials, and click "Setup". You should see "Cloud Canary" in the settings menu and an entry for Azure Canaries.
Cloud Canaries are enabled
Azure Canaries are listed
If you don't find Azure images on your Console, please see the "First steps" for getting Azure enabled.
Step 2: Start the Deployment Wizard
On the Setup page, click "Launch" next to the Azure Canary image to open the deployment wizard. This wizard will guide you through choosing values like the VM name and region for the deployment, then generate a script to perform the necessary actions.
Step 3: Authorise the Canary App
On the wizard's First phase, you are shown a link to click on. This link takes you to the Azure login page where you authorise the Canary App. Authorising the App is necessary for accessing the Shared Image Gallery, but we keep the requested permissions to the absolute minimum.
This step only needs to be performed once; if the App is authorised you don't need to repeat this step and can skip ahead.
Authorise the Canary App, if not already done so
Click "Continue" when the Canary App is authorised.
Step 4: Enter VM details
In Azure, every VM must be deployed into a Resource Group, in a specific region. Deploying an Azure Canary needs (at minimum) a name for the Resource Group, a name for the new Canary VM, and the region in which the VM will be deployed.
If the Resource Group does not yet exist, it'll first need to be created.
If the Resource Group does exist, it needs a certain Role assigned to it. Please follow these steps on the Resource Group if the Role hasn't yet been assigned.
With all that in mind, on the wizard's next step you're prompted for the Azure Resource Group Name, whether the Resource Group was new (or not), the new VM's name, and the region in which you want to launch the VM.
Enter the VM details
Click "Continue" when once the details have been entered.
Step 4: Generate the deployment script
The final wizard step generates a series of commands which will create and configure the Resource Group in your Tenant (if it does not exist), login to the App, and launch the Shared Image.
The script's contents are explained in more detail over here, but for now click "Copy" to grab the generated commands. You can then close the wizard by clicking "All done, close this".
Step 5: Open a shell with azure-cli installed
You'll need a command line shell, where the Azure CLI tool can be run to launch the instance.
In either case, simply paste the commands copied in the previous step into your shell. This will setup the Resource Group (if selected), login to the App and create a new VM in your tenant.
Once you run the command, the bird will boot and configure itself.
If you get any errors, please see our Azure troubleshooting page.
Step 6: Commission bird
When the bird is configured and running, it will contact the Console to register itself. You will then need to commission the device in the Canary console. In your Console tab, wait for the commission dialog.
Click "Commission Canary", and the bird's status will go green.
It's now ready for remote configuration to enable profiles and services. Tip: to help track the Canary in Azure, change the instance name in Azure when changing the Canary name on the Console to keep them sync.