Set-AzureServiceADDomainExtension

Module:

Azure

Enables an AD Domain extension for a cloud service.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Set-AzureServiceADDomainExtension
   [[-ServiceName] <String>]
   [[-Slot] <String>]
   [[-Role] <String[]>]
   [[-X509Certificate] <X509Certificate2>]
   [[-ThumbprintAlgorithm] <String>]
   [-DomainName] <String>
   [-Restart]
   [[-Credential] <PSCredential>]
   [[-UnjoinDomainCredential] <PSCredential>]
   [[-Options] <JoinOptions>]
   [[-OUPath] <String>]
   [[-Version] <String>]
   [[-ExtensionId] <String>]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Set-AzureServiceADDomainExtension
   [[-ServiceName] <String>]
   [[-Slot] <String>]
   [[-Role] <String[]>]
   [[-X509Certificate] <X509Certificate2>]
   [[-ThumbprintAlgorithm] <String>]
   [-DomainName] <String>
   [-Restart]
   [[-Credential] <PSCredential>]
   [[-UnjoinDomainCredential] <PSCredential>]
   [-JoinOption] <UInt32>
   [[-OUPath] <String>]
   [[-Version] <String>]
   [[-ExtensionId] <String>]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Set-AzureServiceADDomainExtension
   [[-ServiceName] <String>]
   [[-Slot] <String>]
   [[-Role] <String[]>]
   [[-X509Certificate] <X509Certificate2>]
   [[-ThumbprintAlgorithm] <String>]
   [-WorkgroupName] <String>
   [-Restart]
   [[-Credential] <PSCredential>]
   [[-Version] <String>]
   [[-ExtensionId] <String>]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Set-AzureServiceADDomainExtension
   [[-ServiceName] <String>]
   [[-Slot] <String>]
   [[-Role] <String[]>]
   [-CertificateThumbprint] <String>
   [[-ThumbprintAlgorithm] <String>]
   [-DomainName] <String>
   [-Restart]
   [[-Credential] <PSCredential>]
   [[-UnjoinDomainCredential] <PSCredential>]
   [[-Options] <JoinOptions>]
   [[-OUPath] <String>]
   [[-Version] <String>]
   [[-ExtensionId] <String>]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Set-AzureServiceADDomainExtension
   [[-ServiceName] <String>]
   [[-Slot] <String>]
   [[-Role] <String[]>]
   [-CertificateThumbprint] <String>
   [[-ThumbprintAlgorithm] <String>]
   [-DomainName] <String>
   [-Restart]
   [[-Credential] <PSCredential>]
   [[-UnjoinDomainCredential] <PSCredential>]
   [-JoinOption] <UInt32>
   [[-OUPath] <String>]
   [[-Version] <String>]
   [[-ExtensionId] <String>]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Set-AzureServiceADDomainExtension
   [[-ServiceName] <String>]
   [[-Slot] <String>]
   [[-Role] <String[]>]
   [-CertificateThumbprint] <String>
   [[-ThumbprintAlgorithm] <String>]
   [-WorkgroupName] <String>
   [-Restart]
   [[-Credential] <PSCredential>]
   [[-Version] <String>]
   [[-ExtensionId] <String>]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Description

The Set-AzureServiceADDomainExtension cmdlet enables an AD (Active Directory) Domain extension for a cloud service.

Examples

1:

Parameters

-CertificateThumbprint

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.

Type:	String
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Credential

Specifies the credentials to join the AD domain. Credentials include a user name and password.

Type:	PSCredential
Position:	7
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DomainName

Specifies the AD domain name.

Type:	String
Position:	5
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ExtensionId

Specifies the extension ID.

Type:	String
Position:	13
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

• Continue
• Ignore
• Inquire
• SilentlyContinue
• Stop
• Suspend

Type:	ActionPreference
Aliases:	infa
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InformationVariable

Specifies an information variable.

Type:	String
Aliases:	iv
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-JoinOption

Specifies the join option enumeration.

Type:	UInt32
Position:	10
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Options

Specifies the unsigned integer join option.

Type:	JoinOptions
Position:	9
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-OUPath

Specifies the Organization Unit (OU) path for the AD domain join operation.

Type:	String
Position:	11
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type:	AzureSMProfile
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Restart

Specifies whether to restart the computer if the join operation succeeds.

Type:	SwitchParameter
Position:	6
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Role

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.

Type:	String[]
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ServiceName

Specifies the cloud service name.

Type:	String
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Slot

Specifies the environment of the deployment to modify. The acceptable values for this parameter are: Production or Staging.

Type:	String
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ThumbprintAlgorithm

Specifies a thumbprint hashing algorithm which is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.

Type:	String
Position:	4
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-UnjoinDomainCredential

Specifies the credentials (user name and password) to unjoin the AD domain.

Type:	PSCredential
Position:	8
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Version

Specifies the extension version.

Type:	String
Position:	12
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-WorkgroupName

Specifies the workgroup name.

Type:	String
Position:	5
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-X509Certificate

Specifies an x509 certificate that when specified will be automatically uploaded to the cloud service and used for encrypting the extension private configuration.

Type:	X509Certificate2
Position:	3
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

Related Links

• Get-AzureServiceADDomainExtension
• Remove-AzureServiceADDomainExtension
• New-AzureServiceADDomainExtensionConfig