Sql Virtual Machines - List By Resource Group

服务:

SQL VM

API 版本:

2022-02-01

获取资源组中的所有 SQL 虚拟机。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines?api-version=2022-02-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
subscriptionId	path	True	string	标识 Azure 订阅的订阅 ID。
api-version	query	True	string	要用于请求的 API 版本。

响应

名称	类型	说明
200 OK	SqlVirtualMachineListResult	已成功检索到资源组中的所有 SQL 虚拟机。
Other Status Codes		错误响应： *** 400 RestoreJobIdsMismatch - 还原作业 ID 不匹配，当前还原作业 ID 在输入 {0}时 {1}。 400 RestoreJobSetToAutoCutover - 还原作业设置为 AutoCutover。 除取消之外，不会接受任何作。 400 AutoBackupEncryptionPasswordNotSpecified - 启用加密作为自动备份设置时未提供密码。 400 BackupScheduleTypeNotSet - 需要设置备份计划类型。 400 BackupStorageCredentialsNotSpecified - 未指定备份存储凭据。 400 KeyVaultCredentialsNotSpecified - 未指定密钥保管库凭据。 400 SqlCredentialsNotSpecified - 未指定 SQL Server 凭据。 400 IncompleteAutoPatchingSettings - 指定的不完整自动修补设置。 400 IncompleteAutoBackupSettings - 指定的自动备份设置不完整。 400 IncompleteSqlStorageSettings - 指定的不完整 SQL 存储设置。 400 InvalidVmResourceIdChange - 无法更新虚拟机资源 ID 属性。 400 SqlVmAlreadyIncludedInGroup - 不能在同一作中将 SQL 虚拟机从一个组移动到另一个组。 400 SqlVmCannotRemoveFromGroup - 无法从组中删除 SQL 虚拟机。 400 VmLocationMismatch - VM 位置与 SQL 虚拟机的位置不匹配。 400 VmInsufficientPermission - 对 Vm 的权限不足。 400 SingleNicOnVmAllowed - SQL VM 组中仅允许单个 NIC 虚拟机。 400 InvalidSqlVmGroupResourceIdParameterValue - SQL 虚拟机组资源 ID 格式不正确。 400 MismatchVmGroupSubscription - SQL 虚拟机和 SQL 虚拟机组的订阅 ID 不同。 400 IncompleteDomainCredentialsProperty - 为域凭据属性提供的输入不完整。 400 BYOLChangeToPAYGNotSupported - BYOL 图像不支持从 AHUB 转换为 PAYG 400 InvalidVmResourceIdParameterValue - 提供的虚拟机资源 ID 无效。 400 MismatchInSqlVmAndVmResourceIdSubscription - SQL 虚拟机和虚拟机资源 ID 属性的订阅 ID 不匹配。 400 MismatchSqlVmAndVmName - SQL 虚拟机名称与 VirtualMachineResourceId 属性上提供的虚拟机名称不同。 400 MismatchSqlVmAndVmRgName - SQL 虚拟机资源组名称与 VirtualMachineResourceId 属性上提供的虚拟机资源组名称不同。 400 NotSupportedSqlVmOSVersion - 虚拟机 OS 类型不是 Windows。 仅支持 Windows OS 版本 400 VmNotRunning - VM 未处于运行状态。 400 VmAgentNotRunning - VM 代理未安装或处于运行状态。 400 PAYGNotSupportedForNonGalleryVM - 许可证类型 PAYG 对于此虚拟机无效，因为这不是从 Azure 市场映像创建的。 400 CannotDetermineSqlVersionAndEditionFromVm - Sql IaaS 扩展无法确定 VM 中的 SQL 版本和版本。 400 MismatchSqlVmSku - Sql 虚拟机 sku 不匹配。 400 CannotConvertToFreeBenefit - 无法将免费 SQL 版本转换为 {0}。 400 SqlEvaluationSkuNotSupported - SQL 评估版本不支持许可更改。 400 IncompleteStorageConfigurationSettings - 不完整的存储配置设置 400 InvalidDefaultFilePath - 默认文件路径无效 400 InvalidLUNSpecified - 指定的逻辑单元号无效，逻辑单元数应为非负数。 400 BothStorageV1V2Specified - 请求无效。 应仅指定一个 SQL 存储存储设置或存储配置设置 400 InvalidLUNsSpecifiedForSameDrive - 指定的逻辑单元数无效。 用于同一驱动器的逻辑单元号需要相同。 400 InvalidLUNsSpecifiedForDifferentDrives - 指定的逻辑单元数无效。 不同的驱动器不能重复使用相同的逻辑单元号。 400 InvalidExtendPayload - 无效的 Sql 存储设置扩展有效负载。 一次仅支持扩展一个驱动器。 400 SqlLicenseTypeMissing - 请为 Sql 虚拟机指定许可证类型。 该属性为“SqlServerLicenceType”，允许的值为 PAYG、AHUB 和 DR。 400 VmAgentIsRunningForNoAgent - 在来宾代理运行时无法创建或更新为 NoAgent 模型。 400 InvalidSqlManagementMode - 无法将 SQL 管理模式更新为 {0}，当前模式 {1}。 请将属性“SqlManagement”的值指定为 {1}。 400 CannotDetermineSqlEditionFromRequest - 无法确定 SQL 版本。 400 SqlManagementMissing - 请指定 Sql 虚拟机的管理模式。 该属性为“SqlManagement”，允许的值为 LightWeight 或 Full。 400 SqlImageSkuMissingNoAgent - 请在 NoAgent 模式下为 Sql 虚拟机指定 Sql Server Edition。 该属性为“SqlImageSku”，允许的值为 Developer、Express、Web、Standard 或 Enterprise。 400 SqlImageOfferMissingNoAgent - 请在 NoAgent 模式下为 Sql 虚拟机指定 Sql Server 版本和 OS 版本。 该属性为“SqlImageOffer”，允许的值 SQL2008-WS2008 和SQL2008R2-WS2008。 400 InvalidSqlImageOfferChange - 无法更新 SqlImageOffer 属性。 400 SqlLicenseTypeNotSupported - SqlLicenseType NotSet 未正确提供 400 UnsupportedSqlManagementMode - 无法将 SQL 管理模式更新为 {0}，{1}仅支持 {2} 模式。 400 SqlVmInValidState - 无法删除 SqlVm，因为它已预配。 400 ClusterOperatorAccountIsEmpty - 当群集作员帐户为 null 或为空时，无法将 VM 添加到 SQLVM 组。 请更新组资源：使用群集作员帐户 {0}。 400 SqlServiceAccountIsEmpty - 当 SQL 服务帐户为 null 或为空时，无法将 VM 添加到 SQLVM 组。 请更新组资源：使用 SQL 服务帐户 {0}。 400 UnknownSqlManagementMode - 无法将 SQL 管理模式更新为 {0}，请使用其中一个受支持的值。 400 CandidateCurrentTimeIsAfterRegEndTime - 不能将候选实体注册为允许的结束时间 {0}之后的当前时间 {1}。 400 CandidateRegStartTimeIsAfterRegEndTime - 无法将候选实体注册为允许的开始时间，{0} 在允许的结束时间之后 {1}。 400 VmOsTypeNotFound - 找不到 OS 类型。 400 SqlLicenseManagementNotAllowed - 请将 sql vm 资源的许可证类型设置为 null。 此云目前不支持许可证类型可管理性。 400 IPNotInSubnet - IP 不是子网的一部分。 400 InvalidSqlSkuUpdate - 阻止许可证类型管理时，无法更新 SqlImageSku 属性。 400 VmOsVersionIsUnsupported - 不支持 OS 版本。 400 RedeployIsNotSupported - 未预配 SqlVm 时不支持重新部署。 400 InvalidLightweightMode - SQL VM 管理模式无效。 请将 SQL VM 属性“SqlManagement”更改为 FULL 400 InvalidAssessmentSettingsEnableIsFalse - 指定的评估设置无效。 启用必须设置为 true 才能使用其他评估设置。 400 SqlInstanceSettingsSet1NotAllowed - SQL 实例设置 MAXDOP，如果禁用功能开关，则不允许配置排序规则 400 InvalidAssessmentScheduleSettings - 指定的评估计划设置无效。 400 LinuxDistroIsNotSupported - 不支持 Linux 发行版 400 SqlServerSettingCollationNotAllowedToUpdate - 不允许在可管理性中更新 SQL Server 排序规则。 400 SqlServerSettingMinMemoryGreaterThanMaxMemory - SQL Server Min Server Memory （MB） 不能大于 Max Server Memory （MB） 400 SqlInstanceSettingsSet2NotAllowed - 如果禁用功能交换机，则不允许配置针对临时工作负荷、最小服务器内存（MB）和最大服务器内存（MB）的 SQL 实例设置优化 400 ClusterIpShouldBeEmpty - 对于单个子网侦听器，参数 wsfcStaticIp 应为空 400 InvalidClusterIpAddress - 提供的群集 IP 地址无效。 400 SqlServerSettingLPIMNotAllowedToUpdate - 不允许在可管理性中更新 SQL Server 锁定页。 400 SqlServerSettingIFINotAllowedToUpdate - 不允许在可管理性中更新 SQL Server IFI。 400 InvalidFileSizeSpecified - 请求无效。 文件大小不能为负 400 InvalidFileCountSpecified - 请求无效。 文件计数不能为负数 400 SubscriptionNotReady - 订阅未就绪 400 SqlVersionMismatchWithGroup - SQL 版本与 SQL 虚拟机组不匹配。 400 VmOSVersionMismatchWithGroup - OS 版本与组不匹配。 400 SqlSkuMismatchWithGroup - 在 SQL 虚拟机组上设置的 SQL sku 与 SQL 虚拟机的 SKU 不匹配。 400 InvalidParameterValue - 为参数提供无效值。 400 RPGenericUser - 调用其他资源提供程序时用户失败。 400 RPResponseMissingAsyncOperationHeader - 响应缺少异步作标头信息 400 InvalidArgument - 参数无效“{0}”。 400 ArgumentNotInRange - 参数“{0}”不在范围内。 400 ResourceNotProvisioned - 由于资源：{0} 未处于预配状态，因此无法继续请求 400 CRPNotAllowedOperation - 由于以下错误，无法完成作： {0} 400 AadAppDisabled - Microsoft租户中禁用了 AAD 应用 SQLVMResourceProviderAuth（{0}）。 400 InvalidRgResourceId - 指定的资源组资源 ID 无效。 400 InternalAPIAccessDenied - 内部 API 访问被拒绝。 应用 ID {0} 使用此 API 无效。 403 AccessDenied - 访问被拒绝。 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - 订阅在资源组中没有 SQL 虚拟机实例。 404 SubscriptionDoesNotExist - 订阅 ID 不存在。 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - 订阅在资源组中没有 SQL 虚拟机组。 404 ResourceNotFound - 找不到请求的资源。 404 SubscriptionDoesNotExist - 订阅 ID 不存在。 404 ResourceDoesNotExist - 资源不存在。 404 RPOperationNotFound - 找不到作 404 OperationIdNotFound - 找不到作 ID。 404 OperationTypeNotFound - 找不到作类型。 409 IPNotAvailable - IP {0} 在{1}不可用。 请考虑使用一个 from （{2}） 409 IpAddressAlreadyReserved - 为此侦听器保留的 IP 地址已存在。 请使用 IP 地址 409 ResourceAlreadyExists - 资源已存在。 409 LBGenericErrors - LB作失败 409 NICGenericError - NIC作失败 409 SqlExtensionNotInstalled - 未安装 SQL 扩展。 409 RPPluginSubstatusMissing - 缺少 RP 插件子状态 409 MissingMoveResources - 无法移动资源，因为请求中缺少某些资源。 409 ResourceExists - 清理资源时出现内部错误。 409 SubscriptionOperationInProgress - 订阅的作正在进行中 409 OperationInProgress - 已在资源上执行作。 409 OperationCanceled -作已取消。 429 TooManyRequestsReceived - 请求因请求过多而受到限制。 429 ArgumentMissingForSetup - 安装程序缺少参数。 请提供参数的值。 429 MultiSubnetOperationNotAllowed - 不允许执行多子网 HA 设置作。 500 RPGenericSystem - 调用其他资源提供程序时系统故障。 500 UnExpectedErrorOccurred - 发生意外错误。 500 OperationTimeout -作超时。

