CloudServiceExtensionProperties interface

Package:

@azure/arm-compute

Extension Properties.

Properties

autoUpgradeMinorVersion	Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.
forceUpdateTag	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	Protected settings for the extension which are encrypted before sent to the role instance.
protectedSettingsFromKeyVault	Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.
provisioningState	The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.
publisher	The name of the extension handler publisher.
rolesAppliedTo	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	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	Specifies the type of the extension.
typeHandlerVersion	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.

Property Details

autoUpgradeMinorVersion

Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.

autoUpgradeMinorVersion?: boolean

Property Value

boolean

forceUpdateTag

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

forceUpdateTag?: string

Property Value

string

protectedSettings

Protected settings for the extension which are encrypted before sent to the role instance.

protectedSettings?: any

Property Value

any

protectedSettingsFromKeyVault

Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.

protectedSettingsFromKeyVault?: CloudServiceVaultAndSecretReference

Property Value

CloudServiceVaultAndSecretReference

provisioningState

The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publisher

The name of the extension handler publisher.

publisher?: string

Property Value

string

rolesAppliedTo

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.

rolesAppliedTo?: string[]

Property Value

string[]

settings

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.

settings?: any

Property Value

any

type

Specifies the type of the extension.

type?: string

Property Value

string

typeHandlerVersion

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.

typeHandlerVersion?: string

Property Value

string