Edit

Share via


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

JoinDomainUsingEnumOptions (Default)

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

JoinDomainUsingJoinOption

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

WorkGroupName

New-AzureServiceADDomainExtensionConfig
    [[-Role] <String[]>]
    [[-X509Certificate] <X509Certificate2>]
    [[-ThumbprintAlgorithm] <String>]
    [-WorkgroupName] <String>
    [[-Credential] <PSCredential>]
    [[-Version] <String>]
    [[-ExtensionId] <String>]
    [-Restart]
    [-Profile <AzureSMProfile>]
    [-InformationAction <ActionPreference>]
    [-InformationVariable <String>]
    [<CommonParameters>]

JoinDomainUsingEnumOptionsAndThumbprint

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

JoinDomainUsingJoinOptionAndThumbprint

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

WorkGroupNameThumbprint

New-AzureServiceADDomainExtensionConfig
    [[-Role] <String[]>]
    [-CertificateThumbprint] <String>
    [[-ThumbprintAlgorithm] <String>]
    [-WorkgroupName] <String>
    [[-Credential] <PSCredential>]
    [[-Version] <String>]
    [[-ExtensionId] <String>]
    [-Restart]
    [-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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

JoinDomainUsingEnumOptionsAndThumbprint
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
JoinDomainUsingJoinOptionAndThumbprint
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
WorkGroupNameThumbprint
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Credential

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

Parameter properties

Type:PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:5
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DomainName

Specifies the AD domain name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

JoinDomainUsingEnumOptions
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
JoinDomainUsingJoinOption
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
JoinDomainUsingEnumOptionsAndThumbprint
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
JoinDomainUsingJoinOptionAndThumbprint
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ExtensionId

Specifies the extension ID.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:10
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

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

Parameter properties

Type:ActionPreference
Default value:None
Supports wildcards:False
DontShow:False
Aliases:infa

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InformationVariable

Specifies an information variable.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:iv

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-JoinOption

Specifies the join option enumeration.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

JoinDomainUsingJoinOption
Position:7
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
JoinDomainUsingJoinOptionAndThumbprint
Position:7
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Options

Specifies the unsigned integer join option.

Parameter properties

Type:JoinOptions
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

JoinDomainUsingEnumOptions
Position:7
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
JoinDomainUsingEnumOptionsAndThumbprint
Position:7
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-OUPath

Specifies the organization unit (OU) path for AD domain join operation.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

JoinDomainUsingEnumOptions
Position:8
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
JoinDomainUsingJoinOption
Position:8
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
JoinDomainUsingEnumOptionsAndThumbprint
Position:8
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
JoinDomainUsingJoinOptionAndThumbprint
Position:8
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:AzureSMProfile
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Restart

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:4
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-UnjoinDomainCredential

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

Parameter properties

Type:PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

JoinDomainUsingEnumOptions
Position:6
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
JoinDomainUsingJoinOption
Position:6
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
JoinDomainUsingEnumOptionsAndThumbprint
Position:6
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
JoinDomainUsingJoinOptionAndThumbprint
Position:6
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Version

Specifies the extension version.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:9
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-WorkgroupName

Specifies the workgroup name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

WorkGroupName
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
WorkGroupNameThumbprint
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-X509Certificate

Specifies an X.509 certificate that is automatically uploaded to the cloud service and used for encrypting the extension private configuration.

Parameter properties

Type:X509Certificate2
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

JoinDomainUsingEnumOptions
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
JoinDomainUsingJoinOption
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
WorkGroupName
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.