Set-AzureServiceExtension

NAME Set-AzureServiceExtension



SYNOPSIS

Adds a cloud service extension to a deployment.





SYNTAX

Set-AzureServiceExtension [[-ServiceName] <String>] [[-Slot] <String>] [[-ExtensionId] <String>] [[-Role] <String[]>] [[-X509Certificate]

<X509Certificate2>] [[-ThumbprintAlgorithm] <String>] [-ExtensionName] <String> [-ProviderNamespace] <String> [-PublicConfiguration] <String>

[-PrivateConfiguration] <String> [-Version] <String> [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>]

[<CommonParameters>]



Set-AzureServiceExtension [[-ServiceName] <String>] [[-Slot] <String>] [[-ExtensionId] <String>] [[-Role] <String[]>] [-CertificateThumbprint] <String>

[[-ThumbprintAlgorithm] <String>] [-ExtensionName] <String> [-ProviderNamespace] <String> [-PublicConfiguration] <String> [-PrivateConfiguration]

<String> [-Version] <String> [-Profile <AzureSMProfile>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-ServiceName <String>

Specifies the Azure service name of the deployment.



Required? false

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Slot <String>

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



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Role <String[]>

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.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-X509Certificate <X509Certificate2>

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



Required? false

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ThumbprintAlgorithm <String>

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

is sha1.



Required? false

Position? 4

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ExtensionName <String>

Specifies the extension name.



Required? true

Position? 5

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ProviderNamespace <String>

Specifies the extension provider namespace.



Required? true

Position? 6

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PublicConfiguration <String>

Specifies the public configuration text.



Required? true

Position? 7

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PrivateConfiguration <String>

Specifies the private configuration text.



Required? true

Position? 8

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Version <String>

Specifies the extension version.



Required? true

Position? 9

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ExtensionId <String>





Required? false

Position? 10

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Profile <AzureSMProfile>

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationAction <ActionPreference>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationVariable <String>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-CertificateThumbprint <String>

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.



Required? true

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES









-------------------------- 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.



RELATED LINKS

Get-AzureServiceExtension

Remove-AzureServiceExtension