@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 da versão da imagem de origem |
| ErrorAdditionalInfo |
O erro de gerenciamento de recursos informações adicionais. |
| ErrorDetail |
O detalhe do erro. |
| ErrorResponse |
Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro para operações com falha. |
| ImageBuilderClientOptionalParams |
Parâmetros opcionais para o cliente. |
| ImageTemplate |
O modelo de imagem é um recurso 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 para 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 para o modelo de imagem. |
| ImageTemplateInVMValidator |
Descreve uma unidade de in-VM validação de imagem |
| ImageTemplateLastRunStatus |
Descreve o status mais recente da execução de um modelo de imagem |
| ImageTemplateManagedImageDistributor |
Distribua como uma imagem de disco gerenciada. |
| ImageTemplateManagedImageSource |
Descreve uma fonte de imagem que é uma imagem gerenciada na assinatura do cliente. Esta imagem deve residir na mesma assinatura e região que o modelo do Construtor de Imagens. |
| ImageTemplatePlatformImageSource |
Descreve uma fonte de imagem do Azure Gallery Images. |
| ImageTemplatePowerShellCustomizer |
Executa o PowerShell especificado na VM (Windows). Corresponde ao provisionador powershell do Packer. Exatamente um dos 'scriptUri' ou 'inline' pode ser especificado. |
| ImageTemplatePowerShellValidator |
Executa o script do PowerShell especificado durante a fase de validação (Windows). Corresponde ao provisionador powershell do Packer. Exatamente um dos 'scriptUri' ou 'inline' pode ser especificado. |
| ImageTemplateProperties |
Descreve as propriedades de um modelo de imagem |
| ImageTemplatePropertiesErrorHandling |
Opções de tratamento de erros em caso de falha de compilação |
| ImageTemplatePropertiesOptimize |
Especifica a otimização a ser executada na imagem. |
| ImageTemplatePropertiesOptimizeVmBoot |
A otimização é aplicada na imagem para uma inicialização mais rápida da VM. |
| 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 |
Reinicia uma VM e aguarda que ela volte a ficar online (Windows). Corresponde ao Packer windows-restart provisioner |
| ImageTemplateSharedImageDistributor |
Distribua através 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 shell script durante a fase de personalização (Linux). Corresponde ao provisionador de shell Packer. Exatamente um dos 'scriptUri' ou 'inline' pode ser especificado. |
| ImageTemplateShellValidator |
Executa o shell script especificado durante a fase de validação (Linux). Corresponde ao provisionador de shell Packer. Exatamente um dos 'scriptUri' ou 'inline' pode ser especificado. |
| ImageTemplateSource |
Descreve uma fonte de imagem de máquina virtual para criar, 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 as atualizações do Windows. Corresponde ao Packer Windows Update Provisioner (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 que representa 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 até a conclusão e por página. |
| PlatformImagePurchasePlan |
Configuração do plano de compra para imagem da plataforma. |
| ProvisioningError |
Descreve o erro ocorrido ao criar ou atualizar um modelo de imagem |
| ProxyResource |
A definição de modelo de recurso para um recurso de proxy do Azure Resource Manager. Ele não terá tags 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 poller simples que pode ser usado para sondar uma operação de longa duração. |
| SourceImageTriggerProperties |
Propriedades do tipo de gatilho SourceImage |
| SystemData |
Metadados referentes à 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 recursos para um recurso de nível superior rastreado do Azure Resource Manager que tem 'tags' e um 'local' |
| Trigger |
Representa um gatilho que pode invocar uma compilação 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 Triggers. |
| 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 |
Ativar este campo acionará uma compilação automática na criação ou atualização de modelo de imagem. |
| AzureSupportedClouds |
Os valores suportados 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 suportados pelo 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 gestão de erros após falha na compilação Valores conhecidos suportados pelo serviço
Limpeza: Limpeza |
| ProvisioningErrorCode |
Código de erro da falha de provisionamento Valores conhecidos suportados pelo serviço
MáFonteTipo: MauFonteTipo |
| ProvisioningState |
Estado de provisionamento do recurso |
| ReplicationMode |
Descreve o modo de replicação para distribuição no Azure Compute Gallery. Omitir usar o padrão (Full). Valores conhecidos suportados pelo serviço
Completo: Modo de replicação total |
| ResourceIdentityType |
O tipo de identidade usado para o modelo de imagem. O tipo 'Nenhum' removerá todas as identidades do modelo de imagem. |
| RunState |
Estado da última corrida |
| RunSubState |
Sub-estado da última corrida |
| SharedImageStorageAccountType |
Especifica o tipo de conta de armazenamento a ser usado para armazenar a versão da imagem do Azure Compute Gallery. Valores conhecidos suportados pelo serviço
Standard_LRS: Standard_LRS |
| TriggerPropertiesUnion |
Alias para TriggerPropertiesUnion |
| VMBootOptimizationState |
Habilitar esse campo melhorará o tempo de inicialização da VM otimizando a saída final da imagem personalizada. |
| WorkloadOptimizationState |
Ativar este campo irá otimizar imagens VM para cargas de trabalho específicas. |
Enumerações
| AzureClouds |
Um enum para descrever ambientes Azure Cloud. |
| KnownCreatedByType |
O tipo de entidade que criou o recurso. |
| KnownOnBuildError |
Comportamento de gestão de erros após falha na compilação |
| KnownProvisioningErrorCode |
Código de erro da falha de provisionamento |
| KnownReplicationMode |
Descreve o modo de replicação para distribuição no Azure Compute Gallery. Omitir usar o padrão (Full). |
| KnownSharedImageStorageAccountType |
Especifica o tipo de conta de armazenamento a ser usado para armazenar a versão da imagem do Azure Compute Gallery. |
| KnownVersions |
As versões de API disponíveis. |
Funções
| is |
Typeguard para RestError |
| restore |
Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo. |
Variáveis
| Rest |
Um tipo de erro personalizado para solicitações de pipeline com falha. |
Detalhes de Função
isRestError(unknown)
Typeguard para RestError
function isRestError(e: unknown): e
Parâmetros
- e
-
unknown
Algo apanhado por uma cláusula de captura.
Devoluções
e
restorePoller<TResponse, TResult>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está 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>
Devoluções
PollerLike<OperationState<TResult>, TResult>
Detalhes das variáveis
RestError
Um tipo de erro personalizado para solicitações de pipeline com falha.
RestError: RestErrorConstructor