IAgentPool Interface

  • Reference

Definition

Namespace:
Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20230701
Assembly:
Az.NetworkCloud.private.dll
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20230701.AgentPoolTypeConverter))]
public interface IAgentPool : Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api40.ITrackedResource
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.NetworkCloud.Models.Api20230701.AgentPoolTypeConverter))>]
type IAgentPool = interface
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
Public Interface IAgentPool
Implements ITrackedResource
Derived
Attributes
TypeConverterAttribute
Implements
IResource ITrackedResource IJsonSerializable

Properties

AdministratorConfigurationAdminUsername

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.
AdministratorConfigurationSshPublicKey

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.
AgentOptionHugepagesCount

The number of hugepages to allocate.
AgentOptionHugepagesSize

The size of the hugepages to allocate.
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.
AvailabilityZone

The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.
Count

The number of virtual machines that use this configuration.
DetailedStatus

The current status of the agent pool.
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.
Id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

(Inherited from IResource)
KubernetesVersion

The Kubernetes version running in this agent pool.
Label

The labels applied to the nodes in this agent pool.
Location

The geo-location where the resource lives

(Inherited from ITrackedResource)
Mode

The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.
Name

The name of the resource

(Inherited from IResource)
ProvisioningState

The provisioning state of the agent pool.
SystemDataCreatedAt

The timestamp of resource creation (UTC).

(Inherited from IResource)
SystemDataCreatedBy

The identity that created the resource.

(Inherited from IResource)
SystemDataCreatedByType

The type of identity that created the resource.

(Inherited from IResource)
SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

(Inherited from IResource)
SystemDataLastModifiedBy

The identity that last modified the resource.

(Inherited from IResource)
SystemDataLastModifiedByType

The type of identity that last modified the resource.

(Inherited from IResource)
Tag

Resource tags.

(Inherited from ITrackedResource)
Taint

The taints applied to the nodes in this agent pool.
Type

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

(Inherited from IResource)
UpgradeSettingMaxSurge

The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1.
VMSkuName

The name of the VM SKU that determines the size of resources allocated for node VMs.

Methods

ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to