示例

Gets all SQL virtual machines in a resource group.

示例请求

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines?api-version=2022-02-01

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Net;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.SqlVirtualMachine.Models;
using Azure.ResourceManager.SqlVirtualMachine;

// Generated from example definition: specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/stable/2022-02-01/examples/ListByResourceGroupSqlVirtualMachine.json
// this example is just showing the usage of "SqlVirtualMachines_ListByResourceGroup" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "testrg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this SqlVmResource
SqlVmCollection collection = resourceGroupResource.GetSqlVms();

// invoke the operation and iterate over the result
await foreach (SqlVmResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SqlVmData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

200

{
  "value": [
    {
      "properties": {
        "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm",
        "provisioningState": "Succeeded",
        "sqlImageOffer": "SQL2016-WS2016",
        "sqlImageSku": "Enterprise",
        "sqlServerLicenseType": "PAYG"
      },
      "location": "northeurope",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm",
      "name": "testvm",
      "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines"
    },
    {
      "properties": {
        "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm1",
        "provisioningState": "Succeeded",
        "sqlImageOffer": "SQL2017-WS2016",
        "sqlImageSku": "Enterprise",
        "sqlServerLicenseType": "PAYG"
      },
      "location": "northeurope",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm1",
      "name": "testvm1",
      "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines"
    }
  ]
}

定义

名称	说明
AdditionalFeaturesServerConfigurations	其他 SQL Server 功能设置。
AssessmentDayOfWeek	运行评估的一周中的一天。
AssessmentSettings	为 SQL 虚拟机中的数据库配置评估。
AutoBackupDaysOfWeek	当 FullBackupFrequency 设置为“每周”时，备份的一周中的天数。
AutoBackupSettings	为 SQL 虚拟机中的数据库配置备份。
AutoPatchingSettings	设置一个修补窗口，在此期间将应用 Windows 和 SQL 修补程序。
BackupScheduleType	备份计划类型。
ConnectivityType	SQL Server 连接选项。
createdByType	创建资源的标识的类型。
DayOfWeek	应用修补程序的一周中的一天。
DiskConfigurationType	要应用于 SQL Server 的磁盘配置。
FullBackupFrequencyType	完整备份的频率。 在这两种情况下，完整备份将在下一个计划的时间范围内开始。
IdentityType	标识类型。 将此设置为“SystemAssigned”，以便自动为资源创建和分配 Azure Active Directory 主体。
KeyVaultCredentialSettings	将 SQL 虚拟机配置为能够连接到 Azure Key Vault 服务。
ResourceIdentity	资源的 Azure Active Directory 标识配置。
Schedule
ServerConfigurationsManagementSettings	设置连接、存储和工作负荷设置。
SqlConnectivityUpdateSettings	设置 SQL Server 的访问级别和网络端口设置。
SqlImageSku	SQL Server 版本类型。
SQLInstanceSettings	设置 SQL Server 的服务器/实例级设置。
SqlManagementMode	SQL Server 管理类型。
SqlServerLicenseType	SQL Server 许可证类型。
SQLStorageSettings	设置 SQL Server 的磁盘存储设置。
SqlStorageUpdateSettings	设置 SQL Server 的磁盘存储设置。
SQLTempDbSettings
SqlVirtualMachine	SQL 虚拟机。
SqlVirtualMachineListResult	SQL 虚拟机的列表。
SqlWorkloadType	SQL Server 工作负荷类型。
SqlWorkloadTypeUpdateSettings	设置工作负荷类型以优化 SQL Server 的存储。
StorageConfigurationSettings	SQL 数据、日志和 TempDb 的存储配置。
StorageWorkloadType	存储工作负荷类型。
systemData	与创建和上次修改资源相关的元数据。
WsfcDomainCredentials	用于为 SQL 可用性组设置 Windows Server 故障转移群集的域凭据。

AdditionalFeaturesServerConfigurations

Object

其他 SQL Server 功能设置。

名称	类型	说明
isRServicesEnabled	boolean	启用或禁用 R 服务（SQL 2016 及更高版本）。

AssessmentDayOfWeek

枚举

运行评估的一周中的一天。

值	说明
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

AssessmentSettings

Object

为 SQL 虚拟机中的数据库配置评估。

名称	类型	说明
enable	boolean	在 SQL 虚拟机上启用或禁用评估功能。
runImmediately	boolean	立即在 SQL 虚拟机上运行评估。
schedule	Schedule	评估计划。

AutoBackupDaysOfWeek

枚举

当 FullBackupFrequency 设置为“每周”时，备份的一周中的天数。

值	说明
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

AutoBackupSettings

Object

为 SQL 虚拟机中的数据库配置备份。

名称	类型	说明
backupScheduleType	BackupScheduleType	备份计划类型。
backupSystemDbs	boolean	包括或排除自动备份中的系统数据库。
daysOfWeek	AutoBackupDaysOfWeek[]	当 FullBackupFrequency 设置为“每周”时，备份的一周中的天数。
enable	boolean	在 SQL 虚拟机上启用或禁用自动回退。
enableEncryption	boolean	启用或禁用 SQL 虚拟机上备份的加密。
fullBackupFrequency	FullBackupFrequencyType	完整备份的频率。 在这两种情况下，完整备份将在下一个计划的时间范围内开始。
fullBackupStartTime	integer (int32)	给定日期的开始时间，在此期间可以进行完整备份。 0-23 小时。
fullBackupWindowHours	integer (int32)	给定日期的时间窗口的持续时间，在此期间可以进行完整备份。 1-23 小时。
logBackupFrequency	integer (int32)	日志备份的频率。 5-60 分钟。
password	string	备份时加密的密码。
retentionPeriod	integer (int32)	备份的保留期：1-90 天。
storageAccessKey	string	将备份到的存储帐户密钥。
storageAccountUrl	string	将备份到的存储帐户 URL。
storageContainerName	string	将备份到的存储容器名称。

AutoPatchingSettings

Object

设置一个修补窗口，在此期间将应用 Windows 和 SQL 修补程序。

名称	类型	说明
dayOfWeek	DayOfWeek	应用修补程序的一周中的一天。
enable	boolean	在 SQL 虚拟机上启用或禁用自动修补。
maintenanceWindowDuration	integer (int32)	修补的持续时间。
maintenanceWindowStartingHour	integer (int32)	开始修补的一天中的一小时。 本地 VM 时间。

BackupScheduleType

枚举

备份计划类型。

值	说明
Automated
Manual

ConnectivityType

枚举

SQL Server 连接选项。

值	说明
LOCAL
PRIVATE
PUBLIC

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

DayOfWeek

枚举

应用修补程序的一周中的一天。

值	说明
Everyday
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

DiskConfigurationType

枚举

要应用于 SQL Server 的磁盘配置。

值	说明
ADD
EXTEND
NEW

FullBackupFrequencyType

枚举

完整备份的频率。 在这两种情况下，完整备份将在下一个计划的时间范围内开始。

值	说明
Daily
Weekly

IdentityType

枚举

标识类型。 将此设置为“SystemAssigned”，以便自动为资源创建和分配 Azure Active Directory 主体。

值	说明
None
SystemAssigned

KeyVaultCredentialSettings

Object

将 SQL 虚拟机配置为能够连接到 Azure Key Vault 服务。

名称	类型	说明
azureKeyVaultUrl	string	Azure Key Vault URL。
credentialName	string	凭据名称。
enable	boolean	启用或禁用密钥保管库凭据设置。
servicePrincipalName	string	用于访问密钥保管库的服务主体名称。
servicePrincipalSecret	string	用于访问密钥保管库的服务主体名称机密。

ResourceIdentity

Object

资源的 Azure Active Directory 标识配置。

名称	类型	说明
principalId	string (uuid)	Azure Active Directory 主体 ID。
tenantId	string (uuid)	Azure Active Directory 租户 ID。
type	IdentityType	标识类型。 将此设置为“SystemAssigned”，以便自动为资源创建和分配 Azure Active Directory 主体。

Schedule

Object

名称	类型	说明
dayOfWeek	AssessmentDayOfWeek	运行评估的一周中的一天。
enable	boolean	在 SQL 虚拟机上启用或禁用评估计划。
monthlyOccurrence	integer (int32)	在一个月内发生 DayOfWeek 日期以安排评估。 采用值：1,2,3,4 和 -1。 对月份的最后一天使用 -1 OfWeek 日期
startTime	string	以 HH：mm 格式表示的一天时间。例如17:30
weeklyInterval	integer (int32)	计划 2 个评估运行之间的周数。 从 1-6 获取值

ServerConfigurationsManagementSettings

Object

设置连接、存储和工作负荷设置。

名称	类型	说明
additionalFeaturesServerConfigurations	AdditionalFeaturesServerConfigurations	其他 SQL 功能设置。
sqlConnectivityUpdateSettings	SqlConnectivityUpdateSettings	SQL 连接类型设置。
sqlInstanceSettings	SQLInstanceSettings	SQL 实例设置。
sqlStorageUpdateSettings	SqlStorageUpdateSettings	SQL 存储更新设置。
sqlWorkloadTypeUpdateSettings	SqlWorkloadTypeUpdateSettings	SQL 工作负荷类型设置。

SqlConnectivityUpdateSettings

Object

设置 SQL Server 的访问级别和网络端口设置。

名称	类型	说明
connectivityType	ConnectivityType	SQL Server 连接选项。
port	integer (int32)	SQL Server 端口。
sqlAuthUpdatePassword	string	SQL Server sysadmin 登录密码。
sqlAuthUpdateUserName	string	要创建的 SQL Server sysadmin 登录名。

SqlImageSku

枚举

SQL Server 版本类型。

值	说明
Developer
Enterprise
Express
Standard
Web

SQLInstanceSettings

Object

设置 SQL Server 的服务器/实例级设置。

名称	类型	说明
collation	string	SQL Server 排序规则。
isIfiEnabled	boolean	SQL Server IFI。
isLpimEnabled	boolean	SQL Server LPIM。
isOptimizeForAdHocWorkloadsEnabled	boolean	SQL Server Optimize for Adhoc workloads.
maxDop	integer (int32)	SQL Server MAXDOP。
maxServerMemoryMB	integer (int32)	SQL Server 最大内存。
minServerMemoryMB	integer (int32)	SQL Server 最小内存。

SqlManagementMode

枚举

SQL Server 管理类型。

值	说明
Full
LightWeight
NoAgent

SqlServerLicenseType

枚举

SQL Server 许可证类型。

值	说明
AHUB
DR
PAYG

SQLStorageSettings

Object

设置 SQL Server 的磁盘存储设置。

名称	类型	说明
defaultFilePath	string	SQL Server 默认文件路径
luns	integer[] (int32)	磁盘的逻辑单元号。

SqlStorageUpdateSettings

Object

设置 SQL Server 的磁盘存储设置。

名称	类型	说明
diskConfigurationType	DiskConfigurationType	要应用于 SQL Server 的磁盘配置。
diskCount	integer (int32)	虚拟机磁盘计数。
startingDeviceId	integer (int32)	要更新的第一个磁盘的设备 ID。

SQLTempDbSettings

Object

名称	类型	说明
dataFileCount	integer (int32)	SQL Server tempdb 数据文件计数
dataFileSize	integer (int32)	SQL Server tempdb 数据文件大小
dataGrowth	integer (int32)	SQL Server tempdb 数据文件自动增长大小
defaultFilePath	string	SQL Server 默认文件路径
logFileSize	integer (int32)	SQL Server tempdb 日志文件大小
logGrowth	integer (int32)	SQL Server tempdb 日志文件自动增长大小
luns	integer[] (int32)	磁盘的逻辑单元号。
persistFolder	boolean	SQL Server tempdb persist 文件夹选项
persistFolderPath	string	SQL Server tempdb 保留文件夹位置

SqlVirtualMachine

Object

SQL 虚拟机。

名称	类型	说明
id	string	资源 ID。
identity	ResourceIdentity	服务器的 Azure Active Directory 标识。
location	string	资源位置。
name	string	资源名称。
properties.assessmentSettings	AssessmentSettings	评估设置。
properties.autoBackupSettings	AutoBackupSettings	SQL Server 的自动备份设置。
properties.autoPatchingSettings	AutoPatchingSettings	自动修补设置，用于将关键安全更新应用到 SQL 虚拟机。
properties.keyVaultCredentialSettings	KeyVaultCredentialSettings	密钥保管库凭据设置。
properties.provisioningState	string	用于跟踪异步作状态的预配状态。
properties.serverConfigurationsManagementSettings	ServerConfigurationsManagementSettings	SQL Server 配置管理设置。
properties.sqlImageOffer	string	SQL 映像产品/服务。 示例包括 SQL2016-WS2016、SQL2017-WS2016。
properties.sqlImageSku	SqlImageSku	SQL Server 版本类型。
properties.sqlManagement	SqlManagementMode	SQL Server 管理类型。
properties.sqlServerLicenseType	SqlServerLicenseType	SQL Server 许可证类型。
properties.sqlVirtualMachineGroupResourceId	string	此 SQL 虚拟机所属的 SQL 虚拟机组的 ARM 资源 ID 或将成为其中的一部分。
properties.storageConfigurationSettings	StorageConfigurationSettings	存储配置设置。
properties.virtualMachineResourceId	string	从 SQL 市场映像创建的基础虚拟机的 ARM 资源 ID。
properties.wsfcDomainCredentials	WsfcDomainCredentials	用于为 SQL 可用性组设置 Windows Server 故障转移群集的域凭据。
properties.wsfcStaticIp	string	用于为 SQL 可用性组设置 Windows Server 故障转移群集的域凭据。
systemData	systemData	与创建和上次修改资源相关的元数据。
tags	object	资源标记。
type	string	资源类型。

SqlVirtualMachineListResult

Object

SQL 虚拟机的列表。

名称	类型	说明
nextLink	string	用于检索下一页结果的链接。
value	SqlVirtualMachine[]	结果数组。

SqlWorkloadType

枚举

SQL Server 工作负荷类型。

值	说明
DW
GENERAL
OLTP

SqlWorkloadTypeUpdateSettings

Object

设置工作负荷类型以优化 SQL Server 的存储。

名称	类型	说明
sqlWorkloadType	SqlWorkloadType	SQL Server 工作负荷类型。

StorageConfigurationSettings

Object

SQL 数据、日志和 TempDb 的存储配置。

名称	类型	说明
diskConfigurationType	DiskConfigurationType	要应用于 SQL Server 的磁盘配置。
sqlDataSettings	SQLStorageSettings	SQL Server 数据存储设置。
sqlLogSettings	SQLStorageSettings	SQL Server 日志存储设置。
sqlSystemDbOnDataDisk	boolean	DataPool 上的 SQL Server SystemDb 存储（如果为 true）。
sqlTempDbSettings	SQLTempDbSettings	SQL Server TempDb 存储设置。
storageWorkloadType	StorageWorkloadType	存储工作负荷类型。

StorageWorkloadType

枚举

存储工作负荷类型。

值	说明
DW
GENERAL
OLTP

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

WsfcDomainCredentials

Object

用于为 SQL 可用性组设置 Windows Server 故障转移群集的域凭据。

名称	类型	说明
clusterBootstrapAccountPassword	string	群集启动帐户密码。
clusterOperatorAccountPassword	string	群集操作员帐户密码。
sqlServiceAccountPassword	string	SQL 服务帐户密码。