Share via


Extension Class

Definition

Describes a cloud service Extension.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ExtensionTypeConverter))]
public class Extension : Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.IExtension
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.ExtensionTypeConverter))>]
type Extension = class
    interface IExtension
    interface IJsonSerializable
Public Class Extension
Implements IExtension
Inheritance
Extension
Attributes
Implements

Constructors

Extension()

Creates an new Extension instance.

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

Name

The name of the extension.

ProtectedSetting

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

ProtectedSettingFromKeyVaultSecretUrl

Secret URL which contains the protected settings of the extension

ProvisioningState

The provisioning state, which only appears in the response.

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.

Setting

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.

SourceVaultId

Resource Id

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.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of Extension.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of Extension.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.CloudService.Models.Api20220904.IExtension.

FromJsonString(String)

Creates a new instance of Extension, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of Extension into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Applies to