IAgentPool Interface
Definition
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.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.AksArc.Models.AgentPoolTypeConverter))]
public interface IAgentPool : Microsoft.Azure.PowerShell.Cmdlets.AksArc.Models.IProxyResource[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.AksArc.Models.AgentPoolTypeConverter))>]
type IAgentPool = interface
interface IJsonSerializable
interface IProxyResource
interface IResourcePublic Interface IAgentPool
Implements IProxyResource- Derived
- Attributes
- Implements
Properties
| Count |
Number of nodes in the agent pool. The default value is 1. |
| EnableAutoScaling |
Whether to enable auto-scaler. Default value is false |
| ExtendedLocationName |
ARM Id of the extended location. |
| ExtendedLocationType |
The extended location type. Allowed value: 'CustomLocation' |
| Id |
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" (Inherited from IResource) |
| KubernetesVersion |
Version of Kubernetes in use by the agent pool. This is inherited from the kubernetesVersion of the provisioned cluster. |
| MaxCount |
The maximum number of nodes for auto-scaling |
| MaxPod |
The maximum number of pods that can run on a node. |
| MinCount |
The minimum number of nodes for auto-scaling |
| Name |
The name of the resource (Inherited from IResource) |
| NodeLabel |
The node labels to be persisted across all nodes in agent pool. |
| NodeTaint |
Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. |
| OSSku |
Specifies the OS SKU used by the agent pool. The default is CBLMariner if OSType is Linux. The default is Windows2019 when OSType is Windows. |
| OSType |
The particular KubernetesVersion Image OS Type (Linux, Windows) |
| ProvisioningState |
The status of the latest long running operation for the agent pool. |
| StatusCurrentState |
The current state of the agent pool. |
| StatusErrorMessage |
Error messages during an agent pool operation or steady state. |
| StatusReadyReplica | |
| 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 |
| Type |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" (Inherited from IResource) |
| VMSize |
The VM sku size of the agent pool node VMs. |
Methods
| ToJson(JsonObject, SerializationMode) | (Inherited from IJsonSerializable) |