xPSDesiredStateConfiguration

8.5.0.0

The xPSDesiredStateConfiguration module is a part of the Windows PowerShell Desired State Configuration (DSC) Resource Kit, which is a collection of DSC Resources produced by the PowerShell Team. This module contains the xDscWebService, xWindowsProcess, xService, xPackage, xArchive, xRemoteFile, xPSEndpoint and xWindowsOptionalFeature resources. Please see the Details
The xPSDesiredStateConfiguration module is a part of the Windows PowerShell Desired State Configuration (DSC) Resource Kit, which is a collection of DSC Resources produced by the PowerShell Team. This module contains the xDscWebService, xWindowsProcess, xService, xPackage, xArchive, xRemoteFile, xPSEndpoint and xWindowsOptionalFeature resources. Please see the Details section for more information on the functionalities provided by these resources.

All of the resources in the DSC Resource Kit are provided AS IS, and are not supported through any Microsoft standard support program or service. The "x" in xPSDesiredStateConfiguration stands for experimental, which means that these resources will be fix forward and monitored by the module owner(s).

Minimum PowerShell version

4.0

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name xPSDesiredStateConfiguration

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deloy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Author(s)

Microsoft Corporation

Copyright

(c) Microsoft Corporation. All rights reserved.

Owners

Tags

DesiredStateConfiguration DSC DSCResourceKit DSCResource

Functions

Publish-DSCModuleAndMof Publish-ModuleToPullServer Publish-MOFToPullServer

DSCResources

xArchive xDSCWebService xEnvironment xFileUpload xGroup xGroupSet xMsiPackage xPackage xProcessSet xPSEndpoint xRegistry xRemoteFile xScript xService xServiceSet xUser xWindowsFeature xWindowsFeatureSet xWindowsOptionalFeature xWindowsOptionalFeatureSet xWindowsPackageCab xWindowsProcess

Dependencies

This module has no dependencies.

Release Notes

- Pull server module publishing
 - Removed forced verbose logging from CreateZipFromSource, Publish-DSCModulesAndMof and Publish-MOFToPullServer as it polluted the console
- Corrected GitHub Pull Request template to remove referral to
 `BestPractices.MD` which has been combined into `StyleGuidelines.md`
 ([issue 520](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/520)).
- xWindowsOptionalFeature
 - Suppress useless verbose output from `Import-Module` cmdlet.
   ([issue 453](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/453)).
- Changes to xRemoteFile
 - Corrected a resource name in the example xRemoteFile_DownloadFileConfig.ps1
- Fix `MSFT_xDSCWebService` to find
`Microsoft.Powershell.DesiredStateConfiguration.Service.Resources.dll`
 when server is configured with pt-BR Locales
 ([issue 284](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/284)).
- Changes to xDSCWebService
 - Fixed an issue which prevented the removal of the IIS Application Pool
   created during deployment of an DSC Pull Server instance.
   ([issue 464](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/464))
 - Fixed an issue where a Pull Server cannot be deployed on a machine when IIS
   Express is installed aside a full blown IIS
   ([issue 191](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/191))
- Update `CommonResourceHelper` unit tests to meet Pester 4.0.0
 standards
 ([issue 473](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/473)).
- Update `ResourceHelper` unit tests to meet Pester 4.0.0
 standards
 ([issue 473](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/473)).
- Update `MSFT_xDSCWebService` unit tests to meet Pester 4.0.0
 standards
 ([issue 473](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/473)).
- Update `MSFT_xDSCWebService` integration tests to meet Pester 4.0.0
 standards
 ([issue 473](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/473)).
- Refactored `MSFT_xDSCWebService` integration tests to meet current
 standards and to use Pester TestDrive.
