Partilhar via

Export-AzResourceGroup

Módulo:
Az.Resources Module

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

Sintaxe

Default (Predefinição) 

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 de usar implantações apoiadas por modelos. Este 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 informá-lo-ão dos 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"

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

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

Este 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á nenhum parâmetro gerado.

Exemplo 4: Exportar um grupo de recursos como um arquivo Bicep

Export-AzResourceGroup -ResourceGroupName "TestGroup" -OutputFormat Bicep

Este comando captura o grupo de recursos chamado TestGroup como um modelo e o salva em um arquivo Bicep no diretório atual.

Exemplo 5: Exportar um grupo de recursos como um arquivo Bicep com caminho personalizado

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

Este 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 dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:False
Suporta carateres universais:False
NãoMostrar:False
Aliases:Cf.

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-DefaultProfile

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

Propriedades dos parâmetros

Tipo:IAzureContextContainer
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Force

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-IncludeComments

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-IncludeParameterDefaultValue

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-OutputFormat

Especifica o formato do modelo exportado. Os valores suportados são "Json" e "Bicep".

Propriedades dos parâmetros

Tipo:String
Default value:Json
Valores aceites:Json, Bicep
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Path

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

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-Pre

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Resource

Uma lista de resourceIds para filtrar os resultados.

Propriedades dos parâmetros

Tipo:

String[]

Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-ResourceGroupName

Especifica o nome do grupo de recursos a ser exportado.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Grupo de Recursos

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-SkipAllParameterization

Ignore toda a parametrização.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-SkipResourceNameParameterization

Ignorar parametrização do nome do recurso.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-WhatIf

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:False
Suporta carateres universais:False
NãoMostrar:False
Aliases:Wi

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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.

Entradas

String

Saídas

PSObject