ActiveDirectoryDsc: Examples prefixed with resource name (#450)

- Changes to ActiveDirectoryDsc - Updated all the examples files to be prefixed with the resource name so they are more easily discovered in PowerShell Gallery and Azure Automation (issue #416).
dsccommunity · Jul 29, 2019 · a2a7c4c · a2a7c4c
1 parent a1494c2
commit a2a7c4c
Show file tree

Hide file tree

Showing 63 changed files with 110 additions and 106 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,7 +3,8 @@
 ## Unreleased
 
 - Changes to ActiveDirectoryDsc
-  - BREAKING CHANGE: Renamed the xActiveDirectory to ActiveDirectoryDsc and removed the 'x' from all resource names.
+  - BREAKING CHANGE: Renamed the xActiveDirectory to ActiveDirectoryDsc
+    and removed the 'x' from all resource names ([issue #312](https://github.com/PowerShell/ActiveDirectoryDsc/issues/312)).
   - Added a Requirements section to every DSC resource README with the
     bullet point stating "Target machine must be running Windows Server
     2008 R2 or later" ([issue #399](https://github.com/PowerShell/ActiveDirectoryDsc/issues/399)).
@@ -40,6 +41,9 @@
       [new helper functions for localization](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md#helper-functions-for-localization)
       ([issue #316](https://github.com/PowerShell/ActiveDirectoryDsc/issues/316),
       [issue #317](https://github.com/PowerShell/ActiveDirectoryDsc/issues/317)).
+  - Updated all the examples files to be prefixed with the resource
+    name so they are more easily discovered in PowerShell Gallery and
+    Azure Automation ([issue #416](https://github.com/PowerShell/ActiveDirectoryDsc/issues/416)).
 - Changes to ADManagedServiceAccount
   - Added a requirement to README stating "Group Managed Service Accounts
     need at least one Windows Server 2012 Domain Controller"

diff --git a/DSCResources/MSFT_ADComputer/en-US/about_ADComputer.help.txt b/DSCResources/MSFT_ADComputer/en-US/about_ADComputer.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     ADComputer
 
 .DESCRIPTION
@@ -99,7 +99,7 @@
 This configuration will create two Active Directory computer accounts
 enabled. The property Enabled will not be enforced in either case.
 
-Configuration AddComputerAccount_Config
+Configuration ADComputer_AddComputerAccount_Config
 {
     param
     (
@@ -131,7 +131,7 @@ Configuration AddComputerAccount_Config
 This configuration will create an Active Directory computer account
 disabled. The property Enabled will not be enforced.
 
-Configuration AddComputerAccountDisabled_Config
+Configuration ADComputer_AddComputerAccountDisabled_Config
 {
     param
     (
@@ -159,7 +159,7 @@ This configuration will create an Active Directory computer account
 on the specified domain controller and in the specific organizational
 unit.
 
-Configuration AddComputerAccountSpecificPath_Config
+Configuration ADComputer_AddComputerAccountSpecificPath_Config
 {
     param
     (
@@ -190,7 +190,7 @@ on the specified domain controller and in the specific organizational
 unit. After the account is create an Offline Domain Join Request file
 is created to the specified path.
 
-Configuration AddComputerAccountAndCreateODJRequest_Config
+Configuration ADComputer_AddComputerAccountAndCreateODJRequest_Config
 {
     param
     (

diff --git a/DSCResources/MSFT_ADDomain/en-US/about_ADDomain.help.txt b/DSCResources/MSFT_ADDomain/en-US/about_ADDomain.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     ADDomain
 
 .DESCRIPTION
@@ -59,7 +59,7 @@
 This configuration will create a new domain with a new forest and a forest
 functional level of Server 2016.
 
-Configuration NewForest_Config
+Configuration ADDomain_NewForest_Config
 {
     param
     (
@@ -111,7 +111,7 @@ $ConfigurationData = @{
 This configuration will create a new child domain in an existing forest with
 a Domain Functional Level of Windows Server 2012R2.
 
-Configuration NewChildDomain_Config
+Configuration ADDomain_NewChildDomain_Config
 {
     param
     (
@@ -165,7 +165,7 @@ $ConfigurationData = @{
 This configuration will create a domain, and then create a child domain on
 another node.
 
-Configuration NewForestWithParentAndChildDomain_Config
+Configuration ADDomain_NewForestWithParentAndChildDomain_Config
 {
     param
     (
@@ -286,7 +286,7 @@ a second domain controller to the newly created domain.
 The WaitForDomain resource is used to ensure that the domain is
 present before the second domain controller is added.
 
-Configuration NewDomainWithTwoDCs_Config
+Configuration ADDomain_NewDomainWithTwoDCs_Config
 {
     param
     (

diff --git a/DSCResources/MSFT_ADDomainController/en-US/about_ADDomainController.help.txt b/DSCResources/MSFT_ADDomainController/en-US/about_ADDomainController.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     ADDomainController
 
 .DESCRIPTION
@@ -75,7 +75,7 @@
 This configuration will add a domain controller to the domain
 contoso.com.
 
-Configuration AddDomainControllerToDomainMinimal_Config
+Configuration ADDomainController_AddDomainControllerToDomainMinimal_Config
 {
     param
     (
@@ -130,7 +130,7 @@ Configuration AddDomainControllerToDomainMinimal_Config
 This configuration will add a domain controller to the domain
 contoso.com, specifying all properties of the resource.
 
-Configuration AddDomainControllerToDomainAllProperties_Config
+Configuration ADDomainController_AddDomainControllerToDomainAllProperties_Config
 {
     param
     (
@@ -190,7 +190,7 @@ Configuration AddDomainControllerToDomainAllProperties_Config
 This configuration will add a domain controller to the domain
 contoso.com using the information from media.
 
-Configuration AddDomainControllerToDomainUsingIFM_Config
+Configuration ADDomainController_AddDomainControllerToDomainUsingIFM_Config
 {
     param
     (
@@ -246,7 +246,7 @@ Configuration AddDomainControllerToDomainUsingIFM_Config
 This configuration will add a read-only domain controller to the domain contoso.com
 and specify a list of account, whose passwords are allowed/denied for synchronisation.
 
-Configuration AddReadOnlyDomainController_Config
+Configuration ADDomainController_AddReadOnlyDomainController_Config
 {
     param
     (

diff --git a/...ces/MSFT_ADDomainDefaultPasswordPolicy/en-US/about_ADDomainDefaultPasswordPolicy.help.txt b/...ces/MSFT_ADDomainDefaultPasswordPolicy/en-US/about_ADDomainDefaultPasswordPolicy.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     ADDomainDefaultPasswordPolicy
 
 .DESCRIPTION
@@ -61,7 +61,7 @@
 This configuration will set an Active Directory domain's default password
 policy to set the minimum password length and complexity.
 
-Configuration ConfigureDefaultPasswordPolicy_Config
+Configuration ADDomainDefaultPasswordPolicy_ConfigureDefaultPasswordPolicy_Config
 {
     Param
     (

diff --git a/DSCResources/MSFT_ADDomainTrust/en-US/about_ADDomainTrust.help.txt b/DSCResources/MSFT_ADDomainTrust/en-US/about_ADDomainTrust.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     ADDomainTrust
 
 .DESCRIPTION
@@ -40,7 +40,7 @@
 This configuration will create a new one way inbound trust between two
 domains.
 
-Configuration NewOneWayTrust_Config
+Configuration ADDomainTrust_NewOneWayTrust_Config
 {
     param
     (

diff --git a/DSCResources/MSFT_ADForestProperties/en-US/about_ADForestProperties.help.txt b/DSCResources/MSFT_ADForestProperties/en-US/about_ADForestProperties.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     ADForestProperties
 
 .DESCRIPTION
@@ -46,7 +46,7 @@ This configuration will manage the Service and User Principal name suffixes
 in the forest by replacing any existing suffixes with the ones specified
 in the configuration.
 
-Configuration ReplaceForestProperties_Config
+Configuration ADForestProperties_ReplaceForestProperties_Config
 {
     Import-DscResource -ModuleName ActiveDirectoryDsc
 
@@ -79,7 +79,7 @@ This configuration will manage the Service and User Principal name suffixes in
 the forest by adding and removing the desired suffixes. This will not overwrite
 existing suffixes in the forest.
 
-Configuration AddRemoveForestProperties_Config
+Configuration ADForestProperties_AddRemoveForestProperties_Config
 {
     Import-DscResource -ModuleName ActiveDirectoryDsc
 

diff --git a/DSCResources/MSFT_ADGroup/en-US/about_ADGroup.help.txt b/DSCResources/MSFT_ADGroup/en-US/about_ADGroup.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     ADGroup
 
 .DESCRIPTION
@@ -80,7 +80,7 @@
 
 This configuration will create a new domain-local group
 
-Configuration NewGroup_Config
+Configuration ADGroup_NewGroup_Config
 {
     param
     (
@@ -120,7 +120,7 @@ Configuration NewGroup_Config
 
 This configuration will create a new domain-local group with three members.
 
-Configuration NewGroupWithMembers_Config
+Configuration ADGroup_NewGroupWithMembers_Config
 {
     Import-DscResource -ModuleName ActiveDirectoryDsc
 
@@ -140,7 +140,7 @@ Configuration NewGroupWithMembers_Config
 This configuration will create a new domain-local group in contoso with
 three members in different domains.
 
-Configuration NewGroupMultiDomainMembers_Config
+Configuration ADGroup_NewGroupMultiDomainMembers_Config
 {
     Import-DscResource -ModuleName ActiveDirectoryDsc
 

diff --git a/DSCResources/MSFT_ADKDSKey/en-US/about_ADKDSKey.help.txt b/DSCResources/MSFT_ADKDSKey/en-US/about_ADKDSKey.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     ADKDSKey
 
 .DESCRIPTION
@@ -43,7 +43,7 @@ This configuration will create a KDS root key. If the date is set to a time
 slightly ahead in the future, the key won't be usable for at least 10 hours
 from the creation time.
 
-Configuration CreateKDSRootKey_Config
+Configuration ADKDSKey_CreateKDSRootKey_Config
 {
     Import-DscResource -Module ActiveDirectoryDsc
 
@@ -65,7 +65,7 @@ the key to be used right away, but if all the domain controllers haven't
 replicated yet, there may be issues when retrieving the gMSA password.
 Use with caution
 
-Configuration CreateKDSRootKeyInPast_Config
+Configuration ADKDSKey_CreateKDSRootKeyInPast_Config
 {
     Import-DscResource -Module ActiveDirectoryDsc
 
@@ -86,7 +86,7 @@ This configuration will remove the last KDS root key. Use with caution.
 If gMSAs are installed on the network, they will not be able to reset
 their passwords and it may cause services to fail.
 
-Configuration CreateKDSRootKeyRemoveLastKey_Config
+Configuration ADKDSKey_CreateKDSRootKeyRemoveLastKey_Config
 {
     Import-DscResource -Module ActiveDirectoryDsc
 

diff --git a/DSCResources/MSFT_ADManagedServiceAccount/en-US/about_ADManagedServiceAccount.help.txt b/DSCResources/MSFT_ADManagedServiceAccount/en-US/about_ADManagedServiceAccount.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     ADManagedServiceAccount
 
 .DESCRIPTION
@@ -69,7 +69,7 @@
 
 This configuration will create a managed service account.
 
-Configuration CreateManagedServiceAccount_Config
+Configuration ADManagedServiceAccount_CreateManagedServiceAccount_Config
 {
     Import-DscResource -Module ActiveDirectoryDsc
 
@@ -87,7 +87,7 @@ Configuration CreateManagedServiceAccount_Config
 
 This configuration will create a group managed service account.
 
-Configuration CreateGroupManagedServiceAccount_Config
+Configuration ADManagedServiceAccount_CreateGroupManagedServiceAccount_Config
 {
     Import-DscResource -Module ActiveDirectoryDsc
 
@@ -107,7 +107,7 @@ Configuration CreateGroupManagedServiceAccount_Config
 
 This configuration will create a group managed service account with members.
 
-Configuration CreateGroupManagedServiceAccountWithMembers_Config
+Configuration ADManagedServiceAccount_CreateGroupManagedServiceAccountWithMembers_Config
 {
     Import-DscResource -Module ActiveDirectoryDsc
 

diff --git a/DSCResources/MSFT_ADObjectEnabledState/en-US/about_ADObjectEnabledState.help.txt b/DSCResources/MSFT_ADObjectEnabledState/en-US/about_ADObjectEnabledState.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     ADObjectEnabledState
 
 .DESCRIPTION
@@ -42,7 +42,7 @@
 This configuration will create a computer account disabled, and
 enforcing the account to be enabled.
 
-Configuration EnabledComputerAccount_Config
+Configuration ADObjectEnabledState_EnabledComputerAccount_Config
 {
     Import-DscResource -ModuleName ActiveDirectoryDsc
 
@@ -71,7 +71,7 @@ This configuration will create a computer account disabled, configure
 a cluster using the disabled computer account, and enforcing the
 computer account to be enabled.
 
-Configuration CreateClusterComputerAccount_Config
+Configuration ADObjectEnabledState_CreateClusterComputerAccount_Config
 {
     param
     (
@@ -117,7 +117,7 @@ Configuration CreateClusterComputerAccount_Config
 This configuration will configure a cluster using a pre-staged computer
 account, and enforcing the pre-staged computer account to be enabled.
 
-Configuration EnabledPrestagedClusterComputerAccount_Config
+Configuration ADObjectEnabledState_EnabledPrestagedClusterComputerAccount_Config
 {
     param
     (

diff --git a/DSCResources/MSFT_ADObjectPermissionEntry/en-US/about_ADObjectPermissionEntry.help.txt b/DSCResources/MSFT_ADObjectPermissionEntry/en-US/about_ADObjectPermissionEntry.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     ADObjectPermissionEntry
 
 .DESCRIPTION
@@ -54,7 +54,7 @@ the virtual computer object (VCO) ROLE01 for a cluster name object (CNO)
 CONTOSO\CLUSTER01$. This is used so that the Windows Failover Cluster
 can control the roles AD objects.
 
-Configuration DelegateFullControl_Config
+Configuration ADObjectPermissionEntry_DelegateFullControl_Config
 {
     Import-DscResource -Module ActiveDirectoryDsc
 
@@ -80,7 +80,7 @@ This configuration will add a group permission to create and delete
 (CreateChild,DeleteChild) computer objects in an OU and any sub-OUs that
 may get created.
 
-Configuration CreateDeleteComputerObject_Config
+Configuration ADObjectPermissionEntry_CreateDeleteComputerObject_Config
 {
     Import-DscResource -Module ActiveDirectoryDsc
 
@@ -106,7 +106,7 @@ This configuration will add a group permission to allow read and write
 (ReadProperty, WriteProperty) of all properties of computer objects in
 an OU and any sub-OUs that may get created.
 
-Configuration ReadWriteComputerObjectProperties_Config
+Configuration ADObjectPermissionEntry_ReadWriteComputerObjectProperties_Config
 {
     Import-DscResource -Module ActiveDirectoryDsc
 

diff --git a/DSCResources/MSFT_ADOrganizationalUnit/en-US/about_ADOrganizationalUnit.help.txt b/DSCResources/MSFT_ADOrganizationalUnit/en-US/about_ADOrganizationalUnit.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     ADOrganizationalUnit
 
 .DESCRIPTION
@@ -42,7 +42,7 @@
 This configuration will add an Active Directory organizational unit to the
 domain.
 
-Configuration CreateADOU_Config
+Configuration ADOrganizationalUnit_CreateADOU_Config
 {
     param
     (

diff --git a/DSCResources/MSFT_ADRecycleBin/en-US/about_ADRecycleBin.help.txt b/DSCResources/MSFT_ADRecycleBin/en-US/about_ADRecycleBin.help.txt
@@ -1,4 +1,4 @@
-.NAME
+.NAME
     ADRecycleBin
 
 .DESCRIPTION
@@ -32,7 +32,7 @@
 This configuration will enable the Active Directory Recycle Bin for a
 specified Domain
 
-Configuration EnableADRecycleBin_Config
+Configuration ADRecycleBin_EnableADRecycleBin_Config
 {
     param
     (