Поделиться через

@azure/arm-imagebuilder package

  • Ссылка

Классы

ImageBuilderClient

Интерфейсы

DistributeVersioner

Описывает создание нового номера версии x.y.z для распространения.
DistributeVersionerLatest

Создает номер версии, который будет иметь последнюю версию на основе существующих номеров версий.
DistributeVersionerSource

Создает номер версии на основе номера версии исходного образа
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
ImageBuilderClientOptionalParams

Необязательные параметры.
ImageTemplate

Шаблон изображения — это ресурс ARM, управляемый поставщиком Microsoft.VirtualMachineImages
ImageTemplateAutoRun

Указывает, нужно ли создать или обновить шаблон образа.
ImageTemplateCustomizer

Описание единицы настройки образа
ImageTemplateDistributor

Универсальный объект распространения
ImageTemplateFileCustomizer

Отправляет файлы на виртуальные машины (Linux, Windows). Соответствует подготовке файлов Packer
ImageTemplateFileValidator

Отправляет файлы, необходимые для проверки на виртуальные машины (Linux, Windows). Соответствует подготовке файлов Packer
ImageTemplateIdentity

Удостоверение для шаблона изображения.
ImageTemplateInVMValidator

Описание единицы проверки изображения in-VM
ImageTemplateLastRunStatus

Описание последнего состояния запуска шаблона образа
ImageTemplateListResult

Результат операции шаблонов изображений списка
ImageTemplateManagedImageDistributor

Распространение в виде образа управляемого диска.
ImageTemplateManagedImageSource

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

Описывает источник изображения из образов коллекции Azure.
ImageTemplatePowerShellCustomizer

Запускает указанный PowerShell на виртуальной машине (Windows). Соответствует подготовке PowerShell Packer. Можно указать именно один из scriptUri или inline.
ImageTemplatePowerShellValidator

Выполняет указанный скрипт PowerShell на этапе проверки (Windows). Соответствует подготовке PowerShell Packer. Можно указать именно один из scriptUri или inline.
ImageTemplatePropertiesErrorHandling

Параметры обработки ошибок при сбое сборки
ImageTemplatePropertiesOptimize

Указывает оптимизацию, выполняемую на изображении.
ImageTemplatePropertiesOptimizeVmBoot

Оптимизация применяется к образу для ускорения загрузки виртуальной машины.
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

Объект, описывающий операцию.
OperationListResult

Результат запроса на перечисление операций REST API. Он содержит список операций и URL-адрес nextLink, чтобы получить следующий набор результатов.
Operations

Интерфейс, представляющий операции.
OperationsListNextOptionalParams

Необязательные параметры.
OperationsListOptionalParams

Необязательные параметры.
PlatformImagePurchasePlan

Конфигурация плана покупки для образа платформы.
ProvisioningError

Описание ошибки при создании или обновлении шаблона образа
ProxyResource

Определение модели ресурсов для ресурса прокси-сервера Azure Resource Manager. У него не будут теги и расположение
Resource

Общие поля, возвращаемые в ответе для всех ресурсов Azure Resource Manager
RunOutput

Представляет выходные данные, созданные с помощью шаблона образа.
RunOutputCollection

Результат операции вывода вывода списка
SourceImageTriggerProperties

Свойства типа триггера SourceImage
SystemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.
TargetRegion

Описание сведений о целевом регионе.
TrackedResource

Определение модели ресурсов для отслеживаемого ресурса Azure Resource Manager с тегами верхнего уровня и расположением
Trigger

Представляет триггер, который может вызвать сборку шаблона образа.
TriggerCollection

Результат операции триггеров списка
TriggerProperties

Описание свойств триггера
TriggerStatus

Описание состояния триггера
Triggers

Интерфейс, представляющий триггеры.
TriggersCreateOrUpdateOptionalParams

Необязательные параметры.
TriggersDeleteHeaders

Определяет заголовки для операции Triggers_delete.
TriggersDeleteOptionalParams

Необязательные параметры.
TriggersGetOptionalParams

Необязательные параметры.
TriggersListByImageTemplateNextOptionalParams

Необязательные параметры.
TriggersListByImageTemplateOptionalParams

Необязательные параметры.
UserAssignedIdentity

Свойства назначаемого пользователем удостоверения
VirtualMachineImageTemplates

Интерфейс, представляющий VirtualMachineImageTemplates.
VirtualMachineImageTemplatesCancelOptionalParams

Необязательные параметры.
VirtualMachineImageTemplatesCreateOrUpdateOptionalParams

Необязательные параметры.
VirtualMachineImageTemplatesDeleteHeaders

Определяет заголовки для операции VirtualMachineImageTemplates_delete.
VirtualMachineImageTemplatesDeleteOptionalParams

Необязательные параметры.
VirtualMachineImageTemplatesGetOptionalParams

Необязательные параметры.
VirtualMachineImageTemplatesGetRunOutputOptionalParams

Необязательные параметры.
VirtualMachineImageTemplatesListByResourceGroupNextOptionalParams

Необязательные параметры.
VirtualMachineImageTemplatesListByResourceGroupOptionalParams

