xActiveDirectory

3.0.0.0

The xActiveDirectory module is originally part of the Windows PowerShell Desired State Configuration (DSC) Resource Kit. This version has been modified for use in Azure. This module contains the xADDomain, xADDomainController, xADUser, and xWaitForDomain resources. These DSC Resources allow you to configure and manage Active Directory.

All of the resources in the D
The xActiveDirectory module is originally part of the Windows PowerShell Desired State Configuration (DSC) Resource Kit. This version has been modified for use in Azure. This module contains the xADDomain, xADDomainController, xADUser, and xWaitForDomain resources. These DSC Resources allow you to configure and manage Active Directory.

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.

Minimum PowerShell version

4.0

Installation Options

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

Install-Module -Name xActiveDirectory

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) 2014 Microsoft Corporation. All rights reserved.

Owners

Tags

DesiredStateConfiguration DSC DSCResourceKit DSCResource

DSCResources

xADComputer xADDomain xADDomainController xADDomainDefaultPasswordPolicy xADDomainTrust xADForestProperties xADGroup xADKDSKey xADManagedServiceAccount xADObjectEnabledState xADObjectPermissionEntry xADOrganizationalUnit xADRecycleBin xADReplicationSite xADReplicationSiteLink xADReplicationSubnet xADServicePrincipalName xADUser xWaitForADDomain

Dependencies

This module has no dependencies.

Release Notes

