Export-AzResourceGroup

Модуль:

Az.Resources Module

Записывает группу ресурсов в виде шаблона и сохраняет ее в файл.

Синтаксис

Default (По умолчанию)

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

Описание

Командлет Export-AzResourceGroup записывает указанную группу ресурсов в виде шаблона и сохраняет ее в json или Bicep-файле. Это может быть полезно в сценариях, когда вы уже создали некоторые ресурсы в группе ресурсов, а затем хотите использовать преимущества использования поддерживаемых шаблонов развертываний. Этот командлет позволяет легко начать с создания шаблона для существующих ресурсов в группе ресурсов. В некоторых случаях этот командлет не может создать некоторые части шаблона. Предупреждающие сообщения будут сообщать вам о ресурсах, которые не удалось выполнить. Шаблон по-прежнему будет создан для частей, которые были успешными.

Примеры

Пример 1. Экспорт группы ресурсов

Export-AzResourceGroup -ResourceGroupName "TestGroup"

Эта команда записывает группу ресурсов с именем TestGroup в качестве шаблона и сохраняет ее в JSON-файл в текущем каталоге.

Пример 2. Экспорт одного ресурса из группы ресурсов

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

Эта команда записывает ресурс виртуальной машины с именем TestVirtualMachine из группы ресурсов TestGroup в качестве шаблона и сохраняет его в JSON-файл в текущем каталоге.

Пример 3. Экспорт выбора ресурсов из группы ресурсов

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

Эта команда записывает два ресурса из группы ресурсов TestGroup в качестве шаблона и сохраняет его в JSON-файл в текущем каталоге. Созданный шаблон не будет содержать созданные параметры.

Пример 4. Экспорт группы ресурсов в виде файла Bicep

Export-AzResourceGroup -ResourceGroupName "TestGroup" -OutputFormat Bicep

Эта команда записывает группу ресурсов с именем TestGroup в качестве шаблона и сохраняет ее в файл Bicep в текущем каталоге.

Пример 5. Экспорт группы ресурсов в виде файла Bicep с пользовательским путем

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

Эта команда записывает группу ресурсов с именем TestGroup в качестве шаблона и сохраняет ее в файл Bicep по указанному пути.

Параметры

-ApiVersion

Указывает версию API поставщика ресурсов для использования. Если не указано, используется последняя версия API.

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Confirm

Запрашивает подтверждение перед запуском cmdlet.

Свойства параметров

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	Cf

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure

Свойства параметров

Тип:	IAzureContextContainer
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Force

Принудительно выполняется команда без запроса подтверждения пользователя.

Свойства параметров

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-IncludeComments

Указывает, что эта операция экспортирует шаблон с комментариями.

Свойства параметров

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-IncludeParameterDefaultValue

Указывает, что эта операция экспортирует параметр шаблона со значением по умолчанию.

Свойства параметров

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-OutputFormat

Задает формат экспортированного шаблона. Поддерживаемые значения: Json и Bicep.

Свойства параметров

Тип:	String
Default value:	Json
Допустимые значения:	Json, Bicep
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Path

Указывает выходной путь файла шаблона.

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-Pre

Указывает, что этот командлет использует версии API предварительной версии при автоматическом определении используемой версии API.

Свойства параметров

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Resource

Список идентификаторов ресурсов для фильтрации результатов.

Свойства параметров

Тип:	String[]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-ResourceGroupName

Указывает имя группы ресурсов для экспорта.

Свойства параметров

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	ResourceGroup

Наборы параметров

(All)

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-SkipAllParameterization

Пропустить все параметризация.

Свойства параметров

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-SkipResourceNameParameterization

Пропустите параметризацию имени ресурса.

Свойства параметров

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-WhatIf

Показывает, что произойдет, если командлет будет запущен. Командлет не запускается.

Свойства параметров

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	Wi

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Входные данные

String

Выходные данные

PSObject

Связанные ссылки

• Get-AzResourceGroup