Extension interface

Package:
@azure/arm-kubernetesconfiguration-extensions

The Extension object.

Extends
ProxyResource

Properties

additionalDetails

Additional details provided by the publisher of the extension.
aksAssignedIdentity

Identity of the Extension resource in an AKS cluster
autoUpgradeMinorVersion

Flag to note if this extension participates in auto upgrade of minor version, or not.
autoUpgradeMode

The upgrade mode for auto upgrade. The default is "compatible".
configurationProtectedSettings

Configuration settings that are sensitive, as name-value pairs for configuring this extension.
configurationSettings

Configuration settings, as name-value pairs for configuring this extension.
currentVersion

Currently installed version of the extension.
customLocationSettings

Custom Location settings properties.
errorInfo

Error information from the Agent - e.g. errors during installation.
extensionState

State of the extension on the cluster.
extensionType

Type of the Extension, of which this resource is an instance of. It must be one of the Extension Types registered with Microsoft.KubernetesConfiguration by the Extension publisher.
identity

Identity of the Extension resource
isSystemExtension

Flag to note if this extension is a system extension
managedBy

The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
managementDetails

Management details of the extension
packageUri

Uri of the Helm package
plan

Details of the resource plan.
provisioningState

Status of installation of this extension.
releaseTrain

ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'.
scope

Scope at which the extension is installed.
statuses

Status from this extension.
version

User-specified version of the extension for this extension to 'pin'. To use 'version', autoUpgradeMinorVersion must be 'false'.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

additionalDetails

Additional details provided by the publisher of the extension.

additionalDetails?: AdditionalDetails

Property Value

AdditionalDetails

aksAssignedIdentity

Identity of the Extension resource in an AKS cluster

aksAssignedIdentity?: ExtensionPropertiesAksAssignedIdentity

Property Value

ExtensionPropertiesAksAssignedIdentity

autoUpgradeMinorVersion

Flag to note if this extension participates in auto upgrade of minor version, or not.

autoUpgradeMinorVersion?: boolean

Property Value

boolean

autoUpgradeMode

The upgrade mode for auto upgrade. The default is "compatible".

autoUpgradeMode?: string

Property Value

string

configurationProtectedSettings

Configuration settings that are sensitive, as name-value pairs for configuring this extension.

configurationProtectedSettings?: Record<string, string>

Property Value

Record<string, string>

configurationSettings

Configuration settings, as name-value pairs for configuring this extension.

configurationSettings?: Record<string, string>

Property Value

Record<string, string>

currentVersion

Currently installed version of the extension.

currentVersion?: string

Property Value

string

customLocationSettings

Custom Location settings properties.

customLocationSettings?: Record<string, string>

Property Value

Record<string, string>

errorInfo

Error information from the Agent - e.g. errors during installation.

errorInfo?: ErrorDetail

Property Value

ErrorDetail

extensionState

State of the extension on the cluster.

extensionState?: string

Property Value

string

extensionType

Type of the Extension, of which this resource is an instance of. It must be one of the Extension Types registered with Microsoft.KubernetesConfiguration by the Extension publisher.

extensionType?: string

Property Value

string

identity

Identity of the Extension resource

identity?: Identity

Property Value

Identity

isSystemExtension

Flag to note if this extension is a system extension

isSystemExtension?: boolean

Property Value

boolean

managedBy

The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

managedBy?: string

Property Value

string

managementDetails

Management details of the extension

managementDetails?: ManagementDetails

Property Value

ManagementDetails

packageUri

Uri of the Helm package

packageUri?: string

Property Value

string

plan

Details of the resource plan.

plan?: Plan

Property Value

Plan

provisioningState

Status of installation of this extension.

provisioningState?: string

Property Value

string

releaseTrain

ReleaseTrain this extension participates in for auto-upgrade (e.g. Stable, Preview, etc.) - only if autoUpgradeMinorVersion is 'true'.

releaseTrain?: string

Property Value

string

scope

Scope at which the extension is installed.

scope?: Scope

Property Value

Scope

statuses

Status from this extension.

statuses?: ExtensionStatus[]

Property Value

ExtensionStatus[]

version

User-specified version of the extension for this extension to 'pin'. To use 'version', autoUpgradeMinorVersion must be 'false'.

version?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type