Remove-AzResource
構文
ByResourceId (既定)
Remove-AzResource
-ResourceId <String>
[-AsJob]
[-ODataQuery <String>]
[-Force]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
BySubscriptionLevel
Remove-AzResource
-ResourceName <String>
-ResourceType <String>
[-AsJob]
[-ExtensionResourceName <String>]
[-ExtensionResourceType <String>]
[-ODataQuery <String>]
[-ResourceGroupName <String>]
[-Force]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByTenantLevel
Remove-AzResource
-ResourceName <String>
-ResourceType <String>
[-AsJob]
[-ExtensionResourceName <String>]
[-ExtensionResourceType <String>]
[-ODataQuery <String>]
[-TenantLevel]
[-Force]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Remove-AzResource コマンドレットは、Azure リソースを削除します。
例
例 1: Web サイト リソースを削除する
Remove-AzResource -ResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup11/providers/Microsoft.Web/sites/ContosoSite" -Force
このコマンドを実行すると、ContosoSite という名前の Web サイト リソースが削除されます。
この例では、サブスクリプション ID にプレースホルダー値を使用します。
このコマンドは Force パラメーターを指定します。
そのため、確認を求めるメッセージは表示されません。
パラメーター
-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
-ODataQuery
Open Data Protocol (OData) スタイル フィルターを指定します。
このコマンドレットは、他のフィルターに加えて、この値を要求に追加します。
パラメーターのプロパティ
型: String
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-Pre
このコマンドレットは、使用するバージョンを自動的に決定するときに、プレリリース API バージョンを考慮することを示します。
パラメーターのプロパティ
パラメーター セット
(All)
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: False
残りの引数からの値: False
-ResourceGroupName
このコマンドレットがリソースを削除するリソース グループの名前を指定します。
パラメーターのプロパティ
型: String
規定値: None
ワイルドカードのサポート: False
DontShow: False
パラメーター セット
BySubscriptionLevel
配置: Named
必須: False
パイプラインからの値: False
プロパティ名別のパイプラインからの値: True
残りの引数からの値: False
-ResourceId
このコマンドレットが削除するリソースの完全修飾リソース ID を指定します。
ID には、次の例のようにサブスクリプションが含まれます: /subscriptions/サブスクリプション ID/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
-TenantLevel
このコマンドレットがテナント レベルで動作することを示します。
パラメーターのプロパティ
パラメーター セット
ByTenantLevel
配置: Named
必須: True
パイプラインからの値: 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 を参照してください。
出力