Invoke-​Azure​Rm​Resource​Action

Invokes an action on a resource.

Syntax

Invoke-AzureRmResourceAction
      -Action <String>
      [-ApiVersion <String>]
      [-ExtensionResourceName <String>]
      [-ExtensionResourceType <String>]
      [-Force]
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      [-ODataQuery <String>]
      [-Parameters <Hashtable>]
      [-Pre]
      [-ResourceGroupName <String>]
      -ResourceName <String>
      -ResourceType <String>
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Invoke-AzureRmResourceAction
      -Action <String>
      [-ApiVersion <String>]
      [-ExtensionResourceName <String>]
      [-ExtensionResourceType <String>]
      [-Force]
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      [-ODataQuery <String>]
      [-Parameters <Hashtable>]
      [-Pre]
      -ResourceName <String>
      -ResourceType <String>
      [-TenantLevel]
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]
Invoke-AzureRmResourceAction
      -Action <String>
      [-ApiVersion <String>]
      [-Force]
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      [-ODataQuery <String>]
      [-Parameters <Hashtable>]
      [-Pre]
      -ResourceId <String>
      [-Confirm]
      [-WhatIf]
      [<CommonParameters>]

Description

The Invoke-AzureRmResourceAction cmdlet invokes an action on a specified Azure resource.

To get a list of supported actions, use the Azure Resource Explorer tool.

Examples

1:

Required Parameters

-Action

Specifies the name of the action to invoke.

Type:String
Aliases:ActionName
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceId

Specifies the fully qualified resource ID of the resource on which this cmdlet invokes an action. The ID includes the subscription, as in the following example:

/subscriptions/subscription ID/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase

Type:String
Aliases:Id
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceName

Specifies the name of the resource of the resource on which this cmdlet invokes an action. For instance, to specify a database, use the following format:

ContosoServer/ContosoDatabase

Type:String
Aliases:Name
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceType

Specifies the type of the resource. For instance, for a database, the resource type is as follows:

Microsoft.Sql/Servers/Databases

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-TenantLevel

Indicates that this cmdlet operates at the tenant level.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-ApiVersion

Specifies the version of the resource provider API to use. If you do not specify a version, this cmdlet uses the latest available version.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-ExtensionResourceName

Specifies the name of an extension resource for the resource on which this cmdlet invokes an action. For instance, to specify a database, use the following format:

server name/database name

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ExtensionResourceType

Specifies the type of the extension resource. For instance:

Microsoft.Sql/Servers/Databases

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ODataQuery

Specifies an Open Data Protocol (OData) style filter. This cmdlet appends this value to the request in addition to any other filters.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Parameters

Specifies parameters, as a hash table, for the action that this cmdlet invokes.

Type:Hashtable
Aliases:Object
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Pre

Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceGroupName

Specifies the name of a resource group in which this cmdlet invokes an action.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False