Automatic registration with SQL IaaS Agent extension

APPLIES TO: SQL Server on Azure VM

Enable the automatic registration feature in the Azure portal to automatically register all current and future SQL Server on Azure Virtual Machines (VMs) with the SQL IaaS Agent extension in lightweight mode.

This article teaches you to enable the automatic registration feature. Alternatively, you can register a single VM, or register your VMs in bulk with the SQL IaaS Agent extension.

Overview

Registering your SQL Server VM with the SQL IaaS Agent extension to unlock a full feature set of benefits.

When automatic registration is enabled, a job runs daily to detect whether or not SQL Server is installed on all the unregistered VMs in the subscription. This is done by copying the SQL IaaS agent extension binaries to the VM, then running a one-time utility that checks for the SQL Server registry hive. If the SQL Server hive is detected, the virtual machine is registered with the extension in lightweight mode. If no SQL Server hive exists in the registry, the binaries are removed.

Once automatic registration is enabled for a subscription, all current and future VMs that have SQL Server installed will be registered with the SQL IaaS Agent extension in lightweight mode. You still need to manually upgrade to full manageability mode to take advantage of the full feature set.

Important

The SQL IaaS Agent extension collects data for the express purpose of giving customers optional benefits when using SQL Server within Azure Virtual Machines. Microsoft will not use this data for licensing audits without the customer's advance consent. See the SQL Server privacy supplement for more information.

Prerequisites

To register your SQL Server VM with the extension, you'll need:

Enable

To enable automatic registration of your SQL Server VMs in the Azure portal, follow these steps:

  1. Sign into the Azure portal.

  2. Navigate to the SQL virtual machines resource page.

  3. Select Automatic SQL Server VM registration to open the Automatic registration page.

    Select Automatic SQL Server VM registration to open the automatic registration page

  4. Choose your subscription from the drop-down.

  5. Read through the terms and if you agree, select I accept.

  6. Select Register to enable the feature and automatically register all current and future SQL Server VMs with the SQL IaaS Agent extension. This will not restart the SQL Server service on any of the VMs.

Disable

Use the Azure CLI or Azure PowerShell to disable the automatic registration feature. When the automatic registration feature is disabled, SQL Server VMs added to the subscription need to be manually registered with the SQL IaaS Agent extension. This will not unregister existing SQL Server VMs that have already been registered.

To disable automatic registration using Azure CLI, run the following command:

az feature unregister --namespace Microsoft.SqlVirtualMachine --name BulkRegistration

Enable for multiple subscriptions

You can enable the automatic registration feature for multiple Azure subscriptions by using PowerShell.

To do so, follow these steps:

  1. Save this script to a .ps1 file, such as EnableBySubscription.ps1.

  2. Navigate to where you saved the script by using an administrative Command Prompt or PowerShell window.

  3. Connect to Azure (az login).

  4. Execute the script, passing in SubscriptionIds as parameters such as
    .\EnableBySubscription.ps1 -SubscriptionList SubscriptionId1,SubscriptionId2

    For example:

    .\EnableBySubscription.ps1 -SubscriptionList a1a1a-aa11-11aa-a1a1-a11a111a1,b2b2b2-bb22-22bb-b2b2-b2b2b2bb
    

Failed registration errors are stored in RegistrationErrors.csv located in the same directory where you saved and executed the .ps1 script from.

Next steps

Upgrade your manageability mode to full to take advantage of the full feature set provided to you by the SQL IaaS Agent extension.