Restart-AzContainerGroup

Reference

Module:: Az.ContainerInstance

Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.

Syntax

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

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

Description

Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.

Examples

Example 1: Restart all containers in a container group

Restart-AzContainerGroup -Name test-cg -ResourceGroupName test-rg

This command restarts all containers in a container group.

Example 2: Restart all containers in a container group by piping

Get-AzContainerGroup -Name test-cg -ResourceGroupName test-rg | Restart-AzContainerGroup

This command restarts all containers in a container group by piping.

Parameters

-AsJob

Run the command as a job

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-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

-DefaultProfile

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

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IContainerInstanceIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

The name of the container group.

Type:	String
Aliases:	ContainerGroupName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NoWait

Run the command asynchronously

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

Returns true when the command succeeds

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

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

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
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

IContainerInstanceIdentity

Outputs

Boolean

Compartilhar via