@azure/arm-hybridcontainerservice package

Classes

HybridContainerServiceClient

Interfaces

AddonStatusProfile	The status profile of the addons and other kubernetes components
AgentPool	The agentPool resource definition
AgentPoolCreateOrUpdateOptionalParams	Optional parameters.
AgentPoolDeleteHeaders	Defines headers for AgentPool_delete operation.
AgentPoolDeleteOptionalParams	Optional parameters.
AgentPoolGetOptionalParams	Optional parameters.
AgentPoolListByProvisionedClusterNextOptionalParams	Optional parameters.
AgentPoolListByProvisionedClusterOptionalParams	Optional parameters.
AgentPoolListResult	List of all agent pool resources associated with the provisioned cluster.
AgentPoolName	Name of the default Agent Pool
AgentPoolOperations	Interface representing a AgentPoolOperations.
AgentPoolProfile	Profile for agent pool properties specified during creation
AgentPoolProperties	Properties of the agent pool resource
AgentPoolProvisioningStatus	The agentPool resource provisioning status definition
AgentPoolProvisioningStatusStatus	The observed status of the agent pool.
AgentPoolUpdateProfile	Profile for agent pool properties that can be updated
CloudProviderProfile	The profile for the underlying cloud infrastructure provider for the provisioned cluster.
CloudProviderProfileInfraNetworkProfile	The profile for the infrastructure networks used by the provisioned cluster
ClusterVMAccessProfile	The SSH restricted access profile for the VMs in the provisioned cluster.
ControlPlaneProfile	The properties of the control plane nodes of the provisioned cluster
ControlPlaneProfileControlPlaneEndpoint	IP Address of the Kubernetes API server
CredentialResult	The credential result response.
DeleteKubernetesVersionsOptionalParams	Optional parameters.
DeleteVMSkusOptionalParams	Optional parameters.
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. (This also follows the OData error response format.).
ExtendedLocation	Extended location pointing to the underlying infrastructure
GetKubernetesVersionsOptionalParams	Optional parameters.
GetVMSkusOptionalParams	Optional parameters.
HybridContainerServiceClientDeleteKubernetesVersionsHeaders	Defines headers for HybridContainerServiceClient_deleteKubernetesVersions operation.
HybridContainerServiceClientDeleteVMSkusHeaders	Defines headers for HybridContainerServiceClient_deleteVMSkus operation.
HybridContainerServiceClientOptionalParams	Optional parameters.
HybridIdentityMetadata	Defines the hybridIdentityMetadata.
HybridIdentityMetadataDeleteHeaders	Defines headers for HybridIdentityMetadata_delete operation.
HybridIdentityMetadataDeleteOptionalParams	Optional parameters.
HybridIdentityMetadataGetOptionalParams	Optional parameters.
HybridIdentityMetadataList	List of hybridIdentityMetadata.
HybridIdentityMetadataListByClusterNextOptionalParams	Optional parameters.
HybridIdentityMetadataListByClusterOptionalParams	Optional parameters.
HybridIdentityMetadataOperations	Interface representing a HybridIdentityMetadataOperations.
HybridIdentityMetadataProperties	Defines the resource properties for the hybrid identity metadata.
HybridIdentityMetadataPutOptionalParams	Optional parameters.
KubernetesPatchVersions	Kubernetes Patch Version profile
KubernetesVersionProfile	The supported kubernetes versions.
KubernetesVersionProfileList	List of supported kubernetes versions.
KubernetesVersionProfileProperties
KubernetesVersionProperties	Kubernetes version profile for given major.minor release
KubernetesVersionReadiness	Indicates whether the kubernetes version image is ready or not
KubernetesVersions	Interface representing a KubernetesVersions.
KubernetesVersionsListNextOptionalParams	Optional parameters.
KubernetesVersionsListOptionalParams	Optional parameters.
LinuxProfile	The profile for Linux VMs in the provisioned cluster.
LinuxProfileProperties	SSH profile for control plane and nodepool VMs of the provisioned cluster.
LinuxProfilePropertiesSsh	SSH configuration for VMs of the provisioned cluster.
LinuxProfilePropertiesSshPublicKeysItem
ListCredentialResponse	The list kubeconfig result response.
ListCredentialResponseError
ListCredentialResponseProperties
NamedAgentPoolProfile	Profile of the default agent pool along with a name parameter
NetworkProfile	The network configuration profile for the provisioned cluster.
NetworkProfileLoadBalancerProfile	Profile of the HA Proxy load balancer.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for this particular operation.
OperationListResult	A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
ProvisionedCluster	The provisioned cluster resource definition.
ProvisionedClusterInstances	Interface representing a ProvisionedClusterInstances.
ProvisionedClusterInstancesCreateOrUpdateOptionalParams	Optional parameters.
ProvisionedClusterInstancesDeleteHeaders	Defines headers for ProvisionedClusterInstances_delete operation.
ProvisionedClusterInstancesDeleteOptionalParams	Optional parameters.
ProvisionedClusterInstancesGetOptionalParams	Optional parameters.
ProvisionedClusterInstancesGetUpgradeProfileOptionalParams	Optional parameters.
ProvisionedClusterInstancesListAdminKubeconfigHeaders	Defines headers for ProvisionedClusterInstances_listAdminKubeconfig operation.
ProvisionedClusterInstancesListAdminKubeconfigOptionalParams	Optional parameters.
ProvisionedClusterInstancesListNextOptionalParams	Optional parameters.
ProvisionedClusterInstancesListOptionalParams	Optional parameters.
ProvisionedClusterInstancesListUserKubeconfigHeaders	Defines headers for ProvisionedClusterInstances_listUserKubeconfig operation.
ProvisionedClusterInstancesListUserKubeconfigOptionalParams	Optional parameters.
ProvisionedClusterLicenseProfile	The license profile of the provisioned cluster.
ProvisionedClusterListResult	Lists the ProvisionedClusterInstance resource associated with the ConnectedCluster.
ProvisionedClusterPoolUpgradeProfile	The list of available kubernetes versions for upgrade.
ProvisionedClusterPoolUpgradeProfileProperties	The upgrade properties.
ProvisionedClusterProperties	Properties of the provisioned cluster.
ProvisionedClusterPropertiesAutoScalerProfile	Parameters to be applied to the cluster-autoscaler when auto scaling is enabled for the provisioned cluster.
ProvisionedClusterPropertiesStatus	The observed status of the provisioned cluster.
ProvisionedClusterUpgradeProfile	The list of available kubernetes version upgrades for the provisioned cluster.
ProvisionedClusterUpgradeProfileProperties	Control plane and agent pool upgrade profiles.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
PutKubernetesVersionsOptionalParams	Optional parameters.
PutVMSkusOptionalParams	Optional parameters.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
StorageProfile	The storage configuration profile for the provisioned cluster.
StorageProfileNfsCSIDriver	NFS CSI Driver settings for the storage profile.
StorageProfileSmbCSIDriver	SMB CSI Driver settings for the storage profile.
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'
VMSkus	Interface representing a VMSkus.
VMSkusListNextOptionalParams	Optional parameters.
VMSkusListOptionalParams	Optional parameters.
VirtualNetwork	The Virtual Network resource definition.
VirtualNetworkExtendedLocation	Extended location pointing to the underlying infrastructure
VirtualNetworkProperties	Properties of the virtual network resource
VirtualNetworkPropertiesInfraVnetProfile
VirtualNetworkPropertiesInfraVnetProfileHci	Infrastructure network profile for HCI platform
VirtualNetworkPropertiesStatus	Status of the virtual network resource
VirtualNetworkPropertiesStatusOperationStatus	The detailed status of the long running operation.
VirtualNetworkPropertiesStatusOperationStatusError	The error if any from the operation.
VirtualNetworkPropertiesVipPoolItem
VirtualNetworkPropertiesVmipPoolItem
VirtualNetworks	Interface representing a VirtualNetworks.
VirtualNetworksCreateOrUpdateOptionalParams	Optional parameters.
VirtualNetworksDeleteHeaders	Defines headers for VirtualNetworks_delete operation.
VirtualNetworksDeleteOptionalParams	Optional parameters.
VirtualNetworksListByResourceGroupNextOptionalParams	Optional parameters.
VirtualNetworksListByResourceGroupOptionalParams	Optional parameters.
VirtualNetworksListBySubscriptionNextOptionalParams	Optional parameters.
VirtualNetworksListBySubscriptionOptionalParams	Optional parameters.
VirtualNetworksListResult	A list of virtual network resources.
VirtualNetworksPatch	The Virtual Network resource patch definition.
VirtualNetworksRetrieveOptionalParams	Optional parameters.
VirtualNetworksUpdateOptionalParams	Optional parameters.
VmSkuCapabilities	Describes the VM SKU capabilities like MemoryGB, vCPUs, etc.
VmSkuProfile	The list of supported VM SKUs.
VmSkuProfileList	The list of supported VM SKUs.
VmSkuProfileProperties
VmSkuProperties	The profile for supported VM SKUs

