次の方法で共有


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 Microsoft Graph API にクエリを実行するマネージド ID のクライアント ID。 空の文字列は、システム割り当てマネージド ID に使用する必要があります

AdditionalFeaturesServerConfigurations

名前 形容 価値
isRServicesEnabled R サービス (SQL 2016 以降) を有効または無効にします。 bool

AssessmentSettings

名前 形容 価値
エネーブル SQL 仮想マシンで SQL ベスト プラクティス評価機能を有効または無効にします。 bool
runImmediately SQL 仮想マシンで SQL ベスト プラクティス評価を直ちに実行します。 bool
計画 SQL ベスト プラクティス評価のスケジュール。 スケジュール の

AutoBackupSettings

名前 形容 価値
backupScheduleType バックアップ スケジュールの種類。 'Automated'
'Manual'
backupSystemDbs システム データベースを自動バックアップに含めるか、自動バックアップから除外します。 bool
daysOfWeek FullBackupFrequency が [週単位] に設定されている場合のバックアップの曜日。 次のいずれかを含む文字列配列:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
エネーブル SQL 仮想マシンでの自動バックを有効または無効にします。 bool
enableEncryption SQL 仮想マシンでのバックアップの暗号化を有効または無効にします。 bool
fullBackupFrequency 完全バックアップの頻度。 どちらの場合も、完全バックアップは次のスケジュールされた時間枠の間に開始されます。 'Daily'
'Weekly'
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 パッチを適用する曜日。 'Everyday'
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
エネーブル SQL 仮想マシンで自動パッチを有効または無効にします。 bool
maintenanceWindowDuration 修正プログラムの適用期間。 int
maintenanceWindowStartingHour 修正プログラムの適用が開始される 1 日の時間。 ローカル VM 時刻。 int

KeyVaultCredentialSettings

名前 形容 価値
azureKeyVaultUrl Azure Key Vault の URL。
credentialName 資格情報の名前。
エネーブル キー コンテナーの資格情報設定を有効または無効にします。 bool
servicePrincipalName キー コンテナーにアクセスするためのサービス プリンシパル名。
servicePrincipalSecret キー コンテナーにアクセスするためのサービス プリンシパル名シークレット。

Microsoft.SqlVirtualMachine/sqlVirtualMachines

名前 形容 価値
同一性 使用しないでください。 この値は非推奨になります。 サーバーの Azure Active Directory ID。 ResourceIdentity
場所 リソースの場所。 string (必須)
名前 リソース名

