Export-AzResourceGroup

  • Referencia
Módulo:
Az.Resources

Captura un grupo de recursos como plantilla y lo guarda en un archivo.

Syntax

Export-AzResourceGroup
      -ResourceGroupName <String>
      [-Path <String>]
      [-IncludeParameterDefaultValue]
      [-IncludeComments]
      [-SkipResourceNameParameterization]
      [-SkipAllParameterization]
      [-Resource <String[]>]
      [-Force]
      [-ApiVersion <String>]
      [-Pre]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

El cmdlet Export-AzResourceGroup captura el grupo de recursos especificado como plantilla y lo guarda en un archivo JSON. Esto puede ser útil en escenarios en los que ya ha creado algunos recursos en el grupo de recursos y, a continuación, desea aprovechar las ventajas de usar implementaciones respaldadas por plantillas. Este cmdlet le ofrece un fácil inicio mediante la generación de la plantilla para los recursos existentes en el grupo de recursos. Puede haber algunos casos en los que este cmdlet no genere algunas partes de la plantilla. Los mensajes de advertencia le informarán de los recursos con errores. La plantilla se seguirá generando para las partes que se realizaron correctamente.

Ejemplos

Ejemplo 1: Exportación de un grupo de recursos

Export-AzResourceGroup -ResourceGroupName "TestGroup"

Este comando captura el grupo de recursos denominado TestGroup como plantilla y lo guarda en un archivo JSON en el directorio actual.

Ejemplo 2: Exportación de un único recurso desde un grupo de recursos

Export-AzResourceGroup -ResourceGroupName "TestGroup" -Resource "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Compute/virtualMachines/TestVirtualMachine"

Este comando captura el recurso de máquina virtual denominado "TestVirtualMachine" del grupo de recursos "TestGroup" como plantilla y lo guarda en un archivo JSON en el directorio actual.

Ejemplo 3: Exportación de una selección de recursos de un 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 dos recursos del grupo de recursos "TestGroup" como plantilla y lo guarda en un archivo JSON en el directorio actual. La plantilla generada no contendrá ningún parámetro generado.

Parámetros

-ApiVersion

Especifica la versión de la API del proveedor de recursos que se va a usar. Si no se especifica, se usa la versión más reciente de la API.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Le solicita su confirmación antes de ejecutar el cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Las credenciales, la cuenta, el inquilino y la suscripción que se usan para la comunicación con Azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Obliga al comando a ejecutarse sin solicitar la confirmación del usuario.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludeComments

Indica que esta operación exporta la plantilla con comentarios.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludeParameterDefaultValue

Indica que esta operación exporta el parámetro de plantilla con el valor predeterminado.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Especifica la ruta de acceso de salida del archivo de plantilla.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Pre

Indica que este cmdlet usa versiones de API de versión preliminar al determinar automáticamente qué versión de API se va a usar.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Resource

Lista de resourceIds para filtrar los resultados por.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Especifica el nombre del grupo de recursos que se va a exportar.

Type:String
Aliases:ResourceGroup
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SkipAllParameterization

Omita todos los parámetros.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SkipResourceNameParameterization

Omita la parametrización del nombre del recurso.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

String

Salidas

PSObject