Package version:

Interface Extension

The Extension object.

interface Extension {
    aksAssignedIdentity?: ExtensionPropertiesAksAssignedIdentity;
    autoUpgradeMinorVersion?: boolean;
    configurationProtectedSettings?: {
        [propertyName: string]: string;
    };
    configurationSettings?: {
        [propertyName: string]: string;
    };
    currentVersion?: string;
    customLocationSettings?: {
        [propertyName: string]: string;
    };
    errorInfo?: ErrorDetail;
    extensionType?: string;
    id?: string;
    identity?: Identity;
    isSystemExtension?: boolean;
    name?: string;
    packageUri?: string;
    plan?: Plan;
    provisioningState?: string;
    releaseTrain?: string;
    scope?: Scope;
    statuses?: ExtensionStatus[];
    systemData?: SystemData;
    type?: string;
    version?: string;
}

Hierarchy (view full)

Properties

aksAssignedIdentity? autoUpgradeMinorVersion? configurationProtectedSettings? configurationSettings? currentVersion? customLocationSettings? errorInfo? extensionType? id? identity? isSystemExtension? name? packageUri? plan? provisioningState? releaseTrain? scope? statuses? systemData? type? version?

Properties

OptionalaksAssignedIdentity

aksAssignedIdentity?: ExtensionPropertiesAksAssignedIdentity

Identity of the Extension resource in an AKS cluster

OptionalautoUpgradeMinorVersion

autoUpgradeMinorVersion?: boolean

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

OptionalconfigurationProtectedSettings

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

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

OptionalconfigurationSettings

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

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

Optional ReadonlycurrentVersion

currentVersion?: string

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

Optional ReadonlycustomLocationSettings

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

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

Optional ReadonlyerrorInfo

errorInfo?: ErrorDetail

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.

OptionalextensionType

extensionType?: string

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.

Optional Readonlyid

id?: string

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.

Optionalidentity

identity?: Identity

Identity of the Extension resource

Optional ReadonlyisSystemExtension

isSystemExtension?: boolean

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.

Optional Readonlyname

name?: string

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

Optional ReadonlypackageUri

packageUri?: string

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

Optionalplan

plan?: Plan

The plan information.

Optional ReadonlyprovisioningState

provisioningState?: string

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

OptionalreleaseTrain

releaseTrain?: string

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

Optionalscope

scope?: Scope

Scope at which the extension is installed.

Optionalstatuses

statuses?: ExtensionStatus[]

Status from this extension.

Optional ReadonlysystemData

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

Optional Readonlytype

type?: string

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.

Optionalversion

version?: string

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

Settings

Member Visibility