Upravit

Sdílet prostřednictvím


Update-AzImage

Updates an image.

Syntax

Update-AzImage
      [-ResourceGroupName] <String>
      [-ImageName] <String>
      [-Tag <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzImage
      [-Tag <Hashtable>]
      [-AsJob]
      [-ResourceId] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzImage
      [-Tag <Hashtable>]
      [-AsJob]
      [-Image] <PSImage>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Update-AzImage cmdlet updates an image. Currently, only the Tags can be updated.

Examples

Example 1

$image = Get-AzImage -ResourceGroupName 'ResourceGroup01' -ImageName 'Image01' 
$image.Tags = New-Object "System.Collections.Generic.Dictionary``2[System.String,System.String]"
$image.Tags.Add("key1", "val1")
Update-AzImage -Image $image

This command updates the Tag value of the existing image 'Image01' in the resource group 'ResourceGroup01'.

Parameters

-AsJob

Run cmdlet in the background.

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 credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Image

Specifies a local image object.

Type:PSImage
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ImageName

Specifies the name of an image.

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

-ResourceGroupName

Specifies the name of a resource group.

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

-ResourceId

The resource Id for the image

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

-Tag

Resource tags

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

String

PSImage

Outputs

PSImage