DscResource.Common

Author(s)

• DSC Community

Tags

DSC Localization

Functions

Assert-BoundParameter Assert-ElevatedUser Assert-IPAddress Assert-Module Compare-DscParameterState Compare-ResourcePropertyState ConvertFrom-DscResourceInstance ConvertTo-CimInstance ConvertTo-HashTable Get-ComputerName Get-DscProperty Get-LocalizedData Get-LocalizedDataForInvariantCulture Get-TemporaryFolder New-InvalidArgumentException New-InvalidDataException New-InvalidOperationException New-InvalidResultException New-NotImplementedException New-ObjectNotFoundException Remove-CommonParameter Set-DscMachineRebootRequired Set-PSModulePath Test-AccountRequirePassword Test-DscParameterState Test-DscProperty Test-IsNanoServer Test-IsNumericType

Dependencies

This module has no dependencies.

Release Notes

## [0.14.0-preview0002] - 2022-12-31

### Added

- Added private function `Assert-RequiredCommandParameter` that throws an
 exception if a specified parameter is not assigned a value, and optionally
 throws only if a specific parameter is passed. - [Issue #92](https://github.com/dsccommunity/DscResource.Common/issues/92)
 - Related to SqlServerDsc [Issue #1796](https://github.com/dsccommunity/SqlServerDsc/issues/1796).
- Added public function `Test-AccountRequirePassword` that returns true or
 false whether an account need a password to be passed - [Issue #93](https://github.com/dsccommunity/DscResource.Common/issues/93)
 - Related to SqlServerDsc [Issue #1794](https://github.com/dsccommunity/SqlServerDsc/issues/1794).
- Added public command `Get-DscProperty` that returns a hashtable of available
 properties for a class-based resource. See comment-based help for more
 information.
- Added public command `Test-DscProperty` that returns a true or false
 whether a property exist in a class-based resource. See comment-based help
 for more information.
- Added private function `Test-DscPropertyIsAssigned` that returns a true
 or false whether a property in a class-based resource has a non-null value.

### Changed

- DscResource.Common
 - Updated Visual Studio Code project settings to configure testing for Pester 5.
- `Assert-BoundParameter`
 - Now has a new parameter set that calls `Assert-RequiredCommandParameter`
   which will throw an exception if a specified parameter is not assigned
   a value, and optionally throws only if a specific parameter is passed.

### Fixed

- Fixed unit tests for `Assert-ElevatedUser` and `Test-IsNumericType` so
 the public function is tested correctly using the exported function.
- Fixed unit tests to easier run test both from command line and inside
 Visual Studio Code.