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>]
Description
Invoke-AzResourceAction Cmdlet 會在指定的 Azure 資源上叫用動作。 若要取得支持的動作清單,請使用 Azure 資源總管工具。
範例
範例 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 |
別名: | ActionName |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | False |
接受萬用字元: | False |
-ApiVersion
指定要使用的資源提供者 API 版本。 如果您未指定版本,此 Cmdlet 會使用最新的可用版本。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-Confirm
在執行 Cmdlet 之前,提示您進行確認。
類型: | SwitchParameter |
別名: | cf |
Position: | Named |
預設值: | False |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-DefaultProfile
用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶
類型: | IAzureContextContainer |
別名: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-ExtensionResourceName
指定此 Cmdlet 叫用動作之資源的擴充資源名稱。
例如,若要指定資料庫,請使用下列格式:伺服器名稱/
資料庫名稱
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-ExtensionResourceType
指定延伸模組資源的類型。
例如:Microsoft.Sql/Servers/Databases
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-Force
強制命令執行,而不要求使用者確認。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-ODataQuery
指定開放式數據通訊協定 (OData) 樣式篩選。 除了任何其他篩選之外,此 Cmdlet 也會將此值附加至要求。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-Parameters
針對這個 Cmdlet 叫用的動作,指定參數做為哈希表。
類型: | Hashtable |
別名: | Object |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-Pre
指出此 Cmdlet 會在自動判斷要使用的版本時,考慮發行前版本 API 版本。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-ResourceGroupName
指定此 Cmdlet 叫用動作的資源群組名稱。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-ResourceId
指定此 Cmdlet 叫用動作之資源的完整資源識別碼。
標識元包含訂用帳戶,如下列範例所示:/subscriptions/
訂用帳戶標識碼/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase
類型: | String |
別名: | Id |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-ResourceName
指定此 Cmdlet 叫用動作之資源的資源名稱。
例如,若要指定資料庫,請使用下列格式:ContosoServer/ContosoDatabase
類型: | String |
別名: | Name |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-ResourceType
指定資源的類型。
例如,針對資料庫,資源類型如下所示:Microsoft.Sql/Servers/Databases
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-TenantLevel
表示此 Cmdlet 會在租用戶層級運作。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | False |
接受萬用字元: | False |
-WhatIf
顯示 Cmdlet 執行時會發生什麼事。 Cmdlet 未執行。
類型: | SwitchParameter |
別名: | wi |
Position: | Named |
預設值: | False |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |