< Back
Set-AzureServiceADDomainExtension
Post
NAME Set-AzureServiceADDomainExtension
SYNOPSIS
Enables an AD Domain extension for a cloud service.
SYNTAX
Set-AzureServiceADDomainExtension [[-ServiceName] <String>] [[-Slot] <String>] [[-OUPath] <String>] [[-Version] <String>] [[-ExtensionId] <String>]
[[-Role] <String[]>] [[-X509Certificate] <X509Certificate2>] [[-ThumbprintAlgorithm] <String>] [-DomainName] <String> [[-Restart]] [[-Credential]
<PSCredential>] [[-UnjoinDomainCredential] <PSCredential>] [[-Options] <JoinOptions>] [-Profile <AzureSMProfile>] [-InformationAction
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Set-AzureServiceADDomainExtension [[-ServiceName] <String>] [[-Slot] <String>] [-JoinOption] <UInt32> [[-OUPath] <String>] [[-Version] <String>]
[[-ExtensionId] <String>] [[-Role] <String[]>] [[-X509Certificate] <X509Certificate2>] [[-ThumbprintAlgorithm] <String>] [-DomainName] <String>
[[-Restart]] [[-Credential] <PSCredential>] [[-UnjoinDomainCredential] <PSCredential>] [-Profile <AzureSMProfile>] [-InformationAction
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Set-AzureServiceADDomainExtension [[-ServiceName] <String>] [[-Slot] <String>] [[-Version] <String>] [[-ExtensionId] <String>] [[-Role] <String[]>]
[[-X509Certificate] <X509Certificate2>] [[-ThumbprintAlgorithm] <String>] [-WorkgroupName] <String> [[-Restart]] [[-Credential] <PSCredential>]
[-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Set-AzureServiceADDomainExtension [[-ServiceName] <String>] [[-Slot] <String>] [[-OUPath] <String>] [[-Version] <String>] [[-ExtensionId] <String>]
[[-Role] <String[]>] [-CertificateThumbprint] <String> [[-ThumbprintAlgorithm] <String>] [-DomainName] <String> [[-Restart]] [[-Credential]
<PSCredential>] [[-UnjoinDomainCredential] <PSCredential>] [[-Options] <JoinOptions>] [-Profile <AzureSMProfile>] [-InformationAction
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Set-AzureServiceADDomainExtension [[-ServiceName] <String>] [[-Slot] <String>] [-JoinOption] <UInt32> [[-OUPath] <String>] [[-Version] <String>]
[[-ExtensionId] <String>] [[-Role] <String[]>] [-CertificateThumbprint] <String> [[-ThumbprintAlgorithm] <String>] [-DomainName] <String> [[-Restart]]
[[-Credential] <PSCredential>] [[-UnjoinDomainCredential] <PSCredential>] [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [<CommonParameters>]
Set-AzureServiceADDomainExtension [[-ServiceName] <String>] [[-Slot] <String>] [[-Version] <String>] [[-ExtensionId] <String>] [[-Role] <String[]>]
[-CertificateThumbprint] <String> [[-ThumbprintAlgorithm] <String>] [-WorkgroupName] <String> [[-Restart]] [[-Credential] <PSCredential>] [-Profile
<AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
DESCRIPTION
The Set-AzureServiceADDomainExtension cmdlet enables an AD (Active Directory) Domain extension for a cloud service.
PARAMETERS
-ServiceName <String>
Specifies the cloud service name.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Slot <String>
Specifies the environment of the deployment to modify. The acceptable values for this parameter are: Production or Staging.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Role <String[]>
Specifies an optional array of roles for which to specify the remote desktop configuration. If not specified the AD domain configuration is applied
as the default configuration for all roles.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-X509Certificate <X509Certificate2>
Specifies an x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private
configuration.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ThumbprintAlgorithm <String>
Specifies a thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default
is sha1.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DomainName <String>
Specifies the AD domain name.
Required? true
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Restart [<SwitchParameter>]
Specifies whether to restart the computer if the join operation succeeds.
Required? false
Position? 6
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Credential <PSCredential>
Specifies the credentials to join the AD domain. Credentials include a user name and password.
Required? false
Position? 7
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-UnjoinDomainCredential <PSCredential>
Specifies the credentials (user name and password) to unjoin the AD domain.
Required? false
Position? 8
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Options <JoinOptions>
Specifies the unsigned integer join option.
Required? false
Position? 9
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OUPath <String>
Specifies the Organization Unit (OU) path for the AD domain join operation.
Required? false
Position? 11
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Version <String>
Specifies the extension version.
Required? false
Position? 12
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ExtensionId <String>
Required? false
Position? 13
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Profile <AzureSMProfile>
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InformationAction <ActionPreference>
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InformationVariable <String>
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-JoinOption <UInt32>
Specifies the join option enumeration.
Required? true
Position? 10
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WorkgroupName <String>
Specifies the workgroup name.
Required? true
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CertificateThumbprint <String>
Specifies a certificate thumbprint to use to encrypt the private configuration. This certificate has to already exist in the certificate store. If
you do not specify a certificate, this cmdlet creates a certificate.
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
-------------------------- 1: --------------------------
RELATED LINKS
Get-AzureServiceADDomainExtension
Remove-AzureServiceADDomainExtension
New-AzureServiceADDomainExtensionConfig
SYNOPSIS
Enables an AD Domain extension for a cloud service.
SYNTAX
Set-AzureServiceADDomainExtension [[-ServiceName] <String>] [[-Slot] <String>] [[-OUPath] <String>] [[-Version] <String>] [[-ExtensionId] <String>]
[[-Role] <String[]>] [[-X509Certificate] <X509Certificate2>] [[-ThumbprintAlgorithm] <String>] [-DomainName] <String> [[-Restart]] [[-Credential]
<PSCredential>] [[-UnjoinDomainCredential] <PSCredential>] [[-Options] <JoinOptions>] [-Profile <AzureSMProfile>] [-InformationAction
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Set-AzureServiceADDomainExtension [[-ServiceName] <String>] [[-Slot] <String>] [-JoinOption] <UInt32> [[-OUPath] <String>] [[-Version] <String>]
[[-ExtensionId] <String>] [[-Role] <String[]>] [[-X509Certificate] <X509Certificate2>] [[-ThumbprintAlgorithm] <String>] [-DomainName] <String>
[[-Restart]] [[-Credential] <PSCredential>] [[-UnjoinDomainCredential] <PSCredential>] [-Profile <AzureSMProfile>] [-InformationAction
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Set-AzureServiceADDomainExtension [[-ServiceName] <String>] [[-Slot] <String>] [[-Version] <String>] [[-ExtensionId] <String>] [[-Role] <String[]>]
[[-X509Certificate] <X509Certificate2>] [[-ThumbprintAlgorithm] <String>] [-WorkgroupName] <String> [[-Restart]] [[-Credential] <PSCredential>]
[-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Set-AzureServiceADDomainExtension [[-ServiceName] <String>] [[-Slot] <String>] [[-OUPath] <String>] [[-Version] <String>] [[-ExtensionId] <String>]
[[-Role] <String[]>] [-CertificateThumbprint] <String> [[-ThumbprintAlgorithm] <String>] [-DomainName] <String> [[-Restart]] [[-Credential]
<PSCredential>] [[-UnjoinDomainCredential] <PSCredential>] [[-Options] <JoinOptions>] [-Profile <AzureSMProfile>] [-InformationAction
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
Set-AzureServiceADDomainExtension [[-ServiceName] <String>] [[-Slot] <String>] [-JoinOption] <UInt32> [[-OUPath] <String>] [[-Version] <String>]
[[-ExtensionId] <String>] [[-Role] <String[]>] [-CertificateThumbprint] <String> [[-ThumbprintAlgorithm] <String>] [-DomainName] <String> [[-Restart]]
[[-Credential] <PSCredential>] [[-UnjoinDomainCredential] <PSCredential>] [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>]
[-InformationVariable <String>] [<CommonParameters>]
Set-AzureServiceADDomainExtension [[-ServiceName] <String>] [[-Slot] <String>] [[-Version] <String>] [[-ExtensionId] <String>] [[-Role] <String[]>]
[-CertificateThumbprint] <String> [[-ThumbprintAlgorithm] <String>] [-WorkgroupName] <String> [[-Restart]] [[-Credential] <PSCredential>] [-Profile
<AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
DESCRIPTION
The Set-AzureServiceADDomainExtension cmdlet enables an AD (Active Directory) Domain extension for a cloud service.
PARAMETERS
-ServiceName <String>
Specifies the cloud service name.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Slot <String>
Specifies the environment of the deployment to modify. The acceptable values for this parameter are: Production or Staging.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Role <String[]>
Specifies an optional array of roles for which to specify the remote desktop configuration. If not specified the AD domain configuration is applied
as the default configuration for all roles.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-X509Certificate <X509Certificate2>
Specifies an x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private
configuration.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ThumbprintAlgorithm <String>
Specifies a thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default
is sha1.
Required? false
Position? 4
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DomainName <String>
Specifies the AD domain name.
Required? true
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Restart [<SwitchParameter>]
Specifies whether to restart the computer if the join operation succeeds.
Required? false
Position? 6
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Credential <PSCredential>
Specifies the credentials to join the AD domain. Credentials include a user name and password.
Required? false
Position? 7
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-UnjoinDomainCredential <PSCredential>
Specifies the credentials (user name and password) to unjoin the AD domain.
Required? false
Position? 8
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Options <JoinOptions>
Specifies the unsigned integer join option.
Required? false
Position? 9
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OUPath <String>
Specifies the Organization Unit (OU) path for the AD domain join operation.
Required? false
Position? 11
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Version <String>
Specifies the extension version.
Required? false
Position? 12
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ExtensionId <String>
Required? false
Position? 13
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Profile <AzureSMProfile>
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InformationAction <ActionPreference>
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InformationVariable <String>
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-JoinOption <UInt32>
Specifies the join option enumeration.
Required? true
Position? 10
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WorkgroupName <String>
Specifies the workgroup name.
Required? true
Position? 5
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CertificateThumbprint <String>
Specifies a certificate thumbprint to use to encrypt the private configuration. This certificate has to already exist in the certificate store. If
you do not specify a certificate, this cmdlet creates a certificate.
Required? true
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
-------------------------- 1: --------------------------
RELATED LINKS
Get-AzureServiceADDomainExtension
Remove-AzureServiceADDomainExtension
New-AzureServiceADDomainExtensionConfig