Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CloudServiceExtensionProperties

Package version

Extension Properties.

Hierarchy

  • CloudServiceExtensionProperties

Index

Properties

Optional autoUpgradeMinorVersion

autoUpgradeMinorVersion: undefined | false | true

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

Optional forceUpdateTag

forceUpdateTag: undefined | string

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

Optional protectedSettings

protectedSettings: undefined | string

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

Optional protectedSettingsFromKeyVault

protectedSettingsFromKeyVault: CloudServiceVaultAndSecretReference

Optional provisioningState

provisioningState: undefined | string

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

Optional publisher

publisher: undefined | string

The name of the extension handler publisher.

Optional rolesAppliedTo

rolesAppliedTo: string[]

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.

Optional settings

settings: undefined | string

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.

Optional type

type: undefined | string

Specifies the type of the extension.

Optional typeHandlerVersion

typeHandlerVersion: undefined | string

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.

Generated using TypeDoc