ExtensionProperties interface
Status of Arc Extension for a particular node in HCI Cluster.
Properties
| aggregate |
Aggregate state of Arc Extensions across the nodes in this HCI cluster. This reflects the overall status of the extension deployment and operation across all nodes. |
| auto |
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. |
| enable |
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. |
| force |
How the extension handler should be forced to update even if the extension configuration has not changed. |
| managed |
Indicates if the extension is managed by Azure or the user. This determines who controls the deployment and lifecycle of the extension. |
| per |
State of Arc Extension in each of the nodes. |
| protected |
Protected settings (may contain secrets). |
| provisioning |
Provisioning state of the Extension proxy resource. Indicates the current lifecycle status of the resource, such as whether it's being created, updated, deleted, or has encountered an error. |
| publisher | The name of the extension handler publisher. |
| settings | Json formatted public settings for the extension. |
| type | Specifies the type of the extension; an example is "CustomScriptExtension". |
| type |
Specifies the version of the script handler. Latest version would be used if not specified. |
Property Details
aggregateState
Aggregate state of Arc Extensions across the nodes in this HCI cluster. This reflects the overall status of the extension deployment and operation across all nodes.
aggregateState?: stringProperty 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?: booleanProperty Value
boolean
enableAutomaticUpgrade
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
enableAutomaticUpgrade?: booleanProperty Value
boolean
forceUpdateTag
How the extension handler should be forced to update even if the extension configuration has not changed.
forceUpdateTag?: stringProperty Value
string
managedBy
Indicates if the extension is managed by Azure or the user. This determines who controls the deployment and lifecycle of the extension.
managedBy?: stringProperty Value
string
perNodeExtensionDetails
State of Arc Extension in each of the nodes.
perNodeExtensionDetails?: PerNodeExtensionState[]Property Value
protectedSettings
Protected settings (may contain secrets).
protectedSettings?: anyProperty Value
any
provisioningState
Provisioning state of the Extension proxy resource. Indicates the current lifecycle status of the resource, such as whether it's being created, updated, deleted, or has encountered an error.
provisioningState?: stringProperty Value
string
publisher
The name of the extension handler publisher.
publisher?: stringProperty Value
string
settings
Json formatted public settings for the extension.
settings?: anyProperty Value
any
type
Specifies the type of the extension; an example is "CustomScriptExtension".
type?: stringProperty Value
string
typeHandlerVersion
Specifies the version of the script handler. Latest version would be used if not specified.
typeHandlerVersion?: stringProperty Value
string