Export-AzureRmResourceGroup
Captura um grupo de recursos como um modelo e o salva em um arquivo.
Aviso
O módulo PowerShell do AzureRM foi oficialmente preterido a partir de 29 de fevereiro de 2024. Os usuários são aconselhados a migrar do AzureRM para o módulo do Az PowerShell para garantir o suporte e as atualizações contínuas.
Embora o módulo AzureRM ainda possa funcionar, ele não tem suporte ou será mantido, colocando qualquer uso contínuo a critério e risco do usuário. Consulte nossos recursos de migração para obter diretrizes sobre a transição para o módulo Az.
Sintaxe
Export-AzureRmResourceGroup
-ResourceGroupName <String>
[-Path <String>]
[-IncludeParameterDefaultValue]
[-IncludeComments]
[-Force]
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
O cmdlet Export-AzureRmResourceGroup 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
PS C:\>Export-AzureRmResourceGroup -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.
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: | 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 |
-InformationAction
Especifica como esse cmdlet responde a um evento de informação. Os valores aceitáveis para esse parâmetro são:
- Continuar
- Ignorar
- Perguntar
- SilentlyContinue
- Parar
- Suspend
Tipo: | ActionPreference |
Aliases: | infa |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
-InformationVariable
Especifica uma variável de informação.
Tipo: | String |
Aliases: | iv |
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 |
-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 |
-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 |