az image builder
Gerencie e crie modelos de construtor de imagens.
Comandos
Nome | Description | Tipo | Status |
---|---|---|---|
az image builder cancel |
Cancele a compilação de imagem de longa execução com base no modelo de imagem. |
Núcleo | GA |
az image builder create |
Crie um modelo de construtor de imagens. |
Núcleo | GA |
az image builder customizer |
Gerenciar os personalizadores de modelo do Construtor de Imagens. |
Núcleo | GA |
az image builder customizer add |
Adicione um personalizador de construtor de imagens a um modelo de construtor de imagens. |
Núcleo | GA |
az image builder customizer clear |
Remova todos os personalizadores do construtor de imagens de um modelo de construtor de imagens. |
Núcleo | GA |
az image builder customizer remove |
Remova um personalizador do construtor de imagens de um modelo do construtor de imagens. |
Núcleo | GA |
az image builder delete |
Exclua o modelo do construtor de imagens. |
Núcleo | GA |
az image builder error-handler |
Gerenciar manipulador de erros de modelo do construtor de imagens. |
Núcleo | GA |
az image builder error-handler add |
Adicione manipulador de erros a um modelo de construtor de imagens existente. |
Núcleo | GA |
az image builder error-handler remove |
Remova o manipulador de erros de um modelo de construtor de imagens existente. |
Núcleo | GA |
az image builder error-handler show |
Mostrar manipulador de erros de um modelo de construtor de imagens existente. |
Núcleo | GA |
az image builder identity |
Gerenciar identidades de um modelo de construtor de imagens. |
Núcleo | GA |
az image builder identity assign |
Adicione identidades gerenciadas a um modelo de construtor de imagens existente. Atualmente, apenas uma identidade de usuário é suportada. |
Núcleo | GA |
az image builder identity remove |
Remova identidades gerenciadas de um modelo de construtor de imagens existente. |
Núcleo | GA |
az image builder identity show |
Exibir identidades gerenciadas de um modelo de construtor de imagens. |
Núcleo | GA |
az image builder list |
Listar modelos do construtor de imagens. |
Núcleo | GA |
az image builder optimizer |
Gerenciar otimizador de modelo do construtor de imagens. |
Núcleo | GA |
az image builder optimizer add |
Adicione o otimizador a um modelo de construtor de imagens existente. |
Núcleo | GA |
az image builder optimizer remove |
Remova o otimizador de um modelo de construtor de imagens existente. |
Núcleo | GA |
az image builder optimizer show |
Mostrar otimizador de um modelo de construtor de imagens existente. |
Núcleo | GA |
az image builder optimizer update |
Atualize um otimizador a partir de um modelo de construtor de imagens existente. |
Núcleo | GA |
az image builder output |
Gerenciar os distribuidores de saída de modelo do Construtor de Imagens. |
Núcleo | GA |
az image builder output add |
Adicione um distribuidor de saída do construtor de imagens a um modelo de construtor de imagens. |
Núcleo | GA |
az image builder output clear |
Remova todos os distribuidores de saída do construtor de imagens de um modelo de construtor de imagens. |
Núcleo | GA |
az image builder output remove |
Remova um distribuidor de saída do construtor de imagens de um modelo do construtor de imagens. |
Núcleo | GA |
az image builder output versioning |
Gerenciar o versionador de saída de modelo do construtor de imagens. |
Núcleo | GA |
az image builder output versioning remove |
Remova todas as opções de controle de versão nas saídas especificadas. |
Núcleo | GA |
az image builder output versioning set |
Defina o versionador de saída do construtor de imagens de um modelo de construtor de imagens. |
Núcleo | GA |
az image builder output versioning show |
Mostrar opções de controle de versão em saídas especificadas. |
Núcleo | GA |
az image builder run |
Crie um modelo de construtor de imagens. |
Núcleo | GA |
az image builder show |
Mostrar um modelo de construtor de imagens. |
Núcleo | GA |
az image builder show-runs |
Mostrar as saídas de execução de um modelo de construtor de imagens. |
Núcleo | GA |
az image builder trigger |
Gerenciar gatilho de modelo do construtor de imagens. |
Núcleo | GA |
az image builder trigger create |
Crie um gatilho para o modelo de imagem de máquina virtual especificado. |
Núcleo | GA |
az image builder trigger delete |
Exclua um gatilho para o modelo de imagem de máquina virtual especificado. |
Núcleo | GA |
az image builder trigger list |
Liste todos os gatilhos para o recurso Modelo de Imagem especificado. |
Núcleo | GA |
az image builder trigger show |
Obtenha o gatilho especificado para o recurso de modelo de imagem especificado. |
Núcleo | GA |
az image builder trigger wait |
Coloque a CLI em um estado de espera até que uma condição seja atendida. |
Núcleo | GA |
az image builder update |
Atualizar um modelo de construtor de imagens. |
Núcleo | GA |
az image builder validator |
Gerenciar validação de modelo do construtor de imagens. |
Núcleo | GA |
az image builder validator add |
Adicione validação a um modelo de construtor de imagens existente. |
Núcleo | GA |
az image builder validator remove |
Remova a validação de um modelo de construtor de imagens existente. |
Núcleo | GA |
az image builder validator show |
Mostrar a validação de um modelo de construtor de imagens existente. |
Núcleo | GA |
az image builder wait |
Coloque a CLI em um estado de espera até que uma condição do modelo seja atendida. |
Núcleo | GA |
az image builder cancel
Cancele a compilação de imagem de longa execução com base no modelo de imagem.
az image builder cancel [--ids]
[--name]
[--resource-group]
[--subscription]
Exemplos
Cancelar uma compilação de imagem.
az image builder cancel -n mytemplate -g my-group
Parâmetros Opcionais
Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
O nome do modelo de imagem.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az image builder create
Crie um modelo de construtor de imagens.
az image builder create --name
--resource-group
[--build-timeout]
[--build-vm-identities]
[--checksum]
[--defer]
[--identity]
[--image-source]
[--image-template]
[--location]
[--managed-image-destinations]
[--no-wait]
[--os-disk-size]
[--proxy-vm-size]
[--scripts]
[--shared-image-destinations]
[--staging-resource-group]
[--subnet]
[--tags]
[--validator]
[--vm-size]
[--vnet]
Exemplos
Crie um modelo de construtor de imagens a partir de uma imagem do Ubuntu2204. Distribua-o como uma imagem gerenciada e uma versão de imagem da galeria de imagens compartilhada. Especifique a ID do grupo de recursos de preparo como o modelo de imagem que será usado para criar a imagem.
scripts="https://my-script-url.net/customize_script.sh"
imagesource="Canonical:0001-com-ubuntu-server-jammy:22_04-lts-gen2:latest"
az image builder create --image-source $imagesource -n myTemplate -g myGroup \
--scripts $scripts --managed-image-destinations image_1=westus \
--shared-image-destinations my_shared_gallery/linux_image_def=westus,brazilsouth \
--identity myIdentity --staging-resource-group myStagingResourceGroup
Crie um modelo de construtor de imagens usando um arquivo de modelo de imagem.
az image builder create -g my-group -n myTemplate --image-template filename
[Avançado] Crie um modelo de imagem com vários personalizadores e distribuidores usando o cache de objetos da CLI via --defer. Suporta recursos como: nomes de customizador e saída, códigos de saída do powershell, scripts embutidos, windows restart, personalizadores de arquivos, tags de artefato e distribuidores de saída vhd.
script="https://my-script-url.com/customize_script.ps1"
imagesource="MicrosoftWindowsServer:WindowsServer:2019-Datacenter:2019.0.20190214"
# create and update template object in local cli cache. Defers put request to ARM
# Cache object ttl set via az configure.
az image builder create --image-source $imagesource -n myTemplate \
-g myGroup --scripts $script --identity myIdentity --defer
# add customizers
az image builder customizer add -n myTemplate -g myGroup \
--customizer-name myPwshScript --exit-codes 0 1 --inline-script \
"mkdir c:\buildActions" "echo Azure-Image-Builder-Was-Here \
> c:\buildActions\Output.txt" --type powershell --defer
az image builder customizer add -n myTemplate -g myGroup \
--customizer-name myFileCustomizer --type file \
--file-source "https://my-file-source.net/file.txt" \
--dest-path "c:\buildArtifacts\file.txt" --defer
# add distributors
az image builder output add -n myTemplate -g myGroup --is-vhd \
--output-name myWinImageVhd --artifact-tags "is_vhd=True" --defer
az image builder output add -n myTemplate -g myGroup \
--output-name myWinImageManaged --managed-image winImage \
--managed-image-location eastus \
--artifact-tags "is_vhd=False" --defer
# Stop deferring put request to ARM. Create the template from the object cache.
# Cache object will be deleted.
az image builder update -n myTemplate -g myGroup
Parâmetros Exigidos
O nome do modelo de imagem.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Opcionais
A duração máxima a aguardar durante a criação do modelo de imagem, em minutos. O padrão é 60.
Configuração opcional da rede virtual a ser usada para implantar a máquina virtual de compilação. Omita isso se nenhuma rede virtual específica precisar ser usada.
A soma de verificação SHA256 da imagem ISO da Red Hat.
Armazene temporariamente o objeto no cache local em vez de enviar para o Azure. Use az cache
comandos para exibir/limpar.
Lista de identidades atribuídas pelo usuário (nome ou ID, espaço delimitado) do modelo de imagem.
A imagem base a ser personalizada. Deve ser um URN de imagem de plataforma válido, alias de imagem de plataforma, URI de imagem ISO Red Hat, nome/ID de imagem gerenciada ou ID de versão de imagem compartilhada.
Caminho local ou URL para um arquivo de modelo de imagem. Ao usar --image-template, todos os outros parâmetros são ignorados, exceto -g e -n. Referência: https://docs.microsoft.com/azure/virtual-machines/linux/image-builder-json.
Local. Valores de: az account list-locations
. Você pode configurar o local padrão usando az configure --defaults location=<location>
.
Informações gerenciadas do distribuidor de saída de imagem. Lista separada por espaço de pares chave-valor. Ex: "image_1=westus2 image_2=westus". Cada chave é o nome ou ID de recurso da imagem gerenciada a ser criada. Cada valor é o local da imagem.
Não aguarde a conclusão da operação de execução longa.
Tamanho do disco do sistema operacional em GB. Omita ou especifique 0 para usar o tamanho padrão do disco do sistema operacional do Azure.
Tamanho da máquina virtual usada para criar, personalizar e capturar imagens (Standard_D1_v2 para imagens Gen1 e Standard_D2ds_v4 para imagens Gen2).
Lista separada por espaço de scripts shell ou powershell para personalizar a imagem. Cada script deve ser uma URL acessível publicamente. Infere o tipo de script da extensão do arquivo ('.sh' ou '.ps1') ou do tipo de origem. Mais opções de personalização e flexibilidade, consulte: 'az image template customizer add'.
Galeria de imagens compartilhada (sig) de informações do distribuidor de saída. Lista separada por espaço de pares chave-valor. Ex.: "my_gallery_1/image_def_1=eastus,westus my_gallery_2/image_def_2=uksouth,canadaeast,francesouth." Cada chave é o ID de definição de imagem sig ou nome da galeria sig e definição de imagem sig delimitada por um "/". Cada valor é uma lista delimitada por vírgulas de locais de réplica.
A ID do grupo de recursos de preparo na mesma assinatura que o modelo de imagem que será usado para criar a imagem.
Nome ou ID da sub-rede para implantar a máquina virtual de compilação.
Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.
O tipo de validação que você deseja usar na Imagem. Por exemplo, "Shell" pode ser validação de shell.
Tamanho da máquina virtual usada para criar, personalizar e capturar imagens. Omita ou especifique a cadeia de caracteres vazia para usar o padrão (Standard_D1_v2).
Nome da VNET para implantar a máquina virtual de compilação. Você só deve especificá-lo quando sub-rede é um nome.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az image builder delete
Exclua o modelo do construtor de imagens.
az image builder delete [--ids]
[--name]
[--resource-group]
[--subscription]
Exemplos
Exclua o modelo do construtor de imagens. (gerado automaticamente)
az image builder delete --name MyImageTemplate --resource-group MyResourceGroup
Parâmetros Opcionais
Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
O nome do modelo de imagem.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az image builder list
Listar modelos do construtor de imagens.
az image builder list [--resource-group]
Parâmetros Opcionais
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az image builder run
Crie um modelo de construtor de imagens.
az image builder run [--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
Exemplos
Inicie uma compilação de modelo e aguarde a conclusão.
az image builder run -n mytemplate -g my-group --no-wait
az image builder wait -n mytemplate -g aibmdi \
--custom "lastRunStatus.runState!='Running'"
az image builder show -n mytemplate -g my-group
Parâmetros Opcionais
Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
O nome do modelo de imagem.
Não aguarde a conclusão da operação de execução longa.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az image builder show
Mostrar um modelo de construtor de imagens.
az image builder show [--ids]
[--name]
[--resource-group]
[--subscription]
Exemplos
Mostrar um modelo de construtor de imagens (gerado automaticamente)
az image builder show --name mytemplate --resource-group my-group
Parâmetros Opcionais
Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
O nome do modelo de imagem.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az image builder show-runs
Mostrar as saídas de execução de um modelo de construtor de imagens.
az image builder show-runs [--ids]
[--name]
[--output-name]
[--resource-group]
[--subscription]
Exemplos
Execute uma execução de compilação de modelo e, em seguida, exiba suas saídas de execução.
az image builder run -n mytemplate -g my-group --no-wait
az image builder wait -n mytemplate -g aibmdi \
--custom "lastRunStatus.runState!='Running'"
az image builder show-runs -n mytemplate -g my-group
Parâmetros Opcionais
Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
O nome do modelo de imagem.
Nome da saída de execução do construtor de imagens.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az image builder update
Atualizar um modelo de construtor de imagens.
No momento, não há suporte para a atualização de modelos de um construtor de imagens. Esse comando pode ser usado em conjunto com --defer para atualizar um objeto de modelo de imagem no cache da CLI. Sem --defer, ele recupera o modelo de imagem especificado do cache e envia uma solicitação ao Azure para criar o modelo de imagem.
az image builder update [--add]
[--defer]
[--force-string]
[--ids]
[--name]
[--remove]
[--resource-group]
[--set]
[--subscription]
Exemplos
Crie um recurso de modelo a partir de um objeto de modelo no cache da cli. Consulte "az image builder create / output add / customizer add --help" e "az cache -h" para obter mais informações
# create and write template object to local cli cache
az image builder create --image-source {image_source} -n mytemplate -g my-group \
--scripts {script} --managed-image-destinations image_1=westus --identity myidentity --defer
# add customizers and outputs to local cache template object via az image template output / customizer add
# one can also update cache object properties through generic update options, such as: --set
az image builder output add -n mytemplate -g my-group --output-name my-win-image-managed \
--artifact-tags "is_vhd=False" --managed-image winImage --managed-image-location eastus --defer
# send template create request to azure to create template resource
az image builder update -n mytemplate -g my-group
Parâmetros Opcionais
Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>
.
Armazene temporariamente o objeto no cache local em vez de enviar para o Azure. Use az cache
comandos para exibir/limpar.
Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter para JSON.
Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
O nome do modelo de imagem.
Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove>
OU --remove propertyToRemove
.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=<value>
.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.
az image builder wait
Coloque a CLI em um estado de espera até que uma condição do modelo seja atendida.
az image builder wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Exemplos
Inicie uma compilação de modelo e aguarde a conclusão.
az image builder run -n mytemplate -g my-group --no-wait
az image builder wait -n mytemplate -g aibmdi \
--custom "lastRunStatus.runState!='Running'"
az image builder show -n mytemplate -g my-group
Parâmetros Opcionais
Aguarde até criar com 'provisioningState' em 'Succeeded'.
Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Aguarde até ser excluído.
Aguarde até que o recurso exista.
Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.
Intervalo de sondagem em segundos.
O nome do modelo de imagem.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Espera máxima em segundos.
Aguarde até que seja atualizado com provisioningState em 'Succeeded'.
Parâmetros Globais
Aumente o detalhamento do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
.
Aumentar o detalhamento do log. Use --debug para logs de depuração completos.