Set-AzResource
構文
ByResourceId (既定)
Set-AzResource
-ResourceId <String>
[-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
-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>]
BySubscriptionLevel
Set-AzResource
-ResourceName <String>
-ResourceType <String>
[-Kind <String>]
[-Properties <PSObject>]
[-Plan <Hashtable>]
[-Sku <Hashtable>]
[-Tag <Hashtable>]
[-UsePatchSemantics]
[-AsJob]
[-ExtensionResourceName <String>]
[-ExtensionResourceType <String>]
[-ODataQuery <String>]
[-ResourceGroupName <String>]
[-Force]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByTenantLevel
Set-AzResource
-ResourceName <String>
-ResourceType <String>
[-Kind <String>]
[-Properties <PSObject>]
[-Plan <Hashtable>]
[-Sku <Hashtable>]
[-Tag <Hashtable>]
[-UsePatchSemantics]
[-AsJob]
[-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
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-AsJob
バックグラウンドでコマンドレットを実行する
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
パラメーターのプロパティ
型: | IAzureContextContainer
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-ExtensionResourceName
リソースの拡張リソースの名前を指定します。
たとえば、データベースを指定するには、サーバー名/
データベース名の形式を使用します。
パラメーターのプロパティ
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
BySubscriptionLevel
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
ByTenantLevel
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-ExtensionResourceType
拡張機能リソースのリソースの種類を指定します。
たとえば、拡張機能リソースがデータベースの場合は、次のように指定します。 Microsoft.Sql/Servers/Databases
パラメーターのプロパティ
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
BySubscriptionLevel
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
ByTenantLevel
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-Force
ユーザーの確認を求めずにコマンドを強制的に実行します。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
更新するリソースのオブジェクト表現。
型: | PSResource
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
ByInputObject
配置: | Named |
必須: | True |
パイプラインからの値: | True |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-Kind
リソースのリソースの種類を指定します。
パラメーターのプロパティ
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-ODataQuery
Open Data Protocol (OData) スタイル フィルターを指定します。
このコマンドレットは、他のフィルターに加えて、この値を要求に追加します。
パラメーターのプロパティ
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-Plan
リソースのハッシュ テーブルとして、リソース プランのプロパティを指定します。
パラメーターのプロパティ
型: | Hashtable
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
Aliases: | PlanObject |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-Pre
このコマンドレットは、使用するバージョンを自動的に決定するときに、プレリリース API バージョンを考慮することを示します。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-Properties
リソースのリソース プロパティを指定します。
パラメーターのプロパティ
型: | PSObject
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
Aliases: | PropertyObject |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-ResourceGroupName
このコマンドレットがリソースを変更するリソース グループの名前を指定します。
パラメーターのプロパティ
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
BySubscriptionLevel
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-ResourceId
次の例のように、サブスクリプションを含む完全修飾リソース ID /subscriptions/
指定します。/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase
パラメーターのプロパティ
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
Aliases: | ID (アイディー) |
パラメーター セット
ByResourceId
配置: | Named |
必須: | True |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-ResourceName
リソースの名前を指定します。
たとえば、データベースを指定するには、次の形式を使用します。 ContosoServer/ContosoDatabase
パラメーターのプロパティ
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
Aliases: | 名前 |
パラメーター セット
BySubscriptionLevel
配置: | Named |
必須: | True |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
ByTenantLevel
配置: | Named |
必須: | True |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-ResourceType
リソースの種類を指定します。
たとえば、データベースの場合、リソースの種類は次のようになります。 Microsoft.Sql/Servers/Databases
パラメーターのプロパティ
型: | String
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
パラメーター セット
BySubscriptionLevel
配置: | Named |
必須: | True |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
ByTenantLevel
配置: | Named |
必須: | True |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-Sku
リソースの SKU オブジェクトをハッシュ テーブルとして指定します。
パラメーターのプロパティ
型: | Hashtable
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
Aliases: | SkuObject |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-Tag
ハッシュ テーブルの形式のキーと値のペア。 例: @{key0="value0";key1=$null;key2="value2"}
パラメーターのプロパティ
型: | Hashtable
|
規定値: | None |
ワイルドカードのサポート: | False |
DontShow: | False |
Aliases: | タグ |
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | True |
残りの引数からの値: | False |
-TenantLevel
このコマンドレットがテナント レベルで動作することを示します。
パラメーターのプロパティ
パラメーター セット
ByTenantLevel
配置: | Named |
必須: | True |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-UsePatchSemantics
このコマンドレットが HTTP PUT ではなく HTTP PATCH を使用してオブジェクトを更新することを示します。
パラメーターのプロパティ
パラメーター セット
(All)
配置: | Named |
必須: | False |
パイプラインからの値: | False |
プロパティ名別のパイプラインからの値: | False |
残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
型: | SwitchParameter
|
規定値: | False |
ワイルドカードのサポート: | 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を参照してください。
出力