@azure/arm-kubernetesconfiguration-extensions package

Interfaces

AccessDetail

Metadata about the access details of the managing entity of the extension

AdditionalDetails

Additional details provided by the publisher of the extension.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

Extension

The Extension object.

ExtensionProperties

Properties of an Extension resource

ExtensionPropertiesAksAssignedIdentity

Identity of the Extension resource in an AKS cluster

ExtensionStatus

Status from the extension.

ExtensionsClientOptionalParams

Optional parameters for the client.

ExtensionsCreateOptionalParams

Optional parameters.

ExtensionsDeleteOptionalParams

Optional parameters.

ExtensionsGetOptionalParams

Optional parameters.

ExtensionsListOptionalParams

Optional parameters.

ExtensionsOperations

Interface representing a Extensions operations.

ExtensionsUpdateOptionalParams

Optional parameters.

Identity

Identity for the resource.

ManagementDetails

Metadata about the managing entity of the extension and the permitted operations.

OperationStatusGetOptionalParams

Optional parameters.

OperationStatusOperations

Interface representing a OperationStatus operations.

OperationStatusResult

The current status of an async operation.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

PatchExtension

The Extension Patch Request object.

PatchExtensionProperties

Updatable properties of an Extension Patch Request

Plan

Plan for the resource.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

RestorePollerOptions
Scope

Scope of the extension. It can be either Cluster or Namespace; but not both.

ScopeCluster

Specifies that the scope of the extension is Cluster

ScopeNamespace

Specifies that the scope of the extension is Namespace

SimplePollerLike

A simple poller that can be used to poll a long running operation.

SystemData

Metadata pertaining to creation and last modification of the resource.

Type Aliases

AKSIdentityType

The identity type.
KnownAKSIdentityType can be used interchangeably with AKSIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssigned: SystemAssigned identity
UserAssigned: UserAssigned identity
Workload: Workload identity

AutoUpgradeMode

The upgrade mode for auto upgrade. The default is "compatible".
KnownAutoUpgradeMode can be used interchangeably with AutoUpgradeMode, this enum contains the known values that the service supports.

Known values supported by the service

none: The extension will not be automatically upgraded.
patch: The extension will be automatically upgraded to the latest patch version within the minor version.
compatible: The extension will be automatically upgraded to compatible versions as determined by the user.

AzureSupportedClouds

The supported values for cloud setting as a string literal type

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

LevelType

Level of the status.
KnownLevelType can be used interchangeably with LevelType, this enum contains the known values that the service supports.

Known values supported by the service

Error: Indicates an error status from the extension.
Warning: Indicates a warning status from the extension.
Information: Indicates an informational status from the extension.

ProvisioningState

The provisioning state of the resource.
KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Resource has been created.
Failed: Resource creation failed.
Canceled: Resource creation was canceled.
Creating: Resource is being created.
Updating: Resource is being updated.
Deleting: Resource is being deleted.

ResourceIdentityType

Type of ResourceIdentityType

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownAKSIdentityType

The identity type.

KnownAutoUpgradeMode

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

KnownCreatedByType

The kind of entity that created the resource.

KnownLevelType

Level of the status.

KnownProvisioningState

The provisioning state of the resource.

KnownVersions

The available API versions.

Functions

restorePoller<TResponse, TResult>(ExtensionsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(ExtensionsClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: ExtensionsClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>