Dela via

Export-AzResourceGroup

Modul:
Az.Resources Module

Samlar in en resursgrupp som en mall och sparar den i en fil.

Syntax

Default (Standard) 

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

Description

Cmdleten Export-AzResourceGroup avbildar den angivna resursgruppen som en mall och sparar den i en JSON- eller Bicep-fil. Detta kan vara användbart i scenarier där du redan har skapat vissa resurser i resursgruppen och sedan vill utnyttja fördelarna med att använda mallstödda distributioner. Den här cmdleten ger dig en enkel start genom att generera mallen för dina befintliga resurser i resursgruppen. Det kan finnas fall där den här cmdleten inte kan generera vissa delar av mallen. Varningsmeddelanden informerar dig om de resurser som misslyckades. Mallen genereras fortfarande för de delar som lyckades.

Exempel

Exempel 1: Exportera en resursgrupp

Export-AzResourceGroup -ResourceGroupName "TestGroup"

Det här kommandot samlar in resursgruppen med namnet TestGroup som en mall och sparar den i en JSON-fil i den aktuella katalogen.

Exempel 2: Exportera en enskild resurs från en resursgrupp

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

Det här kommandot samlar in den virtuella datorresursen med namnet "TestVirtualMachine" från resursgruppen "TestGroup" som en mall och sparar den i en JSON-fil i den aktuella katalogen.

Exempel 3: Exportera ett urval av resurser från en resursgrupp

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

Det här kommandot samlar in två resurser från resursgruppen "TestGroup" som en mall och sparar dem i en JSON-fil i den aktuella katalogen. Den genererade mallen innehåller inga genererade parametrar.

Exempel 4: Exportera en resursgrupp som en Bicep-fil

Export-AzResourceGroup -ResourceGroupName "TestGroup" -OutputFormat Bicep

Det här kommandot samlar in resursgruppen med namnet TestGroup som en mall och sparar den i en Bicep-fil i den aktuella katalogen.

Exempel 5: Exportera en resursgrupp som en Bicep-fil med anpassad sökväg

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

Det här kommandot samlar in resursgruppen med namnet TestGroup som en mall och sparar den i en Bicep-fil på den angivna sökvägen.

Parametrar

-ApiVersion

Anger vilken version av resursprovider-API:et som ska användas. Om den inte anges används den senaste API-versionen.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:jfr

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure

Parameteregenskaper

Typ:IAzureContextContainer
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Force

Tvingar kommandot att köras utan att be om användarbekräftelse.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-IncludeComments

Anger att den här åtgärden exporterar mallen med kommentarer.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-IncludeParameterDefaultValue

Anger att den här åtgärden exporterar mallparametern med standardvärdet.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-OutputFormat

Anger formatet för den exporterade mallen. Värden som stöds är "Json" och "Bicep".

Parameteregenskaper

Typ:String
Standardvärde:Json
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Path

Anger utdatasökvägen för mallfilen.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-Pre

Anger att den här cmdleten använder förhandsversioner av API-versioner när du automatiskt avgör vilken API-version som ska användas.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Resource

En lista över resourceIds som du vill filtrera resultatet efter.

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ResourceGroupName

Anger namnet på den resursgrupp som ska exporteras.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:Resursgrupp

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-SkipAllParameterization

Hoppa över all parameterisering.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-SkipResourceNameParameterization

Hoppa över parameterisering av resursnamn.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-WhatIf

Visar vad som skulle hända om kommandot körs. Cmdleten körs inte.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False
Alias:Wi

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

String

Utdata

PSObject