Remove-AzureRmContainerServiceAgentPoolProfile

Module:
AzureRM.Compute
Removes an agent pool profile from a container service.

Syntax

Remove-AzureRmContainerServiceAgentPoolProfile
      [-ContainerService] <PSContainerService>
      [-Name] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzureRmContainerServiceAgentPoolProfile cmdlet removes an agent pool profile from a container service.

Examples

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.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ContainerService

Specifies the container service object from which this cmdlet removes an agent pool profile.

Type:PSContainerService
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of the agent pool profile that this cmdlet removes.

Type:String
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSContainerService

String

Outputs

PSContainerService