SqlVirtualMachine Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A SQL virtual machine.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.SqlVirtualMachineTypeConverter))]
public class SqlVirtualMachine : Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.ISqlVirtualMachine, Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Runtime.IValidates[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.SqlVirtualMachineTypeConverter))>]
type SqlVirtualMachine = class
interface ISqlVirtualMachine
interface IJsonSerializable
interface ITrackedResource
interface IResource
interface IValidatesPublic Class SqlVirtualMachine
Implements ISqlVirtualMachine, IValidates- Inheritance
-
SqlVirtualMachine
- Attributes
- Implements
Constructors
| SqlVirtualMachine() |
Creates an new SqlVirtualMachine instance. |
Properties
| AdditionalFeatureServerConfigurationIsRServicesEnabled |
Enable or disable R services (SQL 2016 onwards). |
| AssessmentSettingEnable |
Enable or disable SQL best practices Assessment feature on SQL virtual machine. |
| AssessmentSettingRunImmediately |
Run SQL best practices Assessment immediately on SQL virtual machine. |
| AutoBackupSettingBackupScheduleType |
Backup schedule type. |
| AutoBackupSettingBackupSystemDb |
Include or exclude system databases from auto backup. |
| AutoBackupSettingDaysOfWeek |
Days of the week for the backups when FullBackupFrequency is set to Weekly. |
| AutoBackupSettingEnable |
Enable or disable autobackup on SQL virtual machine. |
| AutoBackupSettingEnableEncryption |
Enable or disable encryption for backup on SQL virtual machine. |
| AutoBackupSettingFullBackupFrequency |
Frequency of full backups. In both cases, full backups begin during the next scheduled time window. |
| AutoBackupSettingFullBackupStartTime |
Start time of a given day during which full backups can take place. 0-23 hours. |
| AutoBackupSettingFullBackupWindowHour |
Duration of the time window of a given day during which full backups can take place. 1-23 hours. |
| AutoBackupSettingLogBackupFrequency |
Frequency of log backups. 5-60 minutes. |
| AutoBackupSettingPassword |
Password for encryption on backup. |
| AutoBackupSettingRetentionPeriod |
Retention period of backup: 1-90 days. |
| AutoBackupSettingStorageAccessKey |
Storage account key where backup will be taken to. |
| AutoBackupSettingStorageAccountUrl |
Storage account url where backup will be taken to. |
| AutoBackupSettingStorageContainerName |
Storage container name where backup will be taken to. |
| AutoPatchingSettingDayOfWeek |
Day of week to apply the patch on. |
| AutoPatchingSettingEnable |
Enable or disable autopatching on SQL virtual machine. |
| AutoPatchingSettingMaintenanceWindowDuration |
Duration of patching. |
| AutoPatchingSettingMaintenanceWindowStartingHour |
Hour of the day when patching is initiated. Local VM time. |
| AzureAdAuthenticationSettingClientId |
The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity |
| EnableAutomaticUpgrade |
Enable automatic upgrade of Sql IaaS extension Agent. |
| GroupResourceId |
ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of. |
| Id |
Resource ID. |
| IdentityPrincipalId |
The Azure Active Directory principal id. |
| IdentityTenantId |
The Azure Active Directory tenant id. |
| IdentityType |
The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. |
| KeyVaultCredentialSettingAzureKeyVaultUrl |
Azure Key Vault url. |
| KeyVaultCredentialSettingCredentialName |
Credential name. |
| KeyVaultCredentialSettingEnable |
Enable or disable key vault credential setting. |
| KeyVaultCredentialSettingServicePrincipalName |
Service principal name to access key vault. |
| KeyVaultCredentialSettingServicePrincipalSecret |
Service principal name secret to access key vault. |
| LeastPrivilegeMode |
SQL IaaS Agent least privilege mode. |
| Location |
Resource location. |
| Name |
Resource name. |
| ProvisioningState |
Provisioning state to track the async operation status. |
| ResourceGroupName |
Gets the resource group name |
| ScheduleDayOfWeek |
Day of the week to run assessment. |
| ScheduleEnable |
Enable or disable assessment schedule on SQL virtual machine. |
| ScheduleMonthlyOccurrence |
Occurrence of the DayOfWeek day within a month to schedule assessment. Takes values: 1,2,3,4 and -1. Use -1 for last DayOfWeek day of the month |
| ScheduleStartTime |
Time of the day in HH:mm format. Eg. 17:30 |
| ScheduleWeeklyInterval |
Number of weeks to schedule between 2 assessment runs. Takes value from 1-6 |
| SqlConnectivityUpdateSettingConnectivityType |
SQL Server connectivity option. |
| SqlConnectivityUpdateSettingPort |
SQL Server port. |
| SqlConnectivityUpdateSettingSqlAuthUpdatePassword |
SQL Server sysadmin login password. |
| SqlConnectivityUpdateSettingSqlAuthUpdateUserName |
SQL Server sysadmin login to create. |
| SqlDataSettingDefaultFilePath |
SQL Server default file path |
| SqlDataSettingLun |
Logical Unit Numbers for the disks. |
| SqlImageOffer |
SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016. |
| SqlImageSku |
SQL Server edition type. |
| SqlInstanceSettingCollation |
SQL Server Collation. |
| SqlInstanceSettingIsIfiEnabled |
SQL Server IFI. |
| SqlInstanceSettingIsLpimEnabled |
SQL Server LPIM. |
| SqlInstanceSettingIsOptimizeForAdHocWorkloadsEnabled |
SQL Server Optimize for Adhoc workloads. |
| SqlInstanceSettingMaxDop |
SQL Server MAXDOP. |
| SqlInstanceSettingMaxServerMemoryMb |
SQL Server maximum memory. |
| SqlInstanceSettingMinServerMemoryMb |
SQL Server minimum memory. |
| SqlLogSettingDefaultFilePath |
SQL Server default file path |
| SqlLogSettingLun |
Logical Unit Numbers for the disks. |
| SqlManagement |
SQL Server Management type. |
| SqlServerLicenseType |
SQL Server license type. |
| SqlStorageUpdateSettingDiskConfigurationType |
Disk configuration to apply to SQL Server. |
| SqlStorageUpdateSettingDiskCount |
Virtual machine disk count. |
| SqlStorageUpdateSettingStartingDeviceId |
Device id of the first disk to be updated. |
| SqlTempDbSettingDataFileCount |
SQL Server tempdb data file count |
| SqlTempDbSettingDataFileSize |
SQL Server tempdb data file size |
| SqlTempDbSettingDataGrowth |
SQL Server tempdb data file autoGrowth size |
| SqlTempDbSettingDefaultFilePath |
SQL Server default file path |
| SqlTempDbSettingLogFileSize |
SQL Server tempdb log file size |
| SqlTempDbSettingLogGrowth |
SQL Server tempdb log file autoGrowth size |
| SqlTempDbSettingLun |
Logical Unit Numbers for the disks. |
| SqlTempDbSettingPersistFolder |
SQL Server tempdb persist folder choice |
| SqlTempDbSettingPersistFolderPath |
SQL Server tempdb persist folder location |
| SqlWorkloadTypeUpdateSettingSqlWorkloadType |
SQL Server workload type. |
| StorageConfigurationSettingDiskConfigurationType |
Disk configuration to apply to SQL Server. |
| StorageConfigurationSettingSqlSystemDbOnDataDisk |
SQL Server SystemDb Storage on DataPool if true. |
| StorageConfigurationSettingStorageWorkloadType |
Storage workload type. |
| SystemDataCreatedAt |
The timestamp of resource creation (UTC). |
| SystemDataCreatedBy |
The identity that created the resource. |
| SystemDataCreatedByType |
The type of identity that created the resource. |
| SystemDataLastModifiedAt |
The timestamp of resource last modification (UTC) |
| SystemDataLastModifiedBy |
The identity that last modified the resource. |
| SystemDataLastModifiedByType |
The type of identity that last modified the resource. |
| Tag |
Resource tags. |
| TroubleshootingStatusEndTimeUtc |
End time in UTC timezone. |
| TroubleshootingStatusLastTriggerTimeUtc |
Last troubleshooting trigger time in UTC timezone |
| TroubleshootingStatusRootCause |
Root cause of the issue |
| TroubleshootingStatusStartTimeUtc |
Start time in UTC timezone. |
| TroubleshootingStatusTroubleshootingScenario |
SQL VM troubleshooting scenario. |
| Type |
Resource type. |
| UnhealthyReplicaInfoAvailabilityGroupName |
The name of the availability group |
| VirtualMachineResourceId |
ARM Resource id of underlying virtual machine created from SQL marketplace image. |
| WsfcDomainCredentialsClusterBootstrapAccountPassword |
Cluster bootstrap account password. |
| WsfcDomainCredentialsClusterOperatorAccountPassword |
Cluster operator account password. |
| WsfcDomainCredentialsSqlServiceAccountPassword |
SQL service account password. |
| WsfcStaticIP |
Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. |
Methods
| DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of SqlVirtualMachine. |
| DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of SqlVirtualMachine. |
| FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.SqlVirtualMachine.Models.Api20220801Preview.ISqlVirtualMachine. |
| FromJsonString(String) |
Creates a new instance of SqlVirtualMachine, deserializing the content from a json string. |
| ToJson(JsonObject, SerializationMode) |
Serializes this instance of SqlVirtualMachine into a JsonNode. |
| ToJsonString() |
Serializes this instance to a json string. |
| ToString() | |
| Validate(IEventListener) |
Validates that this object meets the validation criteria. |