你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Invoke-AzResourceAction

对资源调用操作。

语法

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>]

说明

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
默认值: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
别名:cf

参数集

(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 调用作的资源的完全限定资源 ID。 ID 包括订阅,如以下示例所示: /subscriptions/订阅 ID/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False
别名:Id

参数集

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