Package-level declarations

Types

Link copied to clipboard
data class AADAuthenticationSettingsResponse(val clientId: String? = null)

Enable AAD authentication for SQL VM.

data class AdditionalFeaturesServerConfigurationsResponse(val isRServicesEnabled: Boolean? = null)

Additional SQL Server feature settings.

Link copied to clipboard
data class AgConfigurationResponse(val replicas: List<AgReplicaResponse>? = null)

Availability group configuration.

Link copied to clipboard
data class AgReplicaResponse(val commit: String? = null, val failover: String? = null, val readableSecondary: String? = null, val role: String? = null, val sqlVirtualMachineInstanceId: String? = null)

Availability group replica configuration.

Link copied to clipboard
data class AssessmentSettingsResponse(val enable: Boolean? = null, val runImmediately: Boolean? = null, val schedule: ScheduleResponse? = null)

Configure SQL best practices Assessment for databases in your SQL virtual machine.

Link copied to clipboard
data class AutoBackupSettingsResponse(val backupScheduleType: String? = null, val backupSystemDbs: Boolean? = null, val daysOfWeek: List<String>? = null, val enable: Boolean? = null, val enableEncryption: Boolean? = null, val fullBackupFrequency: String? = null, val fullBackupStartTime: Int? = null, val fullBackupWindowHours: Int? = null, val logBackupFrequency: Int? = null, val retentionPeriod: Int? = null, val storageAccountUrl: String? = null, val storageContainerName: String? = null)

Configure backups for databases in your SQL virtual machine.

Link copied to clipboard
data class AutoPatchingSettingsResponse(val additionalVmPatch: String? = null, val dayOfWeek: String? = null, val enable: Boolean? = null, val maintenanceWindowDuration: Int? = null, val maintenanceWindowStartingHour: Int? = null)

Set a patching window during which Windows and SQL patches will be applied.

