Invoke-AzResourceAction

Référence

Module:: Az.Resources

Appelle une action sur une ressource.

Syntaxe

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

L’applet de commande Invoke-AzResourceAction appelle une action sur une ressource Azure spécifiée. Pour obtenir la liste des actions prises en charge, utilisez l’outil Azure Resource Explorer.

Exemples

Exemple 1 : Appeler le démarrage d’une machine virtuelle avec 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

Cette commande démarre la machine virtuelle avec {ResourceId}.

Exemple 2 : Appeler le poweroffing d’une machine virtuelle avec ResourceName

Invoke-AzResourceAction -ResourceGroupName testGroup -ResourceName testVM -ResourceType Microsoft.Compute/virtualMachines/ -Action Poweroff -Force

Cette commande arrête la machine virtuelle avec {ResourceId}. La commande spécifie le paramètre Force , par conséquent, il ne vous invite pas à confirmer.

Exemple 3 : Appeler l’inscription d’un fournisseur de ressources avec 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

Cette commande inscrit un fournisseur de ressources « Microsoft.Network ». La commande spécifie le paramètre Force , par conséquent, il ne vous invite pas à confirmer.

Paramètres

-Action

Spécifie le nom de l’action à appeler.

Type:	String
Alias:	ActionName
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-ApiVersion

Spécifie la version de l’API du fournisseur de ressources à utiliser. Si vous ne spécifiez pas de version, cette applet de commande utilise la dernière version disponible.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

Type:	SwitchParameter
Alias:	cf
Position:	Named
Valeur par défaut:	False
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure

Type:	IAzureContextContainer
Alias:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-ExtensionResourceName

Spécifie le nom d’une ressource d’extension pour la ressource sur laquelle cette applet de commande appelle une action. Par exemple, pour spécifier une base de données, utilisez le format suivant : nom de la base de données de nom/de serveur

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-ExtensionResourceType

Spécifie le type de la ressource d’extension. Par exemple : Microsoft.Sql/Servers/Databases

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-Force

Force l’exécution de la commande sans demander la confirmation de l’utilisateur.

Type:	SwitchParameter
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-ODataQuery

Spécifie un filtre de style OData (Open Data Protocol). Cette applet de commande ajoute cette valeur à la demande en plus des autres filtres.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Parameters

Spécifie les paramètres, en tant que table de hachage, pour l’action appelée par cette applet de commande.

Type:	Hashtable
Alias:	Object
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Pre

Indique que cette applet de commande prend en compte les versions d’API en préversion lorsqu’elle détermine automatiquement la version à utiliser.

Type:	SwitchParameter
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-ResourceGroupName

Spécifie le nom d’un groupe de ressources dans lequel cette applet de commande appelle une action.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-ResourceId

Spécifie l’ID de ressource complet de la ressource sur laquelle cette applet de commande appelle une action. L’ID inclut l’abonnement, comme dans l’exemple suivant : /subscriptions/ID d’abonnement/providers/Microsoft.Sql/servers/ContosoServer/databases/ContosoDatabase

Type:	String
Alias:	Id
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-ResourceName

Spécifie le nom de la ressource sur laquelle cette applet de commande appelle une action. Par exemple, pour spécifier une base de données, utilisez le format suivant : ContosoServer/ContosoDatabase

Type:	String
Alias:	Name
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-ResourceType

Spécifie le type de la ressource. Par exemple, pour une base de données, le type de ressource est le suivant : Microsoft.Sql/Servers/Databases

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-TenantLevel

Indique que cette applet de commande fonctionne au niveau du locataire.

Type:	SwitchParameter
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:	SwitchParameter
Alias:	wi
Position:	Named
Valeur par défaut:	False
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

Entrées

String

Sorties

PSObject

Partager via