< Back

Update-AzureRmContainerService

Tue Jan 29, 2019 9:40 pm

NAME Update-AzureRmContainerService



SYNOPSIS

Updates the state of a container service.





SYNTAX

Update-AzureRmContainerService [-ResourceGroupName] <String> [-Name] <String> [-ContainerService] <PSContainerService> [-AsJob] [-DefaultProfile

<IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Update-AzureRmContainerService cmdlet updates the state of a container service to match a local instance of the service.





PARAMETERS

-AsJob [<SwitchParameter>]

Run cmdlet in the background



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-ContainerService <PSContainerService>

Specifies a local ContainerService object that contains changes.



Required? true

Position? 3

Default value None

Accept pipeline input? True (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 container service that this cmdlet updates.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the resource group of the container service that this cmdlet updates.



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: Update a container service



PS C:\\> Get-AzureRmContainerService -ResourceGroupName "ResourceGroup17" -Name "CSResourceGroup17" |

Remove-AzureRmContainerServiceAgentPoolProfile -Name "AgentPool01" | Add-AzureRmContainerServiceAgentPoolProfile -Name "AgentPool01" -VmSize

"Standard_A1" -DnsPrefix "APResourceGroup17" -Count 2 | Update-AzureRmContainerService -ResourceGroupName "ResourceGroup17" -Name

"CSResourceGroup17"



This command gets the container service named CSResourceGroup17 by using the Get-AzureRmContainerService cmdlet. The command passes that object to

the Remove-AzureRmContainerServiceAgentPoolProfile cmdlet by using the pipeline operator. Remove-AzureRmContainerServiceAgentPoolProfile removes

the profile named AgentPool01. The command passes the result to the Add-AzureRmContainerServiceAgentPoolProfile cmdlet.

Add-AzureRmContainerServiceAgentPoolProfile adds a profile that has the name AgentPool01, and has the specified properties. The command passes the

result to the current cmdlet.



The current cmdlet updates the container service to reflect the changes that were made in this command.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... nerservice

Add-AzureRmContainerServiceAgentPoolProfile

Get-AzureRmContainerService

New-AzureRmContainerService

Remove-AzureRmContainerService

Remove-AzureRmContainerServiceAgentPoolProfile