Invoke-AzResourceAction
リソースに対するアクションを呼び出します。
構文
Invoke-AzResourceAction
[-Parameters <Hashtable>]
-Action <String>
-ResourceId <String>
[-ODataQuery <String>]
[-Force]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Invoke-AzResourceAction
[-Parameters <Hashtable>]
-Action <String>
-ResourceName <String>
-ResourceType <String>
[-ExtensionResourceName <String>]
[-ExtensionResourceType <String>]
[-ODataQuery <String>]
[-ResourceGroupName <String>]
[-Force]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Invoke-AzResourceAction
[-Parameters <Hashtable>]
-Action <String>
-ResourceName <String>
-ResourceType <String>
[-ExtensionResourceName <String>]
[-ExtensionResourceType <String>]
[-ODataQuery <String>]
[-TenantLevel]
[-Force]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Invoke-AzResourceAction コマンドレットは、指定した Azure リソースに対してアクションを呼び出します。 サポートされているアクションの一覧を取得するには、Azure Resource Explorer ツールを使用します。
例
例 1: ResourceId を使用して VM の起動を呼び出す
Invoke-AzResourceAction -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testVM -Action start
Confirm
Are you sure you want to invoke the 'start' action on the following resource: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testVM
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y
このコマンドは、{ResourceId} を使用して仮想マシンを起動します。
例 2: ResourceName を使用して VM の電源オフを呼び出す
Invoke-AzResourceAction -ResourceGroupName testGroup -ResourceName testVM -ResourceType Microsoft.Compute/virtualMachines/ -Action Poweroff -Force
このコマンドは、{ResourceId} を使用して仮想マシンを停止します。 このコマンドは、 Force パラメーターを指定するため、確認を求めるメッセージは表示されません。
例 3: ResourceId を使用してリソース プロバイダーの登録を呼び出す
Invoke-AzResourceAction -ResourceId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Network -action register -Force
id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Network
namespace : Microsoft.Network
authorizations : {…}
resourceTypes : {@{resourceType=virtualNetworks; locations=System.Object[]; apiVersions=System.Object[]},
@{resourceType=publicIPAddresses; locations=System.Object[]; apiVersions=System.Object[]},
@{resourceType=networkInterfaces; locations=System.Object[]; apiVersions=System.Object[]},
@{resourceType=privateEndpoints; locations=System.Object[]; apiVersions=System.Object[]}…}
registrationState : Registered
このコマンドは、リソース プロバイダー "Microsoft.Network" を登録します。 このコマンドは、 Force パラメーターを指定するため、確認を求めるメッセージは表示されません。
パラメーター
-Action
呼び出すアクションの名前を指定します。
型: | String |
Aliases: | ActionName |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ApiVersion
使用するリソース プロバイダー API のバージョンを指定します。 バージョンを指定しない場合、このコマンドレットは使用可能な最新バージョンを使用します。
型: | String |
配置: | 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 |
-ODataQuery
Open Data Protocol (OData) スタイル フィルターを指定します。 このコマンドレットは、他のフィルターに加えて、この値を要求に追加します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Parameters
このコマンドレットが呼び出すアクションのパラメーターをハッシュ テーブルとして指定します。
型: | Hashtable |
Aliases: | Object |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Pre
このコマンドレットは、使用するバージョンを自動的に決定するときに、プレリリース API バージョンを考慮することを示します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ResourceGroupName
このコマンドレットがアクションを呼び出すリソース グループの名前を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ResourceId
このコマンドレットがアクションを呼び出すリソースの完全修飾リソース ID を指定します。
ID には、次の例のようにサブスクリプションが含まれます: /subscriptions/
サブスクリプション ID/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 |
-TenantLevel
このコマンドレットがテナント レベルで動作することを示します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
出力
Azure PowerShell