Share via

az automation configuration

  • Referência

Nota

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

Gerencie a configuração do DSC.

Comandos

Name Description Tipo Estado
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 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 Obrigatórios

--account --automation-account-name

O nome da conta de automação.

--configuration-name --name -n

A criação ou atualização de parâmetros para configuração.

--resource-group -g

o 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 a localização do recurso.

--log-progress

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

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

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

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

Obtém ou define os parâmetros de configuração. Suporta sintaxe taquigráfica, 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. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--source-type

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

valores aceites: embeddedContent, uri
--source-version

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

--tags

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

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

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

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

--yes -y

Não solicite confirmação.

valor predefinido: False
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 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 Obrigatórios

--account --automation-account-name

O nome da conta de automação.

--resource-group -g

o 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 aplicar na operação.

--inlinecount

Retornar o total de linhas.

--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 por onde começar a paginar. Este é 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 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 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 seu 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

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

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

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

--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 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 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 valor de chave. Exemplo: --add property.listProperty <key=value, string ou JSON string>.

--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 string em vez de tentar converter para JSON.

valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--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'.

--location

Obtém ou define a localização do recurso.

--log-progress

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

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

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

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

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

--remove

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

--resource-group -g

o 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 ser definido. 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. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--source-type

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

valores aceites: embeddedContent, uri
--source-version

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

--subscription

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

--tags

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

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.