Partilhar via

az workload-orchestration config-template

Note

Essa referência faz parte da extensão de orquestração de carga de trabalho para a CLI do Azure (versão 2.67.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az workload-orchestration config-template . Saiba mais sobre extensões.

O modelo de configuração de orquestração de carga de trabalho ajuda a gerenciar modelos de configuração.

Comandos

Nome Descrição Tipo Estado
az workload-orchestration config-template create

Crie um recurso de modelo de configuração.

 Extension disponibilidade geral
az workload-orchestration config-template delete

Exclua um recurso de modelo de configuração.

 Extension disponibilidade geral
az workload-orchestration config-template hierarchy

A hierarquia de modelos de configuração de orquestração de carga de trabalho ajuda a gerir hierarquias de modelos de configuração.

 Extension disponibilidade geral
az workload-orchestration config-template hierarchy show

Mostrar hierarquias ligadas para um template de configuração.

 Extension disponibilidade geral
az workload-orchestration config-template link

Liga um Modelo de Configuração a hierarquias.

 Extension disponibilidade geral
az workload-orchestration config-template list

Listar por assinatura.

 Extension disponibilidade geral
az workload-orchestration config-template remove-version

Remova o recurso de versão do modelo de configuração.

 Extension disponibilidade geral
az workload-orchestration config-template show

Obtenha um recurso de modelo de configuração.

 Extension disponibilidade geral
az workload-orchestration config-template unlink

Desvincule um Modelo de Configuração das hierarquias.

 Extension disponibilidade geral
az workload-orchestration config-template version

Gerencie versões de modelos de configuração de orquestração de carga de trabalho.

 Extension disponibilidade geral
az workload-orchestration config-template version list

Listar recursos de versão do modelo de configuração.

 Extension disponibilidade geral
az workload-orchestration config-template version show

Obtenha um recurso de versão do modelo de configuração.

 Extension disponibilidade geral
az workload-orchestration config-template wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

 Extension disponibilidade geral

az workload-orchestration config-template create

Crie um recurso de modelo de configuração.

az workload-orchestration config-template create --config-template-file --configuration-template-file
                                                 --description
                                                 --resource-group
                                                 [--config-template-name --name]
                                                 [--location]
                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--tags]
                                                 [--version]

Exemplos

Criar um modelo de configuração

az workload-orchestration config-template create -g rg1 -n ct1 --description "test" --location eastus --version 1.0.0 --config-template-file config.yaml

Parâmetros Obrigatórios

--config-template-file --configuration-template-file

Link para Arquivo que contém expressões de configuração para esta versão de configuração.

--description

Descrição do modelo de configuração.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
--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 parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--config-template-name --name -n

O nome do ConfigTemplate.

--location -l

A localização geográfica onde o recurso reside Quando não especificada, a localização do grupo de recursos será usada.

Propriedade Valor
Grupo de parâmetros: Resource Arguments
--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--tags

Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Resource Arguments
--version -v

Versão do modelo de configuração.

Propriedade Valor
Grupo de parâmetros: Body Arguments
Parâmetros globais
--debug

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

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

Mostrar esta mensagem de ajuda e sair.

--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 aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az workload-orchestration config-template delete

Exclua um recurso de modelo de configuração.

az workload-orchestration config-template delete [--config-template-name --name]
                                                 [--ids]
                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--yes]

Exemplos

Excluir um modelo de configuração

az workload-orchestration config-template delete -n myConfigTemplate -g myResourceGroup

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--config-template-name --name -n

O nome do ConfigTemplate.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--yes -y

Não solicite confirmação.

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

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

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

Mostrar esta mensagem de ajuda e sair.

--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 aceites: 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.

--verbose

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

Propriedade Valor
Valor padrão: False

Liga um Modelo de Configuração a hierarquias.

az workload-orchestration config-template link --config-template-name --name
                                               --context-id
                                               --hierarchy-ids
                                               --resource-group
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Ligar um Modelo de Configuração a hierarquias

az workload-orchestration config-template link -g rg1 -n configTemplatename --hierarchy-ids "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --context-id "context123"
--config-template-name --name -n

