diff --git a/docset/winserver2025-ps/activedirectory/Complete-ADServiceAccountMigration.md b/docset/winserver2025-ps/activedirectory/Complete-ADServiceAccountMigration.md new file mode 100644 index 0000000000..2ab9ac0ad8 --- /dev/null +++ b/docset/winserver2025-ps/activedirectory/Complete-ADServiceAccountMigration.md @@ -0,0 +1,238 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml +Module Name: ActiveDirectory +ms.date: 02/15/2024 +online version: https://learn.microsoft.com/powershell/module/activedirectory/complete-adserviceaccountMigration?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Complete-ADServiceAccountMigration +--- + + +# Complete-ADServiceAccountMigration + +## SYNOPSIS +Completes the migration process and supersedes a normal user account to a delegated managed service +account. + +## SYNTAX + +### ADServiceAccountMigrationParameterSet (Default) + +``` +Complete-ADServiceAccountMigration [-AuthType ] [-Credential ] + [-Identity] [-SupersededAccount ] [-Server ] + [] +``` + +## DESCRIPTION + +The `Complete-ADServiceAccountMigration` cmdlet will complete the migration process of superseding +a normal user account specificed by the distinguished name string provided in the +**SupersededAccount** parameter to the delegated managed service account provided in the +**identity** parameter. They must've been previously linked via the +`Start-ADServiceAccountMigration` cmdlet. + +The **Identity** parameter specifies the delegated managed service account to use. You can identify +a managed service account by its distinguished name, GUID, security identifier (SID), or Security +Account Manager (SAM) account name. + +The **SupersededAccount** parameter specifies the user account that's linked to the delegated +managed service account. The superseded account must be identified by its distinguished name. + +## EXAMPLES + +### Example 1: Complete a service account migration using the Security Account Manager name of the delegated managed service account + +```powershell +$params = @{ + Identity = "delegatedSvc1" + SupersededAccount = "CN=User1,OU=Accounts,DC=Contoso,DC=com" +} +Complete-ADServiceAccountMigration @params +``` + +### Example 2: Complete a service account migration by specifying a 2025 Domain Controller + +```powershell +$params = @{ + Identity = "delegatedSvc1" + SupersededAccount = "CN=User1,OU=Accounts,DC=Contoso,DC=com" + Server = "2025DC.Contoso.com" +} +Complete-ADServiceAccountMigration @params +``` + +## PARAMETERS + +### -AuthType + +Specifies the authentication method to use. +The acceptable values for this parameter are: + +- Negotiate or 0 +- Basic or 1 + +The default authentication method is Negotiate. + +A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. + +```yaml +Type: ADAuthType +Parameter Sets: (All) +Aliases: +Accepted values: Negotiate, Basic + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory +module for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the +account associated with the drive is the default. + +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you +can specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet +prompts for a password. + +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the *Credential* parameter to the **PSCredential** object. + +If the acting credentials don't have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies an Active Directory account object by providing one of the following property values. The +identifier in parentheses is the LDAP display name for the attribute. The acceptable values for +this parameter are: + +- A distinguished name +- A GUID (objectGUID) +- A security identifier (objectSid) +- A SAM account name (sAMAccountName) + +The cmdlet searches the default naming context or partition to find the object. +If two or more objects are found, the cmdlet returns a non-terminating error. + +```yaml +Type: ADServiceAccount +Parameter Sets: ADServiceAccountMigrationParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupersededAccount + +Specifies the user account that you want to be migrated to a delegated managed service account. The +account must be specified by it's distinguished name. + +```yaml +Type: String +Parameter Sets: ADServiceAccountMigrationParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server + +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory Snapshot instance. + +Domain name values: + +- Fully qualified domain name (FQDN) +- NetBIOS name + +Directory server values: + +- Fully qualified directory server name +- NetBIOS name +- Fully qualified directory server name and port + +The default value for the **Server** parameter is determined by one of the following methods in the +order that they are listed: + +- By using **Server** value from objects passed through the pipeline. +- By using the server information associated with the Active Directory PowerShell provider drive, + when running under that drive. +- By using the domain of the computer running PowerShell. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, +`-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, +`-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.ActiveDirectory.Management.ADServiceAccount + +A delegated managed service account object is received by the **Identity** parameter. + +## NOTES + +- This cmdlet doesn't work with AD LDS. +- This cmdlet doesn't work with an Active Directory snapshot. +- This cmdlet doesn't work with a read-only domain controller. +- This cmdlet requires that you create a Microsoft Group Key Distribution Service (GKDS) root key + first to begin using group managed service accounts in your Active Directory deployment. For more + information on how to create the GKDS root key using Windows PowerShell, see + [Create the Key Distribution Services KDS Root Key](https://go.microsoft.com/fwlink/?LinkId=253584). + +## RELATED LINKS + +[Reset-ADServiceAccountMigration](./Reset-ADServiceAccountMigration.md) + +[Start-ADServiceAccountMigration](./Start-ADServiceAccountMigration.md) + +[Undo-ADServiceAccountMigration](./Undo-ADServiceAccountMigration.md) + +[Get-ADServiceAccount](./Get-ADServiceAccount.md) + +[New-ADServiceAccount](./New-ADServiceAccount.md) + +[Set-ADServiceAccount](Set-ADServiceAccount.md) diff --git a/docset/winserver2025-ps/activedirectory/New-ADServiceAccount.md b/docset/winserver2025-ps/activedirectory/New-ADServiceAccount.md index 605391ddde..8a4908bdc1 100644 --- a/docset/winserver2025-ps/activedirectory/New-ADServiceAccount.md +++ b/docset/winserver2025-ps/activedirectory/New-ADServiceAccount.md @@ -2,7 +2,7 @@ description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml Module Name: ActiveDirectory -ms.date: 12/27/2016 +ms.date: 02/15/2024 online version: https://learn.microsoft.com/powershell/module/activedirectory/new-adserviceaccount?view=windowsserver2025-ps&wt.mc_id=ps-gethelp schema: 2.0.0 title: New-ADServiceAccount @@ -16,115 +16,165 @@ Creates a new Active Directory managed service account or group managed service ## SYNTAX ### Group (Default) + ``` -New-ADServiceAccount [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNotDelegated ] - [-AuthenticationPolicy ] [-AuthenticationPolicySilo ] - [-AuthType ] [-Certificates ] [-CompoundIdentitySupported ] - [-Credential ] [-Description ] [-DisplayName ] -DNSHostName - [-Enabled ] [-HomePage ] [-Instance ] - [-KerberosEncryptionType ] [-ManagedPasswordIntervalInDays ] [-Name] - [-OtherAttributes ] [-PassThru] [-Path ] - [-PrincipalsAllowedToDelegateToAccount ] - [-PrincipalsAllowedToRetrieveManagedPassword ] [-SamAccountName ] [-Server ] - [-ServicePrincipalNames ] [-TrustedForDelegation ] [] +New-ADServiceAccount [-WhatIf] [-Confirm] [-AccountExpirationDate ] + [-AccountNotDelegated ] [-AuthenticationPolicy ] + [-AuthenticationPolicySilo ] [-AuthType ] + [-Certificates ] [-CompoundIdentitySupported ] [-Credential ] + [-Description ] [-DisplayName ] -DNSHostName [-Enabled ] + [-HomePage ] [-Instance ] + [-KerberosEncryptionType ] [-ManagedPasswordIntervalInDays ] + [-Name] [-OtherAttributes ] [-PassThru] [-Path ] + [-CreateDelegatedServiceAccount] [-PrincipalsAllowedToDelegateToAccount ] + [-PrincipalsAllowedToRetrieveManagedPassword ] [-SamAccountName ] + [-Server ] [-ServicePrincipalNames ] [-TrustedForDelegation ] + [] ``` ### RestrictedToSingleComputer + ``` -New-ADServiceAccount [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNotDelegated ] - [-AccountPassword ] [-AuthenticationPolicy ] - [-AuthenticationPolicySilo ] [-AuthType ] [-Certificates ] - [-Credential ] [-Description ] [-DisplayName ] [-Enabled ] - [-HomePage ] [-Instance ] [-KerberosEncryptionType ] - [-Name] [-OtherAttributes ] [-PassThru] [-Path ] [-RestrictToSingleComputer] +New-ADServiceAccount [-WhatIf] [-Confirm] [-AccountExpirationDate ] + [-AccountNotDelegated ] [-AccountPassword ] + [-AuthenticationPolicy ] + [-AuthenticationPolicySilo ] [-AuthType ] + [-Certificates ] [-Credential ] [-Description ] + [-DisplayName ] [-Enabled ] [-HomePage ] [-Instance ] + [-KerberosEncryptionType ] [-Name] + [-OtherAttributes ] [-PassThru] [-Path ] [-RestrictToSingleComputer] [-SamAccountName ] [-Server ] [-ServicePrincipalNames ] [-TrustedForDelegation ] [] ``` ### RestrictedToOutboundAuthenticationOnly + ``` -New-ADServiceAccount [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNotDelegated ] - [-AuthenticationPolicy ] [-AuthenticationPolicySilo ] - [-AuthType ] [-Certificates ] [-Credential ] [-Description ] +New-ADServiceAccount [-WhatIf] [-Confirm] [-AccountExpirationDate ] + [-AccountNotDelegated ] [-AuthenticationPolicy ] + [-AuthenticationPolicySilo ] [-AuthType ] + [-Certificates ] [-Credential ] [-Description ] [-DisplayName ] [-Enabled ] [-HomePage ] [-Instance ] - [-KerberosEncryptionType ] [-Name] [-OtherAttributes ] - [-PassThru] [-Path ] [-RestrictToOutboundAuthenticationOnly] [-SamAccountName ] - [-Server ] [-ServicePrincipalNames ] [-TrustedForDelegation ] [] + [-KerberosEncryptionType ] [-Name] + [-OtherAttributes ] [-PassThru] [-Path ] + [-RestrictToOutboundAuthenticationOnly] [-SamAccountName ] [-Server ] + [-ServicePrincipalNames ] [-TrustedForDelegation ] [] ``` ## DESCRIPTION -The **New-ADServiceAccount** cmdlet creates a new Active Directory managed service account. -By default, the cmdlet creates a group managed service account. -To create a standalone managed service account which is linked to a specific computer, use the **RestrictToSingleComputer** parameter. -To create a group managed service account which can only be used in client roles, use the **RestrictToOutboundAuthenticationOnly** parameter. -This creates a group managed service account that can be used for outbound connections only and any attempts to connect to services using this account will fail because the account does not have enough information for authentication. -You can set commonly used managed service account property values by using the cmdlet parameters. -Property values that are not associated with cmdlet parameters can be set by using the **OtherAttributes** parameter. -The **Path** parameter specifies the container or organizational unit (OU) for the new managed service account object. -When you do not specify the **Path** parameter, the cmdlet creates an object in the default managed service accounts container for managed service account objects in the domain. +The `New-ADServiceAccount` cmdlet creates a new Active Directory managed service account. By +default, the cmdlet creates a group managed service account. To create a delegated managed service +account, use the **CreateDelegatedServiceAccount** parameter. Delegated managed service accounts +can be used to migrate services that use normal user accounts. To create a standalone managed +service account which is linked to a specific computer, use the **RestrictToSingleComputer** +parameter. To create a group managed service account which can only be used in client roles, use +the **RestrictToOutboundAuthenticationOnly** parameter. This creates a group managed service +account that can be used for outbound connections only and any attempts to connect to services +using this account will fail because the account doesn't have enough information for +authentication. You can set commonly used managed service account property values by using the +cmdlet parameters. Property values that aren't associated with cmdlet parameters can be set by +using the **OtherAttributes** parameter. + +The **Path** parameter specifies the container or organizational unit (OU) for the new managed +service account object. When you Don�t specify the **Path** parameter, the cmdlet creates an +object in the default managed service accounts container for managed service account objects in the +domain. The following methods explain different ways to create an object by using this cmdlet. -- Method 1: Use the **New-ADServiceAccount** cmdlet, specify the required parameters, and set any additional property values by using the cmdlet parameters. +- Method 1: Use the `New-ADServiceAccount` cmdlet, specify the required parameters, and set any + additional property values by using the cmdlet parameters. -- Method 2: Use a template to create the new object. -To do this, create a new managed service account object or retrieve a copy of an existing managed service account object and set the **Instance** parameter to this object. -The object provided to the **Instance** parameter is used as a template for the new object. -You can override property values from the template by setting cmdlet parameters. -For examples and more information, see the **Instance** parameter description for this cmdlet. +- Method 2: Use a template to create the new object. To do this, create a new managed service + account object or retrieve a copy of an existing managed service account object and set the + **Instance** parameter to this object. The object provided to the **Instance** parameter is used + as a template for the new object. You can override property values from the template by setting + cmdlet parameters. For examples and more information, see the **Instance** parameter description + for this cmdlet. -- Method 3: Use the **Import-Csv** cmdlet with the **New-ADServiceAccount** cmdlet to create multiple Active Directory managed service account objects. -To do this, use the **Import-CSV** cmdlet to create the custom objects from a comma-separated value (CSV) file that contains a list of object properties. -For more information, type `Get-Help Import-CSV`. -Then pass these objects through the pipeline to the **New-ADServiceAccount** cmdlet to create the managed service account objects. +- Method 3: Use the `Import-Csv` cmdlet with the `New-ADServiceAccount` cmdlet to create + multiple Active Directory managed service account objects. To do this, use the `Import-CSV` + cmdlet to create the custom objects from a comma-separated value (CSV) file that contains a list + of object properties. For more information, type `Get-Help Import-CSV`. Then pass these objects + through the pipeline to the `New-ADServiceAccount` cmdlet to create the managed service account + objects. ## EXAMPLES ### Example 1: Create an enabled managed service account + ```powershell -PS C:\> New-ADServiceAccount -Name "Service01" -DNSHostName "Service01.contoso.com" -Enabled $True +New-ADServiceAccount -Name "Service01" -DNSHostName "Service01.contoso.com" -Enabled $True ``` This command creates an enabled managed service account in Active Directory Domain Services (AD DS). ### Example 2: Create a managed service account and register its service principal name + ```powershell -PS C:\> New-ADServiceAccount -Name "Service01" -ServicePrincipalNames "MSSQLSVC/Machine3.corp.contoso.com" -DNSHostName "Service01.contoso.com" +$params = @{ + Name = "Service01" + ServicePrincipalNames = "MSSQLSVC/Machine3.corp.contoso.com" + DNSHostName = "Service01.contoso.com" +} +New-ADServiceAccount @params ``` This command creates a managed service account and registers its service principal name. ### Example 3: Create a managed service account for a single computer + ```powershell -PS C:\> New-ADServiceAccount -Name "Service01" -RestrictToSingleComputer +New-ADServiceAccount -Name "Service01" -RestrictToSingleComputer ``` This command creates a managed service account and restricts its use to a single computer. ### Example 4: Create a managed service account for outbound authentication only + ```powershell -PS C:\> New-ADServiceAccount -Name "Service01" -RestrictToOutboundAuthenticationOnly +New-ADServiceAccount -Name "Service01" -RestrictToOutboundAuthenticationOnly ``` This command creates a managed service account and restricts its use to outbound authentication. ### Example 5: Create a new managed service account and register multiple service principal names -```Powershell -PS C:\> New-ADServiceAccount service1 -ServicePrincipalNames "HTTP/Machine3.corp.contoso.com,HTTP/Machine3.corp.contoso.com/contoso" -DNSHostName service1.contoso.com + +```powershell +$params = @{ + Name = "Service01" + ServicePrincipalNames = "HTTP/Machine3.corp.contoso.com","HTTP/Machine3.corp.contoso.com/contoso" + DNSHostName = "Service01.contoso.com" +} +New-ADServiceAccount @params +``` + +This command creates a delegated managed service account. + +### Example 6: Create an enabled delegated managed service account to be used for migration + +```powershell +$params = @{ + Name = "Service01" + DNSHostName = "Service01.contoso.com" + Enabled = $True + CreateDelegatedServiceAccount = $True +} +New-ADServiceAccount @params ``` ## PARAMETERS ### -AccountExpirationDate -Specifies the expiration date for an account. -This parameter sets the **AccountExpirationDate** property of an account object. -The LDAP display name (**ldapDisplayName**) for this property is accountExpires. -Use the **DateTime** syntax when you specify this parameter. -Time is assumed to be local time unless otherwise specified. -When a time value is not specified, the time is assumed to 12:00:00 AM local time. -When a date is not specified, the date is assumed to be the current date. +Specifies the expiration date for an account. This parameter sets the **AccountExpirationDate** +property of an account object. The LDAP display name (**ldapDisplayName**) for this property is +accountExpires. + +Use the **DateTime** syntax when you specify this parameter. Time is assumed to be local time +unless otherwise specified. When a time value isn't specified, the time is assumed to 12:00:00 AM +local time. When a date isn't specified, the date is assumed to be the current date. ```yaml Type: DateTime @@ -139,10 +189,12 @@ Accept wildcard characters: False ``` ### -AccountNotDelegated -Indicates whether the security context of the user is delegated to a service. -When this parameter is set to true, the security context of the account is not delegated to a service even when the service account is set as trusted for Kerberos delegation. -This parameter sets the **AccountNotDelegated** property for an Active Directory account. -This parameter also sets the **ADS_UF_NOT_DELEGATED** flag of the Active Directory User Account Control (UAC) attribute. + +Indicates whether the security context of the user is delegated to a service. When this parameter +is set to true, the security context of the account isn't delegated to a service even when the +service account is set as trusted for Kerberos delegation. This parameter sets the +**AccountNotDelegated** property for an Active Directory account. This parameter also sets the +**ADS_UF_NOT_DELEGATED** flag of the Active Directory User Account Control (UAC) attribute. ```yaml Type: Boolean @@ -157,20 +209,23 @@ Accept wildcard characters: False ``` ### -AccountPassword -Specifies a new password value for the service account. -This value is stored as an encrypted string. + +Specifies a new password value for the service account. This value is stored as an encrypted +string. The following conditions apply based on the manner in which the password parameter is used: -- $Null password is specified. -Random password is set and the account is enabled unless it is requested to be disabled. -- No password is specified. -Random password is set and the account is enabled unless it is requested to be disabled. -- User password is specified. -Password is set and the account is enabled unless it is requested to be disabled, unless the password you provided does not meet password policy or was not set for other reasons, at which point the account is disabled. +- $Null password is specified. Random password is set and the account is enabled unless it's + requested to be disabled. +- No password is specified. Random password is set and the account is enabled unless it's + requested to be disabled. +- User password is specified. Password is set and the account is enabled unless it's requested to + be disabled, unless the password you provided doesn't meet password policy or was not set for + other reasons, at which point the account is disabled. -The new **ADServiceAccount** object will always either be disabled or have a user-requested or randomly-generated password. -There is no way to create an enabled service account object with a password that violates domain password policy, such as an empty password. +The new **ADServiceAccount** object will always either be disabled or have a user-requested or +randomly-generated password. there's no way to create an enabled service account object with a +password that violates domain password policy, such as an empty password. ```yaml Type: SecureString @@ -184,19 +239,20 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` - ### -AuthenticationPolicy -Specifies an Active Directory Domain Services authentication policy object. -Specify the authentication policy object in one of the following formats: + +Specifies an Active Directory Domain Services authentication policy object. Specify the +authentication policy object in one of the following formats: - Distinguished name - GUID - Name -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +object instance. -The cmdlet searches the default naming context or partition to find the object. -If the cmdlet finds two or more objects, the cmdlet returns a non-terminating error. +The cmdlet searches the default naming context or partition to find the object. If the cmdlet finds +two or more objects, the cmdlet returns a non-terminating error. ```yaml Type: ADAuthenticationPolicy @@ -211,17 +267,19 @@ Accept wildcard characters: False ``` ### -AuthenticationPolicySilo -Specifies an Active Directory Domain Services authentication policy silo object. -Specify the authentication policy silo object in one of the following formats: + +Specifies an Active Directory Domain Services authentication policy silo object. Specify the +authentication policy silo object in one of the following formats: - Distinguished name - GUID - Name -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. +This parameter can also get this object through the pipeline or you can set this parameter to an +object instance. -The cmdlet searches the default naming context or partition to find the object. -If the cmdlet finds two or more objects, the cmdlet returns a non-terminating error. +The cmdlet searches the default naming context or partition to find the object. If the cmdlet finds +two or more objects, the cmdlet returns a non-terminating error. ```yaml Type: ADAuthenticationPolicySilo @@ -236,8 +294,8 @@ Accept wildcard characters: False ``` ### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: + +Specifies the authentication method to use. The acceptable values for this parameter are: - Negotiate or 0 - Basic or 1 @@ -260,11 +318,11 @@ Accept wildcard characters: False ``` ### -Certificates -Specifies an array of certificates. -The cmdlet modifies the DER-encoded X.509v3 certificates of the account. -These certificates include the public key certificates issued to this account by the Microsoft Certificate Service. -This parameter sets the **Certificates** property of the account object. -The LDAP Display Name (**ldapDisplayName**) for this property is userCertificate. + +Specifies an array of certificates. The cmdlet modifies the DER-encoded X.509v3 certificates of the +account. These certificates include the public key certificates issued to this account by the +Microsoft Certificate Service. This parameter sets the **Certificates** property of the account +object. The LDAP Display Name (**ldapDisplayName**) for this property is userCertificate. To add values: @@ -282,8 +340,8 @@ To clear all values: `-Certificates $Null` -You can specify more than one operation by using a list separated by semicolons. -For example, use the following syntax to add and remove Certificate values: +You can specify more than one operation by using a list separated by semicolons. For example, use +the following syntax to add and remove Certificate values: `-Certificates @{Add=value1,value2,...};@{Remove=value3,value4,...}` @@ -306,15 +364,19 @@ Accept wildcard characters: False ``` ### -CompoundIdentitySupported -Indicates whether an account supports Kerberos service tickets which includes the authorization data for the user's device. -This value sets the compound identity supported flag of the Active Directory **msDS-SupportedEncryptionTypes** attribute. -The acceptable values for this parameter are: + +Indicates whether an account supports Kerberos service tickets which includes the authorization +data for the user's device. This value sets the compound identity supported flag of the Active +Directory `msDS-SupportedEncryptionTypes` attribute. The acceptable values for this parameter +are: - $False or 0 - $True or 1 -Warning: Domain-joined Windows systems and services such as clustering manage their own **msDS-SupportedEncryptionTypes** attribute. -Therefore any changes to the flag on the **msDS-SupportedEncryptionTypes** attribute will be overwritten by the service or system which manages the setting. +Warning: Domain-joined Windows systems and services such as clustering manage their own +`msDS-SupportedEncryptionTypes` attribute. Therefore any changes to the flag on the +`msDS-SupportedEncryptionTypes` attribute will be overwritten by the service or system which +manages the setting. ```yaml Type: Boolean @@ -329,6 +391,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -344,17 +407,21 @@ Accept wildcard characters: False ``` ### -Credential -Specifies the service account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. -To specify this parameter, you can type an administrative account name, such as Admin1 or Contoso\Admin1 or you can specify a **PSCredential** object. -If you specify a service account name for this parameter, the cmdlet prompts for a password. +Specifies the service account credentials to use to perform this task. The default credentials are +the credentials of the currently logged on user unless the cmdlet is run from an Active Directory +PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated +with the drive is the default. -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. +To specify this parameter, you can type an administrative account name, such as `Admin1` or +`Contoso\Admin1` or you can specify a **PSCredential** object. If you specify a service account name +for this parameter, the cmdlet prompts for a password. -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the *Credential* parameter to the **PSCredential** object. + +If the acting credentials don't have directory-level permission to perform the task, Active +Directory PowerShell returns a terminating error. ```yaml Type: PSCredential @@ -369,9 +436,10 @@ Accept wildcard characters: False ``` ### -Description -Specifies a description of the object. -This parameter sets the value of the **Description** property for the object. -The LDAP Display Name (**ldapDisplayName**) for this property is description. + +Specifies a description of the object. This parameter sets the value of the **Description** +property for the object. The LDAP Display Name (**ldapDisplayName**) for this property is +description. ```yaml Type: String @@ -386,9 +454,9 @@ Accept wildcard characters: False ``` ### -DisplayName -Specifies the display name of the object. -This parameter sets the **DisplayName** property of the object. -The LDAP Display Name (**ldapDisplayName**) for this property is displayName. + +Specifies the display name of the object. This parameter sets the **DisplayName** property of the +object. The LDAP Display Name (**ldapDisplayName**) for this property is displayName. ```yaml Type: String @@ -403,6 +471,7 @@ Accept wildcard characters: False ``` ### -DNSHostName + Specifies the DNS host name of Service Account. ```yaml @@ -418,10 +487,10 @@ Accept wildcard characters: False ``` ### -Enabled -Indicates whether an account is enabled. -An enabled account requires a password. -This parameter sets the **Enabled** property for an account object. -This parameter also sets the **ADS_UF_ACCOUNTDISABLE** flag of the Active Directory UAC attribute. + +Indicates whether an account is enabled. An enabled account requires a password. This parameter +sets the **Enabled** property for an account object. This parameter also sets the +**ADS_UF_ACCOUNTDISABLE** flag of the Active Directory UAC attribute. ```yaml Type: Boolean @@ -436,9 +505,10 @@ Accept wildcard characters: False ``` ### -HomePage -Specifies the URL of the home page of the object. -This parameter sets the **homePage** property of an Active Directory object. -The LDAP Display Name (**ldapDisplayName**) for this property is wWWHomePage. + +Specifies the URL of the home page of the object. This parameter sets the **homePage** property of +an Active Directory object. The LDAP Display Name (**ldapDisplayName**) for this property is +wWWHomePage. ```yaml Type: String @@ -453,12 +523,16 @@ Accept wildcard characters: False ``` ### -Instance -Specifies an instance of a service account object to use as a template for a new service account object. -You can use an instance of an existing service account object as a template or you can construct a new service account object for template use. -You can construct a new service account using the Windows PowerShell command line or by using a script. +Specifies an instance of a service account object to use as a template for a new service account +object. -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set raises an error. +You can use an instance of an existing service account object as a template or you can construct a +new service account object for template use. You can construct a new service account using the +Windows PowerShell command line or by using a script. + +Note: Specified attributes aren't validated, so attempting to set attributes that Don�t exist or +can't be set raises an error. ```yaml Type: ADServiceAccount @@ -473,9 +547,10 @@ Accept wildcard characters: False ``` ### -KerberosEncryptionType -Indicates whether an account supports Kerberos encryption types which are used during creation of service tickets. -This value sets the encryption types supported flags of the Active Directory **msDS-SupportedEncryptionTypes** attribute. -The acceptable values for this parameter are: + +Indicates whether an account supports Kerberos encryption types which are used during creation of +service tickets. This value sets the encryption types supported flags of the Active Directory +`msDS-SupportedEncryptionTypes` attribute. The acceptable values for this parameter are: - None - DES @@ -483,12 +558,16 @@ The acceptable values for this parameter are: - AES128 - AES256 -None will remove all encryption types from the account may result in the KDC being unable to issue service tickets for services using the account. +None will remove all encryption types from the account may result in the KDC being unable to issue +service tickets for services using the account. -DES is a weak encryption type that is not supported by default since Windows 7 and Windows Server 2008 R2. +DES is a weak encryption type that'sn't supported by default since Windows 7 and Windows Server +2008 R2. -Warning: Domain-joined Windows systems and services such as clustering manage their own **msDS-SupportedEncryptionTypes** attribute. -Therefore any changes to the flag on the **msDS-SupportedEncryptionTypes** attribute will be overwritten by the service or system which manages the setting. +Warning: Domain-joined Windows systems and services such as clustering manage their own +`msDS-SupportedEncryptionTypes` attribute. Therefore any changes to the flag on the +`msDS-SupportedEncryptionTypes` attribute will be overwritten by the service or system which +manages the setting. ```yaml Type: ADKerberosEncryptionType @@ -504,11 +583,10 @@ Accept wildcard characters: False ``` ### -ManagedPasswordIntervalInDays -Specifies the number of days for the password change interval. -If set to 0 then the default is used. -This can only be set on object creation. -After that the setting is read only. -This value returns the **msDS-ManagedPasswordInterval** of the group managed service account object. + +Specifies the number of days for the password change interval. If set to 0 then the default is +used. This can only be set on object creation. After that the setting is read only. This value +returns the `msDS-ManagedPasswordInterval` of the group managed service account object. ```yaml Type: Int32 @@ -523,9 +601,9 @@ Accept wildcard characters: False ``` ### -Name -Specifies the name of the object. -This parameter sets the **Name** property of the Active Directory object. -The LDAP Display Name (**ldapDisplayName**) of this property is name. + +Specifies the name of the object. This parameter sets the **Name** property of the Active Directory +object. The LDAP Display Name (**ldapDisplayName**) of this property is name. ```yaml Type: String @@ -540,10 +618,11 @@ Accept wildcard characters: False ``` ### -OtherAttributes -Specifies object attribute values for attributes that are not represented by cmdlet parameters. -You can set one or more parameters at the same time with this parameter. -If an attribute takes more than one value, you can assign multiple values. -To identify an attribute, specify the LDAP Display Name (**ldapDisplayName**) defined for it in the Active Directory schema. + +Specifies object attribute values for attributes that aren't represented by cmdlet parameters. You +can set one or more parameters at the same time with this parameter. If an attribute takes more +than one value, you can assign multiple values. To identify an attribute, specify the LDAP Display +Name (**ldapDisplayName**) defined for it in the Active Directory schema. To specify a single value for an attribute: @@ -571,8 +650,9 @@ Accept wildcard characters: False ``` ### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. + +Returns an object representing the item with which you're working. By default, this cmdlet does +not generate any output. ```yaml Type: SwitchParameter @@ -587,30 +667,39 @@ Accept wildcard characters: False ``` ### -Path -Specifies the X.500 path of the organizational unit (OU) or container where the new object is created. + +Specifies the X.500 path of the organizational unit (OU) or container where the new object is +created. In many cases, a default value will be used for the **Path** parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. +The rules for determining the default value are given below. Note that rules listed first are +evaluated first and once a default value can be determined, no further rules are evaluated. In AD DS environments, a default value for **Path** is set in the following cases: -- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive. +- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to + the current path of the provider drive. - If the cmdlet has a default path, this is used. -For example: in **New-ADUser**, the **Path** parameter defaults to the Users container. -- If none of the previous cases apply, the default value of **Path** is set to the default partition or naming context of the target domain. + For example: in `New-ADUser`, the **Path** parameter defaults to the Users container. +- If none of the previous cases apply, the default value of **Path** is set to the default + partition or naming context of the target domain. In AD LDS environments, a default value for **Path** is set in the following cases: -- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive. +- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to + the current path of the provider drive. - If the cmdlet has a default path, this is used. -For example: in **New-ADUser**, the **Path** parameter defaults to the Users container. -- If the target AD LDS instance has a default naming context, the default value of **Path** is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the **Path** parameter does not take any default value. - -Note: The Active Directory Provider cmdlets, such as **New-Item**, **Remove-Item**, **Remove-ItemProperty**, **Rename-Item**, and **Set-ItemProperty**, also contain a **Path** property. -However, for the provider cmdlets, the **Path** parameter identifies the path of the actual object and not the container as with the Active Directory cmdlets. + For example: in `New-ADUser`, the **Path** parameter defaults to the Users container. +- If the target AD LDS instance has a default naming context, the default value of **Path** is set + to the default naming context. To specify a default naming context for an AD LDS environment, set + the `msDS-defaultNamingContext` property of the Active Directory directory service agent object + (**nTDSDSA**) for the AD LDS instance. +- If none of the previous cases apply, the **Path** parameter doesn't take any default value. + +Note: The Active Directory Provider cmdlets, such as `New-Item`, `Remove-Item`, +`Remove-ItemProperty`, `Rename-Item`, and `Set-ItemProperty`, also contain a **Path** +property. However, for the provider cmdlets, the **Path** parameter identifies the path of the +actual object and not the container as with the Active Directory cmdlets. ```yaml Type: String @@ -625,8 +714,10 @@ Accept wildcard characters: False ``` ### -PrincipalsAllowedToDelegateToAccount -Specifies the accounts that can act on the behalf of users to services running as this managed service account or group-managed service account. -This parameter sets the **msDS-AllowedToActOnBehalfOfOtherIdentity** attribute of the object. + +Specifies the accounts that can act on the behalf of users to services running as this managed +service account or group-managed service account. This parameter sets the +`msDS-AllowedToActOnBehalfOfOtherIdentity` attribute of the object. ```yaml Type: ADPrincipal[] @@ -641,10 +732,12 @@ Accept wildcard characters: False ``` ### -PrincipalsAllowedToRetrieveManagedPassword -Specifies the membership policy for systems that can use a group-managed service account. -For a service to run under a group managed service account, the system must be in the membership policy of the account. -This parameter sets the **msDS-GroupMSAMembership** attribute of a group-managed service account object. -This parameter should be set to the principals allowed to use this group-managed service account. + +Specifies the membership policy for systems that can use a group-managed service account. For a +service to run under a group managed service account, the system must be in the membership policy +of the account. This parameter sets the `msDS-GroupMSAMembership` attribute of a group-managed +service account object. This parameter should be set to the principals allowed to use this +group-managed service account. ```yaml Type: ADPrincipal[] @@ -659,8 +752,10 @@ Accept wildcard characters: False ``` ### -RestrictToOutboundAuthenticationOnly -Indicates that the cmdlet creates a group-managed service account that on success can be used by a service for successful outbound authentication requests only. -This allows creating a group managed service account without the parameters required for successful inbound authentication. + +Indicates that the cmdlet creates a group-managed service account that on success can be used by a +service for successful outbound authentication requests only. This allows creating a group managed +service account without the parameters required for successful inbound authentication. ```yaml Type: SwitchParameter @@ -676,8 +771,10 @@ Accept wildcard characters: False ``` ### -RestrictToSingleComputer -Indicates that the cmdlet creates a managed service account that can be used only for a single computer. -Managed service accounts that are linked to a single computer account were introduced in Windows Server 2008 R2. + +Indicates that the cmdlet creates a managed service account that can be used only for a single +computer. Managed service accounts that are linked to a single computer account were introduced in +Windows Server 2008 R2. ```yaml Type: SwitchParameter @@ -692,14 +789,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -CreateDelegatedServiceAccount + +Indicates that the cmdlet creates a delegated managed service account that be used for migration. +Delegated managed service accounts were introduced in Windows Server 2025. + +```yaml +Type: SwitchParameter +Parameter Sets: Group +Aliases: +AcceptedValues: true + +Required: False +Position: Named +Default value: none +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SamAccountName -Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service account. -The maximum length of the description is 256 characters. -To be compatible with older operating systems, create a SAM account name that is 15 characters or less. -This parameter sets the **SAMAccountName** for an account object. -The LDAP display name (**ldapDisplayName**) for this property is sAMAccountName. -Note: If the specified **SAMAccountName** string does not end with a $ (dollar sign), one is appended if necessary. +Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service +account. The maximum length of the description is 256 characters. To be compatible with older +operating systems, create a SAM account name that's 15 characters or less. This parameter sets the +**SAMAccountName** for an account object. The LDAP display name (**ldapDisplayName**) for this +property is sAMAccountName. + +Note: If the specified **SAMAccountName** string doesn't end with a $ (dollar sign), one is +appended if necessary. ```yaml Type: String @@ -714,8 +831,11 @@ Accept wildcard characters: False ``` ### -Server -Specifies the Active Directory Domain Services (AD DS) instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services (AD LDS), AD DS, or Active Directory snapshot instance. + +Specifies the Active Directory Domain Services (AD DS) instance to connect to, by providing one of +the following values for a corresponding domain name or directory server. The service may be any of +the following: Active Directory Lightweight Domain Services (AD LDS), AD DS, or Active Directory +snapshot instance. Domain name values: @@ -728,10 +848,12 @@ Directory server values: - NetBIOS name - Fully qualified directory server name and port -The default value for the *Server* parameter is determined by one of the following methods in the order that they are listed: +The default value for the *Server* parameter is determined by one of the following methods in the +order that they are listed: - By using *Server* value from objects passed through the pipeline. -- By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. +- By using the server information associated with the Active Directory PowerShell provider drive, + when running under that drive. - By using the domain of the computer running PowerShell. ```yaml @@ -747,10 +869,11 @@ Accept wildcard characters: False ``` ### -ServicePrincipalNames -Specifies the service principal names for the account. -This parameter sets the **ServicePrincipalNames** property of the account. -The LDAP display name (**ldapDisplayName**) for this property is servicePrincipalName. -This parameter uses the following syntax to add remove, replace or clear service principal name values. + +Specifies the service principal names for the account. This parameter sets the +**ServicePrincipalNames** property of the account. The LDAP display name (**ldapDisplayName**) for +this property is servicePrincipalName. This parameter uses the following syntax to add remove, +replace or clear service principal name values. To add values: @@ -768,8 +891,8 @@ To clear all values: `-ServicePrincipalNames $Null` -You can specify more than one change by using a list separated by semicolons. -For example, use the following syntax to add and remove service principal names. +You can specify more than one change by using a list separated by semicolons. For example, use the +following syntax to add and remove service principal names. `@{Add=value1,value2,...};@{Remove=value3,value4,...}` @@ -792,11 +915,12 @@ Accept wildcard characters: False ``` ### -TrustedForDelegation -Indicates whether an account is trusted for Kerberos delegation. -A service that runs under an account that is trusted for Kerberos delegation can assume the identity of a client requesting the service. -This parameter sets the **TrustedForDelegation** property of an account object. -This value also sets the **ADS_UF_TRUSTED_FOR_DELEGATION** flag of the Active Directory User Account Control attribute. -The acceptable values for this parameter are: + +Indicates whether an account is trusted for Kerberos delegation. A service that runs under an +account that's trusted for Kerberos delegation can assume the identity of a client requesting the +service. This parameter sets the **TrustedForDelegation** property of an account object. This value +also sets the **ADS_UF_TRUSTED_FOR_DELEGATION** flag of the Active Directory User Account Control +attribute. The acceptable values for this parameter are: - $False or 0 - $True or 1 @@ -814,8 +938,8 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet isn't run. ```yaml Type: SwitchParameter @@ -830,24 +954,35 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216) + +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, +`-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, +`-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216) ## INPUTS ### None or Microsoft.ActiveDirectory.Management.ADServiceAccount -You can pipe a managed service account object that is a template for the new managed service account object to the **Instance** parameter. + +You can pipe a managed service account object that's a template for the new managed service +account object to the **Instance** parameter. ## OUTPUTS ### None or Microsoft.ActiveDirectory.Management.ADServiceAccount -This cmdlet returns the new managed service account object when the **PassThru** parameter is specified. -By default, this cmdlet does not generate any output. + +This cmdlet returns the new managed service account object when the **PassThru** parameter.is +specified. By default, this cmdlet doesn't generate any output. ## NOTES -* This cmdlet does not work with AD LDS. -* This cmdlet does not work with an Active Directory snapshot. -* This cmdlet does not work with a read-only domain controller. -* This cmdlet requires that you create a Microsoft Group Key Distribution Service (GKDS) root key first to begin using group managed service accounts in your Active Directory deployment. For more information on how to create the GKDS root key using Windows PowerShell, see [Create the Key Distribution Services KDS Root Key](https://go.microsoft.com/fwlink/?LinkId=253584). + +- This cmdlet doesn't work with AD LDS. +- This cmdlet doesn't work with an Active Directory snapshot. +- This cmdlet doesn't work with a read-only domain controller. +- This cmdlet requires that you create a Microsoft Group Key Distribution Service (GKDS) root key + first to begin using group managed service accounts in your Active Directory deployment. For more + information on how to create the GKDS root key using Windows PowerShell, see + [Create the Key Distribution Services KDS Root Key](https://go.microsoft.com/fwlink/?LinkId=253584). ## RELATED LINKS diff --git a/docset/winserver2025-ps/activedirectory/Reset-ADServiceAccountMigration.md b/docset/winserver2025-ps/activedirectory/Reset-ADServiceAccountMigration.md new file mode 100644 index 0000000000..f86ddebd48 --- /dev/null +++ b/docset/winserver2025-ps/activedirectory/Reset-ADServiceAccountMigration.md @@ -0,0 +1,237 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml +Module Name: ActiveDirectory +ms.date: 02/15/2024 +online version: https://learn.microsoft.com/powershell/module/activedirectory/reset-adserviceaccountMigration?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Reset-ADServiceAccountMigration +--- + +# Reset-ADServiceAccountMigration + +## SYNOPSIS +Resets the state of a migration to an delegated managed service account and unlinks the delegated +managed service account from the user account. + +## SYNTAX + +### ADServiceAccountMigrationParameterSet (Default) + +``` +Reset-ADServiceAccountMigration [-AuthType ] [-Credential ] + [-Identity] [-SupersededAccount ] [-Server ] + [] +``` + +## DESCRIPTION + +The `Reset-ADServiceAccountMigration` cmdlet will reset the migration process of superseding a +normal user account specified by the distinguished name string provided in the +**SupersededAccount** parameter to the delegated managed service account provided in the +**identity** parameter. They must've been previously linked via the +`Start-ADServiceAccountMigration` cmdlet. + +The **Identity** parameter specifies the delegated managed service account to use. You can identify +a managed service account by its distinguished name, GUID, security identifier (SID), or Security +Account Manager (SAM) account name. + +The **SupersededAccount** parameter specifies the user account that's linked to the delegated +managed service account. The superseded account must be identified by its distinguished name. + +## EXAMPLES + +### Example 1: Reset a service account migration by using the Security Account Manager name of the delegated managed service account + +```powershell +$params = @{ + Identity = "delegatedSvc1" + SupersededAccount = "CN=User1,OU=Accounts,DC=Contoso,DC=com" +} +Reset-ADServiceAccountMigration @params +``` + +### Example 2: Reset a service account migration by specifying a 2025 Domain Controller + +```powershell +$params = @{ + Identity = "delegatedSvc1" + SupersededAccount = "CN=User1,OU=Accounts,DC=Contoso,DC=com" + Server = "2025DC.Contoso.Com" +} +Reset-ADServiceAccountMigration @params +``` + +## PARAMETERS + +### -AuthType + +Specifies the authentication method to use. +The acceptable values for this parameter are: + +- Negotiate or 0 +- Basic or 1 + +The default authentication method is Negotiate. + +A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. + +```yaml +Type: ADAuthType +Parameter Sets: (All) +Aliases: +Accepted values: Negotiate, Basic + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory +module for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the +account associated with the drive is the default. + +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you +can specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet +prompts for a password. + +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the *Credential* parameter to the **PSCredential** object. + +If the acting credentials don't have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies an Active Directory account object by providing one of the following property values. +The identifier in parentheses is the LDAP display name for the attribute. +The acceptable values for this parameter are: + +- A distinguished name +- A GUID (objectGUID) +- A security identifier (objectSid) +- A SAM account name (sAMAccountName) + +The cmdlet searches the default naming context or partition to find the object. +If two or more objects are found, the cmdlet returns a non-terminating error. + +```yaml +Type: ADServiceAccount +Parameter Sets: ADServiceAccountMigrationParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupersededAccount + +Specifies the user account that you want to be migrated to a delegated managed service account. The +account must be specified by it's distinguished name. + +```yaml +Type: String +Parameter Sets: ADServiceAccountMigrationParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server + +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory Snapshot instance. + +Domain name values: + +- Fully qualified domain name (FQDN) +- NetBIOS name + +Directory server values: + +- Fully qualified directory server name +- NetBIOS name +- Fully qualified directory server name and port + +The default value for the **Server** parameter is determined by one of the following methods in the +order that they are listed: + +- By using **Server** value from objects passed through the pipeline. +- By using the server information associated with the Active Directory PowerShell provider drive, + when running under that drive. +- By using the domain of the computer running PowerShell. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, +`-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, +`-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.ActiveDirectory.Management.ADServiceAccount + +A delegated managed service account object is received by the **Identity** parameter. + +## NOTES + +- This cmdlet doesn't work with AD LDS. +- This cmdlet doesn't work with an Active Directory snapshot. +- This cmdlet doesn't work with a read-only domain controller. +- This cmdlet requires that you create a Microsoft Group Key Distribution Service (GKDS) root key + first to begin using group managed service accounts in your Active Directory deployment. For more + information on how to create the GKDS root key using Windows PowerShell, see + [Create the Key Distribution Services KDS Root Key](https://go.microsoft.com/fwlink/?LinkId=253584). + +## RELATED LINKS + +[Complete-AdServiceAccountMigration](./Complete-AdServiceAccountMigration.md) + +[Start-AdServiceAccountMigration](./Start-AdServiceAccountMigration.md) + +[Undo-AdServiceAccountMigration](./Undo-AdServiceAccountMigration.md) + +[Get-ADServiceAccount](./Get-ADServiceAccount.md) + +[New-ADServiceAccount](./New-ADServiceAccount.md) + +[Set-ADServiceAccount](./Set-ADServiceAccount.md) diff --git a/docset/winserver2025-ps/activedirectory/Start-ADServiceAccountMigration.md b/docset/winserver2025-ps/activedirectory/Start-ADServiceAccountMigration.md new file mode 100644 index 0000000000..5a6162c60c --- /dev/null +++ b/docset/winserver2025-ps/activedirectory/Start-ADServiceAccountMigration.md @@ -0,0 +1,236 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml +Module Name: ActiveDirectory +ms.date: 02/15/2024 +online version: https://learn.microsoft.com/powershell/module/activedirectory/start-adserviceaccountMigration?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Start-ADServiceAccountMigration +--- + +# Start-ADServiceAccountMigration + +## SYNOPSIS +Starts the migration process by linking a normal user account to a delegated managed service +account. + +## SYNTAX + +### ADServiceAccountMigrationParameterSet (Default) + +``` +Start-ADServiceAccountMigration [-AuthType ] [-Credential ] + [-Identity] [-SupersededAccount ] [-Server ] + [] +``` + +## DESCRIPTION + +The `Start-ADServiceAccountMigration` cmdlet will begin the migration process of superseding a +normal user account specified by the distinguished name string provided in the +**SupersededAccount** parameter to the delegated managed service account provided in the +**identity** parameter. + +The **Identity** parameter specifies the delegated managed service account to use. You can identify +a managed service account by its distinguished name, GUID, security identifier (SID), or Security +Account Manager (SAM) account name. + +The **SupersededAccount** parameter specifies the user account you want to link to the delegated +managed service account. The superseded account must be identified by its distinguished name. + +## EXAMPLES + +### Example 1: Start a service account migration by using the Security Account Manager name of the delegated managed service account + +```powershell +$params = @{ + Identity = "delegatedSvc1" + SupersededAccount = "CN=User1,OU=Accounts,DC=Contoso,DC=com" +} +Start-ADServiceAccountMigration @params +``` + +### Example 2: Start a service account migration by specifying a 2025 Domain Controller + +```powershell +$params = @{ + Identity = "delegatedSvc1" + SupersededAccount = "CN=User1,OU=Accounts,DC=Contoso,DC=com" + Server = "2025DC.Contoso.com" +} +Start-ADServiceAccountMigration @params +``` + +## PARAMETERS + +### -AuthType + +Specifies the authentication method to use. +The acceptable values for this parameter are: + +- Negotiate or 0 +- Basic or 1 + +The default authentication method is Negotiate. + +A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. + +```yaml +Type: ADAuthType +Parameter Sets: (All) +Aliases: +Accepted values: Negotiate, Basic + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory +module for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the +account associated with the drive is the default. + +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you +can specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet +prompts for a password. + +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the *Credential* parameter to the **PSCredential** object. + +If the acting credentials don't have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies an Active Directory account object by providing one of the following property values. +The identifier in parentheses is the LDAP display name for the attribute. +The acceptable values for this parameter are: + +- A distinguished name +- A GUID (objectGUID) +- A security identifier (objectSid) +- A SAM account name (sAMAccountName) + +The cmdlet searches the default naming context or partition to find the object. +If two or more objects are found, the cmdlet returns a non-terminating error. + +```yaml +Type: ADServiceAccount +Parameter Sets: ADServiceAccountMigrationParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupersededAccount + +Specifies the user account that you want to be migrated to a delegated managed service account. The +account must be specified by it's distinguished name. + +```yaml +Type: String +Parameter Sets: ADServiceAccountMigrationParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server + +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory Snapshot instance. + +Domain name values: + +- Fully qualified domain name (FQDN) +- NetBIOS name + +Directory server values: + +- Fully qualified directory server name +- NetBIOS name +- Fully qualified directory server name and port + +The default value for the **Server** parameter is determined by one of the following methods in the +order that they are listed: + +- By using **Server** value from objects passed through the pipeline. +- By using the server information associated with the Active Directory PowerShell provider drive, + when running under that drive. +- By using the domain of the computer running PowerShell. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, +`-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, +`-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.ActiveDirectory.Management.ADServiceAccount + +A delegated managed service account object is received by the **Identity** parameter. + +## NOTES + +- This cmdlet doesn't work with AD LDS. +- This cmdlet doesn't work with an Active Directory snapshot. +- This cmdlet doesn't work with a read-only domain controller. +- This cmdlet requires that you create a Microsoft Group Key Distribution Service (GKDS) root key + first to begin using group managed service accounts in your Active Directory deployment. For more + information on how to create the GKDS root key using Windows PowerShell, see + [Create the Key Distribution Services KDS Root Key](https://go.microsoft.com/fwlink/?LinkId=253584). + +## RELATED LINKS + +[Complete-ADServiceAccountMigration](./Complete-ADServiceAccountMigration.md) + +[Reset-ADServiceAccountMigration](./Reset-ADServiceAccountMigration.md) + +[Undo-ADServiceAccountMigration](./Undo-ADServiceAccountMigration.md) + +[Get-ADServiceAccount](./Get-ADServiceAccount.md) + +[New-ADServiceAccount](./New-ADServiceAccount.md) + +[Set-ADServiceAccount](./Set-ADServiceAccount.md) diff --git a/docset/winserver2025-ps/activedirectory/Undo-ADServiceAccountMigration.md b/docset/winserver2025-ps/activedirectory/Undo-ADServiceAccountMigration.md new file mode 100644 index 0000000000..7fde2698ff --- /dev/null +++ b/docset/winserver2025-ps/activedirectory/Undo-ADServiceAccountMigration.md @@ -0,0 +1,238 @@ +--- +description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. +external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml +Module Name: ActiveDirectory +ms.date: 02/15/2024 +online version: https://learn.microsoft.com/powershell/module/activedirectory/undo-adserviceaccountMigration?view=windowsserver2025-ps&wt.mc_id=ps-gethelp +schema: 2.0.0 +title: Undo-AdServiceAccountMigration +--- + +# Undo-ADServiceAccountMigration + +## SYNOPSIS +Reverts the previous migration phase of a migration to an delegated managed service account. If the +migration process is currently in the start phase, the accounts will be unlinked from each other. +If the migration is in the completed phase, it'll return back to the state in the start phase. + +## SYNTAX + +### ADServiceAccountMigrationParameterSet (Default) + +``` +Undo-ADServiceAccountMigration [-AuthType ] [-Credential ] + [-Identity] [-SupersededAccount ] [-Server ] + [] +``` + +## DESCRIPTION + +The `Undo-ADServiceAccountMigration` cmdlet will undo the previous step of the migration process of +superseding a normal user account specified by the distinguished name string provided in the +**SupersededAccount** parameter to the delegated managed service account provided in the +**identity** parameter. They must've been previously linked via the +`Start-ADServiceAccountMigration` cmdlet. + +The **Identity** parameter specifies the delegated managed service account to use. You can identify +a managed service account by its distinguished name, GUID, security identifier (SID), or Security +Account Manager (SAM) account name. + +The **SupersededAccount** parameter specifies the user account that's linked to the delegated +managed service account. The superseded account must be identified by its distinguished name. + +## EXAMPLES + +### Example 1: Undo a service account migration phase by using the Security Account Manager name of the delegated managed service account + +```powershell +$params = @{ + Identity = "delegatedSvc1" + SupersededAccount = "CN=User1,OU=Accounts,DC=Contoso,DC=com" +} +Undo-ADServiceAccountMigration @params +``` + +### Example 2: Undo a service account migration phase by specifying a 2025 Domain Controller + +```powershell +$params = @{ + Identity = "delegatedSvc1" + SupersededAccount = "CN=User1,OU=Accounts,DC=Contoso,DC=com" + Server = "2025DC.Contoso.com" +} +Undo-ADServiceAccountMigration @params +``` + +## PARAMETERS + +### -AuthType + +Specifies the authentication method to use. +The acceptable values for this parameter are: + +- Negotiate or 0 +- Basic or 1 + +The default authentication method is Negotiate. + +A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. + +```yaml +Type: ADAuthType +Parameter Sets: (All) +Aliases: +Accepted values: Negotiate, Basic + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential + +Specifies the user account credentials to use to perform this task. The default credentials are the +credentials of the currently logged on user unless the cmdlet is run from an Active Directory +module for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the +account associated with the drive is the default. + +To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you +can specify a **PSCredential** object. If you specify a user name for this parameter, the cmdlet +prompts for a password. + +You can also create a **PSCredential** object by using a script or by using the `Get-Credential` +cmdlet. You can then set the *Credential* parameter to the **PSCredential** object. + +If the acting credentials don't have directory-level permission to perform the task, Active +Directory module for Windows PowerShell returns a terminating error. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +Specifies an Active Directory account object by providing one of the following property values. +The identifier in parentheses is the LDAP display name for the attribute. +The acceptable values for this parameter are: + +- A distinguished name +- A GUID (objectGUID) +- A security identifier (objectSid) +- A SAM account name (sAMAccountName) + +The cmdlet searches the default naming context or partition to find the object. +If two or more objects are found, the cmdlet returns a non-terminating error. + +```yaml +Type: ADServiceAccount +Parameter Sets: ADServiceAccountMigrationParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SupersededAccount + +Specifies the user account that you want to be migrated to a delegated managed service account. The +account must be specified by it's distinguished name. + +```yaml +Type: String +Parameter Sets: ADServiceAccountMigrationParameterSet +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server + +Specifies the Active Directory Domain Services instance to connect to, by providing one of the +following values for a corresponding domain name or directory server. The service may be any of the +following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active +Directory Snapshot instance. + +Domain name values: + +- Fully qualified domain name (FQDN) +- NetBIOS name + +Directory server values: + +- Fully qualified directory server name +- NetBIOS name +- Fully qualified directory server name and port + +The default value for the **Server** parameter is determined by one of the following methods in the +order that they are listed: + +- By using **Server** value from objects passed through the pipeline. +- By using the server information associated with the Active Directory PowerShell provider drive, + when running under that drive. +- By using the domain of the computer running PowerShell. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, +`-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, +`-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see +[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.ActiveDirectory.Management.ADServiceAccount + +A delegated managed service account object is received by the **Identity** parameter. + +## NOTES + +- This cmdlet doesn't work with AD LDS. +- This cmdlet doesn't work with an Active Directory snapshot. +- This cmdlet doesn't work with a read-only domain controller. +- This cmdlet requires that you create a Microsoft Group Key Distribution Service (GKDS) root key + first to begin using group managed service accounts in your Active Directory deployment. For more + information on how to create the GKDS root key using Windows PowerShell, see + [Create the Key Distribution Services KDS Root Key](https://go.microsoft.com/fwlink/?LinkId=253584). + +## RELATED LINKS + +[Complete-ADServiceAccountMigration](./Complete-ADServiceAccountMigration.md) + +[Start-ADServiceAccountMigration](./Start-ADServiceAccountMigration.md) + +[Reset-ADServiceAccountMigration](./Reset-ADServiceAccountMigration.md) + +[Get-ADServiceAccount](./Get-ADServiceAccount.md) + +[New-ADServiceAccount](./New-ADServiceAccount.md) + +[Set-ADServiceAccount](./Set-ADServiceAccount.md)