Export-AzResourceGroup
Captura um grupo de recursos como um modelo e o salva em um arquivo.
Sintaxe
Default (Default)
Export-AzResourceGroup
-ResourceGroupName <String>
[-Path <String>]
[-IncludeParameterDefaultValue]
[-IncludeComments]
[-SkipResourceNameParameterization]
[-SkipAllParameterization]
[-Resource <String[]>]
[-Force]
[-ApiVersion <String>]
[-OutputFormat <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
O cmdlet Export-AzResourceGroup captura o grupo de recursos especificado como um modelo e o salva em um arquivo JSON ou Bicep. Isso pode ser útil em cenários em que você já criou alguns recursos em seu grupo de recursos e, em seguida, deseja aproveitar os benefícios do uso de implantações com suporte de modelo.
Esse cmdlet oferece um início fácil gerando o modelo para seus recursos existentes no grupo de recursos.
Pode haver alguns casos em que esse cmdlet não gera algumas partes do modelo.
As mensagens de aviso informarão sobre os recursos que falharam.
O modelo ainda será gerado para as partes que foram bem-sucedidas.
Exemplos
Exemplo 1: exportar um grupo de recursos
Export-AzResourceGroup -ResourceGroupName "TestGroup"
Esse comando captura o grupo de recursos chamado TestGroup como um modelo e o salva em um arquivo JSON no diretório atual.
Exemplo 2: exportar um único recurso de um grupo de recursos
Export-AzResourceGroup -ResourceGroupName "TestGroup" -Resource "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Compute/virtualMachines/TestVirtualMachine"
Esse comando captura o recurso de Máquina Virtual chamado "TestVirtualMachine" do grupo de recursos "TestGroup" como um modelo e o salva em um arquivo JSON no diretório atual.
Exemplo 3: exportar uma seleção de recursos de um grupo de recursos
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"
)
Esse comando captura dois recursos do grupo de recursos "TestGroup" como um modelo e o salva em um arquivo JSON no diretório atual. O modelo gerado não conterá parâmetros gerados.
Exemplo 4: exportar um grupo de recursos como um arquivo Bicep
Export-AzResourceGroup -ResourceGroupName "TestGroup" -OutputFormat Bicep
Esse comando captura o grupo de recursos chamado TestGroup como um modelo e o salva em um arquivo Bicep no diretório atual.
Export-AzResourceGroup -ResourceGroupName "TestGroup" -OutputFormat Bicep -Path "C:\Templates\MyResourceGroup.bicep"
Esse comando captura o grupo de recursos chamado TestGroup como um modelo e o salva em um arquivo Bicep no caminho especificado.
Parâmetros
-ApiVersion
Especifica a versão da API do provedor de recursos a ser usada.
Se não for especificado, a versão mais recente da API será usada.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: False Dá suporte a curingas: False DontShow: False Aliases: cf
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure
Propriedades do parâmetro
Tipo: IAzureContextContainer
Valor padrão: None Dá suporte a curingas: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-Force
Força o comando a ser executado sem solicitar a confirmação do usuário.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
Indica que essa operação exporta o modelo com comentários.
Tipo: SwitchParameter
Valor padrão: None Dá suporte a curingas: False DontShow: False
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-IncludeParameterDefaultValue
Indica que essa operação exporta o parâmetro de modelo com o valor padrão.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
Especifica o formato do modelo exportado. Os valores com suporte são "Json" e "Bicep".
Tipo: String
Valor padrão: Json Valores aceitos: Json, Bicep Dá suporte a curingas: False DontShow: False
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-Path
Especifica o caminho de saída do arquivo de modelo.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-Pre
Indica que esse cmdlet usa versões de API de pré-lançamento ao determinar automaticamente qual versão da API usar.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-Resource
Uma lista de resourceIds para filtrar os resultados.
Propriedades do parâmetro
Tipo: String [ ]
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-ResourceGroupName
Especifica o nome do grupo de recursos a ser exportado.
Propriedades do parâmetro
Tipo: String
Valor padrão: None Dá suporte a curingas: False DontShow: False Aliases: Grupo de recursos
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: True Valor do pipeline: False Valor do pipeline pelo nome da propriedade: True Valor dos argumentos restantes: False
-SkipAllParameterization
Ignore toda a parametrização.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-SkipResourceNameParameterization
Ignorar a parametrização do nome do recurso.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None Dá suporte a curingas: False DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado.
O cmdlet não é executado.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: False Dá suporte a curingas: False DontShow: False Aliases: wi
Conjuntos de parâmetros
(All)
Cargo: Named Obrigatório: False Valor do pipeline: False Valor do pipeline pelo nome da propriedade: False Valor dos argumentos restantes: False
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters .
Saídas
