Invoke-AzResourceAction

模組:

Az.Resources Module

呼叫資源上的動作。

語法

ByResourceId (預設值)

Invoke-AzResourceAction
    -Action <String>
    -ResourceId <String>
    [-Parameters <Hashtable>]
    [-ODataQuery <String>]
    [-Force]
    [-ApiVersion <String>]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

BySubscriptionLevel

Invoke-AzResourceAction
    -Action <String>
    -ResourceName <String>
    -ResourceType <String>
    [-Parameters <Hashtable>]
    [-ExtensionResourceName <String>]
    [-ExtensionResourceType <String>]
    [-ODataQuery <String>]
    [-ResourceGroupName <String>]
    [-Force]
    [-ApiVersion <String>]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByTenantLevel

Invoke-AzResourceAction
    -Action <String>
    -ResourceName <String>
    -ResourceType <String>
    [-Parameters <Hashtable>]
    [-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} 的虛擬機器。 此指令會指定 「力」 參數，因此不會提示您進行確認。

範例 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”。 此指令會指定 「力」 參數，因此不會提示您進行確認。

參數

-Action

指定要叫用的動作名稱。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	動作名稱

參數集

(All)

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ApiVersion

指定要使用的資源提供者 API 版本。 如果您未指定版本，此 Cmdlet 會使用最新的可用版本。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Confirm

在執行 Cmdlet 之前，提示您進行確認。

參數屬性

類型:	SwitchParameter
預設值:	False
支援萬用字元:	False
不要顯示:	False
別名:	參見

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-DefaultProfile

用來與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶

參數屬性

類型:	IAzureContextContainer
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	AzContext, AzureRmContext, AzureCredential

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ExtensionResourceName

指定此 Cmdlet 叫用動作之資源的延伸模組資源名稱。 例如，若要指定資料庫，請使用下列格式： 伺服器名稱/資料庫名稱

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

BySubscriptionLevel

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

ByTenantLevel

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-ExtensionResourceType

指定延伸模組資源的類型。 例如：Microsoft.Sql/Servers/Databases

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

BySubscriptionLevel

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

ByTenantLevel

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-Force

強制命令執行，而不要求使用者確認。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ODataQuery

指定開放資料通訊協定 （OData） 樣式篩選。 除了任何其他篩選條件之外，此 Cmdlet 還會將此值附加至要求。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Parameters

將參數指定為雜湊表，以供此 Cmdlet 叫用之動作使用。

參數屬性

類型:	Hashtable
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	物體

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Pre

指出此 Cmdlet 在自動決定要使用的版本時，會考慮發行前 API 版本。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ResourceGroupName

指定此 Cmdlet 叫用動作的資源群組名稱。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

BySubscriptionLevel

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-ResourceId

指定此 Cmdlet 叫用動作之資源的完整資源識別碼。 識別碼包含訂用帳戶，如下列範例所示： /subscriptions/訂用帳戶識別碼/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	身份識別碼

參數集

ByResourceId

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-ResourceName

指定此 Cmdlet 叫用動作之資源的資源名稱。 例如，若要指定資料庫，請使用下列格式： ContosoServer/ContosoDatabase

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	名稱

參數集

BySubscriptionLevel

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

ByTenantLevel

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-ResourceType

指定資源的類型。 例如，對於資料庫，資源類型如下： Microsoft.Sql/Servers/Databases

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

BySubscriptionLevel

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

ByTenantLevel

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-TenantLevel

表示此 Cmdlet 會在租用戶層級運作。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

ByTenantLevel

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。 指令未執行。

參數屬性

類型:	SwitchParameter
預設值:	False
支援萬用字元:	False
不要顯示:	False
別名:	威斯康辛

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

CommonParameters

此 cmdlet 支援常見參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。

輸入

String

輸出

PSObject