O nome do ConfigTemplate.

--context-id

ID de contexto para a operação de ligação.

--hierarchy-ids

Lista de IDs de hierarquia para ligar ao modelo de configuração Suporte sintaxe abreviada, ficheiro json e ficheiro yaml. Tente "??" para mostrar mais.

--resource-group -g

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

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
Parâmetros globais
--debug

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

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

Mostrar esta mensagem de ajuda e sair.

--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 aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az workload-orchestration config-template list

Listar por assinatura.

az workload-orchestration config-template list [--max-items]
                                               [--next-token]
                                               [--resource-group]

Exemplos

Listar modelos de configuração por assinatura

az workload-orchestration config-template list --subscription mySubscription

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--max-items

Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token em --next-token argumento de um comando subsequente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
--next-token

Token para especificar por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
--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 do log para mostrar todos os logs de depuração.

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

Mostrar esta mensagem de ajuda e sair.

--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 aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az workload-orchestration config-template remove-version

Remova o recurso de versão do modelo de configuração.

az workload-orchestration config-template remove-version --config-template-version --version
                                                         [--config-template-name --name]
                                                         [--ids]
                                                         [--resource-group]
                                                         [--subscription]

Exemplos

Remover uma versão do modelo de configuração

az workload-orchestration config-template remove-version -n myConfigTemplate -g myResource

Parâmetros Obrigatórios

--config-template-version --version -v

Versão do recurso.

Propriedade Valor
Grupo de parâmetros: Body Arguments

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--config-template-name --name -n

O nome do ConfigTemplate.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros globais
--debug

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

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

Mostrar esta mensagem de ajuda e sair.

--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 aceites: 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.

--verbose

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

Propriedade Valor
Valor padrão: False

az workload-orchestration config-template show

Obtenha um recurso de modelo de configuração.

az workload-orchestration config-template show [--config-template-name --name]
                                               [--ids]
                                               [--resource-group]
                                               [--subscription]

Exemplos

Mostrar um modelo de configuração

az workload-orchestration config-template show -n myConfigTemplate -g myResourceGroup

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--config-template-name --name -n

O nome do ConfigTemplate.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros globais
--debug

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

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

Mostrar esta mensagem de ajuda e sair.

--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 aceites: 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.

--verbose

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

Propriedade Valor
Valor padrão: False

Desvincule um Modelo de Configuração das hierarquias.

az workload-orchestration config-template unlink --config-template-name --name
                                                 --context-id
                                                 --hierarchy-ids
                                                 --resource-group
                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Desvincular um Modelo de Configuração das hierarquias

az workload-orchestration config-template unlink -g rg1 -n configTemplatename --hierarchy-ids "/subscriptions/sub1/resourceGroups/rg1/providers/Microsoft.Edge/sites/site1" --context-id "context123"
--config-template-name --name -n

O nome do ConfigTemplate.

--context-id

ID de contexto para a operação de desligamento.

--hierarchy-ids

Lista de IDs de hierarquia a desligar do modelo de configuração Suporte para sintaxe abreviada, ficheiro json e ficheiro yaml. Tente "??" para mostrar mais.

--resource-group -g

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

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
Parâmetros globais
--debug

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

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

Mostrar esta mensagem de ajuda e sair.

--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 aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az workload-orchestration config-template wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

az workload-orchestration config-template wait [--config-template-name --name]
                                               [--created]
                                               [--custom]
                                               [--deleted]
                                               [--exists]
                                               [--ids]
                                               [--interval]
                                               [--resource-group]
                                               [--subscription]
                                               [--timeout]
                                               [--updated]

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--config-template-name --name -n

O nome do ConfigTemplate.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
--deleted

Aguarde até ser excluído.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--exists

Aguarde até que o recurso exista.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--interval

Intervalo de sondagem em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: 30
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--timeout

Espera máxima em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: 3600
--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
Parâmetros globais
--debug

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

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

Mostrar esta mensagem de ajuda e sair.

--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 aceites: 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.

--verbose

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

Propriedade Valor
Valor padrão: False