Set-SmartAdmin

DBSystems: Configures SQL Server Smart Admin settings

Script

#Requires -Version 5.0
#Requires -Modules SQLServer

[CmdLetBinding()]
Param(
    [Parameter(Mandatory = $true)]   
    [string]$ServerInstance,    
    [pscredential]$ServerCredential,
    [string]$DatabaseName,
    [bool]$BackupEnabled,
    [int]$BackupRetentionPeriodInDays,
    [bool]$MasterSwitch,
    [int]$ConnectionTimeout = 30
)

function Get-SqlServerInstanceInternal {
    [CmdLetBinding()]
    Param(
        [Parameter(Mandatory = $true)]   
        [string]$ServerInstance,    
        [pscredential]$ServerCredential,
        [int]$ConnectionTimeout = 30
    )
    try {
        [hashtable]$cmdArgs = @{
            'ErrorAction' = 'Stop'
            'Confirm' = $false
            'ServerInstance' = $ServerInstance
            'ConnectionTimeout' = $ConnectionTimeout
        }
        if ($null -ne $ServerCredential) {
            $cmdArgs.Add('Credential', $ServerCredential)
        }
        return Get-SqlInstance @cmdArgs
    } catch {
        throw
    }
}

Import-Module SQLServer

try {
    $instance = Get-SqlServerInstanceInternal -ServerInstance $ServerInstance -ServerCredential $ServerCredential -ConnectionTimeout $ConnectionTimeout

    [hashtable]$getArgs = @{
        'ErrorAction' = 'Stop'
        'InputObject' = $instance
        'Confirm' = $false
    }    
    [hashtable]$setArgs = @{
        'ErrorAction' = 'Stop'
        'BackupEnabled' = $BackupEnabled
        'MasterSwitch' = $MasterSwitch
        'Confirm' = $false
    }
    if (-not [string]::IsNullOrWhiteSpace($DatabaseName)) {
        $getArgs.Add('DatabaseName', $DatabaseName)
    }
    if ($BackupRetentionPeriodInDays -gt 0) {
        $setArgs.Add('BackupRetentionPeriodInDays', $BackupRetentionPeriodInDays)
    }

    $smartAdmin = Get-SqlSmartAdmin @getArgs
    $result = $smartAdmin | Set-SqlSmartAdmin @setArgs | Select-Object *    
    Write-Output $result
} catch {
    throw
}

Customize

ServerInstance string

Specifies the name of the target computer including the instance name, e.g. MyServer\Instance

ServerCredential pscredential

Specifies a PSCredential object for the connection to the SQL Server. ServerCredential is ONLY used for SQL Logins. When you are using Windows Authentication you don't specify -Credential. It is picked up from your current login.

DatabaseName string

Specifies the name of the database for which to configure Smart Admin settings

BackupEnabled bool

Indicates whether SQL Server Managed Backup to Windows Azure should be enabled

BackupRetentionPeriodInDays int

Specifies the number of days the backup files should be retained

MasterSwitch bool

Indicates whether to pause or restart all services under Smart Admin

ConnectionTimeout int

Specifies the time period to retry the command on the target server