@azure/arm-imagebuilder package

Классы

ImageBuilderClient

Интерфейсы

DataDisk	Свойства диска данных.
DistributeVersioner	Описывает создание нового номера версии x.y.z для распространения.
DistributeVersionerLatest	Создает номер версии, который будет иметь последнюю версию на основе существующих номеров версий.
DistributeVersionerSource	Создает номер версии на основе номера версии исходного образа
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций.
ImageBuilderClientOptionalParams	Необязательные параметры для клиента.
ImageTemplate	Шаблон изображения — это ресурс ARM, управляемый поставщиком Microsoft.VirtualMachineImages
ImageTemplateAutoRun	Указывает, нужно ли создать или обновить шаблон образа.
ImageTemplateCustomizer	Описание единицы настройки образа
ImageTemplateDistributor	Универсальный объект распространения
ImageTemplateFileCustomizer	Отправляет файлы на виртуальные машины (Linux, Windows). Соответствует подготовке файлов Packer
ImageTemplateFileValidator	Отправляет файлы, необходимые для проверки на виртуальные машины (Linux, Windows). Соответствует подготовке файлов Packer
ImageTemplateIdentity	Удостоверение для шаблона изображения.
ImageTemplateInVMValidator	Описание единицы проверки изображения in-VM
ImageTemplateLastRunStatus	Описание последнего состояния запуска шаблона образа
ImageTemplateManagedImageDistributor	Распространение в виде образа управляемого диска.
ImageTemplateManagedImageSource	Описывает источник образа, который является управляемым образом в подписке клиента. Этот образ должен находиться в той же подписке и регионе, что и шаблон построителя образов.
ImageTemplatePlatformImageSource	Описывает источник изображения из образов коллекции Azure.
ImageTemplatePowerShellCustomizer	Запускает указанный PowerShell на виртуальной машине (Windows). Соответствует подготовке PowerShell Packer. Можно указать именно один из scriptUri или inline.
ImageTemplatePowerShellValidator	Выполняет указанный скрипт PowerShell на этапе проверки (Windows). Соответствует подготовке PowerShell Packer. Можно указать именно один из scriptUri или inline.
ImageTemplateProperties	Описывает свойства шаблона изображения
ImageTemplatePropertiesErrorHandling	Параметры обработки ошибок при сбое сборки
ImageTemplatePropertiesOptimize	Указывает оптимизацию, выполняемую на изображении.
ImageTemplatePropertiesOptimizeVmBoot	Оптимизация применяется к образу для ускорения загрузки виртуальной машины.
ImageTemplatePropertiesOptimizeWorkload	Оптимизация применяется к изображению для конкретных рабочих нагрузок.
ImageTemplatePropertiesValidate	Параметры конфигурации и список проверок, выполняемых на результирующем изображении.
ImageTemplateRestartCustomizer	Перезагружает виртуальную машину и ожидает возвращения в интернет (Windows). Соответствует подготовке packer windows-restart
ImageTemplateSharedImageDistributor	Распространение через коллекцию вычислений Azure.
ImageTemplateSharedImageVersionSource	Описывает источник образа, который является версией образа в коллекции вычислений Azure или в общей коллекции Direct.
ImageTemplateShellCustomizer	Запускает скрипт оболочки на этапе настройки (Linux). Соответствует подготовке оболочки Packer. Можно указать именно один из scriptUri или inline.
ImageTemplateShellValidator	Выполняет указанный скрипт оболочки во время этапа проверки (Linux). Соответствует подготовке оболочки Packer. Можно указать именно один из scriptUri или inline.
ImageTemplateSource	Описание источника образа виртуальной машины для создания, настройки и распространения
ImageTemplateUpdateParameters	Параметры для обновления шаблона изображения.
ImageTemplateUpdateParametersProperties	Параметры для обновления шаблона изображения.
ImageTemplateVhdDistributor	Распространение через VHD в учетной записи хранения.
ImageTemplateVmProfile	Описание виртуальных машин, используемых для создания и проверки образов
ImageTemplateWindowsUpdateCustomizer	Устанавливает обновления Windows. Соответствует поставщику подготовки центра обновления Windows Packer (https://github.com/rgl/packer-provisioner-windows-update)
Operation	Операция REST API
OperationDisplay	Объект, описывающий операцию.
OperationsListOptionalParams	Необязательные параметры.
OperationsOperations	Интерфейс, представляющий операции Operations.
PageSettings	Параметры метода byPage
PagedAsyncIterableIterator	Интерфейс, позволяющий асинхронно итерации выполнять итерацию как по страницам, так и по страницам.
PlatformImagePurchasePlan	Конфигурация плана покупки для образа платформы.
ProvisioningError	Описание ошибки при создании или обновлении шаблона образа
ProxyResource	Определение модели ресурсов для ресурса прокси-сервера Azure Resource Manager. У него не будут теги и расположение
Resource	Общие поля, возвращаемые в ответе для всех ресурсов Azure Resource Manager
RestorePollerOptions
RunOutput	Представляет выходные данные, созданные с помощью шаблона образа.
RunOutputProperties	Описывает свойства выхода серии
SimplePollerLike	Простой опросщик, который можно использовать для опроса длительной операции.
SourceImageTriggerProperties	Свойства типа триггера SourceImage
SystemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
TargetRegion	Описание сведений о целевом регионе.
TrackedResource	Определение модели ресурсов для отслеживаемого ресурса Azure Resource Manager с тегами верхнего уровня и расположением
Trigger	Представляет триггер, который может вызвать сборку шаблона образа.
TriggerProperties	Описание свойств триггера
TriggerStatus	Описание состояния триггера
TriggersCreateOrUpdateOptionalParams	Необязательные параметры.
TriggersDeleteOptionalParams	Необязательные параметры.
TriggersGetOptionalParams	Необязательные параметры.
TriggersListByImageTemplateOptionalParams	Необязательные параметры.
TriggersOperations	Интерфейс, представляющий операции триггеров.
UserAssignedIdentity	Свойства назначаемого пользователем удостоверения
VirtualMachineImageTemplatesCancelOptionalParams	Необязательные параметры.
VirtualMachineImageTemplatesCreateOrUpdateOptionalParams	Необязательные параметры.
VirtualMachineImageTemplatesDeleteOptionalParams	Необязательные параметры.
VirtualMachineImageTemplatesGetOptionalParams	Необязательные параметры.
VirtualMachineImageTemplatesGetRunOutputOptionalParams	Необязательные параметры.
VirtualMachineImageTemplatesListByResourceGroupOptionalParams	Необязательные параметры.
VirtualMachineImageTemplatesListOptionalParams	Необязательные параметры.
VirtualMachineImageTemplatesListRunOutputsOptionalParams	Необязательные параметры.
VirtualMachineImageTemplatesOperations	Интерфейс, представляющий операции VirtualMachineImageTemplates.
VirtualMachineImageTemplatesRunOptionalParams	Необязательные параметры.
VirtualMachineImageTemplatesUpdateOptionalParams	Необязательные параметры.
VirtualNetworkConfig	Конфигурация виртуальной сети.

Псевдонимы типа

AutoRunState	Включение этого поля приведет к активации автоматической сборки на основе создания шаблона образа или обновления.
AzureSupportedClouds	Поддерживаемые значения для настройки облака в виде строкового литерала
ContinuablePage	Интерфейс, описывающий страницу результатов.
CreatedByType	Тип сущности, создающей ресурс. KnownCreatedByType можно использовать взаимозаменяемо с CreatedByType, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой user: сущность была создана пользователем. приложения: сущность была создана приложением. ManagedIdentity: сущность была создана управляемым удостоверением. ключ: сущность была создана ключом.
DistributeVersionerUnion	Псевдоним для DistributeVersionerUnion
ImageTemplateCustomizerUnion	Alias for ImageTemplateCustomizerUnion
ImageTemplateDistributorUnion	Псевдоним для ImageTemplateDistributorUnion
ImageTemplateInVMValidatorUnion	Alias for ImageTemplateInVMValidatorUnion
ImageTemplateSourceUnion	Псевдоним для ImageTemplateSourceUnion
OnBuildError	Поведение при обработке ошибок при сбое сборки KnownOnBuildError можно использовать взаимозаменяемо с OnBuildError, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Уборка: Уборка Отмена: Отмена
ProvisioningErrorCode	Код ошибки сбоя провизии KnownProvisioningErrorCode можно использовать взаимозаменяемо с ProvisioningErrorCode, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой BadSourceType: BadSourceType BadPIRSorce: BadPIRSource BadManagedImageSource: BadManagedImageSource BadSharedImageVersionSource: BadSharedImageVersionSource BadCustomizerТип: BadCustomizerТип Неподдерживаемый КастомизаторТип: Неподдерживаемый КастомизаторТип NoCustomizerScript: NoCustomizerScript BadValidatorType: BadValidatorType UnsupportedValidatorType: UnsupportedValidatorType NoValidatorScript: NoValidatorScript BadDistributeType: BadDistributeType BadSharedImageDistribute: BadSharedImageDistribution BadStagingResourceGroup: BadStagingResourceGroup ServerError: ServerError Прочие: Другое
ProvisioningState	Состояние подготовки ресурса
ReplicationMode	Описывает режим репликации для распространения в Azure Compute Gallery. Опусти использование стандартного режима (Full). KnownReplicationMode можно использовать взаимозаменяемо с ReplicationMode, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Полный: режим полной репликации Мелководье: Мелкий режим репликации
ResourceIdentityType	Тип удостоверения, используемого для шаблона изображения. Тип "Нет" приведет к удалению удостоверений из шаблона образа.
RunState	Состояние последнего запуска
RunSubState	Субштат последнего запуска
SharedImageStorageAccountType	Указывает тип аккаунта хранения для хранения версии образа Azure Compute Gallery. KnownSharedImageStorageAccountType можно использовать взаимозаменяемо с SharedImageStorageAccountType, этот перечисление содержит известные значения, поддерживаемые службой. Известные значения, поддерживаемые службой Standard_LRS: Standard_LRS Standard_ZRS: Standard_ZRS Premium_LRS: Premium_LRS
TriggerPropertiesUnion	Псевдоним для TriggerPropertiesUnion
VMBootOptimizationState	Включение этого поля улучшит время загрузки виртуальной машины, оптимизируя окончательные настраиваемые выходные данные образа.
WorkloadOptimizationState	Включение этого поля оптимизирует изображения виртуальных машин под конкретные рабочие нагрузки.

Перечисления

AzureClouds	Enum для описания среды Azure Cloud.
KnownCreatedByType	Тип сущности, создающей ресурс.
KnownOnBuildError	Поведение при обработке ошибок при сбое сборки
KnownProvisioningErrorCode	Код ошибки сбоя провизии
KnownReplicationMode	Описывает режим репликации для распространения в Azure Compute Gallery. Опусти использование стандартного режима (Full).
KnownSharedImageStorageAccountType	Указывает тип аккаунта хранения для хранения версии образа Azure Compute Gallery.
KnownVersions	Доступные версии API.

Функции

isRestError(unknown)	Typeguard для RestError
restorePoller<TResponse, TResult>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Создает поллер из сериализованного состояния другого поллера. Это может быть полезно, когда вы хотите создать поллеры на другом узле или если поллер должен быть создан после того, как исходный поллер не находится в области видимости.

Переменные

RestError

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

Сведения о функции

isRestError(unknown)

Typeguard для RestError

function isRestError(e: unknown): e

Параметры

e

unknown

Что-то поймано предложением catch.

Возвращаемое значение

e

restorePoller<TResponse, TResult>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Создает поллер из сериализованного состояния другого поллера. Это может быть полезно, когда вы хотите создать поллеры на другом узле или если поллер должен быть создан после того, как исходный поллер не находится в области видимости.

function restorePoller<TResponse, TResult>(client: ImageBuilderClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Параметры

client

ImageBuilderClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Возвращаемое значение

PollerLike<OperationState<TResult>, TResult>

Сведения об переменной

RestError

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

RestError: RestErrorConstructor

Тип

RestErrorConstructor