Skip to content

Commit e32f544

Browse files
MikeRayMSFTMikeRayMSFT
authored
Merge pull request #174784 from MashaMSFT/sqlvmlinux-extension
adding sql iaas extension articles for linux
2 parents db6f418 + 1983be8 commit e32f544

10 files changed

+438
-126
lines changed

‎articles/azure-sql/toc.yml

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1150,14 +1150,14 @@
11501150
items:
11511151
- name: Documentation
11521152
href: virtual-machines/index.yml
1153+
- name: What's new?
1154+
href: virtual-machines/windows/doc-changes-updates-release-notes-whats-new.md
11531155
- name: Windows
11541156
items:
11551157
- name: Overview
11561158
items:
11571159
- name: What is a SQL Server VM?
11581160
href: virtual-machines/windows/sql-server-on-azure-vm-iaas-what-is-overview.md
1159-
- name: What's new?
1160-
href: virtual-machines/windows/doc-changes-updates-release-notes-whats-new.md
11611161
- name: Quickstarts
11621162
items:
11631163
- name: Portal
@@ -1369,6 +1369,15 @@
13691369
items:
13701370
- name: Create SQL VM - Portal
13711371
href: virtual-machines/linux/sql-vm-create-portal-quickstart.md
1372+
1373+
- name: Concepts
1374+
items:
1375+
- name: SQL IaaS agent extension
1376+
href: virtual-machines/linux/sql-server-iaas-agent-extension-linux.md
1377+
- name: "How-to guides"
1378+
items:
1379+
- name: Register with SQL IaaS extension
1380+
href: virtual-machines/linux/sql-iaas-agent-extension-register-vm-linux.md
13721381
- name: Tutorials
13731382
items:
13741383
- name: Setting up Azure RHEL VM availability group with STONITH

