Export-AzResourceGroup

  • Referenz
Modul:
Az.Resources

Erfasst eine Ressourcengruppe als Vorlage und speichert sie in einer Datei.

Syntax

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

Beschreibung

Das Cmdlet Export-AzResourceGroup erfasst die angegebene Ressourcengruppe als Vorlage und speichert sie in einer JSON-Datei. Dies kann in Szenarien hilfreich sein, in denen Sie bereits einige Ressourcen in Ihrer Ressourcengruppe erstellt haben, und dann die Vorteile der Verwendung von vorlagenbasierten Bereitstellungen nutzen möchten. Mit diesem Cmdlet können Sie ganz einfach beginnen, indem Sie die Vorlage für Ihre vorhandenen Ressourcen in der Ressourcengruppe generieren. Es kann vorkommen, dass dieses Cmdlet einige Teile der Vorlage nicht generiert. Warnmeldungen informieren Sie über die ressourcen, die fehlgeschlagen sind. Die Vorlage wird weiterhin für die Teile generiert, die erfolgreich waren.

Beispiele

Beispiel 1: Exportieren einer Ressourcengruppe

Export-AzResourceGroup -ResourceGroupName "TestGroup"

Dieser Befehl erfasst die Ressourcengruppe "TestGroup" als Vorlage und speichert sie in einer JSON-Datei im aktuellen Verzeichnis.

Beispiel 2: Exportieren einer einzelnen Ressource aus einer Ressourcengruppe

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

Dieser Befehl erfasst die Ressource "Virtual Machine" mit dem Namen "TestVirtualMachine" aus der Ressourcengruppe "TestGroup" als Vorlage und speichert sie in einer JSON-Datei im aktuellen Verzeichnis.

Beispiel 3: Exportieren einer Auswahl von Ressourcen aus einer Ressourcengruppe

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"
)

Mit diesem Befehl werden zwei Ressourcen aus der Ressourcengruppe "TestGroup" als Vorlage erfasst und in einer JSON-Datei im aktuellen Verzeichnis gespeichert. Die generierte Vorlage enthält keine generierten Parameter.

Parameter

-ApiVersion

Gibt die version der zu verwendenden Ressourcenanbieter-API an. Wenn nicht angegeben, wird die neueste API-Version verwendet.

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

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

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

-DefaultProfile

Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Erzwingt die Ausführung des Befehls ohne Aufforderung zur Bestätigung durch den Benutzer.

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

-IncludeComments

Gibt an, dass dieser Vorgang die Vorlage mit Kommentaren exportiert.

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

-IncludeParameterDefaultValue

Gibt an, dass dieser Vorgang den Vorlagenparameter mit dem Standardwert exportiert.

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

-Path

Gibt den Ausgabepfad der Vorlagendatei an.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Pre

Gibt an, dass dieses Cmdlet Vorabversionen der API verwendet, wenn automatisch bestimmt wird, welche API-Version verwendet werden soll.

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

-Resource

Eine Liste der resourceIds, nach der die Ergebnisse gefiltert werden sollen.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Gibt den Namen der zu exportierenden Ressourcengruppe an.

Type:String
Aliases:ResourceGroup
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SkipAllParameterization

Überspringen Sie alle Parameterisierung.

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

-SkipResourceNameParameterization

Überspringen Sie die Parameterisierung des Ressourcennamens.

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

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

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

Eingaben

String

Ausgaben

PSObject