Compartilhar via

az automation configuration

  • Referência

Observação

Essa referência faz parte da extensão de automação da CLI do Azure (versão 2.55.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando de configuração de automação az. Saiba mais sobre extensões.

Gerenciar configuração de Dsc.

Comandos

Nome Description Tipo Status
az automation configuration create

Crie a configuração identificada pelo nome da configuração.

 Extensão GA
az automation configuration delete

Exclua a configuração dsc identificada pelo nome da configuração.

 Extensão GA
az automation configuration list

Liste uma lista de configurações.

 Extensão GA
az automation configuration show

Obtenha a configuração identificada pelo nome da configuração.

 Extensão GA
az automation configuration show-content

Obtenha o script de configuração identificado pelo nome da configuração.

 Extensão GA
az automation configuration update

Atualize a configuração identificada pelo nome da configuração.

 Extensão GA

az automation configuration create

Crie a configuração identificada pelo nome da configuração.

az automation configuration create --account
                                   --configuration-name
                                   --resource-group
                                   [--description]
                                   [--location]
                                   [--log-progress {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--log-verbose {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--parameters]
                                   [--source]
                                   [--source-hash]
                                   [--source-type {embeddedContent, uri}]
                                   [--source-version]
                                   [--tags]

Exemplos

Criar configuração de DSC que configura um servidor

az automation configuration create -g rg --automation-account-name myAutomationAccount -n SetupServer --location westus2 --source-type embeddedContent --source "Configuration SetupServer {
Node localhost {
WindowsFeature IIS {
Name = "Web-Server";
Ensure = "Present"
}
}
}"

Parâmetros Exigidos

--account --automation-account-name

O nome da conta de automação.

--configuration-name --name -n

Os parâmetros de criação ou atualização para configuraçã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

--description

Obtém ou define a descrição da configuração.

--location

Obtém ou define o local do recurso.

--log-progress

Obtém ou define a opção de log de progresso.

valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--log-verbose

Obtém ou define a opção de log detalhado.

valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--parameters

Obtém ou define os parâmetros de configuração. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

--source

Obtém ou define o valor do conteúdo. Isso se baseia no tipo de fonte de conteúdo.

--source-hash

Obtém ou define o hash. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

--source-type

Obtém ou define o tipo de fonte de conteúdo.

valores aceitos: embeddedContent, uri
--source-version

Obtém ou define a versão do conteúdo.

--tags

Obtém ou define as marcas anexadas ao recurso. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az automation configuration delete

Exclua a configuração dsc identificada pelo nome da configuração.

az automation configuration delete [--account]
                                   [--configuration-name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]
                                   [--yes]

Exemplos

Excluir a configuração do DSC

az automation configuration list -g rg --automation-account-name myAutomationAccount

Parâmetros Opcionais

--account --automation-account-name

O nome da conta de automação.

--configuration-name --name -n

O nome da configuração.

--ids

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'.

--resource-group -g

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

--subscription

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

--yes -y

Não solicite confirmação.

valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az automation configuration list

Liste uma lista de configurações.

az automation configuration list --account
                                 --resource-group
                                 [--filter]
                                 [--inlinecount]
                                 [--max-items]
                                 [--next-token]
                                 [--skip]
                                 [--top]

Exemplos

Listar todas as configurações de DSC

az automation configuration list -g rg --automation-account-name myAutomationAccount

Parâmetros Exigidos

--account --automation-account-name

O nome da conta de automaçã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

--filter

O filtro a ser aplicado na operação.

--inlinecount

Retornar linhas totais.

--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 no --next-token argumento de um comando subsequente.

--next-token

Token para especificar onde iniciar a paginação. Esse é o valor de token de uma resposta truncada anteriormente.

--skip

O número de linhas a serem ignoradas.

--top

O número de linhas a serem tomadas.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az automation configuration show

Obtenha a configuração identificada pelo nome da configuração.

az automation configuration show [--account]
                                 [--configuration-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Exemplos

Obter a configuração pelo nome

az automation configuration show -g rg --automation-account-name myAutomationAccount -n SetupServer

Parâmetros Opcionais

--account --automation-account-name

O nome da conta de automação.

--configuration-name --name -n

O nome da configuração.

--ids

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'.

--resource-group -g

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

--subscription

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

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az automation configuration show-content

Obtenha o script de configuração identificado pelo nome da configuração.

az automation configuration show-content [--account]
                                         [--configuration-name]
                                         [--ids]
                                         [--resource-group]
                                         [--subscription]

Exemplos

Mostrar o conteúdo do script da Configuração do DSC

az automation configuration show-content -g rg --automation-account-name myAutomationAccount -n SetupServer

Parâmetros Opcionais

--account --automation-account-name

O nome da conta de automação.

--configuration-name --name -n

O nome da configuração.

--ids

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'.

--resource-group -g

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

--subscription

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

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az automation configuration update

Atualize a configuração identificada pelo nome da configuração.

az automation configuration update [--account]
                                   [--add]
                                   [--configuration-name]
                                   [--description]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--ids]
                                   [--location]
                                   [--log-progress {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--log-verbose {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--parameters]
                                   [--remove]
                                   [--resource-group]
                                   [--set]
                                   [--source]
                                   [--source-hash]
                                   [--source-type {embeddedContent, uri}]
                                   [--source-version]
                                   [--subscription]
                                   [--tags]

Exemplos

Script de atualização na Configuração do DSC

az automation configuration update -g rg --automation-account-name myAutomationAccount -n SetupServer --location westus2 --source-type embeddedContent --source "Configuration SetupServer {
Node localhostServer {
WindowsFeature IIS {
Name = "Web-Server";
Ensure = "Present"
}
}
}"

Parâmetros Opcionais

--account --automation-account-name

O nome da conta de automação.

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string ou string> JSON.

--configuration-name --name -n

O nome da configuração.

--description

Obtém ou define a descrição da configuração.

--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter para JSON.

valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--ids

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'.

--location

Obtém ou define o local do recurso.

--log-progress

Obtém ou define a opção de log de progresso.

valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--log-verbose

Obtém ou define a opção de log detalhado.

valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--parameters

Obtém ou define os parâmetros de configuração. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list OU --remove propertyToRemove.

--resource-group -g

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

--set

Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=.

--source

Obtém ou define o valor do conteúdo. Isso se baseia no tipo de fonte de conteúdo.

--source-hash

Obtém ou define o hash. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

--source-type

Obtém ou define o tipo de fonte de conteúdo.

valores aceitos: embeddedContent, uri
--source-version

Obtém ou define a versão do conteúdo.

--subscription

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

--tags

Obtém ou define as marcas anexadas ao recurso. Suporte taquigráfico-sintaxe, json-file e yaml-file. Tente "??" para mostrar mais.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.