‎articles/azure-sql/virtual-machines/linux/sql-iaas-agent-extension-register-vm-linux.md

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
---
2+
title: Register with SQL IaaS Agent extension (Linux)
3+
description: Learn how to register your SQL Server on Linux Azure VM with the SQL IaaS Agent extension to enable Azure features, as well as for compliance, and improved manageability.
4+
services: virtual-machines-windows
5+
documentationcenter: na
6+
author: adbadram
7+
tags: azure-resource-manager
8+
ms.service: virtual-machines-sql
9+
ms.subservice: management
10+
ms.devlang: na
11+
ms.topic: how-to
12+
ms.tgt_pltfrm: vm-Linux-sql-server
13+
ms.workload: iaas-sql-server
14+
ms.date: 10/26/2021
15+
ms.author: adbadram
16+
ms.reviewer: mathoma
17+
ms.custom: devx-track-azurecli, devx-track-azurepowershell, contperf-fy21q2
18+
19+
---
20+
# Register Linux SQL Server VM with SQL IaaS Agent extension
21+
[!INCLUDE[appliesto-sqlvm](../../includes/appliesto-sqlvm.md)]
22+
23+
> [!div class="op_single_selector"]
24+
> * [Windows](../windows/sql-agent-extension-manually-register-single-vm.md)
25+
> * [Linux](sql-iaas-agent-extension-register-vm-linux.md)
26+
27+
28+
Register your SQL Server VM with the [SQL IaaS Agent extension](sql-server-iaas-agent-extension-linux.md) to unlock a wealth of feature benefits for your SQL Server on Linux Azure VM.
29+
30+
## Overview
31+
32+
Registering with the [SQL Server IaaS Agent extension](sql-server-iaas-agent-extension-linux.md) creates the **SQL virtual machine** _resource_ 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.
33+
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.
35+
36+
> [!IMPORTANT]
37+
> 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.
38+
39+
## Prerequisites
40+
41+
To register your SQL Server VM with the extension, you'll need:
42+
43+
- An [Azure subscription](https://azure.microsoft.com/free/).
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.
45+
- The latest version of [Azure CLI](/cli/azure/install-azure-cli) or [Azure PowerShell (5.0 minimum)](/powershell/azure/install-az-ps).
46+
47+
## Register subscription with RP
48+
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.
50+
51+
### Azure portal
52+
53+
Register your subscription with the resource provider by using the Azure portal:
54+
55+
1. Open the Azure portal and go to **All Services**.
56+
1. Go to **Subscriptions** and select the subscription of interest.
57+
1. On the **Subscriptions** page, select **Resource providers** under **Settings**.
58+
1. Enter **sql** in the filter to bring up the SQL-related resource providers.
59+
1. Select **Register**, **Re-register**, or **Unregister** for the **Microsoft.SqlVirtualMachine** provider, depending on your desired action.
60+
61+
62+
![Modify the provider](../windows/media/sql-agent-extension-manually-register-single-vm/select-resource-provider-sql.png)
63+
64+
### Command line
65+
66+
Register your Azure subscription with the **Microsoft.SqlVirtualMachine** provider using either Azure CLI or Azure PowerShell.
67+
68+
# [Azure CLI](#tab/bash)
69+
70+
Register your subscription with the resource provider by using the Azure CLI:
71+
72+
```azurecli-interactive
73+
# Register the SQL IaaS Agent extension to your subscription
74+
az provider register --namespace Microsoft.SqlVirtualMachine
75+
```
76+
77+
# [Azure PowerShell](#tab/powershell)
78+
79+
Register your subscription with the resource provider by using Azure PowerShell:
80+
81+
```powershell-interactive
82+
# Register the SQL IaaS Agent extension to your subscription
83+
Register-AzResourceProvider -ProviderNamespace Microsoft.SqlVirtualMachine
84+
```
85+
86+
---
87+
88+
## Register VM
89+
90+
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.
91+
92+
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](../windows/business-continuity-high-availability-disaster-recovery-hadr-overview.md#free-dr-replica-in-azure).
93+
94+
# [Azure CLI](#tab/bash)
95+
96+
Register a SQL Server VM in lightweight mode with the Azure CLI:
97+
98+
```azurecli-interactive
99+
# Register Enterprise or Standard self-installed VM in Lightweight mode
100+
az sql vm create --name <vm_name> --resource-group <resource_group_name> --location <vm_location> --license-type <license_type>
101+
```
102+
103+
# [Azure PowerShell](#tab/powershell)
104+
105+
Register a SQL Server VM in lightweight mode with Azure PowerShell:
106+
107+
```powershell-interactive
108+
# Get the existing compute VM
109+
$vm = Get-AzVM -Name <vm_name> -ResourceGroupName <resource_group_name>
110+
# Register SQL VM with 'Lightweight' SQL IaaS agent
111+
New-AzSqlVM -Name $vm.Name -ResourceGroupName $vm.ResourceGroupName -Location $vm.Location `
112+
-LicenseType <license_type> -SqlManagementType LightWeight
113+
```
114+
115+
---
116+
117+
## Verify registration status
118+
119+
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.
120+
121+
122+
### Azure portal
123+
124+
Verify the registration status by using the Azure portal:
125+
126+
1. Sign in to the [Azure portal](https://portal.azure.com).
127+
1. Go to your SQL virtual machines resource.
128+
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.
129+
130+
### Command line
131+
132+
Verify current SQL Server VM registration status using either Azure CLI or Azure PowerShell. `ProvisioningState` shows as `Succeeded` if registration was successful.
133+
134+
# [Azure CLI](#tab/bash)
135+
136+
Verify the registration status by using the Azure CLI:
137+
138+
```azurecli-interactive
139+
az sql vm show -n <vm_name> -g <resource_group>
140+
```
141+
142+
# [Azure PowerShell](#tab/powershell)
143+
144+
Verify the registration status by using the Azure PowerShell:
145+
146+
```powershell-interactive
147+
Get-AzSqlVM -Name <vm_name> -ResourceGroupName <resource_group>
148+
```
149+
150+
---
151+
152+
An error indicates that the SQL Server VM has not been registered with the extension.
153+
154+
155+
## Next steps
156+
157+
For more information, see the following articles:
158+
159+
* [Overview of SQL Server on a Windows VM](sql-server-on-linux-vm-what-is-iaas-overview.md)
160+
* [FAQ for SQL Server on a Windows VM](frequently-asked-questions-faq.yml)
161+
* [Pricing guidance for SQL Server on a Windows VM](../windows/pricing-guidance.md)
162+
* [Release notes for SQL Server on a Windows VM](../windows/doc-changes-updates-release-notes.md)

‎articles/azure-sql/virtual-machines/linux/sql-server-iaas-agent-extension-linux.md

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
---
2+
title: SQL Server IaaS Agent extension for Linux
3+
description: This article describes how the SQL Server IaaS Agent extension helps automate management specific administration tasks of SQL Server on Linux Azure VMs.
4+
services: virtual-machines-windows
5+
documentationcenter: ''
6+
author: adbadram
7+
tags: azure-resource-manager
8+
ms.service: virtual-machines-sql
9+
ms.subservice: management
10+
ms.devlang: na
11+
ms.topic: conceptual
12+
ms.tgt_pltfrm: vm-windows-sql-server
13+
ms.workload: iaas-sql-server
14+
ms.date: 10/26/2021
15+
ms.author: adbadram
16+
ms.reviewer: mathoma
17+
---
18+
# SQL Server IaaS Agent extension for Linux
19+
[!INCLUDE[appliesto-sqlvm](../../includes/appliesto-sqlvm.md)]
20+
21+
> [!div class="op_single_selector"]
22+
> * [Windows](../windows/sql-server-iaas-agent-extension-automate-management.md)
23+
> * [Linux](sql-server-iaas-agent-extension-linux.md)
24+
25+
The SQL Server IaaS Agent extension (SqlIaasExtension) runs on SQL Server on Linux Azure Virtual Machines (VMs) to automate management and administration tasks.
26+
27+
This article provides an overview of the extension. See [Register with the extension](sql-iaas-agent-extension-register-vm-linux.md) to learn more.
28+
29+
30+
## Overview
31+
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:
33+
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.
35+
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, Azure PowerShell or the Azure CLI:
37+
38+
# [PowerShell](#tab/azure-powershell)
39+
40+
```powershell-interactive
41+
Get-AzSqlVM | Where-Object {$_.LicenseType -eq 'AHUB'}
42+
```
43+
44+
# [Azure CLI](#tab/azure-cli)
45+
46+
```azurecli-interactive
47+
$ az sql vm list --query "[?sqlServerLicenseType=='AHUB']"
48+
```
49+
---
50+
51+
- **Free**: There is no additional cost associated with the extension.
52+
53+
54+
55+
## Installation
56+
57+
[Register](sql-iaas-agent-extension-register-vm-linux.md) your SQL Server VM with the SQL Server IaaS Agent extension to create the **SQL virtual machine** _resource_ 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.
58+
59+
The SQL Server IaaS Agent extension for Linux is currently only available in lightweight mode.
60+
61+
62+
## Verify extension status
63+
64+
Use the Azure portal or Azure PowerShell to check the status of the extension.
65+
66+
### Azure portal
67+
68+
Verify the extension is installed by using the Azure portal.
69+
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:
71+
72+
![Check the Status of the SQL Server IaaS Agent extension SqlIaaSExtension in the Azure portal](../windows/media/sql-server-iaas-agent-extension-automate-management/azure-rm-sql-server-iaas-agent-portal.png)
73+
74+
75+
76+
77+
### Azure PowerShell
78+
79+
You can also use the **Get-AzVMSqlServerExtension** Azure PowerShell cmdlet:
80+
81+
```powershell-interactive
82+
Get-AzVMSqlServerExtension -VMName "vmname" -ResourceGroupName "resourcegroupname"
83+
```
84+
85+
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:
86+
87+
```powershell-interactive
88+
$sqlext = Get-AzVMSqlServerExtension -VMName "vmname" -ResourceGroupName "resourcegroupname"
89+
$sqlext.AutoPatchingSettings
90+
$sqlext.AutoBackupSettings
91+
```
92+
93+
## Limitations
94+
95+
The Linux SQL IaaS Agent extension has the following limitations:
96+
97+
- Only SQL Server VMs running on the Ubuntu Linux operating system are supported. Other Linux distributions are not currently supported.
98+
- SQL Server VMs running Ubuntu Linux Pro are not supported.
99+
- SQL Server VMs running on generalized images are not supported.
100+
- Only SQL Server VMs deployed through the Azure Resource Manager are supported. SQL Server VMs deployed through the classic model are not supported.
101+
- SQL Server with only a single instance. Multiple instances are not supported.
102+
103+
## <a id="in-region-data-residency"></a> Privacy statement
104+
105+
When using SQL Server on Azure VMs and the SQL IaaS extension, consider the following privacy statements:
106+
107+
- **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.
108+
109+
- **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.
110+
111+
112+
## Next steps
113+
114+
For more information about running SQL Server on Azure Virtual Machines, see the [What is SQL Server on Azure Linux Virtual Machines?](sql-server-on-linux-vm-what-is-iaas-overview.md).
115+
116+
To learn more, see [frequently asked questions](frequently-asked-questions-faq.yml).

‎articles/azure-sql/virtual-machines/linux/sql-server-on-linux-vm-what-is-iaas-overview.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ ms.subservice: service-overview
1010

1111
ms.topic: overview
1212
ms.workload: iaas-sql-server
13-
ms.date: 04/10/2018
13+
ms.date: 10/26/2021
1414
ms.author: mathoma
1515
ms.reviewer: jroth
1616
---
17-
# Overview of SQL Server on Azure Virtual Machines (Linux)
17+
# Overview of SQL Server on Linux Azure Virtual Machines
1818
[!INCLUDE[appliesto-sqlvm](../../includes/appliesto-sqlvm.md)]
1919

2020
> [!div class="op_single_selector"]
@@ -57,6 +57,10 @@ When you configure SQL Server on Linux, you install the Database Engine package
5757
| SLES | ![SLES and database engine](./media/sql-server-on-linux-vm-what-is-iaas-overview/yes.png) | ![SLES and tools](./media/sql-server-on-linux-vm-what-is-iaas-overview/yes.png) | ![SLES and SQL Server agent](./media/sql-server-on-linux-vm-what-is-iaas-overview/yes.png) | ![SLES and full-text search](./media/sql-server-on-linux-vm-what-is-iaas-overview/yes.png) | ![SLES and SSIS](./media/sql-server-on-linux-vm-what-is-iaas-overview/no.png) | ![SLES and HA add-on](./media/sql-server-on-linux-vm-what-is-iaas-overview/yes.png)|
5858
| Ubuntu | ![Ubuntu and database engine](./media/sql-server-on-linux-vm-what-is-iaas-overview/yes.png) | ![Ubuntu and tools](./media/sql-server-on-linux-vm-what-is-iaas-overview/yes.png) | ![Ubuntu and SQL Server agent](./media/sql-server-on-linux-vm-what-is-iaas-overview/yes.png) | ![Ubuntu and full-text search](./media/sql-server-on-linux-vm-what-is-iaas-overview/yes.png) | ![Ubuntu and SSIS](./media/sql-server-on-linux-vm-what-is-iaas-overview/yes.png) | ![Ubuntu and HA add-on](./media/sql-server-on-linux-vm-what-is-iaas-overview/yes.png) |
5959

60+
61+
> [!NOTE]
62+
> SQL IaaS Agent extension for SQL Server on Azure Linux Virtual Machines is only available for Ubuntu Linux distribution.
63+
6064
## Related products and services
6165

6266
### Linux virtual machines

‎articles/azure-sql/virtual-machines/windows/doc-changes-updates-release-notes-whats-new.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,14 @@ ms.date: 09/01/2021
1818

1919
When you deploy an Azure virtual machine (VM) with SQL Server installed on it, either manually, or through a built-in image, you can leverage Azure features to improve your experience. This article summarizes the documentation changes associated with new features and improvements in the recent releases of [SQL Server on Azure Virtual Machines (VMs)](https://azure.microsoft.com/services/virtual-machines/sql-server/). To learn more about SQL Server on Azure VMs, see the [overview](sql-server-on-azure-vm-iaas-what-is-overview.md).
2020

21+
## October 2021
22+
23+
24+
| Changes | Details |
25+
| --- | --- |
26+
| **SQL IaaS extension now supports Ubuntu** | Support has been added to [register](../linux/sql-iaas-agent-extension-register-vm-linux.md) your SQL Server VM running on Ubuntu linux with the [SQL Server IaaS Extension](../linux/sql-server-iaas-agent-extension-linux.md) for limited functionality. |
27+
28+
2129
## September 2021
2230

2331
| Changes | Details |

‎articles/azure-sql/virtual-machines/windows/sql-agent-extension-automatic-registration-all-vms.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.subservice: management
99
ms.topic: how-to
1010
ms.tgt_pltfrm: vm-windows-sql-server
1111
ms.workload: iaas-sql-server
12-
ms.date: 9/01/2021
12+
ms.date: 10/26/2021
1313
ms.custom: devx-track-azurepowershell
1414
ms.reviewer: mathoma
1515
---
@@ -35,9 +35,14 @@ When automatic registration is enabled, a job runs daily to detect whether or no
3535

3636
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.
3737

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+
3840
> [!IMPORTANT]
3941
> 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.
4042
43+
44+
45+
4146
## Prerequisites
4247

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

0 commit comments

Comments
 (0)