< Back
New-AzureServiceADDomainExtensionConfig
Post
NAME New-AzureServiceADDomainExtensionConfig
SYNOPSIS
Generates the configuration for the AD domain extension for cloud services.
SYNTAX
New-AzureServiceADDomainExtensionConfig [[-Role] <String[]>] [[-X509Certificate] <X509Certificate2>] [[-ExtensionId] <String>] [[-ThumbprintAlgorithm]
<String>] [-DomainName] <String> [[-Restart]] [[-Credential] <PSCredential>] [[-UnjoinDomainCredential] <PSCredential>] [[-Options] <JoinOptions>]
[[-OUPath] <String>] [[-Version] <String>] [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[<CommonParameters>]
New-AzureServiceADDomainExtensionConfig [[-Role] <String[]>] [[-X509Certificate] <X509Certificate2>] [[-ExtensionId] <String>] [[-ThumbprintAlgorithm]
<String>] [-DomainName] <String> [[-Restart]] [[-Credential] <PSCredential>] [[-UnjoinDomainCredential] <PSCredential>] [-JoinOption] <UInt32>
[[-OUPath] <String>] [[-Version] <String>] [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[<CommonParameters>]
New-AzureServiceADDomainExtensionConfig [[-Role] <String[]>] [[-X509Certificate] <X509Certificate2>] [[-ExtensionId] <String>] [[-ThumbprintAlgorithm]
<String>] [-WorkgroupName] <String> [[-Restart]] [[-Credential] <PSCredential>] [[-Version] <String>] [-Profile <AzureSMProfile>] [-InformationAction
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
New-AzureServiceADDomainExtensionConfig [[-Role] <String[]>] [-CertificateThumbprint] <String> [[-ExtensionId] <String>] [[-ThumbprintAlgorithm]
<String>] [-DomainName] <String> [[-Restart]] [[-Credential] <PSCredential>] [[-UnjoinDomainCredential] <PSCredential>] [[-Options] <JoinOptions>]
[[-OUPath] <String>] [[-Version] <String>] [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[<CommonParameters>]
New-AzureServiceADDomainExtensionConfig [[-Role] <String[]>] [-CertificateThumbprint] <String> [[-ExtensionId] <String>] [[-ThumbprintAlgorithm]
<String>] [-DomainName] <String> [[-Restart]] [[-Credential] <PSCredential>] [[-UnjoinDomainCredential] <PSCredential>] [-JoinOption] <UInt32>
[[-OUPath] <String>] [[-Version] <String>] [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[<CommonParameters>]
New-AzureServiceADDomainExtensionConfig [[-Role] <String[]>] [-CertificateThumbprint] <String> [[-ExtensionId] <String>] [[-ThumbprintAlgorithm]
<String>] [-WorkgroupName] <String> [[-Restart]] [[-Credential] <PSCredential>] [[-Version] <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.
PARAMETERS
-Role <String[]>
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.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-X509Certificate <X509Certificate2>
Specifies an X.509 certificate that is automatically uploaded to the cloud service and used for encrypting the extension private configuration.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ThumbprintAlgorithm <String>
Specifies a thumbprint hashing algorithm that is used with the thumbprint to identify the certificate. This parameter is optional and the default is
sha1.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DomainName <String>
Specifies the AD domain name.
Required? true
Position? 3
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? 4
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Credential <PSCredential>
Specifies the credentials to use to join the AD domain. Credentials include a user name and password.
Required? false
Position? 5
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? 6
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Options <JoinOptions>
Specifies the unsigned integer join option.
Required? false
Position? 7
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OUPath <String>
Specifies the organization unit (OU) path for AD domain join operation.
Required? false
Position? 8
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Version <String>
Specifies the extension version.
Required? false
Position? 9
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ExtensionId <String>
Required? false
Position? 10
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? 7
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WorkgroupName <String>
Specifies the workgroup name.
Required? true
Position? 3
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? 1
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
-------------------------- 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.
RELATED LINKS
Get-AzureServiceADDomainExtension
Set-AzureServiceADDomainExtension
SYNOPSIS
Generates the configuration for the AD domain extension for cloud services.
SYNTAX
New-AzureServiceADDomainExtensionConfig [[-Role] <String[]>] [[-X509Certificate] <X509Certificate2>] [[-ExtensionId] <String>] [[-ThumbprintAlgorithm]
<String>] [-DomainName] <String> [[-Restart]] [[-Credential] <PSCredential>] [[-UnjoinDomainCredential] <PSCredential>] [[-Options] <JoinOptions>]
[[-OUPath] <String>] [[-Version] <String>] [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[<CommonParameters>]
New-AzureServiceADDomainExtensionConfig [[-Role] <String[]>] [[-X509Certificate] <X509Certificate2>] [[-ExtensionId] <String>] [[-ThumbprintAlgorithm]
<String>] [-DomainName] <String> [[-Restart]] [[-Credential] <PSCredential>] [[-UnjoinDomainCredential] <PSCredential>] [-JoinOption] <UInt32>
[[-OUPath] <String>] [[-Version] <String>] [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[<CommonParameters>]
New-AzureServiceADDomainExtensionConfig [[-Role] <String[]>] [[-X509Certificate] <X509Certificate2>] [[-ExtensionId] <String>] [[-ThumbprintAlgorithm]
<String>] [-WorkgroupName] <String> [[-Restart]] [[-Credential] <PSCredential>] [[-Version] <String>] [-Profile <AzureSMProfile>] [-InformationAction
<ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]
New-AzureServiceADDomainExtensionConfig [[-Role] <String[]>] [-CertificateThumbprint] <String> [[-ExtensionId] <String>] [[-ThumbprintAlgorithm]
<String>] [-DomainName] <String> [[-Restart]] [[-Credential] <PSCredential>] [[-UnjoinDomainCredential] <PSCredential>] [[-Options] <JoinOptions>]
[[-OUPath] <String>] [[-Version] <String>] [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[<CommonParameters>]
New-AzureServiceADDomainExtensionConfig [[-Role] <String[]>] [-CertificateThumbprint] <String> [[-ExtensionId] <String>] [[-ThumbprintAlgorithm]
<String>] [-DomainName] <String> [[-Restart]] [[-Credential] <PSCredential>] [[-UnjoinDomainCredential] <PSCredential>] [-JoinOption] <UInt32>
[[-OUPath] <String>] [[-Version] <String>] [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>]
[<CommonParameters>]
New-AzureServiceADDomainExtensionConfig [[-Role] <String[]>] [-CertificateThumbprint] <String> [[-ExtensionId] <String>] [[-ThumbprintAlgorithm]
<String>] [-WorkgroupName] <String> [[-Restart]] [[-Credential] <PSCredential>] [[-Version] <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.
PARAMETERS
-Role <String[]>
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.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-X509Certificate <X509Certificate2>
Specifies an X.509 certificate that is automatically uploaded to the cloud service and used for encrypting the extension private configuration.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ThumbprintAlgorithm <String>
Specifies a thumbprint hashing algorithm that is used with the thumbprint to identify the certificate. This parameter is optional and the default is
sha1.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DomainName <String>
Specifies the AD domain name.
Required? true
Position? 3
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? 4
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Credential <PSCredential>
Specifies the credentials to use to join the AD domain. Credentials include a user name and password.
Required? false
Position? 5
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? 6
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Options <JoinOptions>
Specifies the unsigned integer join option.
Required? false
Position? 7
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OUPath <String>
Specifies the organization unit (OU) path for AD domain join operation.
Required? false
Position? 8
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Version <String>
Specifies the extension version.
Required? false
Position? 9
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ExtensionId <String>
Required? false
Position? 10
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? 7
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WorkgroupName <String>
Specifies the workgroup name.
Required? true
Position? 3
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? 1
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
-------------------------- 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.
RELATED LINKS
Get-AzureServiceADDomainExtension
Set-AzureServiceADDomainExtension