Add-AzContainerServiceAgentPoolProfile
Adds a container service agent pool profile.
Syntax
Add-AzContainerServiceAgentPoolProfile
[-ContainerService] <PSContainerService>
[[-Name] <String>]
[[-Count] <Int32>]
[[-VmSize] <String>]
[[-DnsPrefix] <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Add-AzContainerServiceAgentPoolProfile cmdlet adds a container service agent pool profile to a local container service object.
Examples
Example 1: Add a profile
PS C:\> Add-AzContainerServiceAgentPoolProfile -Name "AgentPool01" -VmSize "Standard_A1" -DnsPrefix "APResourceGroup17"
This command adds a container service agent pool profile to the local container service object.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ContainerService
Specifies the container service object to which this cmdlet adds an agent pool profile. To obtain a ContainerService object, use the New-AzContainerServiceConfig cmdlet.
Type: | PSContainerService |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Count
Specifies the number of agents that host containers. The acceptable values for this parameter are: integers from 1 to 100. The default value is 1.
Type: | Int32 |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Type: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DnsPrefix
Specifies the DNS prefix that this cmdlet uses to create the fully qualified domain name for this agent pool.
Type: | String |
Position: | 4 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies the name of the agent pool profile. This value must be unique in the context of the subscription and resource group.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-VmSize
Specifies the size of the virtual machines for the agents.
Type: | String |
Position: | 3 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
ContainerService
Parameter 'ContainerService' accepts value of type 'ContainerService' from the pipeline