Set-AzureServiceExtension

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

Set-AzureServiceExtension

This cmdlet adds a cloud service extension to a deployment.

Syntax

Parameter Set: SetExtension
Set-AzureServiceExtension [[-ServiceName] <String> ] [[-Slot] <String> ] [[-Role] <String[]> ] [[-X509Certificate] <X509Certificate2> ] [[-ThumbprintAlgorithm] <String> ] [-ExtensionName] <String> [-ProviderNamespace] <String> [-PublicConfiguration] <String> [-PrivateConfiguration] <String> [-Version] <String> [ <CommonParameters>]

Parameter Set: SetExtensionUsingThumbprint
Set-AzureServiceExtension [[-ServiceName] <String> ] [[-Slot] <String> ] [[-Role] <String[]> ] [-CertificateThumbprint] <String> [[-ThumbprintAlgorithm] <String> ] [-ExtensionName] <String> [-ProviderNamespace] <String> [-PublicConfiguration] <String> [-PrivateConfiguration] <String> [-Version] <String> [ <CommonParameters>]

Detailed Description

This cmdlet adds a cloud service extension to a deployment.

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.

-ExtensionName<String>

-PrivateConfiguration<String>

The private configuration text.

-ProviderNamespace<String>

The Extension's Provider Namespace.

-PublicConfiguration<String>

The public configuration text.

-Role<String[]>

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.

-ServiceName<String>

Specifies the Microsoft Azure service name of the deployment.

-Slot<String>

Specifies the environment of the deployment to modify. Supported values are "Production" or "Staging".

-ThumbprintAlgorithm<String>

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

-Version<String>

The Extension Version.

-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

-----------

Set the Remote Desktop Extension in version 1.0 for all roles in the cloud service.

C:\PS>Set-AzureServiceExtension -Service $svc -Slot Production -ExtensionName 'RDP' -Version '1.0' -ProviderNamespace Microsoft.Windows.Azure.Extensions -PublicConfiguration $p1 -PrivateConfiguration $p2;

-------------------------- EXAMPLE 2 --------------------------

Description

-----------

Set the Remote Desktop Extension for the 'WebRole1' role in the cloud service.

C:\PS>Set-AzureServiceExtension -Service $svc -Slot Production -Role WebRole1 -ExtensionName 'RDP' -ProviderNamespace Microsoft.Windows.Azure.Extensions -PublicConfiguration $p1 -PrivateConfiguration $p2;