Поделиться через


Microsoft.SqlVirtualMachine sqlVirtualMachines

Определение ресурсов Bicep

Тип ресурса sqlVirtualMachines можно развернуть с помощью операций, целевых:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.SqlVirtualMachine/sqlVirtualMachines, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.SqlVirtualMachine/sqlVirtualMachines@2023-10-01' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    assessmentSettings: {
      enable: bool
      runImmediately: bool
      schedule: {
        dayOfWeek: 'string'
        enable: bool
        monthlyOccurrence: int
        startTime: 'string'
        weeklyInterval: int
      }
    }
    autoBackupSettings: {
      backupScheduleType: 'string'
      backupSystemDbs: bool
      daysOfWeek: [
        'string'
      ]
      enable: bool
      enableEncryption: bool
      fullBackupFrequency: 'string'
      fullBackupStartTime: int
      fullBackupWindowHours: int
      logBackupFrequency: int
      password: 'string'
      retentionPeriod: int
      storageAccessKey: 'string'
      storageAccountUrl: 'string'
      storageContainerName: 'string'
    }
    autoPatchingSettings: {
      additionalVmPatch: 'string'
      dayOfWeek: 'string'
      enable: bool
      maintenanceWindowDuration: int
      maintenanceWindowStartingHour: int
    }
    enableAutomaticUpgrade: bool
    keyVaultCredentialSettings: {
      azureKeyVaultUrl: 'string'
      credentialName: 'string'
      enable: bool
      servicePrincipalName: 'string'
      servicePrincipalSecret: 'string'
    }
    leastPrivilegeMode: 'string'
    serverConfigurationsManagementSettings: {
      additionalFeaturesServerConfigurations: {
        isRServicesEnabled: bool
      }
      azureAdAuthenticationSettings: {
        clientId: 'string'
      }
      sqlConnectivityUpdateSettings: {
        connectivityType: 'string'
        port: int
        sqlAuthUpdatePassword: 'string'
        sqlAuthUpdateUserName: 'string'
      }
      sqlInstanceSettings: {
        collation: 'string'
        isIfiEnabled: bool
        isLpimEnabled: bool
        isOptimizeForAdHocWorkloadsEnabled: bool
        maxDop: int
        maxServerMemoryMB: int
        minServerMemoryMB: int
      }
      sqlStorageUpdateSettings: {
        diskConfigurationType: 'string'
        diskCount: int
        startingDeviceId: int
      }
      sqlWorkloadTypeUpdateSettings: {
        sqlWorkloadType: 'string'
      }
    }
    sqlImageOffer: 'string'
    sqlImageSku: 'string'
    sqlManagement: 'string'
    sqlServerLicenseType: 'string'
    sqlVirtualMachineGroupResourceId: 'string'
    storageConfigurationSettings: {
      diskConfigurationType: 'string'
      enableStorageConfigBlade: bool
      sqlDataSettings: {
        defaultFilePath: 'string'
        luns: [
          int
        ]
        useStoragePool: bool
      }
      sqlLogSettings: {
        defaultFilePath: 'string'
        luns: [
          int
        ]
        useStoragePool: bool
      }
      sqlSystemDbOnDataDisk: bool
      sqlTempDbSettings: {
        dataFileCount: int
        dataFileSize: int
        dataGrowth: int
        defaultFilePath: 'string'
        logFileSize: int
        logGrowth: int
        luns: [
          int
        ]
        persistFolder: bool
        persistFolderPath: 'string'
        useStoragePool: bool
      }
      storageWorkloadType: 'string'
    }
    virtualMachineIdentitySettings: {
      resourceId: 'string'
      type: 'string'
    }
    virtualMachineResourceId: 'string'
    wsfcDomainCredentials: {
      clusterBootstrapAccountPassword: 'string'
      clusterOperatorAccountPassword: 'string'
      sqlServiceAccountPassword: 'string'
    }
    wsfcStaticIp: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Значения свойств

AADAuthenticationSettings

Имя Описание Ценность
clientId Идентификатор клиента управляемого удостоверения для запроса API Microsoft Graph. Пустая строка должна использоваться для назначаемого системой управляемого удостоверения струна

ДополнительныеfeaturesServerConfigurations

Имя Описание Ценность
isRServicesEnabled Включите или отключите службы R (SQL 2016 и более поздних версий). bool

ОценкиSettings

Имя Описание Ценность
давать возможность Включите или отключите функцию оценки рекомендаций SQL на виртуальной машине SQL. bool
runImmediately Запустите оценку рекомендаций SQL сразу же на виртуальной машине SQL. bool
расписание Планирование оценки рекомендаций SQL. расписания

AutoBackupSettings

Имя Описание Ценность
backupScheduleType Тип расписания резервного копирования. "Автоматизировано"
"Вручную"
backupSystemDbs Включите или исключите системные базы данных из автоматического резервного копирования. bool
daysOfWeek Дни недели для резервных копий, когда FullBackupFrequency имеет значение Weekly. Массив строк, содержащий любой из:
"Пятница"
"Понедельник"
"Суббота"
"Воскресенье"
"Четверг"
"Вторник"
"Среда"
давать возможность Включение или отключение автоматического восстановления на виртуальной машине SQL. bool
enableEncryption Включение или отключение шифрования для резервного копирования на виртуальной машине SQL. bool
fullBackupFrequency Частота полных резервных копий. В обоих случаях полное резервное копирование начинается во время следующего запланированного периода времени. "Ежедневно"
"Еженедельно"
fullBackupStartTime Время начала заданного дня, в течение которого могут выполняться полные резервные копии. 0–23 часа. int
fullBackupWindowHours Длительность периода времени заданного дня, в течение которого могут выполняться полные резервные копии. 1–23 часа. int
logBackupFrequency Частота резервного копирования журналов. 5–60 минут. int
пароль Пароль для шифрования при резервном копировании. струна
retentionPeriod Период хранения резервного копирования: 1–90 дней. int
storageAccessKey Ключ учетной записи хранения, в который будет выполняться резервное копирование. струна
storageAccountUrl URL-адрес учетной записи хранения, в который будет выполняться резервное копирование. струна
storageContainerName Имя контейнера хранилища, в котором будет выполняться резервное копирование. струна

