Share via

Extension interface

  • Reference
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.
createdAt

The timestamp of resource creation (UTC).
createdBy

The identity that created the resource.
createdByType

The type of identity that created the resource.
forceUpdateTag

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

The timestamp of resource last modification (UTC)
lastModifiedBy

The identity that last modified the resource.
lastModifiedByType

The type of identity that last modified the resource.
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.
typePropertiesExtensionParametersType

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

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /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.
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

createdAt

The timestamp of resource creation (UTC).

createdAt?: Date

Property Value

Date

createdBy

The identity that created the resource.

createdBy?: string

Property Value

string

createdByType

The type of identity that created the resource.

createdByType?: string

Property Value

string

forceUpdateTag

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

forceUpdateTag?: string

Property Value

string

lastModifiedAt

The timestamp of resource last modification (UTC)

lastModifiedAt?: Date

Property Value

Date

lastModifiedBy

The identity that last modified the resource.

lastModifiedBy?: string

Property Value

string

lastModifiedByType

The type of identity that last modified the resource.

lastModifiedByType?: 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.

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. Ex - /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

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