@azure/arm-hybridkubernetes package

Classes

ConnectedKubernetesClient

Interfaces

AadProfile	AAD Profile specifies attributes for Azure Active Directory integration.
AgentError	Agent Errors if any during agent or system component upgrade.
ArcAgentProfile	Defines the Arc Agent properties for the clusters.
ArcAgentryConfigurations	model interface ArcAgentryConfigurations
ConnectedCluster	Represents a connected cluster.
ConnectedClusterIdentity	Identity for the connected cluster.
ConnectedClusterOperationsCreateOrReplaceOptionalParams	Optional parameters.
ConnectedClusterOperationsDeleteOptionalParams	Optional parameters.
ConnectedClusterOperationsGetOptionalParams	Optional parameters.
ConnectedClusterOperationsListByResourceGroupOptionalParams	Optional parameters.
ConnectedClusterOperationsListBySubscriptionOptionalParams	Optional parameters.
ConnectedClusterOperationsListClusterUserCredentialOptionalParams	Optional parameters.
ConnectedClusterOperationsOperations	Interface representing a ConnectedClusterOperations operations.
ConnectedClusterOperationsUpdateAsyncOptionalParams	Optional parameters.
ConnectedClusterPatch	Object containing updates for patch operations.
ConnectedClusterPatchProperties	Properties which can be patched on the connected cluster resource.
ConnectedClusterProperties	Properties of the connected cluster.
ConnectedKubernetesClientOptionalParams	Optional parameters for the client.
CredentialResult	The credential result response.
CredentialResults	The list of credential result response.
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.
Gateway	model interface Gateway
HybridConnectionConfig	Contains the REP (rendezvous endpoint) and “Sender” access token.
ListClusterUserCredentialProperties	model interface ListClusterUserCredentialProperties
OidcIssuerProfile	OIDC Issuer Profile specifies attributes for workload identity integration.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an 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
SecurityProfile	Security Profile specifies attributes for cluster security features.
SecurityProfileWorkloadIdentity	The workload identity feature webhook.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SystemComponent	System extensions and its current versions installed on the cluster resource.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Type Aliases

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.
AuthenticationMethod	The mode of client authentication. KnownAuthenticationMethod can be used interchangeably with AuthenticationMethod, this enum contains the known values that the service supports. Known values supported by the service Token AAD
AutoUpgradeOptions	Indicates whether the Arc agents on the be upgraded automatically to the latest version. Defaults to Enabled. KnownAutoUpgradeOptions can be used interchangeably with AutoUpgradeOptions, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
AzureHybridBenefit	Indicates whether Azure Hybrid Benefit is opted in KnownAzureHybridBenefit can be used interchangeably with AzureHybridBenefit, this enum contains the known values that the service supports. Known values supported by the service True False NotApplicable
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ConnectedClusterKind	Indicates the kind of Arc connected cluster based on host infrastructure. KnownConnectedClusterKind can be used interchangeably with ConnectedClusterKind, this enum contains the known values that the service supports. Known values supported by the service ProvisionedCluster
ConnectivityStatus	Represents the connectivity status of the connected cluster. KnownConnectivityStatus can be used interchangeably with ConnectivityStatus, this enum contains the known values that the service supports. Known values supported by the service Connecting Connected Offline Expired AgentNotInstalled
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.
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.
PrivateLinkState	Property which describes the state of private link on a connected cluster resource. KnownPrivateLinkState can be used interchangeably with PrivateLinkState, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
ProvisioningState	The current deployment state of connectedClusters. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Failed Canceled Provisioning Updating Deleting Accepted
ResourceIdentityType	The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAuthenticationMethod	The mode of client authentication.
KnownAutoUpgradeOptions	Indicates whether the Arc agents on the be upgraded automatically to the latest version. Defaults to Enabled.
KnownAzureHybridBenefit	Indicates whether Azure Hybrid Benefit is opted in
KnownConnectedClusterKind	Indicates the kind of Arc connected cluster based on host infrastructure.
KnownConnectivityStatus	Represents the connectivity status of the connected cluster.
KnownCreatedByType	The kind of entity that created the resource.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownPrivateLinkState	Property which describes the state of private link on a connected cluster resource.
KnownProvisioningState	The current deployment state of connectedClusters.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(ConnectedKubernetesClient, 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.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(ConnectedKubernetesClient, 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: ConnectedKubernetesClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

ConnectedKubernetesClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor