Export-AzResourceGroup
Erfasst eine Ressourcengruppe als Vorlage und speichert sie in einer Datei.
Syntax
Default (Standard)
Export-AzResourceGroup
-ResourceGroupName <String>
[-Path <String>]
[-IncludeParameterDefaultValue]
[-IncludeComments]
[-SkipResourceNameParameterization]
[-SkipAllParameterization]
[-Resource <String[]>]
[-Force]
[-ApiVersion <String>]
[-OutputFormat <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Beschreibung
Das Cmdlet Export-AzResourceGroup erfasst die angegebene Ressourcengruppe als Vorlage und speichert sie in einer JSON- oder Bicep-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.
Beispiel 4: Exportieren einer Ressourcengruppe als Bicep-Datei
Export-AzResourceGroup -ResourceGroupName "TestGroup" -OutputFormat Bicep
Mit diesem Befehl wird die Ressourcengruppe "TestGroup" als Vorlage erfasst und in einer Bicep-Datei im aktuellen Verzeichnis gespeichert.
Beispiel 5: Exportieren einer Ressourcengruppe als Bicep-Datei mit benutzerdefiniertem Pfad
Export-AzResourceGroup -ResourceGroupName "TestGroup" -OutputFormat Bicep -Path "C:\Templates\MyResourceGroup.bicep"
Dieser Befehl erfasst die Ressourcengruppe "TestGroup" als Vorlage und speichert sie in einer Bicep-Datei im angegebenen Pfad.
Parameter
-ApiVersion
Gibt die version der zu verwendenden Ressourcenanbieter-API an.
Wenn nicht angegeben, wird die neueste API-Version verwendet.
Parametereigenschaften
Typ: String
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-Confirm
Fordert Sie zur Bestätigung auf, bevor Sie das Cmdlet ausführen.
Parametereigenschaften
Typ: SwitchParameter
Standardwert: False Unterstützt Platzhalter: False Nicht anzeigen: False Aliase: vgl
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-DefaultProfile
Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure
Parametereigenschaften
Typ: IAzureContextContainer
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False Aliase: AzContext, AzureRmContext, AzureCredential
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-Force
Erzwingt die Ausführung des Befehls, ohne eine Benutzerbestätigung zu verlangen.
Parametereigenschaften
Typ: SwitchParameter
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
Gibt an, dass dieser Vorgang die Vorlage mit Kommentaren exportiert.
Typ: SwitchParameter
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-IncludeParameterDefaultValue
Gibt an, dass dieser Vorgang den Vorlagenparameter mit dem Standardwert exportiert.
Parametereigenschaften
Typ: SwitchParameter
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
Gibt das Format der exportierten Vorlage an. Unterstützte Werte sind "Json" und "Bicep".
Typ: String
Standardwert: Json Zulässige Werte: Json, Bicep Unterstützt Platzhalter: False Nicht anzeigen: False
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-Path
Gibt den Ausgabepfad der Vorlagendatei an.
Parametereigenschaften
Typ: String
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: True Wert aus verbleibenden Argumenten: False
-Pre
Gibt an, dass dieses Cmdlet Vorabversionen der API verwendet, wenn automatisch bestimmt wird, welche API-Version verwendet werden soll.
Parametereigenschaften
Typ: SwitchParameter
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-Resource
Eine Liste der resourceIds, nach der die Ergebnisse gefiltert werden sollen.
Parametereigenschaften
Typ: String [ ]
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-ResourceGroupName
Gibt den Namen der zu exportierenden Ressourcengruppe an.
Parametereigenschaften
Typ: String
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False Aliase: ResourceGroup
Parametersätze
(All)
Position: Named Obligatorisch: True Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: True Wert aus verbleibenden Argumenten: False
-SkipAllParameterization
Überspringen Sie alle Parameterisierung.
Parametereigenschaften
Typ: SwitchParameter
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-SkipResourceNameParameterization
Überspringen Sie die Parameterisierung des Ressourcennamens.
Parametereigenschaften
Typ: SwitchParameter
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-WhatIf
Zeigt, was passiert, wenn das Cmdlet ausgeführt wird.
Das Cmdlet wird nicht ausgeführt.
Parametereigenschaften
Typ: SwitchParameter
Standardwert: False Unterstützt Platzhalter: False Nicht anzeigen: False Aliase: Wi
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
CommonParameters
Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters .
Ausgaben
