Update-AzGallery

モジュール:

Az.Compute Module

ギャラリーを更新します。

構文

DefaultParameter (既定)

Update-AzGallery
    [-ResourceGroupName] <String>
    [-Name] <String>
    [-AsJob]
    [-Description <String>]
    [-Tag <Hashtable>]
    [-Permission <String>]
    [-Subscription <String[]>]
    [-Tenant <String[]>]
    [-RemoveSubscription <String[]>]
    [-RemoveTenant <String[]>]
    [-Share]
    [-Community]
    [-Reset]
    [-PublisherUri <String>]
    [-PublisherContact <String>]
    [-Eula <String>]
    [-PublicNamePrefix <String>]
    [-EnableSystemAssignedIdentity]
    [-DisableSystemAssignedIdentity]
    [-UserAssignedIdentity <String[]>]
    [-RemoveUserAssignedIdentity <String[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ResourceIdParameter

Update-AzGallery
    [-ResourceId] <String>
    [-AsJob]
    [-Description <String>]
    [-Tag <Hashtable>]
    [-Permission <String>]
    [-Subscription <String[]>]
    [-Tenant <String[]>]
    [-RemoveSubscription <String[]>]
    [-RemoveTenant <String[]>]
    [-Share]
    [-Community]
    [-Reset]
    [-PublisherUri <String>]
    [-PublisherContact <String>]
    [-Eula <String>]
    [-PublicNamePrefix <String>]
    [-EnableSystemAssignedIdentity]
    [-DisableSystemAssignedIdentity]
    [-UserAssignedIdentity <String[]>]
    [-RemoveUserAssignedIdentity <String[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ObjectParameter

Update-AzGallery
    [-InputObject] <PSGallery>
    [-AsJob]
    [-Description <String>]
    [-Tag <Hashtable>]
    [-Permission <String>]
    [-Subscription <String[]>]
    [-Tenant <String[]>]
    [-RemoveSubscription <String[]>]
    [-RemoveTenant <String[]>]
    [-Share]
    [-Community]
    [-Reset]
    [-PublisherUri <String>]
    [-PublisherContact <String>]
    [-Eula <String>]
    [-PublicNamePrefix <String>]
    [-EnableSystemAssignedIdentity]
    [-DisableSystemAssignedIdentity]
    [-UserAssignedIdentity <String[]>]
    [-RemoveUserAssignedIdentity <String[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

ギャラリーを更新します。

例

例 1

Update-AzGallery -ResourceGroupName $rgname -Name $galleryName -Description $galleryDescription

ギャラリーを更新します。

例 2

Update-AzGallery -ResourceGroupName $rgname -Name $galleryName -Permission Groups -Share -Tenant xxxxxxxx-xxx-xxxxxxx,zzzzzz-zzzzzzz-zzzzzz

共有するギャラリーを更新し、共有する 2 つのサブスクリプションを追加します。

例 3

Update-AzGallery -ResourceGroupName $rgname -Name $galleryName -EnableSystemAssignedIdentity

ギャラリーを更新して、システム割り当てマネージド ID を有効にします。

例 4

$uid = Get-AzUserAssignedIdentity -ResourceGroupName $rgname -Name $identityName
Get-AzGallery -ResourceGroupName $rgname -Name $galleryName | Update-AzGallery -UserAssignedIdentity $uid.Id

パイプライン入力を使用してユーザー割り当てマネージド ID を追加するようにギャラリーを更新します。

例 5

$uid1 = (Get-AzUserAssignedIdentity -ResourceGroupName $rgname -Name $identityName1).Id
$uid2 = (Get-AzUserAssignedIdentity -ResourceGroupName $rgname -Name $identityName2).Id
Update-AzGallery -ResourceGroupName $rgname -Name $galleryName -UserAssignedIdentity @($uid1, $uid2)

ギャラリーを更新して、指定された 2 つのユーザー割り当てマネージド ID を追加します。 これらは、以前に割り当てられた ID に追加されます。

例 6

Update-AzGallery -ResourceGroupName $rgname -Name $galleryName -DisableSystemAssignedIdentity

ギャラリーを更新して、システム割り当てマネージド ID を無効にします。

例 7

Update-AzGallery -ResourceGroupName $rgname -Name $galleryName -RemoveUserAssignedIdentity "All"

ギャラリーを更新して、ユーザー割り当てマネージド ID をすべて削除します。

例 8

$uid = (Get-AzUserAssignedIdentity -ResourceGroupName $rgname -Name $identityName).Id
Update-AzGallery -ResourceGroupName $rgname -Name $galleryName -RemoveUserAssignedIdentity @($uid)

ギャラリーを更新して、特定のユーザー割り当てマネージド ID を削除します。

パラメーター

-AsJob

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

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

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

パラメーター セット

(All)

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

-Community

ギャラリーの共有プロファイルをコミュニティに更新します。

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

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

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	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

-DisableSystemAssignedIdentity

ギャラリーでシステム割り当てマネージド ID を無効にします。 -EnableSystemAssignedIdentity と一緒に使用することはできません。

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

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

パラメーター セット

(All)

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

-EnableSystemAssignedIdentity

ギャラリーでシステム割り当てマネージド ID を有効にします。 -DisableSystemAssignedIdentity と一緒に使用することはできません。

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

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

パラメーター セット

(All)

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

-Eula

コミュニティ ギャラリー イメージのエンドユーザー ライセンス契約を取得または設定します。

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

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

パラメーター セット

(All)

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

-InputObject

PS ギャラリー オブジェクト。

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

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

パラメーター セット

ObjectParameter

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

-Name

ギャラリーの名前。

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

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

パラメーター セット

DefaultParameter

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

-Permission

このプロパティを使用すると、共有ギャラリーのアクセス許可を指定できます。 使用可能な値は、'Private' と 'Groups' です。

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

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

パラメーター セット

(All)

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

-PublicNamePrefix

一般に表示されるギャラリー名のプレフィックスを取得または設定します。 すべてのユーザーに表示されます。

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

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

パラメーター セット

(All)

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

-PublisherContact

コミュニティ ギャラリーの発行元サポートメールを取得または設定します。 発行元の電子メール アドレス。 すべてのユーザーに表示されます。

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

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

パラメーター セット

(All)

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

-PublisherUri

パブリッシャー Web サイトへのリンクを取得または設定します。 すべてのユーザーに表示されます。

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

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

パラメーター セット

(All)

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

-RemoveSubscription

ギャラリーが共有を停止するサブスクリプション ID の一覧。

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

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

パラメーター セット

(All)

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

-RemoveTenant

ギャラリーが共有を停止するテナント ID の一覧。

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

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

パラメーター セット

(All)

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

-RemoveUserAssignedIdentity

ギャラリーから削除するユーザー割り当てマネージド ID リソース ID の一覧。 または、[すべて] を指定して、ユーザー割り当て ID をすべて削除します。 'All' が指定されている場合、-RemoveUserAssignedIdentity 内の唯一の値である必要があり、'All' を使用すると、すべてのユーザー割り当て ID が削除されます。 -UserAssignedIdentity と共に 'All' を使用することはできません。

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

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

パラメーター セット

(All)

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

-Reset

ギャラリーの共有アクセス許可を "プライベート" にリセットします。

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

型:	SwitchParameter
規定値:	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

-Share

ギャラリーの共有プロファイルを更新します。

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

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

パラメーター セット

(All)

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

-Subscription

ギャラリーが共有を目的としているサブスクリプション ID の一覧。

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

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

パラメーター セット

(All)

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

-Tag

リソース タグ

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

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

パラメーター セット

(All)

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

-Tenant

ギャラリーの共有先となるテナント ID の一覧。

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

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

パラメーター セット

(All)

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

-UserAssignedIdentity

ギャラリーに追加するユーザー割り当てマネージド ID リソース ID の一覧。 ID は、既存のユーザー割り当て ID に追加されます。 '-RemoveUserAssignedIdentity All' と一緒に使用することはできません。 リソース ID は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft の形式です。ManagedIdentity/userAssignedIdentities/{identityName}'。

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

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

パラメーター セット

(All)

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

-WhatIf

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

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

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
Aliases:	ウィスコンシン

パラメーター セット

(All)

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

CommonParameters

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

入力

String

PSGallery

Hashtable

String

出力

PSGallery