Edit

Share via

New-AzureServiceExtensionConfig

  • Reference
Module:
Azure

Creates a cloud service extension configuration for a deployment.

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-AzureServiceExtensionConfig
   [[-Role] <String[]>]
   [[-X509Certificate] <X509Certificate2>]
   [[-ThumbprintAlgorithm] <String>]
   [-ExtensionName] <String>
   [-ProviderNamespace] <String>
   [-PublicConfiguration] <String>
   [-PrivateConfiguration] <String>
   [-Version] <String>
   [[-ExtensionId] <String>]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]
New-AzureServiceExtensionConfig
   [[-Role] <String[]>]
   [-CertificateThumbprint] <String>
   [[-ThumbprintAlgorithm] <String>]
   [-ExtensionName] <String>
   [-ProviderNamespace] <String>
   [-PublicConfiguration] <String>
   [-PrivateConfiguration] <String>
   [-Version] <String>
   [[-ExtensionId] <String>]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]
New-AzureServiceExtensionConfig
   [[-Role] <String[]>]
   [-ExtensionId] <String>
   [-ExtensionState] <String>
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Description

The New-AzureServiceExtensionConfig cmdlet creates a cloud service extension configuration for a deployment.

Examples

Example 1: Create an extension configuration

PS C:\> New-AzureServiceExtensionConfig -ExtensionName 'RDP' -Version '1.0' -ProviderNamespace Microsoft.Windows.Azure.Extensions -PublicConfiguration $p1 -PrivateConfiguration $p2;

This command specifies an extension configuration.

Example 2: Create an extension configuration for a role

PS C:\> New-AzureServiceExtensionConfig -Role WebRole1 -ExtensionName 'RDP' -ProviderNamespace Microsoft.Windows.Azure.Extensions -PublicConfiguration $p1 -PrivateConfiguration $p2;

This command specifies an extension configuration for the role WebRole1.

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

-ExtensionId

Specifies the name of the extension.

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

-ExtensionName

Specifies the name of the extension.

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

-ExtensionState

Specifies the state of the extension. The acceptable values for this parameter are:

  • Enable
  • Disable
  • Uninstall
Type:String
Position:2
Default value:None
Required:True
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

-PrivateConfiguration

Specifies the private configuration text.

Type:String
Position:6
Default value:None
Required:True
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

-ProviderNamespace

Specifies the Extension's Provider Namespace.

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

-PublicConfiguration

Specifies the public configuration text.

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

-Role

Specifies an optional array of roles to specify the remote desktop configuration for. If not specified the remote desktop 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 which 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

-Version

Specifies the extension version.

Type:String
Position:7
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:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False