You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Register your SQL Server VM with the [SQL IaaS Agent extension](sql-server-iaas-agent-extension-automate-management.md) to unlock a wealth of feature benefits for your SQL Server on Linux Azure VM.
25
29
26
30
## Overview
27
31
28
-
Registering with the [SQL Server IaaS Agent extension](sql-server-iaas-agent-extension-automate-management.md) creates the [**SQL virtual machine**_resource_](manage-sql-vm-portal.md) within your subscription, which is a _separate_ resource from the virtual machine resource. Unregistering your SQL Server VM from the extension will remove the **SQL virtual machine**_resource_ but will not drop the actual virtual machine.
32
+
Registering with the [SQL Server IaaS Agent extension](sql-server-iaas-agent-extension-automate-management.md) creates the [**SQL virtual machine**_resource_](manage-sql-vm-portal.md) within your subscription, which is a _separate_ resource from the virtual machine resource. Unregistering your SQL Server VM from the extension removes the **SQL virtual machine**_resource_ but will not drop the actual virtual machine.
29
33
30
34
To utilize the SQL IaaS Agent extension, you must first [register your subscription with the **Microsoft.SqlVirtualMachine** provider](#register-subscription-with-rp), which gives the SQL IaaS extension the ability to create resources within that specific subscription.
31
35
@@ -37,16 +41,17 @@ To utilize the SQL IaaS Agent extension, you must first [register your subscript
37
41
To register your SQL Server VM with the extension, you'll need:
38
42
39
43
- An [Azure subscription](https://azure.microsoft.com/free/).
40
-
- An Azure Resource Model [Windows Server 2008 (or greater) virtual machine](../../../virtual-machines/windows/quick-create-portal.md) with [SQL Server 2008 (or greater)](https://www.microsoft.com/sql-server/sql-server-downloads) deployed to the public or Azure Government cloud.
44
+
- An Azure Resource Model [Ubuntu Linux virtual machine](../../../virtual-machines/linux/quick-create-portal.md) with [SQL Server 2017 (or greater)](https://www.microsoft.com/sql-server/sql-server-downloads) deployed to the public or Azure Government cloud.
41
45
- The latest version of [Azure CLI](/cli/azure/install-azure-cli) or [Azure PowerShell (5.0 minimum)](/powershell/azure/install-az-ps).
42
-
- Azure Virtual Machine running Ubuntu Linux.
43
46
44
47
## Register subscription with RP
45
48
46
49
To register your SQL Server VM with the SQL IaaS Agent extension, you must first register your subscription with the **Microsoft.SqlVirtualMachine** resource provider (RP). This gives the SQL IaaS Agent extension the ability to create resources within your subscription. You can do so by using the Azure portal, the Azure CLI, or Azure PowerShell.
47
50
48
51
### Azure portal
49
52
53
+
Register your subscription with the resource provider by using the Azure portal:
54
+
50
55
1. Open the Azure portal and go to **All Services**.
51
56
1. Go to **Subscriptions** and select the subscription of interest.
52
57
1. On the **Subscriptions** page, select **Resource providers** under **Settings**.
@@ -61,78 +66,83 @@ Register your Azure subscription with the **Microsoft.SqlVirtualMachine** provid
61
66
62
67
# [Azure CLI](#tab/bash)
63
68
69
+
Register your subscription with the resource provider by using the Azure CLI:
70
+
64
71
```azurecli-interactive
65
72
# Register the SQL IaaS Agent extension to your subscription
66
73
az provider register --namespace Microsoft.SqlVirtualMachine
67
74
```
68
75
69
76
# [Azure PowerShell](#tab/powershell)
70
77
78
+
Register your subscription with the resource provider by using Azure PowerShell:
79
+
71
80
```powershell-interactive
72
81
# Register the SQL IaaS Agent extension to your subscription
SQL IaaS Agent extension on Linux comes only with Lightweight mode where changing the license type and edition of SQL Server is supported. Use the Azure CLI or Azure PowerShell to register your SQL Server VM with the extension in lightweight mode for limited functionality.
87
+
The SQL IaaS Agent extension on Linux is only available in lightweight mode, which supports only changing the license type and edition of SQL Server. Use the Azure CLI or Azure PowerShell to register your SQL Server VM with the extension in lightweight mode for limited functionality.
80
88
81
89
Provide the SQL Server license type as either pay-as-you-go (`PAYG`) to pay per usage, Azure Hybrid Benefit (`AHUB`) to use your own license, or disaster recovery (`DR`) to activate the [free DR replica license](business-continuity-high-availability-disaster-recovery-hadr-overview.md#free-dr-replica-in-azure).
82
90
83
91
# [Azure CLI](#tab/bash)
84
92
85
93
Register a SQL Server VM in lightweight mode with the Azure CLI:
86
94
87
-
```azurecli-interactive
88
-
# Register Enterprise or Standard self-installed VM in Lightweight mode
89
-
az sql vm create --name <vm_name> --resource-group <resource_group_name> --location <vm_location> --license-type <license_type>
90
-
```
95
+
```azurecli-interactive
96
+
# Register Enterprise or Standard self-installed VM in Lightweight mode
97
+
az sql vm create --name <vm_name> --resource-group <resource_group_name> --location <vm_location> --license-type <license_type>
98
+
```
91
99
92
100
# [Azure PowerShell](#tab/powershell)
93
101
94
102
Register a SQL Server VM in lightweight mode with Azure PowerShell:
You can verify if your SQL Server VM has already been registered with the SQL IaaS Agent extension by using the Azure portal, the Azure CLI, or Azure PowerShell.
108
117
118
+
109
119
### Azure portal
110
120
111
-
To verify the registration status using the Azure portal, follow these steps:
121
+
Verify the registration status by using the Azure portal:
112
122
113
123
1. Sign in to the [Azure portal](https://portal.azure.com).
114
124
1. Go to your [SQL Server VMs](manage-sql-vm-portal.md).
115
125
1. Select your SQL Server VM from the list. If your SQL Server VM is not listed here, it likely hasn't been registered with the SQL IaaS Agent extension.
116
126
117
127
### Command line
118
128
119
-
Verify current SQL Server VM registration status using either Azure CLI or Azure PowerShell. `ProvisioningState`will show`Succeeded` if registration was successful.
129
+
Verify current SQL Server VM registration status using either Azure CLI or Azure PowerShell. `ProvisioningState`shows as`Succeeded` if registration was successful.
120
130
121
131
# [Azure CLI](#tab/bash)
122
132
123
-
To verify the registration status using the Azure CLI, run the following code snippet:
133
+
Verify the registration status by using the Azure CLI:
124
134
125
-
```azurecli-interactive
126
-
az sql vm show -n <vm_name> -g <resource_group>
127
-
```
135
+
```azurecli-interactive
136
+
az sql vm show -n <vm_name> -g <resource_group>
137
+
```
128
138
129
139
# [Azure PowerShell](#tab/powershell)
130
140
131
-
To verify the registration status using the Azure PowerShell, run the following code snippet:
141
+
Verify the registration status by using the Azure PowerShell:
The SQL Server IaaS Agent extension (SqlIaasExtension) runs on SQL Server on Linux Azure Virtual Machines (VMs) to automate management and administration tasks.
23
26
@@ -26,11 +29,11 @@ This article provides an overview of the extension. See [Register with the exten
26
29
27
30
## Overview
28
31
29
-
The SQL Server IaaS Agent extension allows for integration with the Azure portal and allows following benefits for SQL Server on Azure VMs:
32
+
The SQL Server IaaS Agent extension enables integration with the Azure portal and unlocks the following benefits for SQL Server on Linux Azure VMs:
30
33
31
-
-**Compliance**: The extension offers a simplified method of fulfilling the requirement to notify Microsoft that the Azure Hybrid Benefit has been enabled as is specified in the product terms. This process negates needing to manage licensing registration forms for each resource.
34
+
-**Compliance**: The extension offers a simplified method to fulfill the requirement of notifying Microsoft that the Azure Hybrid Benefit has been enabled as is specified in the product terms. This process negates needing to manage licensing registration forms for each resource.
32
35
33
-
-**Simplified license management**: The extension simplifies SQL Server license management, and allows you to quickly identify SQL Server VMs with the Azure Hybrid Benefit enabled using the [Azure portal](manage-sql-vm-portal.md), PowerShell or the Azure CLI:
36
+
-**Simplified license management**: The extension simplifies SQL Server license management, and allows you to quickly identify SQL Server VMs with the Azure Hybrid Benefit enabled using the [Azure portal](manage-sql-vm-portal.md), Azure PowerShell or the Azure CLI:
34
37
35
38
# [PowerShell](#tab/azure-powershell)
36
39
@@ -47,77 +50,61 @@ The SQL Server IaaS Agent extension allows for integration with the Azure portal
47
50
48
51
-**Free**: There is no additional cost associated with the extension.
49
52
50
-
> [!IMPORTANT]
51
-
> 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](/sql/sql-server/sql-server-privacy#non-personal-data) for more information.
52
53
53
-
## Installation
54
-
55
-
Register your SQL Server VM with the SQL Server IaaS Agent extension to create the [**SQL virtual machine**_resource_](manage-sql-vm-portal.md) within your subscription, which is a _separate_ resource from the virtual machine resource. Unregistering your SQL Server VM from the extension will remove the **SQL virtual machine**_resource_ but will not drop the actual virtual machine.
56
-
57
-
Today SQL Server IaaS Agent extension is only available in lightweight mode. You can manually register Azure Linux Virtual machine using following command
58
-
# [Azure CLI](#tab/bash)
59
-
60
-
Register a SQL Server VM in lightweight mode with the Azure CLI:
61
54
62
-
```azurecli-interactive
63
-
# Register Enterprise or Standard self-installed VM in Lightweight mode
64
-
az sql vm create --name <vm_name> --resource-group <resource_group_name> --location <vm_location> --license-type <license_type>
65
-
```
66
-
67
-
# [Azure PowerShell](#tab/powershell)
55
+
## Installation
68
56
69
-
Register a SQL Server VM in lightweight mode with Azure PowerShell:
57
+
[Register](sql-agent-extension-register-vm-linux.md) your SQL Server VM with the SQL Server IaaS Agent extension to create the [**SQL virtual machine**_resource_](manage-sql-vm-portal.md) within your subscription, which is a _separate_ resource from the virtual machine resource. Unregistering your SQL Server VM from the extension will remove the **SQL virtual machine**_resource_ from your subscription but will not drop the actual virtual machine.
Use the Azure portal or Azure PowerShell to check the status of the extension.
83
65
84
66
### Azure portal
85
67
86
-
Verify the extension is installed in the Azure portal.
68
+
Verify the extension is installed by using the Azure portal.
87
69
88
-
Select **All settings** in the virtual machine pane, and then select **Extensions**. You should see the **SqlIaasExtension** extension listed.
70
+
Go to your **Virtual machine**resource in the Azure portal (not the *SQL virtual machines* resource, but the resource for your VM). Select **Extensions** under **Settings**. You should see the **SqlIaasExtension** extension listed, as in the following example:
89
71
90
-
72
+
91
73
92
74
93
75
### Azure PowerShell
94
76
95
77
You can also use the **Get-AzVMSqlServerExtension** Azure PowerShell cmdlet:
The previous command confirms that the agent is installed and provides general status information. You can get specific status information about automated backup and patching by using the following commands:
The Linux SQL IaaS Agent extension has the following limitations:
94
+
95
+
- Only SQL Server VMs running on the Ubuntu Linux operating system are supported. Other Linux distributions are not currently supported.
96
+
- SQL Server VMs running Ubuntu Linux Pro are not supported.
97
+
- SQL Server VMs running on generalized images are not supported.
98
+
- Only SQL Server VMs deployed through the Azure Resource Manager are supported. SQL Server VMs deployed through the classic model are not supported.
99
+
100
+
## Privacy statement
101
+
102
+
When using SQL Server on Azure VMs and the SQL IaaS extension, consider the following privacy statements:
112
103
113
-
- SQL Server VMs running Ubuntu Linux Operating system is only supported. Other Linux distributions are not supported today.
114
-
- SQL Server VMs running Ubuntu Pro Linux are not supported.
115
-
- SQL Server VMs running on the generalized images are not supported.
116
-
- SQL Server VMs deployed through the Azure Resource Manager. SQL Server VMs deployed through the classic model are not supported.
104
+
-**Data collection**: The SQL IaaS Agent extension collects data for the express purpose of giving customers optional benefits when using SQL Server on Azure Virtual Machines. Microsoft **will not use this data for licensing audits** without the customer's advance consent. See the [SQL Server privacy supplement](/sql/sql-server/sql-server-privacy#non-personal-data) for more information.
117
105
118
-
## In-region data residency
106
+
-**In-region data residency**: SQL Server on Azure VMs and SQL IaaS Agent Extension do not move or store customer data out of the region in which the VMs are deployed.
119
107
120
-
Azure SQL virtual machine and the SQL IaaS Agent Extension do not move or store customer data out of the region in which they are deployed.
Copy file name to clipboardExpand all lines: articles/azure-sql/virtual-machines/windows/sql-agent-extension-automatic-registration-all-vms.md
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ ms.subservice: management
9
9
ms.topic: how-to
10
10
ms.tgt_pltfrm: vm-windows-sql-server
11
11
ms.workload: iaas-sql-server
12
-
ms.date: 9/01/2021
12
+
ms.date: 10/26/2021
13
13
ms.custom: devx-track-azurepowershell
14
14
ms.reviewer: mathoma
15
15
---
@@ -35,9 +35,14 @@ When automatic registration is enabled, a job runs daily to detect whether or no
35
35
36
36
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 without downtime, and without restarting the SQL Server service**. You still need to [manually upgrade to full manageability mode](sql-agent-extension-manually-register-single-vm.md#upgrade-to-full) to take advantage of the full feature set. The license type automatically defaults to that of the VM image. If you use a pay-as-you-go image for your VM, then your license type will be `PAYG`, otherwise your license type will be `AHUB` by default.
37
37
38
+
By default, Azure VMs with SQL Server 2016 or later installed will be automatically registered with the SQL IaaS Agent extension when detected by the [CEIP service](/sql/sql-server/usage-and-diagnostic-data-configuration-for-sql-server). See the [SQL Server privacy supplement](/sql/sql-server/sql-server-privacy#non-personal-data) for more information.
39
+
38
40
> [!IMPORTANT]
39
41
> 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](/sql/sql-server/sql-server-privacy#non-personal-data) for more information.
40
42
43
+
44
+
45
+
41
46
## Prerequisites
42
47
43
48
To register your SQL Server VM with the extension, you'll need:
0 commit comments