New-AzNetworkCloudInitialAgentPoolConfigurationObject

  • Reference
Module:
Az.NetworkCloud

Create an in-memory object for InitialAgentPoolConfiguration.

Syntax

New-AzNetworkCloudInitialAgentPoolConfigurationObject
   -Count <Int64>
   -Mode <AgentPoolMode>
   -Name <String>
   -VMSkuName <String>
   [-AdministratorConfigurationAdminUsername <String>]
   [-AdministratorConfigurationSshPublicKey <ISshPublicKey[]>]
   [-AgentOptionHugepagesCount <Int64>]
   [-AgentOptionHugepagesSize <HugepagesSize>]
   [-AttachedNetworkConfigurationL2Network <IL2NetworkAttachmentConfiguration[]>]
   [-AttachedNetworkConfigurationL3Network <IL3NetworkAttachmentConfiguration[]>]
   [-AttachedNetworkConfigurationTrunkedNetwork <ITrunkedNetworkAttachmentConfiguration[]>]
   [-AvailabilityZone <String[]>]
   [-Label <IKubernetesLabel[]>]
   [-Taint <IKubernetesLabel[]>]
   [-UpgradeSettingMaxSurge <String>]
   [<CommonParameters>]

Description

Create an in-memory object for InitialAgentPoolConfiguration.

Examples

Example 1: Create an in-memory object for InitialAgentPoolConfiguration.

New-AzNetworkCloudInitialAgentPoolConfigurationObject -Count <Int64> -Mode <AgentPoolMode> -Name <String> -VMSkuName <String> -AdministratorConfigurationAdminUsername <String> -AdministratorConfigurationSshPublicKey <ISshPublicKey[]>  -AgentOptionHugepagesCount <Int64> -AgentOptionHugepagesSize <HugepagesSize> -AttachedNetworkConfigurationL2Network <IL2NetworkAttachmentConfiguration[]> -AttachedNetworkConfigurationL3Network <IL3NetworkAttachmentConfiguration[]> -AttachedNetworkConfigurationTrunkedNetwork <ITrunkedNetworkAttachmentConfiguration[]> -AvailabilityZone <String[]> -Label <IKubernetesLabel[]> -Taint <IKubernetesLabel[]> -UpgradeSettingMaxSurge <String>

Create an in-memory object for InitialAgentPoolConfiguration.

Parameters

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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. To construct, see NOTES section for ADMINISTRATORCONFIGURATIONSSHPUBLICKEY properties and create a hash table.

Type:ISshPublicKey[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AgentOptionHugepagesCount

The number of hugepages to allocate.

Type:Int64
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AgentOptionHugepagesSize

The size of the hugepages to allocate.

Type:HugepagesSize
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AttachedNetworkConfigurationL2Network

The list of Layer 2 Networks and related configuration for attachment. To construct, see NOTES section for ATTACHEDNETWORKCONFIGURATIONL2NETWORK properties and create a hash table.

Type:IL2NetworkAttachmentConfiguration[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AttachedNetworkConfigurationL3Network

The list of Layer 3 Networks and related configuration for attachment. To construct, see NOTES section for ATTACHEDNETWORKCONFIGURATIONL3NETWORK properties and create a hash table.

Type:IL3NetworkAttachmentConfiguration[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AttachedNetworkConfigurationTrunkedNetwork

The list of Trunked Networks and related configuration for attachment. To construct, see NOTES section for ATTACHEDNETWORKCONFIGURATIONTRUNKEDNETWORK properties and create a hash table.

Type:ITrunkedNetworkAttachmentConfiguration[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Count

The number of virtual machines that use this configuration.

Type:Int64
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Label

The labels applied to the nodes in this agent pool. To construct, see NOTES section for LABEL properties and create a hash table.

Type:IKubernetesLabel[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:AgentPoolMode
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

The name that will be used for the agent pool resource representing this agent pool.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Taint

The taints applied to the nodes in this agent pool. To construct, see NOTES section for TAINT properties and create a hash table.

Type:IKubernetesLabel[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMSkuName

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Outputs

InitialAgentPoolConfiguration