Share via

az image builder customizer

  • Referência

Gerencie personalizadores de modelos do construtor de imagens.

Comandos

Name Description Tipo Estado
az image builder customizer add

Adicione um personalizador de construtor de imagens a um modelo de construtor de imagens.

 Principal GA
az image builder customizer clear

Remova todos os personalizadores do construtor de imagens de um modelo de construtor de imagens.

 Principal GA
az image builder customizer remove

Remova um personalizador de construtor de imagens de um modelo de construtor de imagens.

 Principal GA

az image builder customizer add

Adicione um personalizador de construtor de imagens a um modelo de construtor de imagens.

Deve ser usado com --defer.

az image builder customizer add --customizer-name
                                --type {file, powershell, shell, windows-restart, windows-update}
                                [--defer]
                                [--dest-path]
                                [--exit-codes]
                                [--file-source]
                                [--filters]
                                [--ids]
                                [--inline-script]
                                [--name]
                                [--resource-group]
                                [--restart-check-command]
                                [--restart-command]
                                [--restart-timeout]
                                [--script-url]
                                [--search-criteria]
                                [--subscription]
                                [--update-limit]

Exemplos

Adicionar um personalizador de shell embutido a um modelo de imagem no cache de objetos cli

az image builder customizer add -n myTemplate -g myGroup \
    --inline-script "sudo mkdir /buildArtifacts" \
                    "sudo cp /tmp/index.html /buildArtifacts/index.html" \
    --customizer-name shellScriptInline --type shell --defer

Adicionar um personalizador de arquivos a um modelo de imagem no cache de objetos cli

az image builder customizer add -n myTemplate -g myGroup \
    --customizer-name myFile --type file \
    --file-source "https://my-remote-file.html" --dest-path "/tmp/index.html" --defer

Adicionar um personalizador de reinicialização do Windows a um modelo de imagem no cache de objetos cli

az image builder customizer add -n myTemplate -g myGroup \
--customizer-name shellScriptUrl \
--restart-check-command "echo Azure-Image-Builder-Restarted-the-VM  > \
                        c:\buildArtifacts\restart.txt" \
    --type windows-restart --restart-timeout 10m --defer

Adicione um personalizador de atualização do Windows a um modelo de imagem no cache de objetos da cli.

az image builder customizer add -n myTemplate -g myGroup --customizer-name winUpdate --type windows-update --search-criteria IsInstalled=0 --filters "exclude:\$_.Title -like \'*Preview*\'" "include:\$true" --update-limit 20 --defer

Parâmetros Obrigatórios

--customizer-name

Nome do personalizador.

--type -t

Tipo de personalizador a ser adicionado ao modelo de imagem.

valores aceites: file, powershell, shell, windows-restart, windows-update

Parâmetros Opcionais

--defer

Armazene temporariamente o objeto no cache local em vez de enviar para o Azure. Use az cache comandos para visualizar/limpar.

--dest-path

O caminho de destino absoluto para onde o arquivo especificado em --file-source será baixado na imagem.

--exit-codes -e

Lista separada por espaços de códigos de saída válidos, como inteiros.

--file-source

O URI do arquivo a ser baixado na imagem. Pode ser um link github, URI SAS para Armazenamento do Azure, etc.

--filters

Filtros delimitados por espaço para selecionar atualizações a serem aplicadas. Omitir ou especificar matriz vazia para usar o padrão (sem filtro).

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--inline-script

Lista separada por espaço de linhas de script embutidas para personalizar a imagem.

--name -n

O nome do modelo de imagem.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--restart-check-command

Comando para verificar se a reinicialização foi bem-sucedida.

--restart-command

Comando para executar a operação de reinicialização.

--restart-timeout

Tempo limite de reinicialização especificado como uma cadeia de caracteres que consiste em uma magnitude e unidade, por exemplo, '5m' (5 minutos) ou '2h' (2 horas).

valor predefinido: 5m
--script-url

URL do script para personalizar a imagem. O URL deve ser acessível publicamente.

--search-criteria

Critérios para pesquisar atualizações. Omita ou especifique a cadeia de caracteres vazia para usar o padrão (pesquisar tudo). Consulte o link acima para obter exemplos e uma descrição detalhada deste campo.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--update-limit

Número máximo de atualizações a aplicar de cada vez. Omita ou especifique 0 para usar o padrão (1000).

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az image builder customizer clear

Remova todos os personalizadores do construtor de imagens de um modelo de construtor de imagens.

Deve ser usado com --defer.

az image builder customizer clear [--defer]
                                  [--ids]
                                  [--name]
                                  [--resource-group]
                                  [--subscription]

Parâmetros Opcionais

--defer

Armazene temporariamente o objeto no cache local em vez de enviar para o Azure. Use az cache comandos para visualizar/limpar.

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

O nome do modelo de imagem.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az image builder customizer remove

Remova um personalizador de construtor de imagens de um modelo de construtor de imagens.

Deve ser usado com --defer.

az image builder customizer remove --customizer-name
                                   [--defer]
                                   [--ids]
                                   [--name]
                                   [--resource-group]
                                   [--subscription]

Parâmetros Obrigatórios

--customizer-name

Nome do personalizador.

Parâmetros Opcionais

--defer

Armazene temporariamente o objeto no cache local em vez de enviar para o Azure. Use az cache comandos para visualizar/limpar.

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

O nome do modelo de imagem.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.