KubernetesCluster Class

Reference

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20230701

Assembly:: Az.NetworkCloud.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

KubernetesCluster represents the Kubernetes cluster hosted on Network Cloud.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20230701.KubernetesClusterTypeConverter))]
public class KubernetesCluster : Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20230701.IKubernetesCluster, Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20230701.KubernetesClusterTypeConverter))>]
type KubernetesCluster = class
    interface IKubernetesCluster
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
    interface IValidates

Public Class KubernetesCluster
Implements IKubernetesCluster, IValidates

Inheritance: Object
KubernetesCluster

Attributes: TypeConverterAttribute

Implements: IKubernetesCluster IResource ITrackedResource IJsonSerializable IValidates

Constructors

KubernetesCluster()

Creates an new KubernetesCluster instance.

Properties

AadConfigurationAdminGroupObjectId	The list of Azure Active Directory group object IDs that will have an administrative role on the Kubernetes cluster.
AdminUsername	The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service.
AttachedNetworkConfigurationL2Network	The list of Layer 2 Networks and related configuration for attachment.
AttachedNetworkConfigurationL3Network	The list of Layer 3 Networks and related configuration for attachment.
AttachedNetworkConfigurationTrunkedNetwork	The list of Trunked Networks and related configuration for attachment.
AttachedNetworkId	The full list of network resource IDs that are attached to this cluster, including those attached only to specific agent pools.
AvailableUpgrade	The list of versions that this Kubernetes cluster can be upgraded to.
BgpServiceLoadBalancerConfigurationBgpAdvertisement	The association of IP address pools to the communities and peers, allowing for announcement of IPs.
BgpServiceLoadBalancerConfigurationBgpPeer	The list of additional BgpPeer entities that the Kubernetes cluster will peer with. All peering must be explicitly defined.
BgpServiceLoadBalancerConfigurationFabricPeeringEnabled	The indicator to specify if the load balancer peers with the network fabric.
BgpServiceLoadBalancerConfigurationIPAddressPool	The list of pools of IP addresses that can be allocated to Load Balancer services.
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.
ControlPlaneNodeConfigurationAdministratorConfigurationAdminUsername	The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service.
ControlPlaneNodeConfigurationAdministratorConfigurationSshPublicKey	The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment.
ControlPlaneNodeConfigurationAvailabilityZone	The list of availability zones of the Network Cloud cluster to be used for the provisioning of nodes in the control plane. If not specified, all availability zones will be used.
ControlPlaneNodeConfigurationCount	The number of virtual machines that use this configuration.
ControlPlaneNodeConfigurationVMSkuName	The name of the VM SKU supplied during creation.
DetailedStatus	The current status of the Kubernetes cluster.
DetailedStatusMessage	The descriptive message about the current detailed status.
ExtendedLocationName	The resource ID of the extended location on which the resource will be created.
ExtendedLocationType	The extended location type, for example, CustomLocation.
FeatureStatuses	The current feature settings.
Id	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
InitialAgentPoolConfiguration	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.
Location	The geo-location where the resource lives
ManagedResourceGroupConfigurationLocation	The location of the managed resource group. If not specified, the location of the parent resource is chosen.
ManagedResourceGroupConfigurationName	The name for the managed resource group. If not specified, the unique name is automatically generated.
Name	The name of the resource
NetworkConfigurationCloudServicesNetworkId	The resource ID of the associated Cloud Services network.
NetworkConfigurationCniNetworkId	The resource ID of the Layer 3 network that is used for creation of the Container Networking Interface network.
NetworkConfigurationDnsServiceIP	The IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in service CIDR.
NetworkConfigurationPodCidr	The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.
NetworkConfigurationServiceCidr	The CIDR notation IP ranges from which to assign service IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking.
Node	The details of the nodes in this cluster.
ProvisioningState	The provisioning state of the Kubernetes cluster resource.
ResourceGroupName	Gets the resource group name
SshPublicKey	The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment.
SystemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
SystemDataCreatedAt	The timestamp of resource creation (UTC).
SystemDataCreatedBy	The identity that created the resource.
SystemDataCreatedByType	The type of identity that created the resource.
SystemDataLastModifiedAt	The timestamp of resource last modification (UTC)
SystemDataLastModifiedBy	The identity that last modified the resource.
SystemDataLastModifiedByType	The type of identity that last modified the resource.
Tag	Resource tags.
Type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of KubernetesCluster.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of KubernetesCluster.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20230701.IKubernetesCluster.
FromJsonString(String)	Creates a new instance of KubernetesCluster, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of KubernetesCluster into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()
Validate(IEventListener)	Validates that this object meets the validation criteria.

Applies to

Share via