Sdílet prostřednictvím

Export-AzResourceGroup

Modul:
Az.Resources Module

Zachytí skupinu prostředků jako šablonu a uloží ji do souboru.

Syntax

Default (Výchozí) 

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

Description

Rutina Export-AzResourceGroup zachytí zadanou skupinu prostředků jako šablonu a uloží ji do souboru JSON nebo Bicep. To může být užitečné ve scénářích, kdy jste už vytvořili některé prostředky ve skupině prostředků a pak chcete využít výhody použití nasazení založených na šablonách. Tato rutina vám umožní snadno začít generováním šablony pro existující prostředky ve skupině prostředků. V některých případech se může stát, že se této rutině nepodaří vygenerovat některé části šablony. Zprávy s upozorněním vás informují o prostředcích, které selhaly. Šablona se bude dál generovat pro části, které byly úspěšné.

Příklady

Příklad 1: Export skupiny prostředků

Export-AzResourceGroup -ResourceGroupName "TestGroup"

Tento příkaz zachytí skupinu prostředků s názvem TestGroup jako šablonu a uloží ji do souboru JSON v aktuálním adresáři.

Příklad 2: Export jednoho prostředku ze skupiny prostředků

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

Tento příkaz zachytí prostředek virtuálního počítače s názvem TestVirtualMachine ze skupiny prostředků TestGroup jako šablonu a uloží ho do souboru JSON v aktuálním adresáři.

Příklad 3: Export výběru prostředků ze skupiny prostředků

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

Tento příkaz zachytí dva prostředky ze skupiny prostředků TestGroup jako šablonu a uloží ho do souboru JSON v aktuálním adresáři. Vygenerovaná šablona nebude obsahovat žádné vygenerované parametry.

Příklad 4: Export skupiny prostředků jako souboru Bicep

Export-AzResourceGroup -ResourceGroupName "TestGroup" -OutputFormat Bicep

Tento příkaz zachytí skupinu prostředků s názvem TestGroup jako šablonu a uloží ji do souboru Bicep v aktuálním adresáři.

Příklad 5: Export skupiny prostředků jako souboru Bicep s vlastní cestou

Export-AzResourceGroup -ResourceGroupName "TestGroup" -OutputFormat Bicep -Path "C:\Templates\MyResourceGroup.bicep"

Tento příkaz zachytí skupinu prostředků s názvem TestGroup jako šablonu a uloží ji do souboru Bicep v zadané cestě.

Parametry

-ApiVersion

Určuje verzi rozhraní API poskytovatele prostředků, která se má použít. Pokud není zadáno, použije se nejnovější verze rozhraní API.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Confirm

Před spuštěním cmdletu vás vyzve k potvrzení.

Vlastnosti parametru

Typ:SwitchParameter
Default value:False
Podporuje zástupné znaky:False
DontShow:False
Aliasy:viz

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure

Vlastnosti parametru

Typ:IAzureContextContainer
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:AzContext, AzureRmContext, AzureCredential

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Force

Vynutí spuštění příkazu bez výzvy k potvrzení uživatele.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-IncludeComments

Označuje, že tato operace exportuje šablonu s komentáři.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-IncludeParameterDefaultValue

Označuje, že tato operace exportuje parametr šablony s výchozí hodnotou.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-OutputFormat

Určuje formát exportované šablony. Podporované hodnoty jsou Json a Bicep.

Vlastnosti parametru

Typ:String
Default value:Json
Přípustné hodnoty:Json, Bicep
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Path

Určuje výstupní cestu k souboru šablony.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-Pre

Označuje, že tato rutina používá předběžné verze rozhraní API při automatickém určení verze rozhraní API, která má být používána.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Resource

Seznam id prostředků pro filtrování výsledků.

Vlastnosti parametru

Typ:

String[]

Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-ResourceGroupName

Určuje název skupiny prostředků, která se má exportovat.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:ResourceGroup

Sady parametrů

(All)
Position:Named
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-SkipAllParameterization

Přeskočte veškerou parametrizaci.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-SkipResourceNameParameterization

Přeskočte parametrizaci názvu prostředku.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-WhatIf

Ukazuje, co se stane, když se příkaz spustí. Příkazový modul nebyl spuštěn.

Vlastnosti parametru

Typ:SwitchParameter
Default value:False
Podporuje zástupné znaky:False
DontShow:False
Aliasy:Wi

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

String

Výstupy

PSObject