Share via

Extension interface

Package:
@azure/arm-kubernetesconfiguration

The Extension object.

Extends
ProxyResource

Properties

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.
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. NOTE: This property will not be serialized. It can only be populated by the server.
customLocationSettings

Custom Location settings properties. NOTE: This property will not be serialized. It can only be populated by the server.
errorInfo

Error information from the Agent - e.g. errors during installation. NOTE: This property will not be serialized. It can only be populated by the server.
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 NOTE: This property will not be serialized. It can only be populated by the server.
packageUri

Uri of the Helm package NOTE: This property will not be serialized. It can only be populated by the server.
plan

The plan information.
provisioningState

Status of installation of this extension. NOTE: This property will not be serialized. It can only be populated by the server.
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.
systemData

Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources NOTE: This property will not be serialized. It can only be populated by the server.
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} 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

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

configurationProtectedSettings

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

configurationProtectedSettings?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

configurationSettings

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

configurationSettings?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

currentVersion

Currently installed version of the extension. NOTE: This property will not be serialized. It can only be populated by the server.

currentVersion?: string

Property Value

string

customLocationSettings

Custom Location settings properties. NOTE: This property will not be serialized. It can only be populated by the server.

customLocationSettings?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

errorInfo

Error information from the Agent - e.g. errors during installation. NOTE: This property will not be serialized. It can only be populated by the server.

errorInfo?: ErrorDetail

Property Value

ErrorDetail

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 NOTE: This property will not be serialized. It can only be populated by the server.

isSystemExtension?: boolean

Property Value

boolean

packageUri

Uri of the Helm package NOTE: This property will not be serialized. It can only be populated by the server.

packageUri?: string

Property Value

string

plan

The plan information.

plan?: Plan

Property Value

Plan

provisioningState

Status of installation of this extension. NOTE: This property will not be serialized. It can only be populated by the server.

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[]

systemData

Top level metadata https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

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} 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