AutoPatchingSettings

Имя Описание Ценность
additionalVmPatch Дополнительное исправление для включения или включения на виртуальной машине SQL. "MicrosoftUpdate"
NotSet
dayOfWeek День недели, на который будет применено исправление. "Каждый день"
"Пятница"
"Понедельник"
"Суббота"
"Воскресенье"
"Четверг"
"Вторник"
"Среда"
давать возможность Включите или отключите автоматическое заполнение на виртуальной машине SQL. bool
maintenanceWindowDuration Длительность исправления. int
maintenanceWindowStartingHour Час дня при инициировании исправления. Время локальной виртуальной машины. int

KeyVaultCredentialSettings

Имя Описание Ценность
azureKeyVaultUrl URL-адрес Azure Key Vault. струна
credentialName Имя учетных данных. струна
давать возможность Включите или отключите параметр учетных данных хранилища ключей. bool
servicePrincipalName Имя субъекта-службы для доступа к хранилищу ключей. струна
servicePrincipalSecret Секрет имени субъекта-службы для доступа к хранилищу ключей. струна

Microsoft.SqlVirtualMachine/sqlVirtualMachines

Имя Описание Ценность
тождество НЕ ИСПОЛЬЗУЙТЕ. Это значение будет устарело. Удостоверение сервера Azure Active Directory. ResourceIdentity
местоположение Расположение ресурса. строка (обязательно)
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 64
Pattern = ^((?!_)[^\\/"'\[\]:|<>+=;,?*@&]{1,64}(?<![.-]))$ (обязательно)
свойства Свойства ресурса. SqlVirtualMachineProperties
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

ResourceIdentity

Имя Описание Ценность
тип Тип удостоверения. Установите для параметра SystemAssigned значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

Расписание

Имя Описание Ценность
dayOfWeek День недели для выполнения оценки. "Пятница"
"Понедельник"
"Суббота"
"Воскресенье"
"Четверг"
"Вторник"
"Среда"
давать возможность Включение или отключение расписания оценки на виртуальной машине SQL. bool
monthlyOccurrence Вхождения дня DayOfWeek в течение месяца для планирования оценки. Принимает значения: 1,2,3,4 и -1. Использование -1 для последнего дня ДняOfWeek месяца int
startTime Время дня в формате HH:mm. Например. 17:30 струна
еженедельноInterval Количество недель для планирования между 2 запусками оценки. Принимает значение от 1 до 6 int

ServerConfigurationsManagementSettings

Имя Описание Ценность
additionalFeaturesServerConfigurations Дополнительные параметры компонентов SQL. AdditionalFeaturesServerConfigurations
azureAdAuthenticationSettings Параметры проверки подлинности Azure AD. AADAuthenticationSettings
sqlConnectivityUpdateSettings Параметры типа подключения SQL. SqlConnectivityUpdateSettings
sqlInstanceSettings Параметры экземпляра SQL. SQLInstanceSettings
sqlStorageUpdateSettings Параметры обновления хранилища SQL. SqlStorageUpdateSettings
sqlWorkloadTypeUpdateSettings Параметры типа рабочей нагрузки SQL. SqlWorkloadTypeUpdateSettings

SqlConnectivityUpdateSettings

Имя Описание Ценность
connectivityType Параметр подключения SQL Server. "LOCAL"
"PRIVATE"
"PUBLIC"
порт Порт SQL Server. int
sqlAuthUpdatePassword Пароль для входа sysadmin в SQL Server. струна
sqlAuthUpdateUserName Имя входа sysadmin SQL Server для создания. струна

SQLInstanceSettings

Имя Описание Ценность
закуска Параметры сортировки SQL Server. струна
isIfiEnabled SQL Server IFI. bool
isLpimEnabled SQL Server LPIM. bool
isOptimizeForAdHocWorkloadsEnabled SQL Server Optimize for Adhoc workloads. bool
maxDop SQL Server MAXDOP. int
maxServerMemoryMB Максимальная память SQL Server. int
minServerMemoryMB Минимальная память SQL Server. int

SQLStorageSettings

Имя Описание Ценность
defaultFilePath Путь к файлу sql Server по умолчанию струна
luns Логические номера единиц для дисков. int[]
useStoragePool Использование пула носителей для создания диска, если задано значение true или не указано bool

SqlStorageUpdateSettings

Имя Описание Ценность
diskConfigurationType Конфигурация диска для применения к SQL Server. 'ADD'
"РАСШИРЕНИЕ"
"NEW"
diskCount Число дисков виртуальной машины. int
startingDeviceId Идентификатор устройства первого диска, который необходимо обновить. int

SQLTempDbSettings

Имя Описание Ценность
dataFileCount Количество файлов данных tempdb SQL Server int
dataFileSize Размер файла данных tempdb SQL Server int
dataGrowth Размер файла данных tempdb SQL Server autoGrowth int
defaultFilePath Путь к файлу sql Server по умолчанию струна
logFileSize Размер файла журнала tempdb SQL Server int
logGrowth Размер файла журнала tempdb SQL Server autoGrowth int
luns Логические номера единиц для дисков. int[]
persistFolder Выбор папки базы данных tempdb SQL Server bool
persistFolderPath Расположение папки хранения базы данных tempdb SQL Server струна
useStoragePool Использование пула носителей для создания диска, если задано значение true или не указано bool

SqlVirtualMachineProperties

Имя Описание Ценность
assessmentSettings Параметры оценки рекомендаций SQL. AssessmentSettings
autoBackupSettings Параметры автоматического резервного копирования для SQL Server. AutoBackupSettings
autoPatchingSettings Параметры автоматического исправления для применения критически важных обновлений системы безопасности к виртуальной машине SQL. AutoPatchingSettings
enableAutomaticUpgrade Включите автоматическое обновление агента расширения IaaS Sql. bool
keyVaultCredentialSettings Параметры учетных данных хранилища ключей. KeyVaultCredentialSettings
leastPrivilegeMode Режим наименьших привилегий агента IaaS SQL. "Включено"
NotSet
serverConfigurationsManagementSettings Параметры управления конфигурацией SQL Server. ServerConfigurationsManagementSettings
sqlImageOffer Предложение образа SQL. Примеры включают SQL2016-WS2016, SQL2017-WS2016. струна
sqlImageSku Тип выпуска SQL Server. 'Разработчик'
"Enterprise"
Express
"Стандартный"
"Интернет"
sqlManagement Тип управления SQL Server. ПРИМЕЧАНИЕ. Этот параметр больше не используется. API автоматически обнаруживает управление SQL, воздерживаться от его использования. "Full"
"Легкий вес"
NoAgent
sqlServerLicenseType Тип лицензии SQL Server. "AHUB"
"DR"
PayG
sqlVirtualMachineGroupResourceId Идентификатор ресурса ARM группы виртуальных машин SQL, включаемой в эту виртуальную машину SQL, или будет частью этой виртуальной машины. струна
storageConfigurationSettings Параметры конфигурации хранилища. StorageConfigurationSettings
virtualMachineIdentitySettings Сведения об удостоверении виртуальной машины, используемые для конфигураций расширений IaaS sql. VirtualMachineIdentity
virtualMachineResourceId Идентификатор ресурса ARM базовой виртуальной машины, созданной на основе образа SQL Marketplace. струна
wsfcDomainCredentials Учетные данные домена для настройки отказоустойчивого кластера Windows Server для группы доступности SQL. WsfcDomainCredentials
wsfcStaticIp Учетные данные домена для настройки отказоустойчивого кластера Windows Server для группы доступности SQL. струна

SqlWorkloadTypeUpdateSettings

Имя Описание Ценность
sqlWorkloadType Тип рабочей нагрузки SQL Server. DW
"ОБЩИЕ"
OLTP

StorageConfigurationSettings

Имя Описание Ценность
diskConfigurationType Конфигурация диска для применения к SQL Server. 'ADD'
"РАСШИРЕНИЕ"
"NEW"
enableStorageConfigBlade Включите колонку конфигурации хранилища агента IaaS SQL на портале Azure. bool
sqlDataSettings Параметры хранилища данных SQL Server. SQLStorageSettings
sqlLogSettings Параметры хранилища журналов SQL Server. SQLStorageSettings
sqlSystemDbOnDataDisk Хранилище SQL Server SystemDb в DataPool, если значение true. bool
sqlTempDbSettings Параметры хранилища TempDb SQL Server. SQLTempDbSettings
storageWorkloadType Тип рабочей нагрузки хранилища. DW
"ОБЩИЕ"
OLTP

TrackedResourceTags

Имя Описание Ценность

VirtualMachineIdentity

Имя Описание Ценность
resourceId Идентификатор ресурса ARM удостоверения. Требуется только при выборе удостоверения UserAssigned. струна
тип Тип удостоверения виртуальной машины. Укажите none, чтобы отказаться от управляемых удостоверений. "Нет"
SystemAssigned
UserAssigned

WsfcDomainCredentials

Имя Описание Ценность
clusterBootstrapAccountPassword Пароль учетной записи начальной загрузки кластера. струна
clusterOperatorAccountPassword Пароль учетной записи оператора кластера. струна
sqlServiceAccountPassword Пароль учетной записи службы SQL. струна

Примеры использования

Примеры быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.

Bicep-файл Описание
виртуальной машине SQL Server с параметрами оптимизированного для производительности хранилища Создание виртуальной машины SQL Server с оптимизированными для производительности параметрами хранилища в PremiumSSD

Определение ресурса шаблона ARM

Тип ресурса sqlVirtualMachines можно развернуть с помощью операций, целевых:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.SqlVirtualMachine/sqlVirtualMachines, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines",
  "apiVersion": "2023-10-01",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "assessmentSettings": {
      "enable": "bool",
      "runImmediately": "bool",
      "schedule": {
        "dayOfWeek": "string",
        "enable": "bool",
        "monthlyOccurrence": "int",
        "startTime": "string",
        "weeklyInterval": "int"
      }
    },
    "autoBackupSettings": {
      "backupScheduleType": "string",
      "backupSystemDbs": "bool",
      "daysOfWeek": [ "string" ],
      "enable": "bool",
      "enableEncryption": "bool",
      "fullBackupFrequency": "string",
      "fullBackupStartTime": "int",
      "fullBackupWindowHours": "int",
      "logBackupFrequency": "int",
      "password": "string",
      "retentionPeriod": "int",
      "storageAccessKey": "string",
      "storageAccountUrl": "string",
      "storageContainerName": "string"
    },
    "autoPatchingSettings": {
      "additionalVmPatch": "string",
      "dayOfWeek": "string",
      "enable": "bool",
      "maintenanceWindowDuration": "int",
      "maintenanceWindowStartingHour": "int"
    },
    "enableAutomaticUpgrade": "bool",
    "keyVaultCredentialSettings": {
      "azureKeyVaultUrl": "string",
      "credentialName": "string",
      "enable": "bool",
      "servicePrincipalName": "string",
      "servicePrincipalSecret": "string"
    },
    "leastPrivilegeMode": "string",
    "serverConfigurationsManagementSettings": {
      "additionalFeaturesServerConfigurations": {
        "isRServicesEnabled": "bool"
      },
      "azureAdAuthenticationSettings": {
        "clientId": "string"
      },
      "sqlConnectivityUpdateSettings": {
        "connectivityType": "string",
        "port": "int",
        "sqlAuthUpdatePassword": "string",
        "sqlAuthUpdateUserName": "string"
      },
      "sqlInstanceSettings": {
        "collation": "string",
        "isIfiEnabled": "bool",
        "isLpimEnabled": "bool",
        "isOptimizeForAdHocWorkloadsEnabled": "bool",
        "maxDop": "int",
        "maxServerMemoryMB": "int",
        "minServerMemoryMB": "int"
      },
      "sqlStorageUpdateSettings": {
        "diskConfigurationType": "string",
        "diskCount": "int",
        "startingDeviceId": "int"
      },
      "sqlWorkloadTypeUpdateSettings": {
        "sqlWorkloadType": "string"
      }
    },
    "sqlImageOffer": "string",
    "sqlImageSku": "string",
    "sqlManagement": "string",
    "sqlServerLicenseType": "string",
    "sqlVirtualMachineGroupResourceId": "string",
    "storageConfigurationSettings": {
      "diskConfigurationType": "string",
      "enableStorageConfigBlade": "bool",
      "sqlDataSettings": {
        "defaultFilePath": "string",
        "luns": [ "int" ],
        "useStoragePool": "bool"
      },
      "sqlLogSettings": {
        "defaultFilePath": "string",
        "luns": [ "int" ],
        "useStoragePool": "bool"
      },
      "sqlSystemDbOnDataDisk": "bool",
      "sqlTempDbSettings": {
        "dataFileCount": "int",
        "dataFileSize": "int",
        "dataGrowth": "int",
        "defaultFilePath": "string",
        "logFileSize": "int",
        "logGrowth": "int",
        "luns": [ "int" ],
        "persistFolder": "bool",
        "persistFolderPath": "string",
        "useStoragePool": "bool"
      },
      "storageWorkloadType": "string"
    },
    "virtualMachineIdentitySettings": {
      "resourceId": "string",
      "type": "string"
    },
    "virtualMachineResourceId": "string",
    "wsfcDomainCredentials": {
      "clusterBootstrapAccountPassword": "string",
      "clusterOperatorAccountPassword": "string",
      "sqlServiceAccountPassword": "string"
    },
    "wsfcStaticIp": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Значения свойств

AADAuthenticationSettings

Имя Описание Ценность
clientId Идентификатор клиента управляемого удостоверения для запроса API Microsoft Graph. Пустая строка должна использоваться для назначаемого системой управляемого удостоверения струна

ДополнительныеfeaturesServerConfigurations

Имя Описание Ценность
isRServicesEnabled Включите или отключите службы R (SQL 2016 и более поздних версий). bool

ОценкиSettings

Имя Описание Ценность
давать возможность Включите или отключите функцию оценки рекомендаций SQL на виртуальной машине SQL. bool
runImmediately Запустите оценку рекомендаций SQL сразу же на виртуальной машине SQL. bool
расписание Планирование оценки рекомендаций SQL. расписания

AutoBackupSettings

Имя Описание Ценность
backupScheduleType Тип расписания резервного копирования. "Автоматизировано"
"Вручную"
backupSystemDbs Включите или исключите системные базы данных из автоматического резервного копирования. bool
daysOfWeek Дни недели для резервных копий, когда FullBackupFrequency имеет значение Weekly. Массив строк, содержащий любой из:
"Пятница"
"Понедельник"
"Суббота"
"Воскресенье"
"Четверг"
"Вторник"
"Среда"
давать возможность Включение или отключение автоматического восстановления на виртуальной машине SQL. bool
enableEncryption Включение или отключение шифрования для резервного копирования на виртуальной машине SQL. bool
fullBackupFrequency Частота полных резервных копий. В обоих случаях полное резервное копирование начинается во время следующего запланированного периода времени. "Ежедневно"
"Еженедельно"
fullBackupStartTime Время начала заданного дня, в течение которого могут выполняться полные резервные копии. 0–23 часа. int
fullBackupWindowHours Длительность периода времени заданного дня, в течение которого могут выполняться полные резервные копии. 1–23 часа. int
logBackupFrequency Частота резервного копирования журналов. 5–60 минут. int
пароль Пароль для шифрования при резервном копировании. струна
retentionPeriod Период хранения резервного копирования: 1–90 дней. int
storageAccessKey Ключ учетной записи хранения, в который будет выполняться резервное копирование. струна
storageAccountUrl URL-адрес учетной записи хранения, в который будет выполняться резервное копирование. струна
storageContainerName Имя контейнера хранилища, в котором будет выполняться резервное копирование. струна

AutoPatchingSettings

Имя Описание Ценность
additionalVmPatch Дополнительное исправление для включения или включения на виртуальной машине SQL. "MicrosoftUpdate"
NotSet
dayOfWeek День недели, на который будет применено исправление. "Каждый день"
"Пятница"
"Понедельник"
"Суббота"
"Воскресенье"
"Четверг"
"Вторник"
"Среда"
давать возможность Включите или отключите автоматическое заполнение на виртуальной машине SQL. bool
maintenanceWindowDuration Длительность исправления. int
maintenanceWindowStartingHour Час дня при инициировании исправления. Время локальной виртуальной машины. int

KeyVaultCredentialSettings

Имя Описание Ценность
azureKeyVaultUrl URL-адрес Azure Key Vault. струна
credentialName Имя учетных данных. струна
давать возможность Включите или отключите параметр учетных данных хранилища ключей. bool
servicePrincipalName Имя субъекта-службы для доступа к хранилищу ключей. струна
servicePrincipalSecret Секрет имени субъекта-службы для доступа к хранилищу ключей. струна

Microsoft.SqlVirtualMachine/sqlVirtualMachines

Имя Описание Ценность
apiVersion Версия API '2023-10-01'
тождество НЕ ИСПОЛЬЗУЙТЕ. Это значение будет устарело. Удостоверение сервера Azure Active Directory. ResourceIdentity
местоположение Расположение ресурса. строка (обязательно)
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 64
Pattern = ^((?!_)[^\\/"'\[\]:|<>+=;,?*@&]{1,64}(?<![.-]))$ (обязательно)
свойства Свойства ресурса. SqlVirtualMachineProperties
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.SqlVirtualMachine/sqlVirtualMachines"

ResourceIdentity

Имя Описание Ценность
тип Тип удостоверения. Установите для параметра SystemAssigned значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

Расписание

Имя Описание Ценность
dayOfWeek День недели для выполнения оценки. "Пятница"
"Понедельник"
"Суббота"
"Воскресенье"
"Четверг"
"Вторник"
"Среда"
давать возможность Включение или отключение расписания оценки на виртуальной машине SQL. bool
monthlyOccurrence Вхождения дня DayOfWeek в течение месяца для планирования оценки. Принимает значения: 1,2,3,4 и -1. Использование -1 для последнего дня ДняOfWeek месяца int
startTime Время дня в формате HH:mm. Например. 17:30 струна
еженедельноInterval Количество недель для планирования между 2 запусками оценки. Принимает значение от 1 до 6 int

ServerConfigurationsManagementSettings

Имя Описание Ценность
additionalFeaturesServerConfigurations Дополнительные параметры компонентов SQL. AdditionalFeaturesServerConfigurations
azureAdAuthenticationSettings Параметры проверки подлинности Azure AD. AADAuthenticationSettings
sqlConnectivityUpdateSettings Параметры типа подключения SQL. SqlConnectivityUpdateSettings
sqlInstanceSettings Параметры экземпляра SQL. SQLInstanceSettings
sqlStorageUpdateSettings Параметры обновления хранилища SQL. SqlStorageUpdateSettings
sqlWorkloadTypeUpdateSettings Параметры типа рабочей нагрузки SQL. SqlWorkloadTypeUpdateSettings

SqlConnectivityUpdateSettings

Имя Описание Ценность
connectivityType Параметр подключения SQL Server. "LOCAL"
"PRIVATE"
"PUBLIC"
порт Порт SQL Server. int
sqlAuthUpdatePassword Пароль для входа sysadmin в SQL Server. струна
sqlAuthUpdateUserName Имя входа sysadmin SQL Server для создания. струна

SQLInstanceSettings

Имя Описание Ценность
закуска Параметры сортировки SQL Server. струна
isIfiEnabled SQL Server IFI. bool
isLpimEnabled SQL Server LPIM. bool
isOptimizeForAdHocWorkloadsEnabled SQL Server Optimize for Adhoc workloads. bool
maxDop SQL Server MAXDOP. int
maxServerMemoryMB Максимальная память SQL Server. int
minServerMemoryMB Минимальная память SQL Server. int

SQLStorageSettings

Имя Описание Ценность
defaultFilePath Путь к файлу sql Server по умолчанию струна
luns Логические номера единиц для дисков. int[]
useStoragePool Использование пула носителей для создания диска, если задано значение true или не указано bool

SqlStorageUpdateSettings

Имя Описание Ценность
diskConfigurationType Конфигурация диска для применения к SQL Server. 'ADD'
"РАСШИРЕНИЕ"
"NEW"
diskCount Число дисков виртуальной машины. int
startingDeviceId Идентификатор устройства первого диска, который необходимо обновить. int

SQLTempDbSettings

Имя Описание Ценность
dataFileCount Количество файлов данных tempdb SQL Server int
dataFileSize Размер файла данных tempdb SQL Server int
dataGrowth Размер файла данных tempdb SQL Server autoGrowth int
defaultFilePath Путь к файлу sql Server по умолчанию струна
logFileSize Размер файла журнала tempdb SQL Server int
logGrowth Размер файла журнала tempdb SQL Server autoGrowth int
luns Логические номера единиц для дисков. int[]
persistFolder Выбор папки базы данных tempdb SQL Server bool
persistFolderPath Расположение папки хранения базы данных tempdb SQL Server струна
useStoragePool Использование пула носителей для создания диска, если задано значение true или не указано bool

SqlVirtualMachineProperties

Имя Описание Ценность
assessmentSettings Параметры оценки рекомендаций SQL. AssessmentSettings
autoBackupSettings Параметры автоматического резервного копирования для SQL Server. AutoBackupSettings
autoPatchingSettings Параметры автоматического исправления для применения критически важных обновлений системы безопасности к виртуальной машине SQL. AutoPatchingSettings
enableAutomaticUpgrade Включите автоматическое обновление агента расширения IaaS Sql. bool
keyVaultCredentialSettings Параметры учетных данных хранилища ключей. KeyVaultCredentialSettings
leastPrivilegeMode Режим наименьших привилегий агента IaaS SQL. "Включено"
NotSet
serverConfigurationsManagementSettings Параметры управления конфигурацией SQL Server. ServerConfigurationsManagementSettings
sqlImageOffer Предложение образа SQL. Примеры включают SQL2016-WS2016, SQL2017-WS2016. струна
sqlImageSku Тип выпуска SQL Server. 'Разработчик'
"Enterprise"
Express
"Стандартный"
"Интернет"
sqlManagement Тип управления SQL Server. ПРИМЕЧАНИЕ. Этот параметр больше не используется. API автоматически обнаруживает управление SQL, воздерживаться от его использования. "Full"
"Легкий вес"
NoAgent
sqlServerLicenseType Тип лицензии SQL Server. "AHUB"
"DR"
PayG
sqlVirtualMachineGroupResourceId Идентификатор ресурса ARM группы виртуальных машин SQL, включаемой в эту виртуальную машину SQL, или будет частью этой виртуальной машины. струна
storageConfigurationSettings Параметры конфигурации хранилища. StorageConfigurationSettings
virtualMachineIdentitySettings Сведения об удостоверении виртуальной машины, используемые для конфигураций расширений IaaS sql. VirtualMachineIdentity
virtualMachineResourceId Идентификатор ресурса ARM базовой виртуальной машины, созданной на основе образа SQL Marketplace. струна
wsfcDomainCredentials Учетные данные домена для настройки отказоустойчивого кластера Windows Server для группы доступности SQL. WsfcDomainCredentials
wsfcStaticIp Учетные данные домена для настройки отказоустойчивого кластера Windows Server для группы доступности SQL. струна

SqlWorkloadTypeUpdateSettings

Имя Описание Ценность
sqlWorkloadType Тип рабочей нагрузки SQL Server. DW
"ОБЩИЕ"
OLTP

StorageConfigurationSettings

Имя Описание Ценность
diskConfigurationType Конфигурация диска для применения к SQL Server. 'ADD'
"РАСШИРЕНИЕ"
"NEW"
enableStorageConfigBlade Включите колонку конфигурации хранилища агента IaaS SQL на портале Azure. bool
sqlDataSettings Параметры хранилища данных SQL Server. SQLStorageSettings
sqlLogSettings Параметры хранилища журналов SQL Server. SQLStorageSettings
sqlSystemDbOnDataDisk Хранилище SQL Server SystemDb в DataPool, если значение true. bool
sqlTempDbSettings Параметры хранилища TempDb SQL Server. SQLTempDbSettings
storageWorkloadType Тип рабочей нагрузки хранилища. DW
"ОБЩИЕ"
OLTP

TrackedResourceTags

Имя Описание Ценность

VirtualMachineIdentity

Имя Описание Ценность
resourceId Идентификатор ресурса ARM удостоверения. Требуется только при выборе удостоверения UserAssigned. струна
тип Тип удостоверения виртуальной машины. Укажите none, чтобы отказаться от управляемых удостоверений. "Нет"
SystemAssigned
UserAssigned

WsfcDomainCredentials

Имя Описание Ценность
clusterBootstrapAccountPassword Пароль учетной записи начальной загрузки кластера. струна
clusterOperatorAccountPassword Пароль учетной записи оператора кластера. струна
sqlServiceAccountPassword Пароль учетной записи службы SQL. струна

Примеры использования

Шаблоны быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.

Шаблон Описание
Развертывание установки Sql Always ON с существующими виртуальными машинами SQL

развертывание в Azure
Развертывание установки SQL Always ON с помощью существующих виртуальных машин SQL. Виртуальные машины уже должны быть присоединены к существующему домену и должны работать с корпоративной версией SQL Server.
виртуальной машине SQL Server с параметрами оптимизированного для производительности хранилища

развертывание в Azure
Создание виртуальной машины SQL Server с оптимизированными для производительности параметрами хранилища в PremiumSSD
параметры оптимизированного хранилища для виртуальной машины SQL в UltraSSD

развертывание в Azure
Создание виртуальной машины SQL Server с параметрами оптимизированного для производительности хранилища с помощью UltraSSD для файлов журнала SQL

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса sqlVirtualMachines можно развернуть с помощью операций, целевых:

  • групп ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.SqlVirtualMachine/sqlVirtualMachines, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SqlVirtualMachine/sqlVirtualMachines@2023-10-01"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      assessmentSettings = {
        enable = bool
        runImmediately = bool
        schedule = {
          dayOfWeek = "string"
          enable = bool
          monthlyOccurrence = int
          startTime = "string"
          weeklyInterval = int
        }
      }
      autoBackupSettings = {
        backupScheduleType = "string"
        backupSystemDbs = bool
        daysOfWeek = [
          "string"
        ]
        enable = bool
        enableEncryption = bool
        fullBackupFrequency = "string"
        fullBackupStartTime = int
        fullBackupWindowHours = int
        logBackupFrequency = int
        password = "string"
        retentionPeriod = int
        storageAccessKey = "string"
        storageAccountUrl = "string"
        storageContainerName = "string"
      }
      autoPatchingSettings = {
        additionalVmPatch = "string"
        dayOfWeek = "string"
        enable = bool
        maintenanceWindowDuration = int
        maintenanceWindowStartingHour = int
      }
      enableAutomaticUpgrade = bool
      keyVaultCredentialSettings = {
        azureKeyVaultUrl = "string"
        credentialName = "string"
        enable = bool
        servicePrincipalName = "string"
        servicePrincipalSecret = "string"
      }
      leastPrivilegeMode = "string"
      serverConfigurationsManagementSettings = {
        additionalFeaturesServerConfigurations = {
          isRServicesEnabled = bool
        }
        azureAdAuthenticationSettings = {
          clientId = "string"
        }
        sqlConnectivityUpdateSettings = {
          connectivityType = "string"
          port = int
          sqlAuthUpdatePassword = "string"
          sqlAuthUpdateUserName = "string"
        }
        sqlInstanceSettings = {
          collation = "string"
          isIfiEnabled = bool
          isLpimEnabled = bool
          isOptimizeForAdHocWorkloadsEnabled = bool
          maxDop = int
          maxServerMemoryMB = int
          minServerMemoryMB = int
        }
        sqlStorageUpdateSettings = {
          diskConfigurationType = "string"
          diskCount = int
          startingDeviceId = int
        }
        sqlWorkloadTypeUpdateSettings = {
          sqlWorkloadType = "string"
        }
      }
      sqlImageOffer = "string"
      sqlImageSku = "string"
      sqlManagement = "string"
      sqlServerLicenseType = "string"
      sqlVirtualMachineGroupResourceId = "string"
      storageConfigurationSettings = {
        diskConfigurationType = "string"
        enableStorageConfigBlade = bool
        sqlDataSettings = {
          defaultFilePath = "string"
          luns = [
            int
          ]
          useStoragePool = bool
        }
        sqlLogSettings = {
          defaultFilePath = "string"
          luns = [
            int
          ]
          useStoragePool = bool
        }
        sqlSystemDbOnDataDisk = bool
        sqlTempDbSettings = {
          dataFileCount = int
          dataFileSize = int
          dataGrowth = int
          defaultFilePath = "string"
          logFileSize = int
          logGrowth = int
          luns = [
            int
          ]
          persistFolder = bool
          persistFolderPath = "string"
          useStoragePool = bool
        }
        storageWorkloadType = "string"
      }
      virtualMachineIdentitySettings = {
        resourceId = "string"
        type = "string"
      }
      virtualMachineResourceId = "string"
      wsfcDomainCredentials = {
        clusterBootstrapAccountPassword = "string"
        clusterOperatorAccountPassword = "string"
        sqlServiceAccountPassword = "string"
      }
      wsfcStaticIp = "string"
    }
  }
}