- xArchive
 - Fix end-to-end tests
   ([issue 457](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/457)).
 - Update integration tests to meet Pester 4.0.0 standards.
 - Update end-to-end tests to meet Pester 4.0.0 standards.
 - Update unit and integration tests to meet Pester 4.0.0 standards.
 - Wrapped all path and identifier strings in verbose messages with
   quotes to make it easier to identify the limit of the string when
   debugging.
 - Refactored date/time checksum code to improve testability and ensure
   tests can run on machines with localized datetime formats that are not
   US.
 - Fix "Get-ArchiveEntryLastWriteTime" to return `[datetime]`
   ([issue 471](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/471)).
 - Improved verbose logging to make debugging path issues easier.
 - Added handling for "/" as a path seperator by backporting code from
   PSDscResources -
   ([issue 469](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/469)).
 - Copied unit tests from
   [PSDscResources](https://github.com/PowerShell/PSDscResources).
 - Added .gitattributes file and removed git configuration from AppVeyor
   to ensure CRLF settings are configured correctly for the repository.
- Updated ".vscode\settings.json" to refer to AnalyzerSettings.psd1 so that
 custom syntax problems are highlighted in Visual Studio Code.
- Fixed style guideline violations in `CommonResourceHelper.psm1`.
- Changes to xService
 - Fixes issue where Get-TargetResource or Test-TargetResource will throw an
   exception if the target service is configured with a non-existent
   dependency.
 - Refactored Get-TargetResource Unit tests.
- Changes to xPackage
 - Fixes an issue where incorrect verbose output was displayed if product
   found.
   ([issue 446](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/446))
- Fixes files which are getting triggered for re-encoding after recent pull
 request (possibly 472).
- Moves version and change history from README.MD to new file, CHANGELOG.MD.
- Fixes markdown issues in README.MD and HighQualityResourceModulePlan.md.
- Opted in to "Common Tests - Validate Markdown Files"
- Changes to xPSDesiredStateConfiguration
 - In AppVeyor CI the tests are split into three separate jobs, and also
   run tests on two different build worker images (Windows Server 2012R2
   and Windows Server 2016). The common tests are only run on the
   Windows Server 2016 build worker image. Helps with
   [issue 477](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/477).
- xGroup
 - Corrected style guideline violations. ([issue 485](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/485))
- xWindowsProcess
 - Corrected style guideline violations. ([issue 496](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/496))
- Changes to PSWSIISEndpoint.psm1
 - Fixes most PSScriptAnalyzer issues.
- Changes to xRegistry
 - Fixed an issue that fails to remove reg key when the `Key` is specified as
   common registry path.
   ([issue 444](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/444))
- Changes to xService
 - Added support for Group Managed Service Accounts
- Adds new Integration tests for MSFT_xDSCWebService and removes old
 Integration test file, MSFT_xDSCWebService.xxx.ps1.
- xRegistry
 - Corrected style guideline violations. ([issue 489](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/489))
...
Continued release notes can be found at https://github.com/PowerShell/xPSDesiredStateConfiguration/blob/dev/CHANGELOG.md

Version History

Version Downloads Last updated
8.5.0.0 (current version) 20,718 2/21/2019
8.4.0.0 338,623 7/25/2018
8.3.0.0 2,834,604 6/13/2018
8.2.0.0 2,805,913 4/20/2018
8.1.0.0 93,063 3/22/2018
8.0.0.0 395,988 11/15/2017
7.0.0.0 77,510 8/23/2017
6.4.0.0 41,695 5/9/2017
6.3.0.0 4,477 5/1/2017
6.2.0.0 6,065 4/19/2017
6.1.0.0 22,969 3/8/2017
6.0.0.0 14,752 2/3/2017
5.2.0.0 5,704 1/26/2017
5.1.0.0 6,991 12/17/2016
5.0.0.0 19,189 11/2/2016
4.0.0.0 17,026 9/21/2016
3.13.0.0 8,644 8/10/2016
3.12.0.0 5,164 6/30/2016
3.11.0.0 261 6/29/2016
3.10.0.0 6,033 5/18/2016
3.9.0.0 5,252 3/31/2016
3.8.0.0 832 3/19/2016
3.7.0.0 15,978 2/3/2016
3.6.0.0 2,871 12/3/2015
3.5.0.0 3,188 9/11/2015
3.4.0.0 780 7/24/2015
3.3.0.0 365 6/9/2015
3.2.0.0 357 5/2/2015
3.1.3.4 94 4/23/2015
3.0.3.4 747 12/18/2014
3.0.3.3 45 12/1/2014
3.0.3.0 81 11/10/2014
3.0.2.0 191 8/22/2014
3.0.1.0 79 7/22/2014
3.0.0.0 725 6/6/2014
2.0.1 91 5/13/2014
2.0.0.0 114 4/8/2014