az migrate runbook execution

Note

Essa referência faz parte da extensão migrate para o CLI do Azure (versão 2.75.0 ou superior). A extensão instalará automaticamente na primeira vez que você executar um comando de execução de runbook de migração az . Saiba mais sobre extensões.

O grupo de comandos 'migrar runbook' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Gerenciar execuções de runbook.

Comandos

Nome Description Tipo Status
az migrate runbook execution cancel

Cancele uma execução de runbook em andamento ou pausada.

Extensão Preview
az migrate runbook execution list

Liste as execuções de um runbook.

Extensão Preview
az migrate runbook execution parameter

Baixe, carregue e configure o arquivo de parâmetros de entrada de uma execução.

Extensão Preview
az migrate runbook execution parameter configure

Gere um editor HTML offline para os parâmetros de uma execução.

Extensão Preview
az migrate runbook execution parameter download

Baixe os arquivos de parâmetros de uma execução.

Extensão Preview
az migrate runbook execution parameter upload

Carregue o arquivo de parâmetros de entrada de uma execução.

Extensão Preview
az migrate runbook execution pause

Pausar uma execução de runbook em andamento.

Extensão Preview
az migrate runbook execution resume

Retome uma execução de runbook pausada.

Extensão Preview
az migrate runbook execution show

Mostrar (ou observar) o status de uma execução de runbook.

Extensão Preview
az migrate runbook execution start

Inicie uma nova execução de um runbook.

Extensão Preview
az migrate runbook execution step

Agir em uma única etapa dentro de uma execução de runbook.

Extensão Preview
az migrate runbook execution step approve

Forneça aprovação para uma etapa de tipo de aprovação durante a execução.

Extensão Preview
az migrate runbook execution step complete

Marque uma etapa manual como concluída durante a execução.

Extensão Preview
az migrate runbook execution step retry

Reinicie a execução de uma etapa com falha.

Extensão Preview
az migrate runbook execution visualize

Renderize o status de uma execução como um grafo HTML autocontido.

Extensão Preview

az migrate runbook execution cancel

Versão Prévia

O grupo de comandos "migrar a execução do runbook" está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Cancele uma execução de runbook em andamento ou pausada.

O cancelamento é terminal; uma execução cancelada não pode ser retomada. Inicie uma nova execução.

az migrate runbook execution cancel --execution-id
                                    --name --runbook-name
                                    --project-name
                                    --resource-group
                                    [--acquire-policy-token]
                                    [--change-reference]
                                    [--yes]

Exemplos

Cancelar uma execução.

az migrate runbook execution cancel -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution

Parâmetros obrigatórios

--execution-id

ID da execução do runbook.

--name --runbook-name -n

Nome do runbook.

--project-name -p

Nome do projeto Migrações para Azure. Você pode configurar o padrão usando az configure --defaults migrate_project=<name>o .

--resource-group -g

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

A ID de referência de alteração relacionada para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--yes -y

Não solicite confirmação.

Propriedade Valor
Valor padrão: False
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az migrate runbook execution list

Versão Prévia

O grupo de comandos "migrar a execução do runbook" está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Liste as execuções de um runbook.

az migrate runbook execution list --name --runbook-name
                                  --project-name
                                  --resource-group

Exemplos

Listar as execuções de um runbook.

az migrate runbook execution list -g myRg \
  --project-name myProject --runbook-name myRunbook

Parâmetros obrigatórios

--name --runbook-name -n

Nome do runbook.

--project-name -p

Nome do projeto Migrações para Azure. Você pode configurar o padrão usando az configure --defaults migrate_project=<name>o .

--resource-group -g

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

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az migrate runbook execution pause

Versão Prévia

O grupo de comandos "migrar a execução do runbook" está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Pausar uma execução de runbook em andamento.

az migrate runbook execution pause --execution-id
                                   --name --runbook-name
                                   --project-name
                                   --resource-group
                                   [--acquire-policy-token]
                                   [--change-reference]

Exemplos

Pausar uma execução.

az migrate runbook execution pause -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution

Parâmetros obrigatórios

--execution-id

ID da execução do runbook.

--name --runbook-name -n

Nome do runbook.

--project-name -p

Nome do projeto Migrações para Azure. Você pode configurar o padrão usando az configure --defaults migrate_project=<name>o .

--resource-group -g

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

A ID de referência de alteração relacionada para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az migrate runbook execution resume

Versão Prévia

O grupo de comandos "migrar a execução do runbook" está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Retome uma execução de runbook pausada.

az migrate runbook execution resume --execution-id
                                    --name --runbook-name
                                    --project-name
                                    --resource-group
                                    [--acquire-policy-token]
                                    [--change-reference]