Значения свойств

AADAuthenticationSettings

Имя Описание Ценность
clientId Идентификатор клиента управляемого удостоверения для запроса API Microsoft Graph. Пустая строка должна использоваться для назначаемого системой управляемого удостоверения струна

ДополнительныеfeaturesServerConfigurations

Имя Описание Ценность
isRServicesEnabled Включите или отключите службы R (SQL 2016 и более поздних версий). bool

ОценкиSettings

Имя Описание Ценность
давать возможность Включите или отключите функцию оценки рекомендаций SQL на виртуальной машине SQL. bool
runImmediately Запустите оценку рекомендаций SQL сразу же на виртуальной машине SQL. bool
расписание Планирование оценки рекомендаций SQL. расписания

AutoBackupSettings

Имя Описание Ценность
backupScheduleType Тип расписания резервного копирования. "Автоматизировано"
"Вручную"
backupSystemDbs Включите или исключите системные базы данных из автоматического резервного копирования. bool
daysOfWeek Дни недели для резервных копий, когда FullBackupFrequency имеет значение Weekly. Массив строк, содержащий любой из:
"Пятница"
"Понедельник"
"Суббота"
"Воскресенье"
"Четверг"
"Вторник"
"Среда"
давать возможность Включение или отключение автоматического восстановления на виртуальной машине SQL. bool
enableEncryption Включение или отключение шифрования для резервного копирования на виртуальной машине SQL. bool
fullBackupFrequency Частота полных резервных копий. В обоих случаях полное резервное копирование начинается во время следующего запланированного периода времени. "Ежедневно"
"Еженедельно"
fullBackupStartTime Время начала заданного дня, в течение которого могут выполняться полные резервные копии. 0–23 часа. int
fullBackupWindowHours Длительность периода времени заданного дня, в течение которого могут выполняться полные резервные копии. 1–23 часа. int
logBackupFrequency Частота резервного копирования журналов. 5–60 минут. int
пароль Пароль для шифрования при резервном копировании. струна
retentionPeriod Период хранения резервного копирования: 1–90 дней. int
storageAccessKey Ключ учетной записи хранения, в который будет выполняться резервное копирование. струна
storageAccountUrl URL-адрес учетной записи хранения, в который будет выполняться резервное копирование. струна
storageContainerName Имя контейнера хранилища, в котором будет выполняться резервное копирование. струна

