Share via

KubernetesCluster interface

  • Reference
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. NOTE: This property will not be serialized. It can only be populated by the server.
availableUpgrades

The list of versions that this Kubernetes cluster can be upgraded to. NOTE: This property will not be serialized. It can only be populated by the server.
clusterId

The resource ID of the Network Cloud cluster. NOTE: This property will not be serialized. It can only be populated by the server.
connectedClusterId

The resource ID of the connected cluster set up when this Kubernetes cluster is created. NOTE: This property will not be serialized. It can only be populated by the server.
controlPlaneKubernetesVersion

The current running version of Kubernetes on the control plane. NOTE: This property will not be serialized. It can only be populated by the server.
controlPlaneNodeConfiguration

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

The current status of the Kubernetes cluster. NOTE: This property will not be serialized. It can only be populated by the server.
detailedStatusMessage

The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.
extendedLocation

The extended location of the cluster associated with the resource.
featureStatuses

The current feature settings. NOTE: This property will not be serialized. It can only be populated by the server.
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. Accepts n.n, n.n.n, and n.n.n-n format. The interpreted version used will be resolved into this field after creation or update.
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. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

The provisioning state of the Kubernetes cluster resource. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

attachedNetworkIds?: string[]

Property Value

string[]

availableUpgrades

The list of versions that this Kubernetes cluster can be upgraded to. NOTE: This property will not be serialized. It can only be populated by the server.

availableUpgrades?: AvailableUpgrade[]

Property Value

AvailableUpgrade[]

clusterId

The resource ID of the Network Cloud cluster. NOTE: This property will not be serialized. It can only be populated by the server.

clusterId?: string

Property Value

string

connectedClusterId

The resource ID of the connected cluster set up when this Kubernetes cluster is created. NOTE: This property will not be serialized. It can only be populated by the server.

connectedClusterId?: string

Property Value

string

controlPlaneKubernetesVersion

The current running version of Kubernetes on the control plane. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

detailedStatus?: string

Property Value

string

detailedStatusMessage

The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.

detailedStatusMessage?: string

Property Value

string

extendedLocation

The extended location of the cluster associated with the resource.

extendedLocation: ExtendedLocation

Property Value

ExtendedLocation

featureStatuses

The current feature settings. NOTE: This property will not be serialized. It can only be populated by the server.

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. Accepts n.n, n.n.n, and n.n.n-n format. The interpreted version used will be resolved into this field after creation or update.

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. NOTE: This property will not be serialized. It can only be populated by the server.

nodes?: KubernetesClusterNode[]

Property Value

KubernetesClusterNode[]

provisioningState

The provisioning state of the Kubernetes cluster resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

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 NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type