Compartilhar via


@azure/arm-imagebuilder package

Classes

ImageBuilderClient

Interfaces

DistributeVersioner

Descreve como gerar um novo número de versão x.y.z para distribuição.

DistributeVersionerLatest

Gera o número de versão que será mais recente com base nos números de versão existentes.

DistributeVersionerSource

Gera o número da versão com base no número de versão da imagem de origem

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).

ImageBuilderClientOptionalParams

Parâmetros opcionais.

ImageTemplate

O modelo de imagem é um recurso do ARM gerenciado pelo provedor Microsoft.VirtualMachineImages

ImageTemplateAutoRun

Indica se o modelo de imagem precisa ser criado na criação/atualização

ImageTemplateCustomizer

Descreve uma unidade de personalização de imagem

ImageTemplateDistributor

Objeto de distribuição genérico

ImageTemplateFileCustomizer

Carrega arquivos em VMs (Linux, Windows). Corresponde ao provisionador de arquivos packer

ImageTemplateFileValidator

Carrega arquivos necessários para validação em VMs (Linux, Windows). Corresponde ao provisionador de arquivos packer

ImageTemplateIdentity

Identidade do modelo de imagem.

ImageTemplateInVMValidator

Descreve uma unidade de in-VM validação da imagem

ImageTemplateLastRunStatus

Descreve o status mais recente da execução de um modelo de imagem

ImageTemplateListResult

O resultado da operação de modelos de imagem de lista

ImageTemplateManagedImageDistributor

Distribua como uma imagem de disco gerenciado.

ImageTemplateManagedImageSource

Descreve uma fonte de imagem que é uma imagem gerenciada na assinatura do cliente. Essa imagem deve residir na mesma assinatura e região que o modelo do Construtor de Imagens.

ImageTemplatePlatformImageSource

Descreve uma fonte de imagem do de Imagens da Galeria do Azure.

ImageTemplatePowerShellCustomizer

Executa o PowerShell especificado na VM (Windows). Corresponde ao provisionador do PowerShell do Packer. Exatamente um de 'scriptUri' ou 'embutido' pode ser especificado.

ImageTemplatePowerShellValidator

Executa o script do PowerShell especificado durante a fase de validação (Windows). Corresponde ao provisionador do PowerShell do Packer. Exatamente um de 'scriptUri' ou 'embutido' pode ser especificado.

ImageTemplatePropertiesErrorHandling

Opções de tratamento de erros após uma falha de build

ImageTemplatePropertiesOptimize

Especifica a otimização a ser executada na imagem.

ImageTemplatePropertiesOptimizeVmBoot

A otimização é aplicada na imagem para uma inicialização de VM mais rápida.

ImageTemplatePropertiesValidate

Opções de configuração e lista de validações a serem executadas na imagem resultante.

ImageTemplateRestartCustomizer

Reinicializa uma VM e aguarda que ela volte a ficar online (Windows). Corresponde ao provisionador de reinicialização de janelas do Packer

ImageTemplateSharedImageDistributor

Distribua por meio da Galeria de Computação do Azure.

ImageTemplateSharedImageVersionSource

Descreve uma fonte de imagem que é uma versão de imagem em uma Galeria de Computação do Azure ou em uma Galeria Compartilhada Direta.

ImageTemplateShellCustomizer

Executa um script de shell durante a fase de personalização (Linux). Corresponde ao provisionador de shell do Packer. Exatamente um de 'scriptUri' ou 'embutido' pode ser especificado.

ImageTemplateShellValidator

Executa o script de shell especificado durante a fase de validação (Linux). Corresponde ao provisionador de shell do Packer. Exatamente um de 'scriptUri' ou 'embutido' pode ser especificado.

ImageTemplateSource

Descreve uma fonte de imagem de máquina virtual para compilar, personalizar e distribuir

ImageTemplateUpdateParameters

Parâmetros para atualizar um modelo de imagem.

ImageTemplateUpdateParametersProperties

Parâmetros para atualizar um modelo de imagem.

ImageTemplateVhdDistributor

Distribua via VHD em uma conta de armazenamento.

ImageTemplateVmProfile

Descreve as máquinas virtuais usadas para criar e validar imagens

