@azure/arm-containerorchestratorruntime package

Classes

KubernetesRuntimeClient

Interfaces

BgpPeer

A BgpPeer resource for an Arc connected cluster (Microsoft.Kubernetes/connectedClusters)

BgpPeerProperties

Details of the BgpPeer.

BgpPeersCreateOrUpdateOptionalParams

Optional parameters.

BgpPeersDeleteOptionalParams

Optional parameters.

BgpPeersGetOptionalParams

Optional parameters.

BgpPeersListOptionalParams

Optional parameters.

BgpPeersOperations

Interface representing a BgpPeers operations.

BlobStorageClassTypeProperties

The properties of Blob StorageClass

ExtensionResource

The base extension resource.

KubernetesRuntimeClientOptionalParams

Optional parameters for the client.

LoadBalancer

A LoadBalancer resource for an Arc connected cluster (Microsoft.Kubernetes/connectedClusters)

LoadBalancerProperties

Details of the LoadBalancer.

LoadBalancersCreateOrUpdateOptionalParams

Optional parameters.

LoadBalancersDeleteOptionalParams

Optional parameters.

LoadBalancersGetOptionalParams

Optional parameters.

LoadBalancersListOptionalParams

Optional parameters.

LoadBalancersOperations

Interface representing a LoadBalancers operations.

NativeStorageClassTypeProperties

The properties of Native StorageClass

NfsStorageClassTypeProperties

The properties of NFS StorageClass

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for and operation.

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

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

Resource

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

RestorePollerOptions
RwxStorageClassTypeProperties

The properties of RWX StorageClass

ServiceProperties

Properties for the service resource

ServiceResource

A Service resource for an Arc connected cluster (Microsoft.Kubernetes/connectedClusters)

ServicesCreateOrUpdateOptionalParams

Optional parameters.

ServicesDeleteOptionalParams

Optional parameters.

ServicesGetOptionalParams

Optional parameters.

ServicesListOptionalParams

Optional parameters.

ServicesOperations

Interface representing a Services operations.

SmbStorageClassTypeProperties

The properties of SMB StorageClass

StorageClassCreateOrUpdateOptionalParams

Optional parameters.

StorageClassDeleteOptionalParams

Optional parameters.

StorageClassGetOptionalParams

Optional parameters.

StorageClassListOptionalParams

Optional parameters.

StorageClassOperations

Interface representing a StorageClass operations.

StorageClassProperties

Details of the StorageClass StorageClass.

StorageClassPropertiesUpdate

The model for updating storageClass properties

StorageClassResource

A StorageClass resource for an Arc connected cluster (Microsoft.Kubernetes/connectedClusters)

StorageClassResourceUpdate

The model for updating a storageClass

StorageClassTypeProperties

The properties of storage class of the StorageClass

StorageClassTypePropertiesUpdate

The model for update a storageClass

StorageClassUpdateOptionalParams

Optional parameters.

SystemData

Metadata pertaining to creation and last modification of the resource.

Type Aliases

AccessMode

Storage Class Access Mode
KnownAccessMode can be used interchangeably with AccessMode, this enum contains the known values that the service supports.

Known values supported by the service

ReadWriteOnce: Read Write Once (RWO) access mode
ReadWriteMany: Read Write Many (RWX) access mode

ActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

AdvertiseMode

Enum of advertise mode
KnownAdvertiseMode can be used interchangeably with AdvertiseMode, this enum contains the known values that the service supports.

Known values supported by the service

ARP: ARP advertise mode
BGP: BGP advertise mode
Both: both ARP and BGP advertise mode

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
<xref: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.

DataResilienceTier

Data resilience tier of a storage class
KnownDataResilienceTier can be used interchangeably with DataResilienceTier, this enum contains the known values that the service supports.

Known values supported by the service

NotDataResilient: Not data resilient
DataResilient: Data resilient

FailoverTier

Failover tier of a storage class
KnownFailoverTier can be used interchangeably with FailoverTier, this enum contains the known values that the service supports.

Known values supported by the service

NotAvailable: Not available Failover Tier
Slow: Slow Failover Tier
Fast: Fast Failover Tier
Super: Super Failover Tier

NfsDirectoryActionOnVolumeDeletion

The action to take when a NFS volume is deleted
KnownNfsDirectoryActionOnVolumeDeletion can be used interchangeably with NfsDirectoryActionOnVolumeDeletion, this enum contains the known values that the service supports.

Known values supported by the service

Delete: When the volume is deleted, delete the directory
Retain: When the volume is deleted, retain the directory

Origin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

PerformanceTier

Performance tier of a storage class
KnownPerformanceTier can be used interchangeably with PerformanceTier, this enum contains the known values that the service supports.

Known values supported by the service

Undefined: Undefined Performance Tier
Basic: Basic Performance Tier
Standard: Standard Performance Tier
Premium: Premium Performance Tier
Ultra: Ultra Performance Tier

ProvisioningState

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

Known values supported by the service

Succeeded
Failed
Canceled
Provisioning
Updating
Deleting
Accepted

SCType

Type of a storage class
KnownSCType can be used interchangeably with SCType, this enum contains the known values that the service supports.

Known values supported by the service

Native: Native storage class
RWX: RWX storage class
Blob: Blob storage class
NFS: NFS storage class
SMB: SMB storage class

StorageClassTypePropertiesUnion

Alias for StorageClassTypePropertiesUnion

VolumeBindingMode

Storage class volume binding mode
KnownVolumeBindingMode can be used interchangeably with VolumeBindingMode, this enum contains the known values that the service supports.

Known values supported by the service

Immediate: Immediate binding mode
WaitForFirstConsumer: Wait for first consumer binding mode

VolumeExpansion

Ability to expand volumes of a storage class
KnownVolumeExpansion can be used interchangeably with VolumeExpansion, this enum contains the known values that the service supports.

Known values supported by the service

Allow: Allow volume expansion
Disallow: Disallow volume expansion

Enums

KnownAccessMode

Storage Class Access Mode

KnownActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

KnownAdvertiseMode

Enum of advertise mode

KnownCreatedByType

The kind of entity that created the resource.

KnownDataResilienceTier

Data resilience tier of a storage class

KnownFailoverTier

Failover tier of a storage class

KnownNfsDirectoryActionOnVolumeDeletion

The action to take when a NFS volume is deleted

KnownOrigin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

KnownPerformanceTier

Performance tier of a storage class

KnownProvisioningState

Known values of <xref:ResourceProvisioningState> that the service accepts.

KnownSCType

Type of a storage class

KnownVolumeBindingMode

Storage class volume binding mode

KnownVolumeExpansion

Ability to expand volumes of a storage class

Functions

restorePoller<TResponse, TResult>(KubernetesRuntimeClient, 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>(KubernetesRuntimeClient, 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: KubernetesRuntimeClient, 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>