@azure/arm-imagebuilder package
Classes
| ImageBuilderClient |
Interfaces
| DataDisk |
Propriedades do disco de dados. |
| 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. |
| ImageBuilderClientOptionalParams |
Parâmetros opcionais para o cliente. |
| 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 |
| 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. |
| ImageTemplateProperties |
Descreve as propriedades de um template de imagem |
| 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. |
| ImageTemplatePropertiesOptimizeWorkload |
A otimização é aplicada à imagem para cargas de trabalho específicas. |
| 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. |
| OperationsListOptionalParams |
Parâmetros opcionais. |
| OperationsOperations |
Interface representando uma operação de operações. |
| PageSettings |
Opções para o método byPage |
| PagedAsyncIterableIterator |
Uma interface que permite iteração assíncrona iterável tanto para conclusão quanto por página. |
| 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 |
| RestorePollerOptions | |
| RunOutput |
Representa uma saída que foi criada executando um modelo de imagem. |
| RunOutputProperties |
Descreve as propriedades de uma saída de execução |
| SimplePollerLike |
Um sondador simples que pode ser usado para sondar uma operação de longa execução. |
| 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. |
| TriggerProperties |
Descreve as propriedades de um gatilho |
| TriggerStatus |
Descreve o status de um gatilho |
| TriggersCreateOrUpdateOptionalParams |
Parâmetros opcionais. |
| TriggersDeleteOptionalParams |
Parâmetros opcionais. |
| TriggersGetOptionalParams |
Parâmetros opcionais. |
| TriggersListByImageTemplateOptionalParams |
Parâmetros opcionais. |
| TriggersOperations |
Interface representando operações de acionamento. |
| UserAssignedIdentity |
Propriedades de identidade atribuídas pelo usuário |
| VirtualMachineImageTemplatesCancelOptionalParams |
Parâmetros opcionais. |
| VirtualMachineImageTemplatesCreateOrUpdateOptionalParams |
Parâmetros opcionais. |
| VirtualMachineImageTemplatesDeleteOptionalParams |
Parâmetros opcionais. |
| VirtualMachineImageTemplatesGetOptionalParams |
Parâmetros opcionais. |
| VirtualMachineImageTemplatesGetRunOutputOptionalParams |
Parâmetros opcionais. |
| VirtualMachineImageTemplatesListByResourceGroupOptionalParams |
Parâmetros opcionais. |
| VirtualMachineImageTemplatesListOptionalParams |
Parâmetros opcionais. |
| VirtualMachineImageTemplatesListRunOutputsOptionalParams |
Parâmetros opcionais. |
| VirtualMachineImageTemplatesOperations |
Interface representando uma operação VirtualMachineImageTemplates. |
| VirtualMachineImageTemplatesRunOptionalParams |
Parâmetros opcionais. |
| VirtualMachineImageTemplatesUpdateOptionalParams |
Parâmetros opcionais. |
| VirtualNetworkConfig |
Configuração de Rede Virtual. |
Aliases de tipo
| AutoRunState |
Habilitar esse campo disparará um build automático na criação ou atualização do modelo de imagem. |
| AzureSupportedClouds |
Os valores com suporte para a configuração de nuvem como um tipo literal de cadeia de caracteres |
| ContinuablePage |
Uma interface que descreve uma página de resultados. |
| CreatedByType |
O tipo de entidade que criou o recurso. Valores conhecidos compatíveis com o serviço
User: a entidade foi criada por um usuário. |
| DistributeVersionerUnion |
Alias para DistributeVersionerUnion |
| ImageTemplateCustomizerUnion |
Alias para ImageTemplateCustomizerUnion |
| ImageTemplateDistributorUnion |
Alias para ImageTemplateDistributorUnion |
| ImageTemplateInVMValidatorUnion |
Alias for ImageTemplateInVMValidatorUnion |
| ImageTemplateSourceUnion |
Alias para ImageTemplateSourceUnion |
| OnBuildError |
Comportamento de tratamento de erros após falha na construção Valores conhecidos compatíveis com o serviço
Limpeza: Limpeza |
| ProvisioningErrorCode |
Código de erro da falha de provisionamento Valores conhecidos compatíveis com o serviço
MáFonteTipo: MáFonteTipo |
| ProvisioningState |
Estado de provisionamento do recurso |
| ReplicationMode |
Descreve o modo de replicação para distribuição no Azure Compute Gallery. Omita usar o padrão (Full). Valores conhecidos compatíveis com o serviço
Full: modo de replicação total |
| ResourceIdentityType |
O tipo de identidade usado para o modelo de imagem. O tipo 'None' removerá as identidades do modelo de imagem. |
| RunState |
Estado da última corrida |
| RunSubState |
Subestado da última passagem |
| SharedImageStorageAccountType |
Especifica o tipo de conta de armazenamento a ser usado para armazenar a versão da imagem da Galeria de Computação do Azure. Valores conhecidos compatíveis com o serviço
Standard_LRS: Standard_LRS |
| TriggerPropertiesUnion |
Aliase para TriggerPropertiesUnion |
| VMBootOptimizationState |
Habilitar esse campo melhorará o tempo de inicialização da VM otimizando a saída da imagem personalizada final. |
| WorkloadOptimizationState |
Ativar esse campo otimizará imagens VM para cargas de trabalho específicas. |
Enumerações
| AzureClouds |
Um enum para descrever ambientes de nuvem Azure. |
| KnownCreatedByType |
O tipo de entidade que criou o recurso. |
| KnownOnBuildError |
Comportamento de tratamento de erros após falha na construção |
| KnownProvisioningErrorCode |
Código de erro da falha de provisionamento |
| KnownReplicationMode |
Descreve o modo de replicação para distribuição no Azure Compute Gallery. Omita usar o padrão (Full). |
| KnownSharedImageStorageAccountType |
Especifica o tipo de conta de armazenamento a ser usado para armazenar a versão da imagem da Galeria de Computação do Azure. |
| KnownVersions |
As versões de API disponíveis. |
Funções
| is |
Typeguard para RestError |
| restore |
Cria um sondador a partir do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondagens em um host diferente ou quando uma sondagem precisa ser construída depois que a original não estiver no escopo. |
Variáveis
| Rest |
Um tipo de erro personalizado para solicitações de pipeline com falha. |
Detalhes da função
isRestError(unknown)
Typeguard para RestError
function isRestError(e: unknown): e
Parâmetros
- e
-
unknown
Algo pego por uma cláusula catch.
Retornos
e
restorePoller<TResponse, TResult>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Cria um sondador a partir do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondagens em um host diferente ou quando uma sondagem precisa ser construída depois que a original não estiver no escopo.
function restorePoller<TResponse, TResult>(client: ImageBuilderClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parâmetros
- client
- ImageBuilderClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Retornos
PollerLike<OperationState<TResult>, TResult>
Detalhes da variável
RestError
Um tipo de erro personalizado para solicitações de pipeline com falha.
RestError: RestErrorConstructor