Update-AzGalleryImageDefinition

ギャラリー イメージ定義を更新します。

構文

DefaultParameter (既定)

Update-AzGalleryImageDefinition
    [-ResourceGroupName] <String>
    [-GalleryName] <String>
    [-Name] <String>
    [-AsJob]
    [-Description <String>]
    [-DisallowedDiskType <String[]>]
    [-EndOfLifeDate <DateTime>]
    [-Eula <String>]
    [-MinimumMemory <Int32>]
    [-MinimumVCPU <Int32>]
    [-MaximumMemory <Int32>]
    [-MaximumVCPU <Int32>]
    [-PrivacyStatementUri <String>]
    [-PurchasePlanName <String>]
    [-PurchasePlanProduct <String>]
    [-PurchasePlanPublisher <String>]
    [-ReleaseNoteUri <String>]
    [-Tag <Hashtable>]
    [-Feature <GalleryImageFeature[]>]
    [-AllowUpdateImage <Boolean>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ResourceIdParameter

Update-AzGalleryImageDefinition
    [-ResourceId] <String>
    [-AsJob]
    [-Description <String>]
    [-DisallowedDiskType <String[]>]
    [-EndOfLifeDate <DateTime>]
    [-Eula <String>]
    [-MinimumMemory <Int32>]
    [-MinimumVCPU <Int32>]
    [-MaximumMemory <Int32>]
    [-MaximumVCPU <Int32>]
    [-PrivacyStatementUri <String>]
    [-PurchasePlanName <String>]
    [-PurchasePlanProduct <String>]
    [-PurchasePlanPublisher <String>]
    [-ReleaseNoteUri <String>]
    [-Tag <Hashtable>]
    [-Feature <GalleryImageFeature[]>]
    [-AllowUpdateImage <Boolean>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ObjectParameter

Update-AzGalleryImageDefinition
    [-InputObject] <PSGalleryImage>
    [-AsJob]
    [-Description <String>]
    [-DisallowedDiskType <String[]>]
    [-EndOfLifeDate <DateTime>]
    [-Eula <String>]
    [-MinimumMemory <Int32>]
    [-MinimumVCPU <Int32>]
    [-MaximumMemory <Int32>]
    [-MaximumVCPU <Int32>]
    [-PrivacyStatementUri <String>]
    [-PurchasePlanName <String>]
    [-PurchasePlanProduct <String>]
    [-PurchasePlanPublisher <String>]
    [-ReleaseNoteUri <String>]
    [-Tag <Hashtable>]
    [-Feature <GalleryImageFeature[]>]
    [-AllowUpdateImage <Boolean>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

ギャラリー イメージ定義を更新します。

例 1: イメージ定義の推奨構成を変更する

$rgName = "myResourceGroup"
$galleryName = "myGallery"
$imageName = "myImage"
$versionName = "1.0.0"
$minVCPU = 1
$maxVCPU = 4
$minMemory = 1
$maxMemory = 8
$description = "My image definition"
$endOfLifeDate = "2024-08-02T00:00:00+00:00"
Update-AzGalleryImageDefinition -ResourceGroupName $resourceGroupName -GalleryName $galleryName -Name $galleryImageDefinitionName -Description $description -EndOfLifeDate $endOfLifeDate -MinimumMemory $minMemory -MaximumMemory $maxMemory -MinimumVCPU $minVCPU -MaximumVCPU $maxVCPU

ギャラリー イメージ定義の推奨構成設定を更新する

例 2: StartsAtVersion を使用してギャラリー イメージ機能を更新する

$rgName = "myResourceGroup"
$galleryName = "myGallery"
$imageDefinitionName = "myImageDefinition"
$DiskControllerType = @{Name='DiskControllerTypes'; Value='SCSI'; StartsAtVersion='4.0.0'}
$SecurityType = @{Name='SecurityType'; Value='TrustedLaunch'; StartsAtVersion='4.0.0'}
$features = @($DiskControllerType, $SecurityType)
Update-AzGalleryImageDefinition -ResourceGroupName $rgName -GalleryName $galleryName -Name $imageDefinitionName -Feature $features -AllowUpdateImage $true

StartsAtVersion を使用して各機能をサポートする最小ギャラリー イメージ バージョンを設定して、ギャラリー イメージ定義の機能を更新します。 機能を更新するときは、AllowUpdateImage パラメーターを true に設定する必要があります。

パラメーター

-AllowUpdateImage

$true パラメーターを使用してギャラリー イメージ機能を更新する場合は、-Featureに設定する必要があります。

パラメーターのプロパティ

型:Boolean
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-AsJob

バックグラウンドでコマンドレットを実行する

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:Cf

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-DefaultProfile

Azureとの通信に使用される資格情報、アカウント、テナント、サブスクリプション。

パラメーターのプロパティ

型:IAzureContextContainer
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Description

ギャラリー イメージ定義リソースの説明。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-DisallowedDiskType

許可されていないディスクの種類。

パラメーターのプロパティ

型:

String[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-EndOfLifeDate

ギャラリーイメージ定義の有効期間の終了日

パラメーターのプロパティ

型:DateTime
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Eula

ギャラリーイメージ定義の使用許諾契約書。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Feature

更新するギャラリー イメージ機能の一覧。 各機能には、StartsAtVersion プロパティを含め、それをサポートする最小ギャラリー イメージ バージョンを示すことができます。

パラメーターのプロパティ

型:

GalleryImageFeature[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-GalleryName

ギャラリーの名前。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

DefaultParameter
配置:1
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-InputObject

PS ギャラリー イメージ定義オブジェクト。

パラメーターのプロパティ

型:PSGalleryImage
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:GalleryImageDefinition

パラメーター セット

ObjectParameter
配置:0
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-MaximumMemory

推奨されるメモリの最大値

パラメーターのプロパティ

型:Int32
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-MaximumVCPU

推奨される CPU コアの最大値

パラメーターのプロパティ

型:Int32
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-MinimumMemory

推奨されるメモリの最小値

パラメーターのプロパティ

型:Int32
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-MinimumVCPU

推奨される CPU コアの最小値

パラメーターのプロパティ

型:Int32
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Name

ギャラリー イメージ定義の名前。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:GalleryImageDefinitionName

パラメーター セット

DefaultParameter
配置:2
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-PrivacyStatementUri

プライバシーに関する声明の URI。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-PurchasePlanName

購入プランの ID。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-PurchasePlanProduct

購入プランの製品 ID。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-PurchasePlanPublisher

購入プランの発行元 ID。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-ReleaseNoteUri

リリース ノート URI。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-ResourceGroupName

リソース グループの名前。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

DefaultParameter
配置:0
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-ResourceId

イメージ定義のリソース ID

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ResourceIdParameter
配置:0
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Tag

リソース タグ

パラメーターのプロパティ

型:Hashtable
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:wi

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、about_CommonParametersを参照してください。

入力

String

PSGalleryImage

DateTime

Hashtable

Int32

String

GalleryImageFeature

Boolean

出力

PSGalleryImage