Необязательные параметры.
VirtualMachineImageTemplatesListNextOptionalParams

Необязательные параметры.
VirtualMachineImageTemplatesListOptionalParams

Необязательные параметры.
VirtualMachineImageTemplatesListRunOutputsNextOptionalParams

Необязательные параметры.
VirtualMachineImageTemplatesListRunOutputsOptionalParams

Необязательные параметры.
VirtualMachineImageTemplatesRunOptionalParams

Необязательные параметры.
VirtualMachineImageTemplatesUpdateOptionalParams

Необязательные параметры.
VirtualNetworkConfig

Конфигурация виртуальной сети.

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

AutoRunState

Определяет значения для AutoRunState.
CreatedByType

Определяет значения для CreatedByType.
KnownCreatedByType можно использовать взаимозаменяемо с CreatedByType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

user
приложения
ManagedIdentity
ключ

DistributeVersionerUnion
ImageTemplateCustomizerUnion
ImageTemplateDistributorUnion
ImageTemplateInVMValidatorUnion
ImageTemplateSourceUnion
OnBuildError

Определяет значения для OnBuildError.
KnownOnBuildError можно использовать взаимозаменяемо с OnBuildError, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

очистки
прерывание
OperationsListNextResponse

Содержит данные ответа для операции listNext.
OperationsListResponse

Содержит данные ответа для операции списка.
ProvisioningErrorCode

Определяет значения для ProvisioningErrorCode.
KnownProvisioningErrorCode можно использовать взаимозаменяемо с ProvisioningErrorCode, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

BadSourceType
BadPIRSource
BadManagedImageSource
BadSharedImageVersionSource
BadCustomizerType
UnsupportedCustomizerType
NoCustomizerScript
BadValidatorType
UnsupportedValidatorType
NoValidatorScript
BadDistributeType
BadSharedImageDistribute
BadStagingResourceGroup
ServerError
Другие
ProvisioningState

Определяет значения для ProvisioningState.
ResourceIdentityType

Определяет значения для ResourceIdentityType.
RunState

Определяет значения для RunState.
RunSubState

Определяет значения для RunSubState.
SharedImageStorageAccountType

Определяет значения для SharedImageStorageAccountType.
KnownSharedImageStorageAccountType можно использовать взаимозаменяемо с SharedImageStorageAccountType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

Standard_LRS
Standard_ZRS
Premium_LRS
TriggerPropertiesUnion
TriggersCreateOrUpdateResponse

Содержит данные ответа для операции createOrUpdate.
TriggersDeleteResponse

Содержит данные ответа для операции удаления.
TriggersGetResponse

Содержит данные ответа для операции получения.
TriggersListByImageTemplateNextResponse

Содержит данные ответа для операции listByImageTemplateNext.
TriggersListByImageTemplateResponse

Содержит данные ответа для операции listByImageTemplate.
VMBootOptimizationState

Определяет значения для VMBootOptimizationState.
VirtualMachineImageTemplatesCreateOrUpdateResponse

Содержит данные ответа для операции createOrUpdate.
VirtualMachineImageTemplatesDeleteResponse

Содержит данные ответа для операции удаления.
VirtualMachineImageTemplatesGetResponse

Содержит данные ответа для операции получения.
VirtualMachineImageTemplatesGetRunOutputResponse

Содержит данные ответа для операции getRunOutput.
VirtualMachineImageTemplatesListByResourceGroupNextResponse

Содержит данные ответа для операции listByResourceGroupNext.
VirtualMachineImageTemplatesListByResourceGroupResponse

Содержит данные ответа для операции listByResourceGroup.
VirtualMachineImageTemplatesListNextResponse

Содержит данные ответа для операции listNext.
VirtualMachineImageTemplatesListResponse

Содержит данные ответа для операции списка.
VirtualMachineImageTemplatesListRunOutputsNextResponse

Содержит данные ответа для операции listRunOutputsNext.
VirtualMachineImageTemplatesListRunOutputsResponse

Содержит данные ответа для операции listRunOutputs.
VirtualMachineImageTemplatesUpdateResponse

Содержит данные ответа для операции обновления.

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

KnownCreatedByType

Известные значения CreatedByType, которые принимает служба.
KnownOnBuildError

Известные значения OnBuildError, которые служба принимает.
KnownProvisioningErrorCode

Известные значения ProvisioningErrorCode, которые служба принимает.
KnownSharedImageStorageAccountType

Известные значения SharedImageStorageAccountType, которые служба принимает.

Функции

getContinuationToken(unknown)

Учитывая последний .value, созданный byPage итератором, возвращает маркер продолжения, который можно использовать для начала разбиения по страницам с этой точки позже.

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

getContinuationToken(unknown)

Учитывая последний .value, созданный byPage итератором, возвращает маркер продолжения, который можно использовать для начала разбиения по страницам с этой точки позже.

function getContinuationToken(page: unknown): string | undefined

Параметры

page

unknown

Объект от доступа к value на итераторе IteratorResult из byPage итератора.

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

string | undefined

Маркер продолжения, который можно передать в byPage() во время будущих вызовов.