Exemplos

Retome uma execução.

az migrate runbook execution resume -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution

Parâmetros obrigatórios

--execution-id

ID da execução do runbook.

--name --runbook-name -n

Nome do runbook.

--project-name -p

Nome do projeto Migrações para Azure. Você pode configurar o padrão usando az configure --defaults migrate_project=<name>o .

--resource-group -g

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

A ID de referência de alteração relacionada para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az migrate runbook execution show

Versão Prévia

O grupo de comandos "migrar a execução do runbook" está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Mostrar (ou observar) o status de uma execução de runbook.

az migrate runbook execution show --execution-id
                                  --name --runbook-name
                                  --project-name
                                  --resource-group
                                  [--interval]
                                  [--step-id]
                                  [--watch]

Exemplos

Mostrar o status de uma execução.

az migrate runbook execution show -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution

Mostrar o status de uma única etapa.

az migrate runbook execution show -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution --step-id step1

Atualize automaticamente a tabela de status até que ela seja concluída.

az migrate runbook execution show -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution --watch

Parâmetros obrigatórios

--execution-id

ID da execução do runbook.

--name --runbook-name -n

Nome do runbook.

--project-name -p

Nome do projeto Migrações para Azure. Você pode configurar o padrão usando az configure --defaults migrate_project=<name>o .

--resource-group -g

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--interval

Intervalo de atualização em segundos para --watch (padrão: 60).

Propriedade Valor
Valor padrão: 60
--step-id

Limite a saída a uma única etapa.

--watch

Renderize novamente a tabela de status em um intervalo até que a execução atinja um estado terminal.

Propriedade Valor
Valor padrão: False
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az migrate runbook execution start

Versão Prévia

O grupo de comandos "migrar a execução do runbook" está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Inicie uma nova execução de um runbook.

az migrate runbook execution start --name --runbook-name
                                   --project-name
                                   --resource-group
                                   [--acquire-policy-token]
                                   [--change-reference]
                                   [--no-visualize]
                                   [--no-wait]

Exemplos

Inicie uma execução de runbook.

az migrate runbook execution start -g myRg \
  --project-name myProject --runbook-name myRunbook

Comece sem aguardar a conclusão.

az migrate runbook execution start -g myRg \
  --project-name myProject --runbook-name myRunbook --no-wait

Parâmetros obrigatórios

--name --runbook-name -n

Nome do runbook.

--project-name -p

Nome do projeto Migrações para Azure. Você pode configurar o padrão usando az configure --defaults migrate_project=<name>o .

--resource-group -g

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

A ID de referência de alteração relacionada para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--no-visualize

Não abra o modo de exibição de inspeção de execução ao vivo após o início da execução. Útil para automação e ambientes não interativos.

Propriedade Valor
Valor padrão: False
--no-wait

Não aguarde a conclusão da operação de execução prolongada.

Propriedade Valor
Valor padrão: False
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az migrate runbook execution visualize

Versão Prévia

O grupo de comandos "migrar a execução do runbook" está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Renderize o status de uma execução como um grafo HTML autocontido.

az migrate runbook execution visualize [--acquire-policy-token]
                                       [--change-reference]
                                       [--execution-id]
                                       [--file]
                                       [--from-file]
                                       [--interval]
                                       [--name --runbook-name]
                                       [--no-open]
                                       [--project-name]
                                       [--resource-group]
                                       [--watch]

Exemplos

Visualize o status de uma execução (é aberto no navegador).

az migrate runbook execution visualize -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution

Regenerar o instantâneo em um intervalo até que ele seja concluído.

az migrate runbook execution visualize -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution --watch

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

A ID de referência de alteração relacionada para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--execution-id

ID da execução do runbook a ser visualizada.

--file

Caminho de saída para o arquivo HTML gerado (padrão: diretório atual).

--from-file

Renderize de um arquivo JSON de status de execução local em vez de buscar do serviço.

--interval

Intervalo de atualização em segundos para --watch (padrão: 60).

Propriedade Valor
Valor padrão: 60
--name --runbook-name -n

Nome do runbook.

--no-open

Escreva o arquivo HTML, mas não o abra em um navegador.

Propriedade Valor
Valor padrão: False
--project-name -p

Nome do projeto Migrações para Azure. Você pode configurar o padrão usando az configure --defaults migrate_project=<name>o .

--resource-group -g

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

--watch

Regenerar o instantâneo HTML em um intervalo até que a execução atinja um estado terminal.

Propriedade Valor
Valor padrão: False
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False