.NET Разработчик: “День 2685. #ЗаметкиНаПолях #PowerShell Атрибуты Валидации Параметров в…”

День 2685. #ЗаметкиНаПолях #PowerShell
Атрибуты Валидации Параметров в PowerShell. Окончание
Начало

ValidateNotNull
Проверяет, что параметр не null.

function Process-Data {
  param(
    [ValidateNotNull()]
    [object]$Data
   )
   Write-Host "Обработка данных: $Data"
}

Process-Data -Data 'some data'  #✅
Process-Data -Data $null        #❌

ValidateNotNullOrEmpty
Проверяет, что строка или коллекция не null и не пустая.

function Write-Log {
  param(
    [ValidateNotNullOrEmpty()]
    [string]$Message
  )
  Write-Host "Log: $Message"
}

Write-Log -Message 'Important event'  #✅
Write-Log -Message ''                 #❌
Write-Log -Message $null              #❌

ValidateNotNullOrWhiteSpace
Аналогично предыдущему, проверяет, что строка не null, не пустая и не пробел.

ValidateDrive
Проверяет, что путь использует один из указанных дисков.

function Get-FileInfo {
  param(
    [ValidateDrive('C', 'D', 'Temp')]
    [string]$Path
  )
  Write-Host "Получаем данные для: $Path"
}

Get-FileInfo -Path 'C:\Windows\System32' #✅
# если диск Temp существует
Get-FileInfo -Path 'Temp:\file.txt'       #✅
Get-FileInfo -Path 'Z:\file.txt'          #❌

ValidateUserDrive
Проверяет, что путь использует диск, созданный пользователем в PowerShell (а не встроенные C:, D:, и т.п.).

New-PSDrive -Name 'MyDrive' -PSProvider FileSystem -Root 'C:\MyFolder'

function Read-UserFile {
  param(
    [ValidateDrive()]
    [ValidateUserDrive()]
    [string]$Path
  )
  Get-Content -Path $Path
}

Read-UserFile -Path 'MyDrive:\file.txt'  #✅
Read-UserFile -Path 'C:\file.txt'        #❌

ValidateTrustedData
С версии 6.1.1+ проверяет, что данные происходят из надёжного источника.

function Invoke-TrustedCommand {
  param(
    [ValidateTrustedData()]
    [string]$Command
  )
  Invoke-Expression $Command
}

Это используется в основном в сценариях, требующих повышенного внимания к безопасности, для обеспечения того, чтобы параметры поступали из доверенных источников, а не были введены пользователем.

Комбинирование нескольких атрибутов
К одному параметру можно применить несколько атрибутов проверки:


function Set-Configuration {
  param(
    [ValidateNotNullOrEmpty()]
    [ValidateLength(3, 50)]
    [ValidatePattern('^[a-zA-Z0-9_-]+$')]
    [string]$ConfigName
  )
  Write-Host "Установка конфигурации: $ConfigName"
}

Set-Configuration -ConfigName 'my-config_123' #✅
Set-Configuration -ConfigName 'ab'            #❌
Set-Configuration -ConfigName 'invalid@name'  #❌

Все атрибуты валидации проверяются в порядке появления. Если любая из валидаций завершается неудачей, ошибка выбрасывается немедленно.

Источник: https://www.meziantou.net/powershell-parameter-validation-attributes.htm