Link copied to clipboard
data class GetAvailabilityGroupListenerResult(val availabilityGroupConfiguration: AgConfigurationResponse? = null, val availabilityGroupName: String? = null, val azureApiVersion: String, val createDefaultAvailabilityGroupIfNotExist: Boolean? = null, val id: String, val loadBalancerConfigurations: List<LoadBalancerConfigurationResponse>? = null, val multiSubnetIpConfigurations: List<MultiSubnetIpConfigurationResponse>? = null, val name: String, val port: Int? = null, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

A SQL Server availability group listener.

Link copied to clipboard
data class GetSqlVirtualMachineGroupResult(val azureApiVersion: String, val clusterConfiguration: String, val clusterManagerType: String, val id: String, val location: String, val name: String, val provisioningState: String, val scaleType: String, val sqlImageOffer: String? = null, val sqlImageSku: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val wsfcDomainProfile: WsfcDomainProfileResponse? = null)

A SQL virtual machine group.

Link copied to clipboard
data class GetSqlVirtualMachineResult(val additionalVmPatch: String, val assessmentSettings: AssessmentSettingsResponse? = null, val autoBackupSettings: AutoBackupSettingsResponse? = null, val autoPatchingSettings: AutoPatchingSettingsResponse? = null, val azureApiVersion: String, val enableAutomaticUpgrade: Boolean? = null, val id: String, val identity: ResourceIdentityResponse? = null, val keyVaultCredentialSettings: KeyVaultCredentialSettingsResponse? = null, val leastPrivilegeMode: String? = null, val location: String, val name: String, val osType: String, val provisioningState: String, val serverConfigurationsManagementSettings: ServerConfigurationsManagementSettingsResponse? = null, val sqlImageOffer: String? = null, val sqlImageSku: String? = null, val sqlManagement: String? = null, val sqlServerLicenseType: String? = null, val sqlVirtualMachineGroupResourceId: String? = null, val storageConfigurationSettings: StorageConfigurationSettingsResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val troubleshootingStatus: TroubleshootingStatusResponse, val type: String, val virtualMachineIdentitySettings: VirtualMachineIdentityResponse? = null, val virtualMachineResourceId: String? = null, val wsfcDomainCredentials: WsfcDomainCredentialsResponse? = null, val wsfcStaticIp: String? = null)

A SQL virtual machine.

Link copied to clipboard
data class KeyVaultCredentialSettingsResponse(val azureKeyVaultUrl: String? = null, val credentialName: String? = null, val enable: Boolean? = null, val servicePrincipalName: String? = null)

Configure your SQL virtual machine to be able to connect to the Azure Key Vault service.

Link copied to clipboard
data class LoadBalancerConfigurationResponse(val loadBalancerResourceId: String? = null, val privateIpAddress: PrivateIPAddressResponse? = null, val probePort: Int? = null, val publicIpAddressResourceId: String? = null, val sqlVirtualMachineInstances: List<String>? = null)

A load balancer configuration for an availability group listener.

Link copied to clipboard
data class MultiSubnetIpConfigurationResponse(val privateIpAddress: PrivateIPAddressResponse, val sqlVirtualMachineInstance: String)

Multi subnet ip configuration for an availability group listener.

Link copied to clipboard
data class PrivateIPAddressResponse(val ipAddress: String? = null, val subnetResourceId: String? = null)

A private IP address bound to the availability group listener.

Link copied to clipboard
data class ResourceIdentityResponse(val principalId: String, val tenantId: String, val type: String? = null)

Azure Active Directory identity configuration for a resource.

Link copied to clipboard
data class ScheduleResponse(val dayOfWeek: String? = null, val enable: Boolean? = null, val monthlyOccurrence: Int? = null, val startTime: String? = null, val weeklyInterval: Int? = null)

Set assessment schedule for SQL Server.

data class ServerConfigurationsManagementSettingsResponse(val additionalFeaturesServerConfigurations: AdditionalFeaturesServerConfigurationsResponse? = null, val azureAdAuthenticationSettings: AADAuthenticationSettingsResponse? = null, val sqlConnectivityUpdateSettings: SqlConnectivityUpdateSettingsResponse? = null, val sqlInstanceSettings: SQLInstanceSettingsResponse? = null, val sqlStorageUpdateSettings: SqlStorageUpdateSettingsResponse? = null, val sqlWorkloadTypeUpdateSettings: SqlWorkloadTypeUpdateSettingsResponse? = null)

Set the connectivity, storage and workload settings.

Link copied to clipboard
data class SqlConnectivityUpdateSettingsResponse(val connectivityType: String? = null, val port: Int? = null)

Set the access level and network port settings for SQL Server.

Link copied to clipboard
data class SQLInstanceSettingsResponse(val collation: String? = null, val isIfiEnabled: Boolean? = null, val isLpimEnabled: Boolean? = null, val isOptimizeForAdHocWorkloadsEnabled: Boolean? = null, val maxDop: Int? = null, val maxServerMemoryMB: Int? = null, val minServerMemoryMB: Int? = null)

Set the server/instance-level settings for SQL Server.

Link copied to clipboard
data class SQLStorageSettingsResponse(val defaultFilePath: String? = null, val luns: List<Int>? = null, val useStoragePool: Boolean? = null)

Set disk storage settings for SQL Server.

Link copied to clipboard
data class SqlStorageUpdateSettingsResponse(val diskConfigurationType: String? = null, val diskCount: Int? = null, val startingDeviceId: Int? = null)

Set disk storage settings for SQL Server.

Link copied to clipboard
data class SQLTempDbSettingsResponse(val dataFileCount: Int? = null, val dataFileSize: Int? = null, val dataGrowth: Int? = null, val defaultFilePath: String? = null, val logFileSize: Int? = null, val logGrowth: Int? = null, val luns: List<Int>? = null, val persistFolder: Boolean? = null, val persistFolderPath: String? = null, val useStoragePool: Boolean? = null)

Set tempDb storage settings for SQL Server.

Link copied to clipboard
data class SqlWorkloadTypeUpdateSettingsResponse(val sqlWorkloadType: String? = null)

Set workload type to optimize storage for SQL Server.

Link copied to clipboard
data class StorageConfigurationSettingsResponse(val diskConfigurationType: String? = null, val sqlDataSettings: SQLStorageSettingsResponse? = null, val sqlLogSettings: SQLStorageSettingsResponse? = null, val sqlSystemDbOnDataDisk: Boolean? = null, val sqlTempDbSettings: SQLTempDbSettingsResponse? = null, val storageWorkloadType: String? = null)

Storage Configurations for SQL Data, Log and TempDb.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

SQL VM Troubleshooting additional properties.

Link copied to clipboard
data class TroubleshootingStatusResponse(val endTimeUtc: String, val lastTriggerTimeUtc: String, val properties: TroubleshootingAdditionalPropertiesResponse, val rootCause: String, val startTimeUtc: String, val troubleshootingScenario: String)

Status of last troubleshooting operation on this SQL VM

Link copied to clipboard
data class UnhealthyReplicaInfoResponse(val availabilityGroupName: String? = null)

SQL VM Troubleshoot UnhealthyReplica scenario information.

Link copied to clipboard
data class VirtualMachineIdentityResponse(val resourceId: String? = null, val type: String? = null)

Virtual Machine Identity details used for Sql IaaS extension configurations.

Link copied to clipboard
data class WsfcDomainCredentialsResponse(val clusterBootstrapAccountPassword: String? = null, val clusterOperatorAccountPassword: String? = null, val sqlServiceAccountPassword: String? = null)

Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.

Link copied to clipboard
data class WsfcDomainProfileResponse(val clusterBootstrapAccount: String? = null, val clusterOperatorAccount: String? = null, val clusterSubnetType: String? = null, val domainFqdn: String? = null, val fileShareWitnessPath: String? = null, val isSqlServiceAccountGmsa: Boolean? = null, val ouPath: String? = null, val sqlServiceAccount: String? = null, val storageAccountUrl: String? = null)

Active Directory account details to operate Windows Server Failover Cluster.