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

Set-SqlSmartAdmin

  • Ссылка
Модуль:
SQLServer

Настраивает или изменяет параметры хранения резервных копий и хранилища.

Синтаксис

Set-SqlSmartAdmin
   [-SqlCredential <PSObject>]
   [-MasterSwitch <Boolean>]
   [-BackupEnabled <Boolean>]
   [-BackupRetentionPeriodInDays <Int32>]
   [-EncryptionOption <BackupEncryptionOptions>]
   [-DatabaseName <String>]
   [[-Path] <String>]
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-SqlSmartAdmin
   [-SqlCredential <PSObject>]
   [-MasterSwitch <Boolean>]
   [-BackupEnabled <Boolean>]
   [-BackupRetentionPeriodInDays <Int32>]
   [-EncryptionOption <BackupEncryptionOptions>]
   [-DatabaseName <String>]
   [-InputObject] <SmartAdmin>
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Описание

Командлет Set-SqlSmartAdmin настраивает или изменяетBackupEnabled , BackupRetentionPeriodinDays, MasterSwitchи параметры параметра SqlCredential. Этот командлет можно запускать только для конфигураций уровня экземпляра, а не для конкретной базы данных.

Этот командлет поддерживает следующие режимы операции для возврата объекта:

  • Передайте объект Smo.Server в параметр InputObject напрямую или через конвейер.
  • Передайте путь экземпляра SQL Server в параметр Path

Примеры

Пример 1. Настройка параметров хранения резервных копий и хранилища

PS C:\> $EncryptionOption = New-SqlBackupEncryptionOption -EncryptionAlgorithm Aes128 -EncryptorType ServerCertificate -EncryptorName "MyBackupCert"

Эта команда настраивает хранение резервных копий для параметров хранения, использующих шифратор с именем MyBackupCert, и сохраняет результат в переменной с именем $EncryptionOption.

Параметры

-AccessToken

Маркер доступа, используемый для проверки подлинности в SQL Server, в качестве альтернативы пользователю или паролю или проверке подлинности Windows.

Это можно использовать, например, для подключения к SQL Azure DB и SQL Azure Managed Instance с помощью Service Principal или Managed Identity.

Используемый параметр может быть строкой, представляющей маркер или объект PSAccessToken, как возвращается при выполнении Get-AzAccessToken -ResourceUrl https://database.windows.net.

Этот параметр является новым в версии 22 модуля.

Тип:PSObject
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-BackupEnabled

Указывает, что этот командлет включает управляемое резервное копирование SQL Server в Windows Azure.

Тип:Boolean
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-BackupRetentionPeriodInDays

Указывает количество дней хранения файлов резервной копии. Это определяет интервал времени восстановления для баз данных. Например, если задать значение в течение 30 дней, можно восстановить базу данных до точки во времени за последние 30 дней.

Тип:Int32
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Confirm

Запрашивает подтверждение перед запуском командлета.

Тип:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-DatabaseName

Указывает имя базы данных, которую изменяет этот командлет.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Encrypt

Тип шифрования, используемый при подключении к SQL Server.

Это значение сопоставляется со свойством EncryptSqlConnectionEncryptOption в объекте SqlConnection драйвера Microsoft.Data.SqlClient.

В версии 22 модуля по умолчанию используется Optional (для совместимости с версией 21). В версии 23+ модуля значение по умолчанию будет "Обязательный", которое может создать критическое изменение для существующих скриптов.

Этот параметр является новым в версии 22 модуля.

Тип:String
Допустимые значения:Mandatory, Optional, Strict
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-EncryptionOption

Задает параметры шифрования.

Тип:BackupEncryptionOptions
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-HostNameInCertificate

Имя узла, используемое при проверке TLS/SSL-сертификата SQL Server. Этот параметр необходимо передать, если экземпляр SQL Server включен для принудительного шифрования и требуется подключиться к экземпляру с помощью имени узла или короткого имени. Если этот параметр опущен, передача полного доменного имени (FQDN) в -ServerInstance необходима для подключения к экземпляру SQL Server, включенного для принудительного шифрования.

Этот параметр является новым в версии 22 модуля.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-InputObject

Указывает объект Smo Smart Admin. Для получения этого объекта можно использовать командлет Get-SqlSmartAdmin.

Тип:SmartAdmin
Position:1
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-MasterSwitch

Указывает, что этот командлет приостанавливает или перезапускает все службы в разделе "Интеллектуальный администратор", включая управляемое резервное копирование SQL Server в Windows Azure.

Тип:Boolean
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Path

Указывает путь к экземпляру SQL Server. Если значение этого параметра не указано, командлет использует текущий рабочий каталог. Это полезно при создании скриптов для управления несколькими экземплярами.

Тип:String
Position:1
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-ProgressAction

Определяет, как PowerShell реагирует на обновления хода выполнения, созданные скриптом, командлетом или поставщиком, например индикаторами хода выполнения, созданными командлетом Write-Progress. Командлет Write-Progress создает индикаторы хода выполнения, показывающие состояние команды.

Тип:ActionPreference
Aliases:proga
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Script

Указывает, что этот командлет возвращает скрипт Transact-SQL, выполняющий задачу, выполняемую этим командлетом.

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-SqlCredential

Указывает объект SqlCredential, используемый для проверки подлинности в учетной записи хранения Windows Azure.

Тип:PSObject
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-TrustServerCertificate

Указывает, будет ли канал зашифрован при обходе цепочки сертификатов для проверки доверия.

В версии 22 модуля по умолчанию используется $true (для совместимости с версией 21). В версии 23+ модуля значение по умолчанию будет иметь значение "$false", которое может создать критическое изменение для существующих скриптов.

Этот параметр является новым в версии 22 модуля.

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-WhatIf

Показывает, что произойдет, если командлет выполняется. Командлет не выполняется.

Тип:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

Входные данные

Microsoft.SqlServer.Management.Smo.SmartAdmin