Update-AzContainerInstanceContainerGroupProfile

Reference

Module:: Az.ContainerInstance

Patches container group profile with specified properties.

Syntax

Update-AzContainerInstanceContainerGroupProfile
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-Tag <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzContainerInstanceContainerGroupProfile
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      -Property <IContainerGroupProfilePatch>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzContainerInstanceContainerGroupProfile
      -InputObject <IContainerInstanceIdentity>
      [-Tag <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzContainerInstanceContainerGroupProfile
      -InputObject <IContainerInstanceIdentity>
      -Property <IContainerGroupProfilePatch>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Patches container group profile with specified properties.

Examples

Example 1: Update a container group profile

$container = Update-AzContainerInstanceContainerGroupProfile -Name test-cgp -ResourceGroupName test-rg -Tag @{"k"="v"}
$container.Tag | Format-List

Keys                 : {k}
Values               : {v}
AdditionalProperties : {[k, v]}
Count                : 1

This command updates a container group profile.

Example 2: Update a container group profile using piping

$container = Get-AzContainerInstanceContainerGroupProfile -Name test-cgp -ResourceGroupName test-rg | Update-AzContainerInstanceContainerGroupProfile -Tag @{"k"="v"}
$container.Tag | Format-List

Keys                 : {k}
Values               : {v}
AdditionalProperties : {[k, v]}
Count                : 1

This command updates a container group profile using pipeing.

Parameters

-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 profile.

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

-Property

Properties of container group profile that need to be patched To construct, see NOTES section for PROPERTY properties and create a hash table.

Type:	IContainerGroupProfilePatch
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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

-Tag

Resource tags.

Type:	Hashtable
Position:	Named
Default value:	None
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

IContainerGroupProfilePatch

IContainerInstanceIdentity

Outputs

IContainerGroupProfile

Share via