New-AzureServiceADDomainExtensionConfig

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

New-AzureServiceADDomainExtensionConfig

This cmdlet generates the configuration for AD Domain extension for cloud services.

Syntax

Parameter Set: JoinDomainUsingEnumOptions
New-AzureServiceADDomainExtensionConfig [[-Role] <String[]> ] [[-X509Certificate] <X509Certificate2> ] [[-ThumbprintAlgorithm] <String> ] [-DomainName] <String> [[-Restart]] [[-Credential] <PSCredential> ] [[-UnjoinDomainCredential] <PSCredential> ] [[-Options] <JoinOptions> ] [[-OUPath] <String> ] [[-Version] <String> ] [ <CommonParameters>]

Parameter Set: JoinDomainUsingEnumOptionsAndThumbprint
New-AzureServiceADDomainExtensionConfig [[-Role] <String[]> ] [-CertificateThumbprint] <String> [[-ThumbprintAlgorithm] <String> ] [-DomainName] <String> [[-Restart]] [[-Credential] <PSCredential> ] [[-UnjoinDomainCredential] <PSCredential> ] [[-Options] <JoinOptions> ] [[-OUPath] <String> ] [[-Version] <String> ] [ <CommonParameters>]

Parameter Set: JoinDomainUsingJoinOption
New-AzureServiceADDomainExtensionConfig [[-Role] <String[]> ] [[-X509Certificate] <X509Certificate2> ] [[-ThumbprintAlgorithm] <String> ] [-DomainName] <String> [[-Restart]] [[-Credential] <PSCredential> ] [[-UnjoinDomainCredential] <PSCredential> ] [-JoinOption] <UInt32> [[-OUPath] <String> ] [[-Version] <String> ] [ <CommonParameters>]

Parameter Set: JoinDomainUsingJoinOptionAndThumbprint
New-AzureServiceADDomainExtensionConfig [[-Role] <String[]> ] [-CertificateThumbprint] <String> [[-ThumbprintAlgorithm] <String> ] [-DomainName] <String> [[-Restart]] [[-Credential] <PSCredential> ] [[-UnjoinDomainCredential] <PSCredential> ] [-JoinOption] <UInt32> [[-OUPath] <String> ] [[-Version] <String> ] [ <CommonParameters>]

Parameter Set: WorkGroupName
New-AzureServiceADDomainExtensionConfig [[-Role] <String[]> ] [[-X509Certificate] <X509Certificate2> ] [[-ThumbprintAlgorithm] <String> ] [-WorkgroupName] <String> [[-Restart]] [[-Credential] <PSCredential> ] [ <CommonParameters>]

Parameter Set: WorkGroupNameThumbprint
New-AzureServiceADDomainExtensionConfig [[-Role] <String[]> ] [-CertificateThumbprint] <String> [[-ThumbprintAlgorithm] <String> ] [-WorkgroupName] <String> [[-Restart]] [[-Credential] <PSCredential> ] [ <CommonParameters>]

Detailed Description

This cmdlet generates the configuration for AD Domain extension for cloud services.

Parameters

-CertificateThumbprint<String>

A certificate thumbprint to use for encrypting the private configuration. If not specified a certificate will be created for you. This certificate has to already exist in the certificate store.

-Credential<PSCredential>

The credentials (user name/password) to join the AD domain.

-DomainName<String>

The AD domain name.

-JoinOption<UInt32>

The join option enumeration.

-Options<JoinOptions>

The unsigned integer join option.

-OUPath<String>

The OU path for AD domain join operation.

-Restart

Whether to restart the computer if the join operation succeeded.

-Role<String[]>

An optional array of roles to specify the remote desktop configuration for. If not specified the AD domain configuration is applied as the default configuration for all roles.

-ThumbprintAlgorithm<String>

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

-UnjoinDomainCredential<PSCredential>

The credentials (user name/password) to unjoin the AD domain.

-Version<String>

Specifies the version of the domain extension to set for the cloud service.

-WorkgroupName<String>

The workgroup name.

-X509Certificate<X509Certificate2>

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

C:\PS>$extensionCfg = New-AzureServiceADDomainExtensionConfig -Role WorkerRole1 -DomainName $domain -Credential $cred -JoinOption 35;

New-AzureDeployment -ServiceName $cloudSvc -Slot Production -Package $pkg -Configuration $config -ExtensionConfiguration $extensionCfg;