Export-AzResourceGroup
Przechwytuje grupę zasobów jako szablon i zapisuje ją w pliku.
Składnia
Default (domyślnie)
Export-AzResourceGroup
-ResourceGroupName <String>
[-Path <String>]
[-IncludeParameterDefaultValue]
[-IncludeComments]
[-SkipResourceNameParameterization]
[-SkipAllParameterization]
[-Resource <String[]>]
[-Force]
[-ApiVersion <String>]
[-OutputFormat <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Opis
Polecenie cmdlet Export-AzResourceGroup przechwytuje określoną grupę zasobów jako szablon i zapisuje ją w pliku JSON lub Bicep. Może to być przydatne w scenariuszach, w których utworzono już niektóre zasoby w grupie zasobów, a następnie chcesz wykorzystać korzyści wynikające z używania wdrożeń opartych na szablonach.
To polecenie cmdlet umożliwia łatwe rozpoczęcie od wygenerowania szablonu dla istniejących zasobów w grupie zasobów.
W niektórych przypadkach nie można wygenerować niektórych części szablonu tego polecenia cmdlet.
Komunikaty ostrzegawcze informują o zasobach, które zakończyły się niepowodzeniem.
Szablon będzie nadal generowany dla części, które zakończyły się pomyślnie.
Przykłady
Przykład 1. Eksportowanie grupy zasobów
Export-AzResourceGroup -ResourceGroupName "TestGroup"
To polecenie przechwytuje grupę zasobów o nazwie TestGroup jako szablon i zapisuje ją w pliku JSON w bieżącym katalogu.
Przykład 2. Eksportowanie pojedynczego zasobu z grupy zasobów
Export-AzResourceGroup -ResourceGroupName "TestGroup" -Resource "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Compute/virtualMachines/TestVirtualMachine"
To polecenie przechwytuje zasób maszyny wirtualnej o nazwie "TestVirtualMachine" z grupy zasobów "TestGroup" jako szablon i zapisuje go w pliku JSON w bieżącym katalogu.
Przykład 3. Eksportowanie wybranych zasobów z grupy zasobów
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"
)
To polecenie przechwytuje dwa zasoby z grupy zasobów "TestGroup" jako szablon i zapisuje je w pliku JSON w bieżącym katalogu. Wygenerowany szablon nie będzie zawierać żadnych wygenerowanych parametrów.
Przykład 4. Eksportowanie grupy zasobów jako pliku Bicep
Export-AzResourceGroup -ResourceGroupName "TestGroup" -OutputFormat Bicep
To polecenie przechwytuje grupę zasobów o nazwie TestGroup jako szablon i zapisuje ją w pliku Bicep w bieżącym katalogu.
Przykład 5. Eksportowanie grupy zasobów jako pliku Bicep ze ścieżką niestandardową
Export-AzResourceGroup -ResourceGroupName "TestGroup" -OutputFormat Bicep -Path "C:\Templates\MyResourceGroup.bicep"
To polecenie przechwytuje grupę zasobów o nazwie TestGroup jako szablon i zapisuje ją w pliku Bicep w określonej ścieżce.
Parametry
-ApiVersion
Określa wersję interfejsu API dostawcy zasobów do użycia.
Jeśli nie zostanie określona, zostanie użyta najnowsza wersja interfejsu API.
Właściwości parametru
Typ: String
Domyślna wartość: None
Obsługuje symbole wieloznaczne: False
DontShow: False
Zestawy parametrów
(All)
Position: Named
Obowiązkowe: False
Wartość z potoku: False
Wartość z potoku według nazwy właściwości: False
Wartość z pozostałych argumentów: False
-Confirm
Prosi o potwierdzenie przed uruchomieniem cmdletu.
Właściwości parametru
Typ: SwitchParameter
Domyślna wartość: False
Obsługuje symbole wieloznaczne: False
DontShow: False
Aliasy: por
Zestawy parametrów
(All)
Position: Named
Obowiązkowe: False
Wartość z potoku: False
Wartość z potoku według nazwy właściwości: False
Wartość z pozostałych argumentów: False
-DefaultProfile
Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure
Właściwości parametru
Typ: IAzureContextContainer
Domyślna wartość: None
Obsługuje symbole wieloznaczne: False
DontShow: False
Aliasy: AzContext, AzureRmContext, AzureCredential
Zestawy parametrów
(All)
Position: Named
Obowiązkowe: False
Wartość z potoku: False
Wartość z potoku według nazwy właściwości: False
Wartość z pozostałych argumentów: False
-Force
Wymusza uruchomienie polecenia bez monitowania o potwierdzenie użytkownika.
Właściwości parametru
Typ: SwitchParameter
Domyślna wartość: None
Obsługuje symbole wieloznaczne: False
DontShow: False
Zestawy parametrów
(All)
Position: Named
Obowiązkowe: False
Wartość z potoku: False
Wartość z potoku według nazwy właściwości: False
Wartość z pozostałych argumentów: False
Wskazuje, że ta operacja eksportuje szablon z komentarzami.
Typ: SwitchParameter
Domyślna wartość: None
Obsługuje symbole wieloznaczne: False
DontShow: False
(All)
Position: Named
Obowiązkowe: False
Wartość z potoku: False
Wartość z potoku według nazwy właściwości: False
Wartość z pozostałych argumentów: False
-IncludeParameterDefaultValue
Wskazuje, że ta operacja eksportuje parametr szablonu z wartością domyślną.
Właściwości parametru
Typ: SwitchParameter
Domyślna wartość: None
Obsługuje symbole wieloznaczne: False
DontShow: False
Zestawy parametrów
(All)
Position: Named
Obowiązkowe: False
Wartość z potoku: False
Wartość z potoku według nazwy właściwości: False
Wartość z pozostałych argumentów: False
Określa format wyeksportowanego szablonu. Obsługiwane wartości to "Json" i "Bicep".
Typ: String
Domyślna wartość: Json
Dopuszczalne wartości: Json, Bicep
Obsługuje symbole wieloznaczne: False
DontShow: False
(All)
Position: Named
Obowiązkowe: False
Wartość z potoku: False
Wartość z potoku według nazwy właściwości: False
Wartość z pozostałych argumentów: False
-Path
Określa ścieżkę wyjściową pliku szablonu.
Właściwości parametru
Typ: String
Domyślna wartość: None
Obsługuje symbole wieloznaczne: False
DontShow: False
Zestawy parametrów
(All)
Position: Named
Obowiązkowe: False
Wartość z potoku: False
Wartość z potoku według nazwy właściwości: True
Wartość z pozostałych argumentów: False
-Pre
Wskazuje, że to polecenie cmdlet używa wersji interfejsu API w wersji wstępnej podczas automatycznego określania wersji interfejsu API do użycia.
Właściwości parametru
Typ: SwitchParameter
Domyślna wartość: None
Obsługuje symbole wieloznaczne: False
DontShow: False
Zestawy parametrów
(All)
Position: Named
Obowiązkowe: False
Wartość z potoku: False
Wartość z potoku według nazwy właściwości: False
Wartość z pozostałych argumentów: False
-Resource
Lista identyfikatorów zasobów do filtrowania wyników według.
Właściwości parametru
Typ: String [ ]
Domyślna wartość: None
Obsługuje symbole wieloznaczne: False
DontShow: False
Zestawy parametrów
(All)
Position: Named
Obowiązkowe: False
Wartość z potoku: False
Wartość z potoku według nazwy właściwości: False
Wartość z pozostałych argumentów: False
-ResourceGroupName
Określa nazwę grupy zasobów do wyeksportowania.
Właściwości parametru
Typ: String
Domyślna wartość: None
Obsługuje symbole wieloznaczne: False
DontShow: False
Aliasy: Grupa zasobów
Zestawy parametrów
(All)
Position: Named
Obowiązkowe: True
Wartość z potoku: False
Wartość z potoku według nazwy właściwości: True
Wartość z pozostałych argumentów: False
-SkipAllParameterization
Pomiń wszystkie parametryzację.
Właściwości parametru
Typ: SwitchParameter
Domyślna wartość: None
Obsługuje symbole wieloznaczne: False
DontShow: False
Zestawy parametrów
(All)
Position: Named
Obowiązkowe: False
Wartość z potoku: False
Wartość z potoku według nazwy właściwości: False
Wartość z pozostałych argumentów: False
-SkipResourceNameParameterization
Pomiń parametryzacja nazwy zasobu.
Właściwości parametru
Typ: SwitchParameter
Domyślna wartość: None
Obsługuje symbole wieloznaczne: False
DontShow: False
Zestawy parametrów
(All)
Position: Named
Obowiązkowe: False
Wartość z potoku: False
Wartość z potoku według nazwy właściwości: False
Wartość z pozostałych argumentów: False
-WhatIf
Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione.
Cmdlet nie jest uruchomiony.
Właściwości parametru
Typ: SwitchParameter
Domyślna wartość: False
Obsługuje symbole wieloznaczne: False
DontShow: False
Aliasy: Wi
Zestawy parametrów
(All)
Position: Named
Obowiązkowe: False
Wartość z potoku: False
Wartość z potoku według nazwy właściwości: False
Wartość z pozostałych argumentów: False
CommonParameters
To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters .
Dane wyjściowe