Extension interface

Package:

@azure/arm-azurestackhci

Details of a particular extension in HCI Cluster.

Extends

ProxyResource

Properties

aggregateState	Aggregate state of Arc Extensions across the nodes in this HCI cluster. NOTE: This property will not be serialized. It can only be populated by the server.
autoUpgradeMinorVersion	Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
enableAutomaticUpgrade	Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
forceUpdateTag	How the extension handler should be forced to update even if the extension configuration has not changed.
managedBy	Indicates if the extension is managed by azure or the user. NOTE: This property will not be serialized. It can only be populated by the server.
perNodeExtensionDetails	State of Arc Extension in each of the nodes. NOTE: This property will not be serialized. It can only be populated by the server.
protectedSettings	Protected settings (may contain secrets).
provisioningState	Provisioning state of the Extension proxy resource. NOTE: This property will not be serialized. It can only be populated by the server.
publisher	The name of the extension handler publisher.
settings	Json formatted public settings for the extension.
typeHandlerVersion	Specifies the version of the script handler. Latest version would be used if not specified.
typePropertiesExtensionParametersType	Specifies the type of the extension; an example is "CustomScriptExtension".

Inherited Properties

id	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

aggregateState

Aggregate state of Arc Extensions across the nodes in this HCI cluster. NOTE: This property will not be serialized. It can only be populated by the server.

aggregateState?: string

Property Value

string

autoUpgradeMinorVersion

Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

autoUpgradeMinorVersion?: boolean

Property Value

boolean

enableAutomaticUpgrade

Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.

enableAutomaticUpgrade?: boolean

Property Value

boolean

forceUpdateTag

How the extension handler should be forced to update even if the extension configuration has not changed.

forceUpdateTag?: string

Property Value

string

managedBy

Indicates if the extension is managed by azure or the user. NOTE: This property will not be serialized. It can only be populated by the server.

managedBy?: string

Property Value

string

perNodeExtensionDetails

State of Arc Extension in each of the nodes. NOTE: This property will not be serialized. It can only be populated by the server.

perNodeExtensionDetails?: PerNodeExtensionState[]

Property Value

PerNodeExtensionState[]

protectedSettings

Protected settings (may contain secrets).

protectedSettings?: Record<string, unknown>

Property Value

Record<string, unknown>

provisioningState

Provisioning state of the Extension proxy resource. 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

settings

Json formatted public settings for the extension.

settings?: Record<string, unknown>

Property Value

Record<string, unknown>

typeHandlerVersion

Specifies the version of the script handler. Latest version would be used if not specified.

typeHandlerVersion?: string

Property Value

string

typePropertiesExtensionParametersType

Specifies the type of the extension; an example is "CustomScriptExtension".

typePropertiesExtensionParametersType?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type