AutoPatchingSettings

Имя Описание Ценность
additionalVmPatch Дополнительное исправление для включения или включения на виртуальной машине SQL. "MicrosoftUpdate"
NotSet
dayOfWeek День недели, на который будет применено исправление. "Каждый день"
"Пятница"
"Понедельник"
"Суббота"
"Воскресенье"
"Четверг"
"Вторник"
"Среда"
давать возможность Включите или отключите автоматическое заполнение на виртуальной машине SQL. bool
maintenanceWindowDuration Длительность исправления. int
maintenanceWindowStartingHour Час дня при инициировании исправления. Время локальной виртуальной машины. int

KeyVaultCredentialSettings

Имя Описание Ценность
azureKeyVaultUrl URL-адрес Azure Key Vault. струна
credentialName Имя учетных данных. струна
давать возможность Включите или отключите параметр учетных данных хранилища ключей. bool
servicePrincipalName Имя субъекта-службы для доступа к хранилищу ключей. струна
servicePrincipalSecret Секрет имени субъекта-службы для доступа к хранилищу ключей. струна

Microsoft.SqlVirtualMachine/sqlVirtualMachines

Имя Описание Ценность
тождество НЕ ИСПОЛЬЗУЙТЕ. Это значение будет устарело. Удостоверение сервера Azure Active Directory. ResourceIdentity
местоположение Расположение ресурса. строка (обязательно)
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 64
Pattern = ^((?!_)[^\\/"'\[\]:|<>+=;,?*@&]{1,64}(?<![.-]))$ (обязательно)
свойства Свойства ресурса. SqlVirtualMachineProperties
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.SqlVirtualMachine/sqlVirtualMachines@2023-10-01"

ResourceIdentity

Имя Описание Ценность
тип Тип удостоверения. Установите для параметра SystemAssigned значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

Расписание

Имя Описание Ценность
dayOfWeek День недели для выполнения оценки. "Пятница"
"Понедельник"
"Суббота"
"Воскресенье"
"Четверг"
"Вторник"
"Среда"
давать возможность Включение или отключение расписания оценки на виртуальной машине SQL. bool
monthlyOccurrence Вхождения дня DayOfWeek в течение месяца для планирования оценки. Принимает значения: 1,2,3,4 и -1. Использование -1 для последнего дня ДняOfWeek месяца int
startTime Время дня в формате HH:mm. Например. 17:30 струна
еженедельноInterval Количество недель для планирования между 2 запусками оценки. Принимает значение от 1 до 6 int

ServerConfigurationsManagementSettings

Имя Описание Ценность
additionalFeaturesServerConfigurations Дополнительные параметры компонентов SQL. AdditionalFeaturesServerConfigurations
azureAdAuthenticationSettings Параметры проверки подлинности Azure AD. AADAuthenticationSettings
sqlConnectivityUpdateSettings Параметры типа подключения SQL. SqlConnectivityUpdateSettings
sqlInstanceSettings Параметры экземпляра SQL. SQLInstanceSettings
sqlStorageUpdateSettings Параметры обновления хранилища SQL. SqlStorageUpdateSettings
sqlWorkloadTypeUpdateSettings Параметры типа рабочей нагрузки SQL. SqlWorkloadTypeUpdateSettings

SqlConnectivityUpdateSettings

Имя Описание Ценность
connectivityType Параметр подключения SQL Server. "LOCAL"
"PRIVATE"
"PUBLIC"
порт Порт SQL Server. int
sqlAuthUpdatePassword Пароль для входа sysadmin в SQL Server. струна
sqlAuthUpdateUserName Имя входа sysadmin SQL Server для создания. струна

SQLInstanceSettings

Имя Описание Ценность
закуска Параметры сортировки SQL Server. струна
isIfiEnabled SQL Server IFI. bool
isLpimEnabled SQL Server LPIM. bool
isOptimizeForAdHocWorkloadsEnabled SQL Server Optimize for Adhoc workloads. bool
maxDop SQL Server MAXDOP. int
maxServerMemoryMB Максимальная память SQL Server. int
minServerMemoryMB Минимальная память SQL Server. int

SQLStorageSettings

Имя Описание Ценность
defaultFilePath Путь к файлу sql Server по умолчанию струна
luns Логические номера единиц для дисков. int[]
useStoragePool Использование пула носителей для создания диска, если задано значение true или не указано bool

SqlStorageUpdateSettings

Имя Описание Ценность
diskConfigurationType Конфигурация диска для применения к SQL Server. 'ADD'
"РАСШИРЕНИЕ"
"NEW"
diskCount Число дисков виртуальной машины. int
startingDeviceId Идентификатор устройства первого диска, который необходимо обновить. int

SQLTempDbSettings

Имя Описание Ценность
dataFileCount Количество файлов данных tempdb SQL Server int
dataFileSize Размер файла данных tempdb SQL Server int
dataGrowth Размер файла данных tempdb SQL Server autoGrowth int
defaultFilePath Путь к файлу sql Server по умолчанию струна
logFileSize Размер файла журнала tempdb SQL Server int
logGrowth Размер файла журнала tempdb SQL Server autoGrowth int
luns Логические номера единиц для дисков. int[]
persistFolder Выбор папки базы данных tempdb SQL Server bool
persistFolderPath Расположение папки хранения базы данных tempdb SQL Server струна
useStoragePool Использование пула носителей для создания диска, если задано значение true или не указано bool

SqlVirtualMachineProperties

Имя Описание Ценность
assessmentSettings Параметры оценки рекомендаций SQL. AssessmentSettings
autoBackupSettings Параметры автоматического резервного копирования для SQL Server. AutoBackupSettings
autoPatchingSettings Параметры автоматического исправления для применения критически важных обновлений системы безопасности к виртуальной машине SQL. AutoPatchingSettings
enableAutomaticUpgrade Включите автоматическое обновление агента расширения IaaS Sql. bool
keyVaultCredentialSettings Параметры учетных данных хранилища ключей. KeyVaultCredentialSettings
leastPrivilegeMode Режим наименьших привилегий агента IaaS SQL. "Включено"
NotSet
serverConfigurationsManagementSettings Параметры управления конфигурацией SQL Server. ServerConfigurationsManagementSettings
sqlImageOffer Предложение образа SQL. Примеры включают SQL2016-WS2016, SQL2017-WS2016. струна
sqlImageSku Тип выпуска SQL Server. 'Разработчик'
"Enterprise"
Express
"Стандартный"
"Интернет"
sqlManagement Тип управления SQL Server. ПРИМЕЧАНИЕ. Этот параметр больше не используется. API автоматически обнаруживает управление SQL, воздерживаться от его использования. "Full"
"Легкий вес"
NoAgent
sqlServerLicenseType Тип лицензии SQL Server. "AHUB"
"DR"
PayG
sqlVirtualMachineGroupResourceId Идентификатор ресурса ARM группы виртуальных машин SQL, включаемой в эту виртуальную машину SQL, или будет частью этой виртуальной машины. струна
storageConfigurationSettings Параметры конфигурации хранилища. StorageConfigurationSettings
virtualMachineIdentitySettings Сведения об удостоверении виртуальной машины, используемые для конфигураций расширений IaaS sql. VirtualMachineIdentity
virtualMachineResourceId Идентификатор ресурса ARM базовой виртуальной машины, созданной на основе образа SQL Marketplace. струна
wsfcDomainCredentials Учетные данные домена для настройки отказоустойчивого кластера Windows Server для группы доступности SQL. WsfcDomainCredentials
wsfcStaticIp Учетные данные домена для настройки отказоустойчивого кластера Windows Server для группы доступности SQL. струна

SqlWorkloadTypeUpdateSettings

Имя Описание Ценность
sqlWorkloadType Тип рабочей нагрузки SQL Server. DW
"ОБЩИЕ"
OLTP

StorageConfigurationSettings

Имя Описание Ценность
diskConfigurationType Конфигурация диска для применения к SQL Server. 'ADD'
"РАСШИРЕНИЕ"
"NEW"
enableStorageConfigBlade Включите колонку конфигурации хранилища агента IaaS SQL на портале Azure. bool
sqlDataSettings Параметры хранилища данных SQL Server. SQLStorageSettings
sqlLogSettings Параметры хранилища журналов SQL Server. SQLStorageSettings
sqlSystemDbOnDataDisk Хранилище SQL Server SystemDb в DataPool, если значение true. bool
sqlTempDbSettings Параметры хранилища TempDb SQL Server. SQLTempDbSettings
storageWorkloadType Тип рабочей нагрузки хранилища. DW
"ОБЩИЕ"
OLTP

TrackedResourceTags

Имя Описание Ценность

VirtualMachineIdentity

Имя Описание Ценность
resourceId Идентификатор ресурса ARM удостоверения. Требуется только при выборе удостоверения UserAssigned. струна
тип Тип удостоверения виртуальной машины. Укажите none, чтобы отказаться от управляемых удостоверений. "Нет"
SystemAssigned
UserAssigned

WsfcDomainCredentials

Имя Описание Ценность
clusterBootstrapAccountPassword Пароль учетной записи начальной загрузки кластера. струна
clusterOperatorAccountPassword Пароль учетной записи оператора кластера. струна
sqlServiceAccountPassword Пароль учетной записи службы SQL. струна