- Changes to xActiveDirectory
 - Added new helper functions in xADCommon, see each functions comment-based
   help for more information.
   - Convert-PropertyMapToObjectProperties
   - Compare-ResourcePropertyState
   - Test-DscPropertyState
 - Move the examples in the README.md to Examples folder.
 - Fix Script Analyzer rule failures.
 - Opt-in to the following DSC Resource Common Meta Tests:
   - Common Tests - Custom Script Analyzer Rules
   - Common Tests - Required Script Analyzer Rules
   - Common Tests - Flagged Script Analyzer Rules
   - Common Tests - Validate Module Files ([issue 282](https://github.com/PowerShell/xActiveDirectory/issues/282))
   - Common Tests - Validate Script Files ([issue 283](https://github.com/PowerShell/xActiveDirectory/issues/283))
   - Common Tests - Relative Path Length ([issue 284](https://github.com/PowerShell/xActiveDirectory/issues/284))
   - Common Tests - Validate Markdown Links ([issue 280](https://github.com/PowerShell/xActiveDirectory/issues/280))
   - Common Tests - Validate Localization ([issue 281](https://github.com/PowerShell/xActiveDirectory/issues/281))
   - Common Tests - Validate Example Files ([issue 279](https://github.com/PowerShell/xActiveDirectory/issues/279))
   - Common Tests - Validate Example Files To Be Published ([issue 311](https://github.com/PowerShell/xActiveDirectory/issues/311))
 - Move resource descriptions to Wiki using auto-documentation ([issue 289](https://github.com/PowerShell/xActiveDirectory/issues/289))
 - Move helper functions from MSFT_xADCommon to the module
   xActiveDirectory.Common ([issue 288](https://github.com/PowerShell/xActiveDirectory/issues/288)).
   - Removed helper function `Test-ADDomain` since it was not used. The
     helper function had design flaws too.
   - Now the helper function `Test-Members` outputs all the members that
     are not in desired state when verbose output is enabled.
 - Update all unit tests to latest unit test template.
 - Deleted the obsolete xActiveDirectory_TechNetDocumentation.html file.
 - Added new resource xADObjectEnabledState. This resource should be
   used to enforce the `Enabled` property of computer accounts. This
   resource replaces the deprecated `Enabled` property in the resource
   xADComputer.
 - Cleanup of code
   - Removed semicolon throughout where it is not needed.
   - Migrate tests to Pester syntax v4.x ([issue 322](https://github.com/PowerShell/xActiveDirectory/issues/322)).
   - Removed `-MockWith {}` in unit tests.
   - Use fully qualified type names for parameters and variables
     ([issue 374](https://github.com/PowerShell/xActiveDirectory/issues/374)).
 - Removed unused legacy test files from the root of the repository.
 - Updated Example List README with missing resources.
 - Added missing examples for xADReplicationSubnet, xADServicePrincipalName and xWaitForADDomain. ([issue 395](https://github.com/PowerShell/xActiveDirectory/issues/395)).
- Changes to xADComputer
 - Refactored the resource and the unit tests.
 - BREAKING CHANGE: The `Enabled` property is **DEPRECATED** and is no
   longer set or enforces with this resource. _If this parameter is_
   _used in a configuration a warning message will be outputted saying_
   _that the `Enabled` parameter has been deprecated_. The new resource
   [xADObjectEnabledState](https://github.com/PowerShell/xActiveDirectoryxadobjectenabledstate)
   can be used to enforce the `Enabled` property.
 - BREAKING CHANGE: The default value of the enabled property of the
   computer account will be set to the default value of the cmdlet
   `New-ADComputer`.
 - A new parameter was added called `EnabledOnCreation` that will control
   if the computer account is created enabled or disabled.
 - Moved examples from the README.md to separate example files in the
   Examples folder.
 - Fix the RestoreFromRecycleBin description.
 - Fix unnecessary cast in `Test-TargetResource` ([issue 295](https://github.com/PowerShell/xActiveDirectory/issues/295)).
 - Fix ServicePrincipalNames property empty string exception ([issue 382](https://github.com/PowerShell/xActiveDirectory/issues/382)).
- Changes to xADGroup
 - Change the description of the property RestoreFromRecycleBin.
 - Code cleanup.
- Changes to xADObjectPermissionEntry
 - Change the description of the property IdentityReference.
 - Fix failure when applied in the same configuration as xADDomain.
 - Localize and Improve verbose messaging.
 - Code cleanup.
- Changes to xADOrganizationalUnit
 - Change the description of the property RestoreFromRecycleBin.
 - Code cleanup.
 - Fix incorrect verbose message when this resource has Ensure set to Absent ([issue 276](https://github.com/PowerShell/xActiveDirectory/issues/276)).
- Changes to xADUser
 - Change the description of the property RestoreFromRecycleBin.
 - Added ServicePrincipalNames property ([issue 153](https://github.com/PowerShell/xActiveDirectory/issues/153)).
 - Added ChangePasswordAtLogon property ([issue 246](https://github.com/PowerShell/xActiveDirectory/issues/246)).
 - Code cleanup.
 - Added LogonWorkstations property
 - Added Organization property
 - Added OtherName property
 - Added AccountNotDelegated property
 - Added AllowReversiblePasswordEncryption property
 - Added CompoundIdentitySupported property
 - Added PasswordNotRequired property
 - Added SmartcardLogonRequired property
 - Added ProxyAddresses property ([Issue 254](https://github.com/PowerShell/xActiveDirectory/issues/254)).
 - Fix Password property being updated whenever another property is changed
   ([issue 384](https://github.com/PowerShell/xActiveDirectory/issues/384)).
 - Replace Write-Error with the correct helper function ([Issue 331](https://github.com/PowerShell/xActiveDirectory/issues/331)).
- Changes to xADDomainController
 - Change the `Requires` statement in the Examples to require the correct
   module.
 - Suppressing the Script Analyzer rule `PSAvoidGlobalVars` since the
   resource is using the `$global:DSCMachineStatus` variable to trigger
   a reboot.
 - Code cleanup.
- Changes to xADDomain
 - Suppressing the Script Analyzer rule `PSAvoidGlobalVars` since the
   resource is using the `$global:DSCMachineStatus` variable to trigger
   a reboot.
 - Code cleanup.
- Changes to xADDomainTrust
 - Replaced New-TerminatingError with Standard Function.
 - Code cleanup.
- Changes to xWaitForADDomain
 - Suppressing the Script Analyzer rule `PSAvoidGlobalVars` since the
   resource is using the `$global:DSCMachineStatus` variable to trigger
   a reboot.
 - Added missing property schema descriptions ([issue 369](https://github.com/PowerShell/xActiveDirectory/issues/369)).
 - Code cleanup.
- Changes to xADRecycleBin
 - Remove unneeded example and resource designer files.
 - Added missing property schema descriptions ([issue 368](https://github.com/PowerShell/xActiveDirectory/issues/368)).
 - Code cleanup.
 - It now sets back the `$ErrorActionPreference` that was set prior to
   setting it to `"Stop"`.
 - Replace Write-Error with the correct helper function ([issue 327](https://github.com/PowerShell/xActiveDirectory/issues/327)).
- Changes to xADReplicationSiteLink
 - Fix ADIdentityNotFoundException when creating a new site link.
 - Code cleanup.
- Changes to xADReplicationSubnet
 - Remove `{ *Present* | Absent }` from the property schema descriptions
   which were causing corruption in the Wiki documentation.
- Changes to xADServicePrincipalNames
 - Remove `{ *Present* | Absent }` from the property schema descriptions
   which were causing corruption in the Wiki documentation.
- Changes to xADDomainDefaultPasswordPolicy
 - Code cleanup.
- Changes to xADForestProperties
 - Minor style cleanup.
- Changes to xADReplicationSubnet
 - Code cleanup.
- Changes to xADKDSKey
 - Code cleanup.
- Changes to xADManagedServiceAccount
 - Code cleanup.
- Changes to xADServicePrincipalName
 - Code cleanup.

Version History

Version Downloads Last updated
3.0.0.0 (current version) 52,111 6/26/2019
2.26.0.0 19,743 5/15/2019
2.25.0.0 26,065 4/3/2019
2.24.0.0 11,267 2/20/2019
2.23.0.0 9,920 1/10/2019
2.22.0.0 9,340 10/25/2018
2.21.0.0 6,989 9/5/2018
2.20.0.0 7,084 7/25/2018
2.19.0.0 103,300 6/13/2018
2.18.0.0 23,933 3/22/2018
2.17.0.0 12,277 2/8/2018
2.16.0.0 68,438 1/11/2017
2.15.0.0 1,276 12/14/2016
2.14.0.0 10,477 11/2/2016
2.13.0.0 5,029 8/10/2016
2.12.0.0 3,361 6/29/2016
2.11.0.0 2,623 5/18/2016
2.10.0.0 2,252 3/31/2016
2.9.0.0 2,071 2/2/2016
2.8.0.0 931 12/3/2015
2.7.0.0 520 10/22/2015
2.6.0.0 1,245 9/11/2015
2.5.0.0 438 7/24/2015
2.4.0.0 189 6/17/2015
2.3 1,896 2/19/2015
2.2 74 12/18/2014
2.1 133 8/22/2014
2.0 90 6/6/2014
1.0.1 61 5/13/2014
1.0 37 4/8/2014