Export-AzResourceGroup

  • Référence
Module:
Az.Resources

Capture un groupe de ressources en tant que modèle et l’enregistre dans un fichier.

Syntaxe

Export-AzResourceGroup
      -ResourceGroupName <String>
      [-Path <String>]
      [-IncludeParameterDefaultValue]
      [-IncludeComments]
      [-SkipResourceNameParameterization]
      [-SkipAllParameterization]
      [-Resource <String[]>]
      [-Force]
      [-ApiVersion <String>]
      [-Pre]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

L’applet de commande Export-AzResourceGroup capture le groupe de ressources spécifié en tant que modèle et l’enregistre dans un fichier JSON. Cela peut être utile dans les scénarios où vous avez déjà créé certaines ressources dans votre groupe de ressources, puis souhaitez tirer parti des avantages de l’utilisation de déploiements soutenus par modèle. Cette applet de commande vous offre un démarrage simple en générant le modèle pour vos ressources existantes dans le groupe de ressources. Il peut arriver que cette applet de commande ne génère pas certaines parties du modèle. Les messages d’avertissement vous informent des ressources qui ont échoué. Le modèle sera toujours généré pour les parties qui ont réussi.

Exemples

Exemple 1 : Exporter un groupe de ressources

Export-AzResourceGroup -ResourceGroupName "TestGroup"

Cette commande capture le groupe de ressources nommé TestGroup en tant que modèle et l’enregistre dans un fichier JSON dans le répertoire actif.

Exemple 2 : Exporter une seule ressource à partir d’un groupe de ressources

Export-AzResourceGroup -ResourceGroupName "TestGroup" -Resource "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Compute/virtualMachines/TestVirtualMachine"

Cette commande capture la ressource de machine virtuelle nommée « TestVirtualMachine » à partir du groupe de ressources « TestGroup » en tant que modèle et l’enregistre dans un fichier JSON dans le répertoire actif.

Exemple 3 : Exporter une sélection de ressources à partir d’un groupe de ressources

Export-AzResourceGroup -ResourceGroupName "TestGroup" -SkipAllParameterization -Resource @(
  "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Compute/virtualMachines/TestVm",
  "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Network/networkInterfaces/TestNic"
)

Cette commande capture deux ressources à partir du groupe de ressources « TestGroup » en tant que modèle et l’enregistre dans un fichier JSON dans le répertoire actif. Le modèle généré ne contient aucun paramètre généré.

Paramètres

-ApiVersion

Spécifie la version de l’API du fournisseur de ressources à utiliser. Si elle n’est pas spécifiée, la dernière version de l’API est utilisée.

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 la commande cmdlet.

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

-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

-IncludeComments

Indique que cette opération exporte le modèle avec des commentaires.

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

-IncludeParameterDefaultValue

Indique que cette opération exporte le paramètre de modèle avec la valeur par défaut.

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

-Path

Spécifie le chemin de sortie du fichier de modèle.

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

-Pre

Indique que cette applet de commande utilise des versions d’API en préversion lors de la détermination automatique de la version d’API à 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

-Resource

Liste des resourceIds par lesquelles filtrer les résultats.

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

-ResourceGroupName

Spécifie le nom du groupe de ressources à exporter.

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

-SkipAllParameterization

Ignorez tout le paramétrage.

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

-SkipResourceNameParameterization

Ignorez le paramétrage du nom de la ressource.

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

-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