Compartilhar via

Export-AzResourceGroup

  • Referência
Módulo:
Az.Resources

Captura um grupo de recursos como um modelo e o salva em um arquivo.

Sintaxe

Export-AzResourceGroup
      -ResourceGroupName <String>
      [-Path <String>]
      [-IncludeParameterDefaultValue]
      [-IncludeComments]
      [-SkipResourceNameParameterization]
      [-SkipAllParameterization]
      [-Resource <String[]>]
      [-Force]
      [-ApiVersion <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. 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 consegue gerar algumas partes do modelo. As mensagens de aviso informarão sobre os recursos que falharam. O modelo ainda será gerado para as peças 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 os salva em um arquivo JSON no diretório atual. O modelo gerado não conterá nenhum parâmetro gerado.

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.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usadas para comunicação com o Azure

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Force

Força o comando a ser executado sem solicitar a confirmação do usuário.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-IncludeComments

Indica que essa operação exporta o modelo com comentários.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-IncludeParameterDefaultValue

Indica que essa operação exporta o parâmetro de modelo com o valor padrão.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Path

Especifica o caminho de saída do arquivo de modelo.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Pre

Indica que esse cmdlet usa versões de API de pré-lançamento ao determinar automaticamente qual versão de API usar.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Resource

Uma lista de resourceIds para filtrar os resultados.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ResourceGroupName

Especifica o nome do grupo de recursos a ser exportado.

Tipo:String
Aliases:ResourceGroup
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-SkipAllParameterization

Ignore toda a parametrização.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-SkipResourceNameParameterization

Ignore a parametrização do nome do recurso.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

String

Saídas

PSObject