Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Remove-AzContainerGroup

Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.

Syntax

Delete (Default) 

Remove-AzContainerGroup
 -Name <String>
 -ResourceGroupName <String>
 [-SubscriptionId <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-PassThru]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

DeleteViaIdentity 

Remove-AzContainerGroup
 -InputObject <IContainerInstanceIdentity>
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-PassThru]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.

Examples

Example 1: Remove a container group

Remove-AzContainerGroup -Name test-cg -ResourceGroupName test-rg

Location Name Zone ResourceGroupName
-------- ---- ---- -----------------
eastus test-cg test-rg

This command removes the specified container group.

Example 2: Removes a container group by piping

Get-AzContainerGroup -Name test-cg -ResourceGroupName bez-rg | Remove-AzContainerGroup

Location Name Zone ResourceGroupName
-------- ---- ---- -----------------
eastus test-cg test-rg

This command removes a container group by piping.

Parameters

-AsJob

Run the command as a job

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

-InputObject

Identity Parameter

Parameter properties

Type:IContainerInstanceIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Name

The name of the container group.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ContainerGroupName

Parameter sets

-NoWait

Run the command asynchronously

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-PassThru

Returns true when the command succeeds

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Parameter properties

Type:String
Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

IContainerInstanceIdentity

Outputs

Microsoft.Azure.PowerShell.Cmdlets.ContainerInstance.Models.IContainerGroup

Feedback

Was this page helpful?