Set-AzResource

リファレンス

モジュール:: Az.Resources

リソースを変更します。

構文

Set-AzResource
   [-Kind <String>]
   [-Properties <PSObject>]
   [-Plan <Hashtable>]
   [-Sku <Hashtable>]
   [-Tag <Hashtable>]
   [-UsePatchSemantics]
   [-AsJob]
   -ResourceId <String>
   [-ODataQuery <String>]
   [-Force]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzResource
   -InputObject <PSResource>
   [-Kind <String>]
   [-Properties <PSObject>]
   [-Plan <Hashtable>]
   [-Sku <Hashtable>]
   [-Tag <Hashtable>]
   [-UsePatchSemantics]
   [-AsJob]
   [-ODataQuery <String>]
   [-Force]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzResource
   [-Kind <String>]
   [-Properties <PSObject>]
   [-Plan <Hashtable>]
   [-Sku <Hashtable>]
   [-Tag <Hashtable>]
   [-UsePatchSemantics]
   [-AsJob]
   -ResourceName <String>
   -ResourceType <String>
   [-ExtensionResourceName <String>]
   [-ExtensionResourceType <String>]
   [-ODataQuery <String>]
   [-ResourceGroupName <String>]
   [-Force]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzResource
   [-Kind <String>]
   [-Properties <PSObject>]
   [-Plan <Hashtable>]
   [-Sku <Hashtable>]
   [-Tag <Hashtable>]
   [-UsePatchSemantics]
   [-AsJob]
   -ResourceName <String>
   -ResourceType <String>
   [-ExtensionResourceName <String>]
   [-ExtensionResourceType <String>]
   [-ODataQuery <String>]
   [-TenantLevel]
   [-Force]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzResource コマンドレットは、既存の Azure リソースを変更します。名前と種類または ID で変更するリソースを指定します。

例

例 1: リソースを変更する

$Resource = Get-AzResource -ResourceType Microsoft.Web/sites -ResourceGroupName ResourceGroup11 -ResourceName ContosoSite
$Resource.Properties.Enabled = "False"
$Resource | Set-AzResource -Force

最初のコマンドは、Get-AzResource コマンドレットを使用して ContosoSite という名前のリソースを取得し、$Resource変数に格納します。 2 番目のコマンドは、$Resourceのプロパティを変更します。最後のコマンドは、$Resourceに一致するようにリソースを更新します。

例 2: 特定のリソースグループ内のすべてのリソースを変更する

$Resource = Get-AzResource -ResourceGroupName testrg
$Resource | ForEach-Object { $_.Tags.Add("testkey", "testval") }
$Resource | Set-AzResource -Force

Name              : kv-test
ResourceId        : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.KeyVault/vaults/kv-test
ResourceName      : kv-test
ResourceType      : Microsoft.KeyVault/vaults
ResourceGroupName : testrg
Location          : westus
SubscriptionId    : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Tags              : {testrgkey, key}
Properties        : @{}

Name              : testresource
ResourceId        : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Providers.Test/statefulResources/testresource
ResourceName      : testresource
ResourceType      : Providers.Test/statefulResources
ResourceGroupName : testrg
Location          : West US 2
SubscriptionId    : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Tags              : {testrgkey, anothertesttag}
Properties        : @{key=value}
Sku               : @{name=A0}

最初のコマンドは、testrg リソースグループ内のリソースを取得し、$Resource変数に格納します。

2 番目のコマンドは、リソースグループ内のこれらの各リソースを反復処理し、それらに新しいタグを追加します。

最後のコマンドは、これらの各リソースを更新します。

パラメーター

-ApiVersion

使用するリソースプロバイダー API のバージョンを指定します。バージョンを指定しない場合、このコマンドレットは使用可能な最新バージョンを使用します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-AsJob

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

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

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

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

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

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ExtensionResourceName

リソースの拡張リソースの名前を指定します。たとえば、データベースを指定するには、次の形式を使用します。サーバー名/データベース名

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ExtensionResourceType

拡張機能リソースのリソースの種類を指定します。たとえば、拡張機能リソースがデータベースの場合は、次のように指定します Microsoft.Sql/Servers/Databases

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Force

ユーザーの確認を求めずにコマンドを強制的に実行します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

更新するリソースのオブジェクト表現。

型:	PSResource
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Kind

リソースのリソースの種類を指定します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ODataQuery

Open Data Protocol (OData) スタイルフィルターを指定します。このコマンドレットは、他のフィルターに加えて、この値を要求に追加します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Plan

リソースのハッシュテーブルとして、リソースプランのプロパティを指定します。

型:	Hashtable
Aliases:	PlanObject
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Pre

このコマンドレットは、使用するバージョンを自動的に決定するときに、プレリリース API バージョンを考慮することを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Properties

リソースのリソースプロパティを指定します。

型:	PSObject
Aliases:	PropertyObject
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ResourceGroupName

このコマンドレットがリソースを変更するリソースグループの名前を指定します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ResourceId

次の例のように、サブスクリプションを含む完全修飾リソース ID を指定します。サブスクリプション ID /subscriptions//providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase

型:	String
Aliases:	Id
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ResourceName

リソースの名前を指定します。たとえば、データベースを指定するには、次の形式を使用します。ContosoServer/ContosoDatabase

型:	String
Aliases:	Name
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ResourceType

リソースの種類を指定します。たとえば、データベースの場合、リソースの種類は次のようになります。Microsoft.Sql/Servers/Databases

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Sku

リソースの SKU オブジェクトをハッシュテーブルとして指定します。

型:	Hashtable
Aliases:	SkuObject
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Tag

ハッシュテーブルの形式のキーと値のペア。例: @{key0="value0";key1=$null;key2="value2"}

型:	Hashtable
Aliases:	Tags
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-TenantLevel

このコマンドレットがテナントレベルで動作することを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-UsePatchSemantics

このコマンドレットが HTTP PUT ではなく HTTP PATCH を使用してオブジェクトを更新することを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

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

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

PSResource

String

PSObject

Hashtable

出力

PSObject

次の方法で共有

Set-AzResource

構文

説明

例

例 1: リソースを変更する

例 2: 特定のリソースグループ内のすべてのリソースを変更する

パラメーター

-ApiVersion

-AsJob

-Confirm

-DefaultProfile

-ExtensionResourceName

-ExtensionResourceType

-Force

-InputObject

-Kind

-ODataQuery

-Plan

-Pre

-Properties

-ResourceGroupName

-ResourceId

-ResourceName

-ResourceType

-Sku

-Tag

-TenantLevel

-UsePatchSemantics

-WhatIf

入力

出力

その他のリソース

次の方法で共有

Set-AzResource

構文

説明

例

例 1: リソースを変更する

例 2: 特定のリソース グループ内のすべてのリソースを変更する

パラメーター

-ApiVersion

-AsJob

-Confirm

-DefaultProfile

-ExtensionResourceName

-ExtensionResourceType

-Force

-InputObject

-Kind

-ODataQuery

-Plan

-Pre

-Properties

-ResourceGroupName

-ResourceId

-ResourceName

-ResourceType

-Sku

-Tag

-TenantLevel

-UsePatchSemantics

-WhatIf

入力

出力

関連リンク

その他のリソース

例 2: 特定のリソースグループ内のすべてのリソースを変更する