Invoke-AzResourceAction
Invoca uma ação em um recurso.
Sintaxe
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
O cmdlet Invoke-AzResourceAction invoca uma ação em um recurso especificado do Azure. Para obter uma lista de ações com suporte, use a ferramenta Azure Resource Explorer.
Exemplos
Exemplo 1: Invocar a inicialização de uma VM com ResourceId
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
Esse comando inicia a Máquina Virtual com {ResourceId}.
Exemplo 2: Invocar o desligamento de uma VM com ResourceName
Invoke-AzResourceAction -ResourceGroupName testGroup -ResourceName testVM -ResourceType Microsoft.Compute/virtualMachines/ -Action Poweroff -Force
Esse comando interrompe a máquina virtual com {ResourceId}. O comando especifica o parâmetro Force, portanto, ele não solicita confirmação.
Exemplo 3: Invocar o registro de um provedor de recursos com 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
Esse comando registra um provedor de recursos "Microsoft.Network". O comando especifica o parâmetro Force, portanto, ele não solicita confirmação.
Parâmetros
-Action
Especifica o nome da ação a ser invocada.
Tipo: | String |
Aliases: | ActionName |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ApiVersion
Especifica a versão da API do provedor de recursos a ser usada. Se você não especificar uma versão, esse cmdlet usará a versão mais recente disponível.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Tipo: | SwitchParameter |
Aliases: | cf |
Cargo: | Named |
Valor padrão: | False |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usadas para comunicação com o Azure
Tipo: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ExtensionResourceName
Especifica o nome de um recurso de extensão para o recurso no qual esse cmdlet invoca uma ação.
Por exemplo, para especificar um banco de dados, use o seguinte formato: nome/
do servidor nome do banco de dados
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-ExtensionResourceType
Especifica o tipo do recurso de extensão.
Por exemplo: Microsoft.Sql/Servers/Databases
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-Force
Força o comando a ser executado sem solicitar a confirmação do usuário.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ODataQuery
Especifica um filtro de estilo OData (Open Data Protocol). Esse cmdlet acrescenta esse valor à solicitação, além de quaisquer outros filtros.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Parameters
Especifica parâmetros, como uma tabela de hash, para a ação que esse cmdlet invoca.
Tipo: | Hashtable |
Aliases: | Object |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-Pre
Indica que esse cmdlet considera versões de API de pré-lançamento quando determina automaticamente qual versão usar.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-ResourceGroupName
Especifica o nome de um grupo de recursos no qual esse cmdlet invoca uma ação.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-ResourceId
Especifica a ID de recurso totalmente qualificada do recurso no qual esse cmdlet invoca uma ação.
A ID inclui a assinatura, como no exemplo a seguir: /subscriptions/
ID da assinatura/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase
Tipo: | String |
Aliases: | Id |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-ResourceName
Especifica o nome do recurso do recurso no qual esse cmdlet invoca uma ação.
Por exemplo, para especificar um banco de dados, use o seguinte formato: ContosoServer/ContosoDatabase
Tipo: | String |
Aliases: | Name |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-ResourceType
Especifica o tipo do recurso.
Por exemplo, para um banco de dados, o tipo de recurso é o seguinte: Microsoft.Sql/Servers/Databases
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | True |
Aceitar caracteres curinga: | False |
-TenantLevel
Indica que esse cmdlet opera no nível do locatário.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | True |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Tipo: | SwitchParameter |
Aliases: | wi |
Cargo: | Named |
Valor padrão: | False |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Entradas
Saídas
Azure PowerShell