Set-AzureServiceExtension

Module:

Azure Module

Adds a cloud service extension to 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.

Important

Cloud Services (classic) is now deprecated for new customers and will be retired on August 31st, 2024 for all customers. New deployments should use the new Azure Resource Manager based deployment model Azure Cloud Services (extended support).

Syntax

SetExtension (Default)

Set-AzureServiceExtension
    [[-ServiceName] <String>]
    [[-Slot] <String>]
    [[-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>]

SetExtensionUsingThumbprint

Set-AzureServiceExtension
    [[-ServiceName] <String>]
    [[-Slot] <String>]
    [[-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>]

Description

The Set-AzureServiceExtension cmdlet adds a cloud service extension to a deployment.

Examples

Example 1: Add a cloud service to a deployment

PS C:\> Set-AzureServiceExtension -Service $Svc -Slot "Production" -ExtensionName "RDP" -Version "1.0" -ProviderNamespace "Microsoft.Windows.Azure.Extensions" -PublicConfiguration $P1 -PrivateConfiguration $P2;

This command adds a cloud service to a deployment.

Example 2: Add a cloud service to a deployment for a specified role

PS C:\> Set-AzureServiceExtension -Service $Svc -Slot "Production" -Role "WebRole1" -ExtensionName "RDP" -ProviderNamespace "Microsoft.Windows.Azure.Extensions" -PublicConfiguration $P1 -PrivateConfiguration $P2;

This command adds a cloud service to a deployment for a specified role.

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

SetExtensionUsingThumbprint

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

-ExtensionName

Specifies the extension name.

Parameter properties

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

Parameter sets

(All)

Position:	5
Mandatory:	True
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

-PrivateConfiguration

Specifies the private configuration text.

Parameter properties

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

Parameter sets

(All)

Position:	8
Mandatory:	True
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

-ProviderNamespace

Specifies the extension provider namespace.

Parameter properties

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

Parameter sets

(All)

Position:	6
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-PublicConfiguration

Specifies the public configuration text.

Parameter properties

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

Parameter sets

(All)

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

-Role

Specifies an optional array of roles for which to specify the remote desktop configuration. If this parameter is not specified the remote desktop 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:	2
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ServiceName

Specifies the Azure service name of the deployment.

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

-Slot

Specifies the environment of the deployment to modify. Valid values are: Production or Staging.

Parameter properties

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

Parameter sets

(All)

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

-ThumbprintAlgorithm

Specifies the thumbprint hashing algorithm which 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:	4
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:	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

SetExtension

Position:	3
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.

Related Links

• Get-AzureServiceExtension
• Remove-AzureServiceExtension