Type Aliases

ActionType	Defines values for ActionType. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal
AddonPhase	Defines values for AddonPhase. KnownAddonPhase can be used interchangeably with AddonPhase, this enum contains the known values that the service supports. Known values supported by the service pending provisioning provisioning {HelmChartInstalled} provisioning {MSICertificateDownloaded} provisioned deleting failed upgrading
AgentPoolCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
AgentPoolDeleteResponse	Contains response data for the delete operation.
AgentPoolGetResponse	Contains response data for the get operation.
AgentPoolListByProvisionedClusterNextResponse	Contains response data for the listByProvisionedClusterNext operation.
AgentPoolListByProvisionedClusterResponse	Contains response data for the listByProvisionedCluster operation.
AzureHybridBenefit	Defines values for AzureHybridBenefit. 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
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
DeleteKubernetesVersionsResponse	Contains response data for the deleteKubernetesVersions operation.
DeleteVMSkusResponse	Contains response data for the deleteVMSkus operation.
Expander	Defines values for Expander. KnownExpander can be used interchangeably with Expander, this enum contains the known values that the service supports. Known values supported by the service least-waste: Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources. most-pods: Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once. priority: Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details here. random: Used when you don't have a particular need for the node groups to scale differently.
ExtendedLocationTypes	Defines values for ExtendedLocationTypes. KnownExtendedLocationTypes can be used interchangeably with ExtendedLocationTypes, this enum contains the known values that the service supports. Known values supported by the service CustomLocation
GetKubernetesVersionsResponse	Contains response data for the getKubernetesVersions operation.
GetVMSkusResponse	Contains response data for the getVMSkus operation.
HybridIdentityMetadataDeleteResponse	Contains response data for the delete operation.
HybridIdentityMetadataGetResponse	Contains response data for the get operation.
HybridIdentityMetadataListByClusterNextResponse	Contains response data for the listByClusterNext operation.
HybridIdentityMetadataListByClusterResponse	Contains response data for the listByCluster operation.
HybridIdentityMetadataPutResponse	Contains response data for the put operation.
KubernetesVersionsListNextResponse	Contains response data for the listNext operation.
KubernetesVersionsListResponse	Contains response data for the list operation.
NetworkPolicy	Defines values for NetworkPolicy. KnownNetworkPolicy can be used interchangeably with NetworkPolicy, this enum contains the known values that the service supports. Known values supported by the service calico
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
Origin	Defines values for Origin. KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user system user,system
OsType	Defines values for OsType. KnownOsType can be used interchangeably with OsType, this enum contains the known values that the service supports. Known values supported by the service Windows Linux
Ossku	Defines values for Ossku. KnownOssku can be used interchangeably with Ossku, this enum contains the known values that the service supports. Known values supported by the service CBLMariner: Use Mariner as the OS for node images. Windows2019: Use Windows2019 as the OS for node images. Windows2022: Use Windows2022 as the OS for node images.
ProvisionedClusterInstancesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ProvisionedClusterInstancesDeleteResponse	Contains response data for the delete operation.
ProvisionedClusterInstancesGetResponse	Contains response data for the get operation.
ProvisionedClusterInstancesGetUpgradeProfileResponse	Contains response data for the getUpgradeProfile operation.
ProvisionedClusterInstancesListAdminKubeconfigResponse	Contains response data for the listAdminKubeconfig operation.
ProvisionedClusterInstancesListNextResponse	Contains response data for the listNext operation.
ProvisionedClusterInstancesListResponse	Contains response data for the list operation.
ProvisionedClusterInstancesListUserKubeconfigResponse	Contains response data for the listUserKubeconfig operation.
ProvisioningState	Defines values for ProvisioningState. 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 Pending Creating Deleting Updating Accepted
PutKubernetesVersionsResponse	Contains response data for the putKubernetesVersions operation.
PutVMSkusResponse	Contains response data for the putVMSkus operation.
ResourceProvisioningState	Defines values for ResourceProvisioningState. KnownResourceProvisioningState 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 Pending Creating Deleting Updating Upgrading Accepted
VMSkusListNextResponse	Contains response data for the listNext operation.
VMSkusListResponse	Contains response data for the list operation.
VirtualNetworksCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
VirtualNetworksDeleteResponse	Contains response data for the delete operation.
VirtualNetworksListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
VirtualNetworksListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
VirtualNetworksListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
VirtualNetworksListBySubscriptionResponse	Contains response data for the listBySubscription operation.
VirtualNetworksRetrieveResponse	Contains response data for the retrieve operation.
VirtualNetworksUpdateResponse	Contains response data for the update operation.

Enums

KnownActionType	Known values of ActionType that the service accepts.
KnownAddonPhase	Known values of AddonPhase that the service accepts.
KnownAzureHybridBenefit	Known values of AzureHybridBenefit that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownExpander	Known values of Expander that the service accepts.
KnownExtendedLocationTypes	Known values of ExtendedLocationTypes that the service accepts.
KnownNetworkPolicy	Known values of NetworkPolicy that the service accepts.
KnownOrigin	Known values of Origin that the service accepts.
KnownOsType	Known values of OsType that the service accepts.
KnownOssku	Known values of Ossku that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownResourceProvisioningState	Known values of ResourceProvisioningState that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.