New-AzureServiceADDomainExtensionConfig
Generates the configuration for the AD domain extension for cloud services.
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
New-AzureServiceADDomainExtensionConfig
[[-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>]
New-AzureServiceADDomainExtensionConfig
[[-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>]
New-AzureServiceADDomainExtensionConfig
[[-Role] <String[]>]
[[-X509Certificate] <X509Certificate2>]
[[-ThumbprintAlgorithm] <String>]
[-WorkgroupName] <String>
[-Restart]
[[-Credential] <PSCredential>]
[[-Version] <String>]
[[-ExtensionId] <String>]
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>]
New-AzureServiceADDomainExtensionConfig
[[-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>]
New-AzureServiceADDomainExtensionConfig
[[-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>]
New-AzureServiceADDomainExtensionConfig
[[-Role] <String[]>]
[-CertificateThumbprint] <String>
[[-ThumbprintAlgorithm] <String>]
[-WorkgroupName] <String>
[-Restart]
[[-Credential] <PSCredential>]
[[-Version] <String>]
[[-ExtensionId] <String>]
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>]
Description
The New-AzureServiceADDomainExtensionConfig cmdlet generates the configuration for the Active Directory (AD) domain extension for cloud services.
Examples
Example 1: Specify an AD domain configuration
PS C:\> $ExtensionCfg = New-AzureServiceADDomainExtensionConfig -Role WorkerRole1 -DomainName $Domain -Credential $Cred -JoinOption 35;
PS C:\> New-AzureDeployment -ServiceName $CloudSvc -Slot "Production" -Package $Pkg -Configuration $Config -ExtensionConfiguration $ExtensionCfg;
This command generates a configuration for the AD domain extension.
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: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Credential
Specifies the credentials to use to join the AD domain. Credentials include a user name and password.
Type: | PSCredential |
Position: | 5 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DomainName
Specifies the AD domain name.
Type: | String |
Position: | 3 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ExtensionId
Specifies the extension ID.
Type: | String |
Position: | 10 |
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: | 7 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Options
Specifies the unsigned integer join option.
Type: | JoinOptions |
Position: | 7 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-OUPath
Specifies the organization unit (OU) path for AD domain join operation.
Type: | String |
Position: | 8 |
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: | 4 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Role
Specifies an optional array of roles to specify the remote desktop configuration for the AD domain configuration. If you do not specify this parameter, the AD domain configuration is applied as the default configuration for all roles.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ThumbprintAlgorithm
Specifies a thumbprint hashing algorithm that is used with the thumbprint to identify the certificate. This parameter is optional and the default is sha1.
Type: | String |
Position: | 2 |
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: | 6 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Version
Specifies the extension version.
Type: | String |
Position: | 9 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WorkgroupName
Specifies the workgroup name.
Type: | String |
Position: | 3 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-X509Certificate
Specifies an X.509 certificate that is automatically uploaded to the cloud service and used for encrypting the extension private configuration.
Type: | X509Certificate2 |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |