< Back
Remove-AzureRmContainerServiceAgentPoolProfile
Post
NAME Remove-AzureRmContainerServiceAgentPoolProfile
SYNOPSIS
Removes an agent pool profile from a container service.
SYNTAX
Remove-AzureRmContainerServiceAgentPoolProfile [-ContainerService] <PSContainerService> [-Name] <String> [-DefaultProfile
<IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmContainerServiceAgentPoolProfile cmdlet removes an agent pool profile from a container service.
PARAMETERS
-ContainerService <PSContainerService>
Specifies the container service object from which this cmdlet removes an agent pool profile.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the agent pool profile that this cmdlet removes.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
ContainerService
Parameter 'ContainerService' accepts value of type 'ContainerService' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService
NOTES
Example 1: Remove a profile from a container service
PS C:\\> $Container = Get-AzureRmContainerService -ResourceGroupName "ResourceGroup17" -Name "CSResourceGroup17"
PS C:\\> Remove-AzureRmContainerServiceAgentPoolProfile -ContainerService $Container -Name "AgentPool01"
The first command gets a container service named CSResourceGroup17 by using the Get-AzureRmContainerService cmdlet. The command stores the service
in the $Container variable.
The second command removes the profile named AgentPool01 from the container service in $Container.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... oolprofile
Add-AzureRmContainerServiceAgentPoolProfile
Get-AzureRmContainerService
SYNOPSIS
Removes an agent pool profile from a container service.
SYNTAX
Remove-AzureRmContainerServiceAgentPoolProfile [-ContainerService] <PSContainerService> [-Name] <String> [-DefaultProfile
<IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmContainerServiceAgentPoolProfile cmdlet removes an agent pool profile from a container service.
PARAMETERS
-ContainerService <PSContainerService>
Specifies the container service object from which this cmdlet removes an agent pool profile.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the agent pool profile that this cmdlet removes.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
ContainerService
Parameter 'ContainerService' accepts value of type 'ContainerService' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.Compute.Automation.Models.PSContainerService
NOTES
Example 1: Remove a profile from a container service
PS C:\\> $Container = Get-AzureRmContainerService -ResourceGroupName "ResourceGroup17" -Name "CSResourceGroup17"
PS C:\\> Remove-AzureRmContainerServiceAgentPoolProfile -ContainerService $Container -Name "AgentPool01"
The first command gets a container service named CSResourceGroup17 by using the Get-AzureRmContainerService cmdlet. The command stores the service
in the $Container variable.
The second command removes the profile named AgentPool01 from the container service in $Container.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... oolprofile
Add-AzureRmContainerServiceAgentPoolProfile
Get-AzureRmContainerService