制約:
最小長 = 1
最大長 = 1
パターン = ^((?!_)[^\\/"'\[\]:|<>+=;,?*@&]{1,64}(?<![.-]))$ (必須)
プロパティ リソースのプロパティ。 SqlVirtualMachineProperties
タグ リソース タグ。 TrackedResourceTags

ResourceIdentity

名前 形容 価値
種類 ID の種類。 リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'

計画

名前 形容 価値
dayOfWeek 評価を実行する曜日。 'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
エネーブル SQL 仮想マシンの評価スケジュールを有効または無効にします。 bool
monthlyOccurrence 評価をスケジュールする 1 か月以内の DayOfWeek 日の発生。 1、2、3、4、-1 の値を受け取ります。 月の最後の DayOfWeek 日に -1 を使用する int
startTime HH:mm 形式の時刻。例えば。17:30
weeklyInterval 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 SQL Server sysadmin ログイン パスワード。
sqlAuthUpdateUserName 作成する SQL Server sysadmin ログイン。

SQLInstanceSettings

名前 形容 価値
照合 SQL Server 照合順序。
isIfiEnabled SQL Server IFI。 bool
isLpimEnabled SQL Server LPIM。 bool
isOptimizeForAdHocWorkloadsEnabled アドホック ワークロード用の SQL Server Optimize。 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'
'EXTEND'
'NEW'
diskCount 仮想マシンのディスク数。 int
startingDeviceId 更新する最初のディスクのデバイス ID。 int

SQLTempDbSettings

名前 形容 価値
dataFileCount SQL Server tempdb データ ファイルの数 int
dataFileSize SQL Server tempdb データ ファイルのサイズ int
dataGrowth SQL Server tempdb データ ファイルの自動拡張サイズ int
defaultFilePath SQL Server の既定のファイル パス
logFileSize SQL Server tempdb ログ ファイルのサイズ int
logGrowth SQL Server tempdb ログ ファイルの自動拡張サイズ int
luns ディスクの論理ユニット番号。 int[]
persistFolder SQL Server tempdb の保存フォルダーの選択 bool
persistFolderPath SQL Server tempdb の保存フォルダーの場所
useStoragePool 記憶域プールを使用してドライブをビルドする (true または指定されていない場合) bool

SqlVirtualMachineProperties

名前 形容 価値
assessmentSettings SQL のベスト プラクティスの評価の設定。 AssessmentSettings
autoBackupSettings SQL Server の自動バックアップ設定。 AutoBackupSettings の
autoPatchingSettings SQL 仮想マシンに重要なセキュリティ更新プログラムを適用するための自動修正プログラムの設定。 AutoPatchingSettings
enableAutomaticUpgrade Sql IaaS 拡張機能エージェントの自動アップグレードを有効にします。 bool
keyVaultCredentialSettings キー コンテナーの資格情報の設定。 KeyVaultCredentialSettings の
leastPrivilegeMode SQL IaaS Agent の最小特権モード。 'Enabled'
'NotSet'
serverConfigurationsManagementSettings SQL Server の構成管理設定。 ServerConfigurationsManagementSettings
sqlImageOffer SQL イメージ オファー。 例としては、SQL2016-WS2016、SQL2017-WS2016 などがあります。
sqlImageSku SQL Server エディションの種類。 'Developer'
'Enterprise'
'Express'
'Standard'
'Web'
sqlManagement SQL Server 管理の種類。 注: このパラメーターは使用されなくなりました。 API は Sql Management を自動的に検出し、使用しないようにします。 'Full'
'LightWeight'
'NoAgent'
sqlServerLicenseType SQL Server ライセンスの種類。 'AHUB'
'DR'
'PAYG'
sqlVirtualMachineGroupResourceId この SQL 仮想マシンが属しているか、その一部となる SQL 仮想マシン グループの ARM リソース ID。
storageConfigurationSettings ストレージ構成設定。 StorageConfigurationSettings
virtualMachineIdentitySettings Sql IaaS 拡張機能の構成に使用される仮想マシン ID の詳細。 VirtualMachineIdentity
virtualMachineResourceId SQL Marketplace イメージから作成された基になる仮想マシンの ARM リソース ID。
wsfcDomainCredentials SQL 可用性グループの Windows Server フェールオーバー クラスターを設定するためのドメイン資格情報。 WsfcDomainCredentials の
wsfcStaticIp SQL 可用性グループの Windows Server フェールオーバー クラスターを設定するためのドメイン資格情報。

SqlWorkloadTypeUpdateSettings

名前 形容 価値
sqlWorkloadType SQL Server ワークロードの種類。 'DW'
'GENERAL'
'OLTP'

StorageConfigurationSettings

名前 形容 価値
diskConfigurationType SQL Server に適用するディスク構成。 'ADD'
'EXTEND'
'NEW'
enableStorageConfigBlade Azure Portal で SQL IaaS Agent ストレージ構成ブレードを有効にします。 bool
sqlDataSettings SQL Server データ ストレージの設定。 SQLStorageSettings
sqlLogSettings SQL Server ログ ストレージの設定。 SQLStorageSettings
sqlSystemDbOnDataDisk True の場合、DataPool 上の SQL Server SystemDb ストレージ。 bool
sqlTempDbSettings SQL Server TempDb ストレージの設定。 SQLTempDbSettings
storageWorkloadType ストレージ ワークロードの種類。 'DW'
'GENERAL'
'OLTP'

TrackedResourceTags

名前 形容 価値

VirtualMachineIdentity

名前 形容 価値
resourceId ID の ARM リソース ID。 UserAssigned ID が選択されている場合にのみ必要です。
種類 仮想マシンの ID の種類。 マネージド ID をオプトアウトするには、[なし] を指定します。 'None'
'SystemAssigned'
'UserAssigned'

WsfcDomainCredentials

名前 形容 価値
clusterBootstrapAccountPassword クラスター ブートストラップ アカウントのパスワード。
clusterOperatorAccountPassword クラスター オペレーター アカウントのパスワード。
sqlServiceAccountPassword SQL サービス アカウントのパスワード。

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート 形容
既存の SQL Virtual Machines を使用して SQL Always ON セットアップをデプロイする

Azure にデプロイする
既存の SQL 仮想マシンを使用して SQL Always ON セットアップをデプロイします。 仮想マシンは既に既存のドメインに参加している必要があり、SQL Server のエンタープライズ バージョンを実行している必要があります。
パフォーマンスが最適化されたストレージ設定を使用して SQL Server VM を

Azure にデプロイする
PremiumSSD でパフォーマンスが最適化されたストレージ設定を使用して SQL Server 仮想マシンを作成する
UltraSSD での SQL VM パフォーマンス最適化ストレージ設定の

Azure
にデプロイする
SQL ログ ファイルに UltraSSD を使用して、パフォーマンスが最適化されたストレージ設定で SQL Server 仮想マシンを作成する

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 Microsoft Graph API にクエリを実行するマネージド ID のクライアント ID。 空の文字列は、システム割り当てマネージド ID に使用する必要があります

AdditionalFeaturesServerConfigurations

名前 形容 価値
isRServicesEnabled R サービス (SQL 2016 以降) を有効または無効にします。 bool

AssessmentSettings

名前 形容 価値
エネーブル SQL 仮想マシンで SQL ベスト プラクティス評価機能を有効または無効にします。 bool
runImmediately SQL 仮想マシンで SQL ベスト プラクティス評価を直ちに実行します。 bool
計画 SQL ベスト プラクティス評価のスケジュール。 スケジュール の

AutoBackupSettings

名前 形容 価値
backupScheduleType バックアップ スケジュールの種類。 'Automated'
'Manual'
backupSystemDbs システム データベースを自動バックアップに含めるか、自動バックアップから除外します。 bool
daysOfWeek FullBackupFrequency が [週単位] に設定されている場合のバックアップの曜日。 次のいずれかを含む文字列配列:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
エネーブル SQL 仮想マシンでの自動バックを有効または無効にします。 bool
enableEncryption SQL 仮想マシンでのバックアップの暗号化を有効または無効にします。 bool
fullBackupFrequency 完全バックアップの頻度。 どちらの場合も、完全バックアップは次のスケジュールされた時間枠の間に開始されます。 'Daily'
'Weekly'
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 パッチを適用する曜日。 'Everyday'
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
エネーブル SQL 仮想マシンで自動パッチを有効または無効にします。 bool
maintenanceWindowDuration 修正プログラムの適用期間。 int
maintenanceWindowStartingHour 修正プログラムの適用が開始される 1 日の時間。 ローカル VM 時刻。 int

KeyVaultCredentialSettings

名前 形容 価値
azureKeyVaultUrl Azure Key Vault の URL。
credentialName 資格情報の名前。
エネーブル キー コンテナーの資格情報設定を有効または無効にします。 bool
servicePrincipalName キー コンテナーにアクセスするためのサービス プリンシパル名。
servicePrincipalSecret キー コンテナーにアクセスするためのサービス プリンシパル名シークレット。

Microsoft.SqlVirtualMachine/sqlVirtualMachines

名前 形容 価値
同一性 使用しないでください。 この値は非推奨になります。 サーバーの Azure Active Directory ID。 ResourceIdentity
場所 リソースの場所。 string (必須)
名前 リソース名

制約:
最小長 = 1
最大長 = 1
パターン = ^((?!_)[^\\/"'\[\]:|<>+=;,?*@&]{1,64}(?<![.-]))$ (必須)
プロパティ リソースのプロパティ。 SqlVirtualMachineProperties
タグ リソース タグ。 TrackedResourceTags

ResourceIdentity

名前 形容 価値
種類 ID の種類。 リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'

計画

名前 形容 価値
dayOfWeek 評価を実行する曜日。 'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
エネーブル SQL 仮想マシンの評価スケジュールを有効または無効にします。 bool
monthlyOccurrence 評価をスケジュールする 1 か月以内の DayOfWeek 日の発生。 1、2、3、4、-1 の値を受け取ります。 月の最後の DayOfWeek 日に -1 を使用する int
startTime HH:mm 形式の時刻。例えば。17:30
weeklyInterval 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 SQL Server sysadmin ログイン パスワード。
sqlAuthUpdateUserName 作成する SQL Server sysadmin ログイン。

SQLInstanceSettings

名前 形容 価値
照合 SQL Server 照合順序。
isIfiEnabled SQL Server IFI。 bool
isLpimEnabled SQL Server LPIM。 bool
isOptimizeForAdHocWorkloadsEnabled アドホック ワークロード用の SQL Server Optimize。 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'
'EXTEND'
'NEW'
diskCount 仮想マシンのディスク数。 int
startingDeviceId 更新する最初のディスクのデバイス ID。 int

SQLTempDbSettings

名前 形容 価値
dataFileCount SQL Server tempdb データ ファイルの数 int
dataFileSize SQL Server tempdb データ ファイルのサイズ int
dataGrowth SQL Server tempdb データ ファイルの自動拡張サイズ int
defaultFilePath SQL Server の既定のファイル パス
logFileSize SQL Server tempdb ログ ファイルのサイズ int
logGrowth SQL Server tempdb ログ ファイルの自動拡張サイズ int
luns ディスクの論理ユニット番号。 int[]
persistFolder SQL Server tempdb の保存フォルダーの選択 bool
persistFolderPath SQL Server tempdb の保存フォルダーの場所
useStoragePool 記憶域プールを使用してドライブをビルドする (true または指定されていない場合) bool

SqlVirtualMachineProperties

名前 形容 価値
assessmentSettings SQL のベスト プラクティスの評価の設定。 AssessmentSettings
autoBackupSettings SQL Server の自動バックアップ設定。 AutoBackupSettings の
autoPatchingSettings SQL 仮想マシンに重要なセキュリティ更新プログラムを適用するための自動修正プログラムの設定。 AutoPatchingSettings
enableAutomaticUpgrade Sql IaaS 拡張機能エージェントの自動アップグレードを有効にします。 bool
keyVaultCredentialSettings キー コンテナーの資格情報の設定。 KeyVaultCredentialSettings の
leastPrivilegeMode SQL IaaS Agent の最小特権モード。 'Enabled'
'NotSet'
serverConfigurationsManagementSettings SQL Server の構成管理設定。 ServerConfigurationsManagementSettings
sqlImageOffer SQL イメージ オファー。 例としては、SQL2016-WS2016、SQL2017-WS2016 などがあります。
sqlImageSku SQL Server エディションの種類。 'Developer'
'Enterprise'
'Express'
'Standard'
'Web'
sqlManagement SQL Server 管理の種類。 注: このパラメーターは使用されなくなりました。 API は Sql Management を自動的に検出し、使用しないようにします。 'Full'
'LightWeight'
'NoAgent'
sqlServerLicenseType SQL Server ライセンスの種類。 'AHUB'
'DR'
'PAYG'
sqlVirtualMachineGroupResourceId この SQL 仮想マシンが属しているか、その一部となる SQL 仮想マシン グループの ARM リソース ID。
storageConfigurationSettings ストレージ構成設定。 StorageConfigurationSettings
virtualMachineIdentitySettings Sql IaaS 拡張機能の構成に使用される仮想マシン ID の詳細。 VirtualMachineIdentity
virtualMachineResourceId SQL Marketplace イメージから作成された基になる仮想マシンの ARM リソース ID。
wsfcDomainCredentials SQL 可用性グループの Windows Server フェールオーバー クラスターを設定するためのドメイン資格情報。 WsfcDomainCredentials の
wsfcStaticIp SQL 可用性グループの Windows Server フェールオーバー クラスターを設定するためのドメイン資格情報。

SqlWorkloadTypeUpdateSettings

名前 形容 価値
sqlWorkloadType SQL Server ワークロードの種類。 'DW'
'GENERAL'
'OLTP'

StorageConfigurationSettings

名前 形容 価値
diskConfigurationType SQL Server に適用するディスク構成。 'ADD'
'EXTEND'
'NEW'
enableStorageConfigBlade Azure Portal で SQL IaaS Agent ストレージ構成ブレードを有効にします。 bool
sqlDataSettings SQL Server データ ストレージの設定。 SQLStorageSettings
sqlLogSettings SQL Server ログ ストレージの設定。 SQLStorageSettings
sqlSystemDbOnDataDisk True の場合、DataPool 上の SQL Server SystemDb ストレージ。 bool
sqlTempDbSettings SQL Server TempDb ストレージの設定。 SQLTempDbSettings
storageWorkloadType ストレージ ワークロードの種類。 'DW'
'GENERAL'
'OLTP'

TrackedResourceTags

名前 形容 価値

VirtualMachineIdentity

名前 形容 価値
resourceId ID の ARM リソース ID。 UserAssigned ID が選択されている場合にのみ必要です。
種類 仮想マシンの ID の種類。 マネージド ID をオプトアウトするには、[なし] を指定します。 'None'
'SystemAssigned'
'UserAssigned'

WsfcDomainCredentials

名前 形容 価値
clusterBootstrapAccountPassword クラスター ブートストラップ アカウントのパスワード。
clusterOperatorAccountPassword クラスター オペレーター アカウントのパスワード。
sqlServiceAccountPassword SQL サービス アカウントのパスワード。

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート 形容
既存の SQL Virtual Machines を使用して SQL Always ON セットアップをデプロイする

Azure にデプロイする
既存の SQL 仮想マシンを使用して SQL Always ON セットアップをデプロイします。 仮想マシンは既に既存のドメインに参加している必要があり、SQL Server のエンタープライズ バージョンを実行している必要があります。
パフォーマンスが最適化されたストレージ設定を使用して SQL Server VM を

Azure にデプロイする
PremiumSSD でパフォーマンスが最適化されたストレージ設定を使用して SQL Server 仮想マシンを作成する
UltraSSD での SQL VM パフォーマンス最適化ストレージ設定の

Azure
にデプロイする
SQL ログ ファイルに UltraSSD を使用して、パフォーマンスが最適化されたストレージ設定で SQL Server 仮想マシンを作成する

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"
  body = jsonencode({
    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 Microsoft Graph API にクエリを実行するマネージド ID のクライアント ID。 空の文字列は、システム割り当てマネージド ID に使用する必要があります

AdditionalFeaturesServerConfigurations

名前 形容 価値
isRServicesEnabled R サービス (SQL 2016 以降) を有効または無効にします。 bool

AssessmentSettings

名前 形容 価値
エネーブル SQL 仮想マシンで SQL ベスト プラクティス評価機能を有効または無効にします。 bool
runImmediately SQL 仮想マシンで SQL ベスト プラクティス評価を直ちに実行します。 bool
計画 SQL ベスト プラクティス評価のスケジュール。 スケジュール の

AutoBackupSettings

名前 形容 価値
backupScheduleType バックアップ スケジュールの種類。 'Automated'
'Manual'
backupSystemDbs システム データベースを自動バックアップに含めるか、自動バックアップから除外します。 bool
daysOfWeek FullBackupFrequency が [週単位] に設定されている場合のバックアップの曜日。 次のいずれかを含む文字列配列:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
エネーブル SQL 仮想マシンでの自動バックを有効または無効にします。 bool
enableEncryption SQL 仮想マシンでのバックアップの暗号化を有効または無効にします。 bool
fullBackupFrequency 完全バックアップの頻度。 どちらの場合も、完全バックアップは次のスケジュールされた時間枠の間に開始されます。 'Daily'
'Weekly'
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 パッチを適用する曜日。 'Everyday'
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
エネーブル SQL 仮想マシンで自動パッチを有効または無効にします。 bool
maintenanceWindowDuration 修正プログラムの適用期間。 int
maintenanceWindowStartingHour 修正プログラムの適用が開始される 1 日の時間。 ローカル VM 時刻。 int

KeyVaultCredentialSettings

名前 形容 価値
azureKeyVaultUrl Azure Key Vault の URL。
credentialName 資格情報の名前。
エネーブル キー コンテナーの資格情報設定を有効または無効にします。 bool
servicePrincipalName キー コンテナーにアクセスするためのサービス プリンシパル名。
servicePrincipalSecret キー コンテナーにアクセスするためのサービス プリンシパル名シークレット。

Microsoft.SqlVirtualMachine/sqlVirtualMachines

名前 形容 価値
同一性 使用しないでください。 この値は非推奨になります。 サーバーの Azure Active Directory ID。 ResourceIdentity
場所 リソースの場所。 string (必須)
名前 リソース名

制約:
最小長 = 1
最大長 = 1
パターン = ^((?!_)[^\\/"'\[\]:|<>+=;,?*@&]{1,64}(?<![.-]))$ (必須)
プロパティ リソースのプロパティ。 SqlVirtualMachineProperties
タグ リソース タグ。 TrackedResourceTags

ResourceIdentity

名前 形容 価値
種類 ID の種類。 リソースの Azure Active Directory プリンシパルを自動的に作成して割り当てるには、これを "SystemAssigned" に設定します。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'

計画

名前 形容 価値
dayOfWeek 評価を実行する曜日。 'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday'
エネーブル SQL 仮想マシンの評価スケジュールを有効または無効にします。 bool
monthlyOccurrence 評価をスケジュールする 1 か月以内の DayOfWeek 日の発生。 1、2、3、4、-1 の値を受け取ります。 月の最後の DayOfWeek 日に -1 を使用する int
startTime HH:mm 形式の時刻。例えば。17:30
weeklyInterval 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 SQL Server sysadmin ログイン パスワード。
sqlAuthUpdateUserName 作成する SQL Server sysadmin ログイン。

SQLInstanceSettings

名前 形容 価値
照合 SQL Server 照合順序。
isIfiEnabled SQL Server IFI。 bool
isLpimEnabled SQL Server LPIM。 bool
isOptimizeForAdHocWorkloadsEnabled アドホック ワークロード用の SQL Server Optimize。 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'
'EXTEND'
'NEW'
diskCount 仮想マシンのディスク数。 int
startingDeviceId 更新する最初のディスクのデバイス ID。 int

SQLTempDbSettings

名前 形容 価値
dataFileCount SQL Server tempdb データ ファイルの数 int
dataFileSize SQL Server tempdb データ ファイルのサイズ int
dataGrowth SQL Server tempdb データ ファイルの自動拡張サイズ int
defaultFilePath SQL Server の既定のファイル パス
logFileSize SQL Server tempdb ログ ファイルのサイズ int
logGrowth SQL Server tempdb ログ ファイルの自動拡張サイズ int
luns ディスクの論理ユニット番号。 int[]
persistFolder SQL Server tempdb の保存フォルダーの選択 bool
persistFolderPath SQL Server tempdb の保存フォルダーの場所
useStoragePool 記憶域プールを使用してドライブをビルドする (true または指定されていない場合) bool

SqlVirtualMachineProperties

名前 形容 価値
assessmentSettings SQL のベスト プラクティスの評価の設定。 AssessmentSettings
autoBackupSettings SQL Server の自動バックアップ設定。 AutoBackupSettings の
autoPatchingSettings SQL 仮想マシンに重要なセキュリティ更新プログラムを適用するための自動修正プログラムの設定。 AutoPatchingSettings
enableAutomaticUpgrade Sql IaaS 拡張機能エージェントの自動アップグレードを有効にします。 bool
keyVaultCredentialSettings キー コンテナーの資格情報の設定。 KeyVaultCredentialSettings の
leastPrivilegeMode SQL IaaS Agent の最小特権モード。 'Enabled'
'NotSet'
serverConfigurationsManagementSettings SQL Server の構成管理設定。 ServerConfigurationsManagementSettings
sqlImageOffer SQL イメージ オファー。 例としては、SQL2016-WS2016、SQL2017-WS2016 などがあります。
sqlImageSku SQL Server エディションの種類。 'Developer'
'Enterprise'
'Express'
'Standard'
'Web'
sqlManagement SQL Server 管理の種類。 注: このパラメーターは使用されなくなりました。 API は Sql Management を自動的に検出し、使用しないようにします。 'Full'
'LightWeight'
'NoAgent'
sqlServerLicenseType SQL Server ライセンスの種類。 'AHUB'
'DR'
'PAYG'
sqlVirtualMachineGroupResourceId この SQL 仮想マシンが属しているか、その一部となる SQL 仮想マシン グループの ARM リソース ID。
storageConfigurationSettings ストレージ構成設定。 StorageConfigurationSettings
virtualMachineIdentitySettings Sql IaaS 拡張機能の構成に使用される仮想マシン ID の詳細。 VirtualMachineIdentity
virtualMachineResourceId SQL Marketplace イメージから作成された基になる仮想マシンの ARM リソース ID。
wsfcDomainCredentials SQL 可用性グループの Windows Server フェールオーバー クラスターを設定するためのドメイン資格情報。 WsfcDomainCredentials の
wsfcStaticIp SQL 可用性グループの Windows Server フェールオーバー クラスターを設定するためのドメイン資格情報。

SqlWorkloadTypeUpdateSettings

名前 形容 価値
sqlWorkloadType SQL Server ワークロードの種類。 'DW'
'GENERAL'
'OLTP'

StorageConfigurationSettings

名前 形容 価値
diskConfigurationType SQL Server に適用するディスク構成。 'ADD'
'EXTEND'
'NEW'
enableStorageConfigBlade Azure Portal で SQL IaaS Agent ストレージ構成ブレードを有効にします。 bool
sqlDataSettings SQL Server データ ストレージの設定。 SQLStorageSettings
sqlLogSettings SQL Server ログ ストレージの設定。 SQLStorageSettings
sqlSystemDbOnDataDisk True の場合、DataPool 上の SQL Server SystemDb ストレージ。 bool
sqlTempDbSettings SQL Server TempDb ストレージの設定。 SQLTempDbSettings
storageWorkloadType ストレージ ワークロードの種類。 'DW'
'GENERAL'
'OLTP'

TrackedResourceTags

名前 形容 価値

VirtualMachineIdentity

名前 形容 価値
resourceId ID の ARM リソース ID。 UserAssigned ID が選択されている場合にのみ必要です。
種類 仮想マシンの ID の種類。 マネージド ID をオプトアウトするには、[なし] を指定します。 'None'
'SystemAssigned'
'UserAssigned'

WsfcDomainCredentials

名前 形容 価値
clusterBootstrapAccountPassword クラスター ブートストラップ アカウントのパスワード。
clusterOperatorAccountPassword クラスター オペレーター アカウントのパスワード。
sqlServiceAccountPassword SQL サービス アカウントのパスワード。