Share via


CloudServiceExtensionProperties Class

Definition

Extension Properties.

public class CloudServiceExtensionProperties
type CloudServiceExtensionProperties = class
Public Class CloudServiceExtensionProperties
Inheritance
CloudServiceExtensionProperties

Constructors

CloudServiceExtensionProperties()

Initializes a new instance of the CloudServiceExtensionProperties class.

CloudServiceExtensionProperties(String, String, String, Nullable<Boolean>, Object, Object, CloudServiceVaultAndSecretReference, String, String, IList<String>)

Initializes a new instance of the CloudServiceExtensionProperties class.

Properties

AutoUpgradeMinorVersion

Gets or sets explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.

ForceUpdateTag

Gets or sets tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not

ProtectedSettings

Gets or sets protected settings for the extension which are encrypted before sent to the role instance.

ProtectedSettingsFromKeyVault
ProvisioningState

Gets the provisioning state, which only appears in the response.

Publisher

Gets or sets the name of the extension handler publisher.

RolesAppliedTo

Gets or sets optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service.

Settings

Gets or sets public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension.

Type

Gets or sets specifies the type of the extension.

TypeHandlerVersion

Gets or sets specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance.

Applies to