ImageTemplateWindowsUpdateCustomizer

Instala o Windows Updates. Corresponde ao Provisionador do Windows Update do Packer (https://github.com/rgl/packer-provisioner-windows-update)

Operation

Uma operação de API REST

OperationDisplay

O objeto que descreve a operação.

OperationListResult

Resultado da solicitação para listar as operações da API REST. Ele contém uma lista de operações e uma URL nextLink para obter o próximo conjunto de resultados.

Operations

Interface que representa uma operação.

OperationsListNextOptionalParams

Parâmetros opcionais.

OperationsListOptionalParams

Parâmetros opcionais.

PlatformImagePurchasePlan

Configuração do plano de compra para a imagem da plataforma.

ProvisioningError

Descreve o erro ocorrido ao criar ou atualizar um modelo de imagem

ProxyResource

A definição do modelo de recurso para um recurso proxy do Azure Resource Manager. Ele não terá marcas e um local

Resource

Campos comuns que são retornados na resposta para todos os recursos do Azure Resource Manager

RunOutput

Representa uma saída que foi criada executando um modelo de imagem.

RunOutputCollection

O resultado da operação de saídas de execução de lista

SourceImageTriggerProperties

Propriedades do tipo de gatilho SourceImage

SystemData

Metadados relativos à criação e última modificação do recurso.

TargetRegion

Descreve as informações da região de destino.

TrackedResource

A definição do modelo de recurso para um recurso de nível superior rastreado pelo Azure Resource Manager que tem 'marcas' e um 'local'

Trigger

Representa um gatilho que pode invocar um build de modelo de imagem.

TriggerCollection

O resultado da operação de gatilhos de lista

TriggerProperties

Descreve as propriedades de um gatilho

TriggerStatus

Descreve o status de um gatilho

Triggers

Interface que representa um Gatilhos.

TriggersCreateOrUpdateOptionalParams

Parâmetros opcionais.

TriggersDeleteHeaders

Define cabeçalhos para Triggers_delete operação.

TriggersDeleteOptionalParams

Parâmetros opcionais.

TriggersGetOptionalParams

Parâmetros opcionais.

TriggersListByImageTemplateNextOptionalParams

Parâmetros opcionais.

TriggersListByImageTemplateOptionalParams

Parâmetros opcionais.

UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

VirtualMachineImageTemplates

Interface que representa um VirtualMachineImageTemplates.

VirtualMachineImageTemplatesCancelOptionalParams

Parâmetros opcionais.

VirtualMachineImageTemplatesCreateOrUpdateOptionalParams

Parâmetros opcionais.

VirtualMachineImageTemplatesDeleteHeaders

Define cabeçalhos para VirtualMachineImageTemplates_delete operação.

VirtualMachineImageTemplatesDeleteOptionalParams

Parâmetros opcionais.

VirtualMachineImageTemplatesGetOptionalParams

Parâmetros opcionais.

VirtualMachineImageTemplatesGetRunOutputOptionalParams

Parâmetros opcionais.

VirtualMachineImageTemplatesListByResourceGroupNextOptionalParams

Parâmetros opcionais.

VirtualMachineImageTemplatesListByResourceGroupOptionalParams

Parâmetros opcionais.

VirtualMachineImageTemplatesListNextOptionalParams

Parâmetros opcionais.

VirtualMachineImageTemplatesListOptionalParams

Parâmetros opcionais.

VirtualMachineImageTemplatesListRunOutputsNextOptionalParams

Parâmetros opcionais.

VirtualMachineImageTemplatesListRunOutputsOptionalParams

Parâmetros opcionais.

VirtualMachineImageTemplatesRunOptionalParams

Parâmetros opcionais.

VirtualMachineImageTemplatesUpdateOptionalParams

Parâmetros opcionais.

VirtualNetworkConfig

Configuração de Rede Virtual.

Aliases de tipo

AutoRunState

Define valores para AutoRunState.

CreatedByType

Define valores para CreatedByType.
KnownCreatedByType pode ser usado de forma intercambiável com CreatedByType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

de usuário do
application
ManagedIdentity
key

DistributeVersionerUnion
ImageTemplateCustomizerUnion
ImageTemplateDistributorUnion
ImageTemplateInVMValidatorUnion
ImageTemplateSourceUnion
OnBuildError

Define valores para OnBuildError.
KnownOnBuildError pode ser usada de forma intercambiável com OnBuildError, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

de limpeza
anulação

OperationsListNextResponse

Contém dados de resposta para a operação listNext.

OperationsListResponse

Contém dados de resposta para a operação de lista.

ProvisioningErrorCode

Define valores para ProvisioningErrorCode.
KnownProvisioningErrorCode podem ser usados de forma intercambiável com ProvisioningErrorCode, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

BadSourceType
BadPIRSource
BadManagedImageSource
BadSharedImageVersionSource
BadCustomizerType
UnsupportedCustomizerType
NoCustomizerScript
BadValidatorType
UnsupportedValidatorType
NoValidatorScript
BadDistributeType
BadSharedImageDistribute
BadStagingResourceGroup
ServerError
Outros

ProvisioningState

Define valores para ProvisioningState.

ResourceIdentityType

Define valores para ResourceIdentityType.

RunState

Define valores para RunState.

RunSubState

Define valores para RunSubState.

SharedImageStorageAccountType

Define valores para SharedImageStorageAccountType.
KnownSharedImageStorageAccountType pode ser usado de forma intercambiável com SharedImageStorageAccountType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Standard_LRS
Standard_ZRS
Premium_LRS

TriggerPropertiesUnion
TriggersCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

TriggersDeleteResponse

Contém dados de resposta para a operação de exclusão.

TriggersGetResponse

Contém dados de resposta para a operação de obtenção.

TriggersListByImageTemplateNextResponse

Contém dados de resposta para a operação listByImageTemplateNext.

TriggersListByImageTemplateResponse

Contém dados de resposta para a operação listByImageTemplate.

VMBootOptimizationState

Define valores para VMBootOptimizationState.

VirtualMachineImageTemplatesCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

VirtualMachineImageTemplatesDeleteResponse

Contém dados de resposta para a operação de exclusão.

VirtualMachineImageTemplatesGetResponse

Contém dados de resposta para a operação de obtenção.

VirtualMachineImageTemplatesGetRunOutputResponse

Contém dados de resposta para a operação getRunOutput.

VirtualMachineImageTemplatesListByResourceGroupNextResponse

Contém dados de resposta para a operação listByResourceGroupNext.

VirtualMachineImageTemplatesListByResourceGroupResponse

Contém dados de resposta para a operação listByResourceGroup.

VirtualMachineImageTemplatesListNextResponse

Contém dados de resposta para a operação listNext.

VirtualMachineImageTemplatesListResponse

Contém dados de resposta para a operação de lista.

VirtualMachineImageTemplatesListRunOutputsNextResponse

Contém dados de resposta para a operação listRunOutputsNext.

VirtualMachineImageTemplatesListRunOutputsResponse

Contém dados de resposta para a operação listRunOutputs.

VirtualMachineImageTemplatesUpdateResponse

Contém dados de resposta para a operação de atualização.

Enumerações

KnownCreatedByType

Valores conhecidos de CreatedByType que o serviço aceita.

KnownOnBuildError

Valores conhecidos de OnBuildError que o serviço aceita.

KnownProvisioningErrorCode

Valores conhecidos de ProvisioningErrorCode que o serviço aceita.

KnownSharedImageStorageAccountType

Valores conhecidos de SharedImageStorageAccountType que o serviço aceita.

Funções

getContinuationToken(unknown)

Dado o último .value produzido pelo iterador byPage, retorna um token de continuação que pode ser usado para iniciar a paginação a partir desse ponto mais tarde.

Detalhes da função

getContinuationToken(unknown)

Dado o último .value produzido pelo iterador byPage, retorna um token de continuação que pode ser usado para iniciar a paginação a partir desse ponto mais tarde.

function getContinuationToken(page: unknown): string | undefined

Parâmetros

page

unknown

Um objeto de acessar value no IteratorResult de um iterador de byPage.

Retornos

string | undefined

O token de continuação que pode ser passado para byPage() durante chamadas futuras.