KubernetesCluster interface

Package:
@azure/arm-networkcloud

KubernetesCluster represents the Kubernetes cluster hosted on Network Cloud.

Extends
TrackedResource

Properties

aadConfiguration

The Azure Active Directory Integration properties.
administratorConfiguration

The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values.
attachedNetworkIds

The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools.
availableUpgrades

The list of versions that this Kubernetes cluster can be upgraded to.
clusterId

The resource ID of the Network Cloud cluster.
connectedClusterId

The resource ID of the connected cluster set up when this Kubernetes cluster is created.
controlPlaneKubernetesVersion

The current running version of Kubernetes on the control plane.
controlPlaneNodeConfiguration

The defining characteristics of the control plane for this Kubernetes Cluster.
detailedStatus

The current status of the Kubernetes cluster.
detailedStatusMessage

The descriptive message about the current detailed status.
etag

"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
extendedLocation

The extended location of the resource. This property is required when creating the resource.
featureStatuses

The current feature settings.
initialAgentPoolConfigurations

The agent pools that are created with this Kubernetes cluster for running critical system services and workloads. This data in this field is only used during creation, and the field will be empty following the creation of the Kubernetes Cluster. After creation, the management of agent pools is done using the agentPools sub-resource.
kubernetesVersion

The Kubernetes version for this cluster.
managedResourceGroupConfiguration

The configuration of the managed resource group associated with the resource.
networkConfiguration

The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster.
nodes

The details of the nodes in this cluster.
provisioningState

The provisioning state of the Kubernetes cluster resource.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

The geo-location where the resource lives
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

aadConfiguration

The Azure Active Directory Integration properties.

aadConfiguration?: AadConfiguration

Property Value

AadConfiguration

administratorConfiguration

The administrative credentials that will be applied to the control plane and agent pool nodes that do not specify their own values.

administratorConfiguration?: AdministratorConfiguration

Property Value

AdministratorConfiguration

attachedNetworkIds

The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools.

attachedNetworkIds?: string[]

Property Value

string[]

availableUpgrades

The list of versions that this Kubernetes cluster can be upgraded to.

availableUpgrades?: AvailableUpgrade[]

Property Value

AvailableUpgrade[]

clusterId

The resource ID of the Network Cloud cluster.

clusterId?: string

Property Value

string

connectedClusterId

The resource ID of the connected cluster set up when this Kubernetes cluster is created.

connectedClusterId?: string

Property Value

string

controlPlaneKubernetesVersion

The current running version of Kubernetes on the control plane.

controlPlaneKubernetesVersion?: string

Property Value

string

controlPlaneNodeConfiguration

The defining characteristics of the control plane for this Kubernetes Cluster.

controlPlaneNodeConfiguration: ControlPlaneNodeConfiguration

Property Value

ControlPlaneNodeConfiguration

detailedStatus

The current status of the Kubernetes cluster.

detailedStatus?: string

Property Value

string

detailedStatusMessage

The descriptive message about the current detailed status.

detailedStatusMessage?: string

Property Value

string

etag

"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")

etag?: string

Property Value

string

extendedLocation

The extended location of the resource. This property is required when creating the resource.

extendedLocation: ExtendedLocation

Property Value

ExtendedLocation

featureStatuses

The current feature settings.

featureStatuses?: FeatureStatus[]

Property Value

FeatureStatus[]

initialAgentPoolConfigurations

The agent pools that are created with this Kubernetes cluster for running critical system services and workloads. This data in this field is only used during creation, and the field will be empty following the creation of the Kubernetes Cluster. After creation, the management of agent pools is done using the agentPools sub-resource.

initialAgentPoolConfigurations: InitialAgentPoolConfiguration[]

Property Value

InitialAgentPoolConfiguration[]

kubernetesVersion

The Kubernetes version for this cluster.

kubernetesVersion: string

Property Value

string

managedResourceGroupConfiguration

The configuration of the managed resource group associated with the resource.

managedResourceGroupConfiguration?: ManagedResourceGroupConfiguration

Property Value

ManagedResourceGroupConfiguration

networkConfiguration

The configuration of the Kubernetes cluster networking, including the attachment of networks that span the cluster.

networkConfiguration: NetworkConfiguration

Property Value

NetworkConfiguration

nodes

The details of the nodes in this cluster.

nodes?: KubernetesClusterNode[]

Property Value

KubernetesClusterNode[]

provisioningState

The provisioning state of the Kubernetes cluster resource.

provisioningState?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type