az guestconfig guest-configuration-assignment
Note
Essa referência faz parte da extensão guestconfig para a CLI do Azure (versão 2.3.1 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az guestconfig guest-configuration-assignment. Saiba mais sobre extensões.
Este grupo de comando é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Guestconfig guest-configuration-assignment.
Comandos
| Name | Description | Tipo | Status |
|---|---|---|---|
| az guestconfig guest-configuration-assignment create |
Cria uma associação entre uma VM e a configuração de convidado. |
Extension | Experimental |
| az guestconfig guest-configuration-assignment delete |
Exclua uma atribuição de configuração de convidado. |
Extension | Experimental |
| az guestconfig guest-configuration-assignment list |
Liste todas as atribuições de configuração de convidado para uma máquina virtual. |
Extension | Experimental |
| az guestconfig guest-configuration-assignment show |
Obtenha informações sobre uma atribuição de configuração de convidado. |
Extension | Experimental |
| az guestconfig guest-configuration-assignment update |
Cria uma associação entre uma VM e a configuração de convidado. |
Extension | Experimental |
| az guestconfig guest-configuration-assignment wait |
Coloque a CLI em um estado de espera até que uma condição da guestconfig guest-configuration-assignment seja atendida. |
Extension | Experimental |
az guestconfig guest-configuration-assignment create
O grupo de comandos 'guestconfig guest-configuration-assignment' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Cria uma associação entre uma VM e a configuração de convidado.
az guestconfig guest-configuration-assignment create --guest-configuration-assignment-name
--resource-group
--vm-name
[--context]
[--guest-configuration-configuration-parameter]
[--guest-configuration-configuration-setting]
[--guest-configuration-name]
[--guest-configuration-version]
[--latest-assignment-report-assignment]
[--location]
[--name]
[--no-wait]
Exemplos
Criar ou atualizar a atribuição de configuração de convidado
az guestconfig guest-configuration-assignment create --guest-configuration-assignment-name "WhitelistedApplication" --guest-configuration-name "WhitelistedApplication" --location "westcentralus" --context "Azure policy" --guest-configuration-name "WhitelistedApplication" --guest-configuration-configuration-parameter name="[InstalledApplication]bwhitelistedapp;Name" value="NotePad,sql" --guest-configuration-configuration-setting action-after-reboot="ContinueConfiguration" configuration-mode="MonitorOnly" configuration-mode-frequency-mins=15 reboot-if-needed="False" --guest-configuration-version "1.*" --resource-group "myResourceGroupName" --vm-name "myVMName"
Parâmetros Obrigatórios
Nome da atribuição de configuração de convidado.
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome da máquina virtual.
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
A origem que iniciou a atribuição de configuração de convidado. Ex: Política do Azure.
Os parâmetros de configuração para a configuração do convidado.
Uso: --guest-configuration-configuration-parameter name=XX value=XX
name: Nome do parâmetro de configuração. value: Valor do parâmetro de configuração.
Várias ações podem ser especificadas usando mais de um argumento --guest-configuration-configuration-parameter.
A definição de configuração para a configuração do convidado.
Uso: --guest-configuration-configuration-setting configuration-mode=XX allow-module-overwrite=XX action-after-reboot=XX refresh-frequency-mins=XX reboot-if-needed=XX configuration-mode-frequency-mins=XX
modo de configuração: especifica como o LCM (Local Configuration Manager) realmente aplica a configuração aos nós de destino. Os valores possíveis são ApplyOnly, ApplyAndMonitor e ApplyAndAutoCorrect. allow-module-overwrite: Se true - novas configurações baixadas do serviço pull podem substituir as antigas no nó de destino. Caso contrário, false action-after-reboot: especifica o que acontece após uma reinicialização durante a aplicação de uma configuração. Os valores possíveis são ContinueConfiguration e StopConfiguration refresh-frequency-mins: o intervalo de tempo, em minutos, no qual o LCM verifica um serviço pull para obter configurações atualizadas. Esse valor será ignorado se o LCM não estiver configurado no modo de receção. O valor padrão é 30. reboot-if-needed: defina isso como true para reinicializar automaticamente o nó depois que uma configuração que requer reinicialização for aplicada. Caso contrário, você terá que reinicializar manualmente o nó para qualquer configuração que o exija. O valor padrão é false. Para usar essa configuração quando uma condição de reinicialização for decretada por algo diferente do DSC (como o Windows Installer), combine essa configuração com o módulo xPendingReboot. configuration-mode-frequency-mins: Com que frequência, em minutos, a configuração atual é verificada e aplicada. Essa propriedade será ignorada se a propriedade ConfigurationMode estiver definida como ApplyOnly. O valor padrão é 15.
Nome da configuração do convidado.
Versão da configuração do convidado.
Detalhes de configuração da atribuição de configuração de convidado. Valor esperado: json-string/@json-file.
Location. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.
Nome da atribuição de configuração de convidado.
Não espere que a operação de longa duração termine.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az guestconfig guest-configuration-assignment delete
O grupo de comandos 'guestconfig guest-configuration-assignment' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Exclua uma atribuição de configuração de convidado.
az guestconfig guest-configuration-assignment delete [--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
[--vm-name]
Exemplos
Excluir uma atribuição de configuração de convidado
az guestconfig guest-configuration-assignment delete --name "SecureProtocol" --resource-group "myResourceGroupName" --vm-name "myVMName"
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
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 |
Nome da atribuição de configuração de convidado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Não espere que a operação de longa duração termine.
| Propriedade | Valor |
|---|---|
| Default value: | False |
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 |
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 |
O nome da máquina virtual.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az guestconfig guest-configuration-assignment list
O grupo de comandos 'guestconfig guest-configuration-assignment' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Liste todas as atribuições de configuração de convidado para uma máquina virtual.
az guestconfig guest-configuration-assignment list --resource-group
--vm-name
Exemplos
Listar todas as atribuições de configuração de convidado para uma máquina virtual
az guestconfig guest-configuration-assignment list --resource-group "myResourceGroupName" --vm-name "myVMName"
Parâmetros Obrigatórios
Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.
O nome da máquina virtual.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az guestconfig guest-configuration-assignment show
O grupo de comandos 'guestconfig guest-configuration-assignment' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Obtenha informações sobre uma atribuição de configuração de convidado.
az guestconfig guest-configuration-assignment show [--ids]
[--name]
[--resource-group]
[--subscription]
[--vm-name]
Exemplos
Obter uma atribuição de configuração de convidado
az guestconfig guest-configuration-assignment show --name "SecureProtocol" --resource-group "myResourceGroupName" --vm-name "myVMName"
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
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 |
O nome da atribuição de configuração de convidado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
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 |
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 |
O nome da máquina virtual.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az guestconfig guest-configuration-assignment update
O grupo de comandos 'guestconfig guest-configuration-assignment' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Cria uma associação entre uma VM e a configuração de convidado.
az guestconfig guest-configuration-assignment update [--context]
[--guest-configuration-assignment-name]
[--guest-configuration-configuration-parameter]
[--guest-configuration-configuration-setting]
[--guest-configuration-name]
[--guest-configuration-version]
[--ids]
[--latest-assignment-report-assignment]
[--location]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
[--vm-name]
Exemplos
Criar ou atualizar a atribuição de configuração de convidado
az guestconfig guest-configuration-assignment update --guest-configuration-assignment-name "WhitelistedApplication" --guest-configuration-name "WhitelistedApplication" --location "westcentralus" --context "Azure policy" --guest-configuration-name "WhitelistedApplication" --guest-configuration-configuration-parameter name="[InstalledApplication]bwhitelistedapp;Name" value="NotePad,sql" --guest-configuration-configuration-setting action-after-reboot="ContinueConfiguration" configuration-mode="MonitorOnly" configuration-mode-frequency-mins=15 reboot-if-needed="False" --guest-configuration-version "1.*" --resource-group "myResourceGroupName" --vm-name "myVMName"
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
A origem que iniciou a atribuição de configuração de convidado. Ex: Política do Azure.
Nome da atribuição de configuração de convidado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Os parâmetros de configuração para a configuração do convidado.
Uso: --guest-configuration-configuration-parameter name=XX value=XX
name: Nome do parâmetro de configuração. value: Valor do parâmetro de configuração.
Várias ações podem ser especificadas usando mais de um argumento --guest-configuration-configuration-parameter.
A definição de configuração para a configuração do convidado.
Uso: --guest-configuration-configuration-setting configuration-mode=XX allow-module-overwrite=XX action-after-reboot=XX refresh-frequency-mins=XX reboot-if-needed=XX configuration-mode-frequency-mins=XX
modo de configuração: especifica como o LCM (Local Configuration Manager) realmente aplica a configuração aos nós de destino. Os valores possíveis são ApplyOnly, ApplyAndMonitor e ApplyAndAutoCorrect. allow-module-overwrite: Se true - novas configurações baixadas do serviço pull podem substituir as antigas no nó de destino. Caso contrário, false action-after-reboot: especifica o que acontece após uma reinicialização durante a aplicação de uma configuração. Os valores possíveis são ContinueConfiguration e StopConfiguration refresh-frequency-mins: o intervalo de tempo, em minutos, no qual o LCM verifica um serviço pull para obter configurações atualizadas. Esse valor será ignorado se o LCM não estiver configurado no modo de receção. O valor padrão é 30. reboot-if-needed: defina isso como true para reinicializar automaticamente o nó depois que uma configuração que requer reinicialização for aplicada. Caso contrário, você terá que reinicializar manualmente o nó para qualquer configuração que o exija. O valor padrão é false. Para usar essa configuração quando uma condição de reinicialização for decretada por algo diferente do DSC (como o Windows Installer), combine essa configuração com o módulo xPendingReboot. configuration-mode-frequency-mins: Com que frequência, em minutos, a configuração atual é verificada e aplicada. Essa propriedade será ignorada se a propriedade ConfigurationMode estiver definida como ApplyOnly. O valor padrão é 15.
Nome da configuração do convidado.
Versão da configuração do convidado.
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 |
Detalhes de configuração da atribuição de configuração de convidado. Valor esperado: json-string/@json-file.
Location. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.
Nome da atribuição de configuração de convidado.
Não espere que a operação de longa duração termine.
| Propriedade | Valor |
|---|---|
| Default value: | False |
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 |
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 |
O nome da máquina virtual.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
az guestconfig guest-configuration-assignment wait
O grupo de comandos 'guestconfig guest-configuration-assignment' é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus
Coloque a CLI em um estado de espera até que uma condição da guestconfig guest-configuration-assignment seja atendida.
az guestconfig guest-configuration-assignment wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
[--vm-name]
Exemplos
Pause a execução da próxima linha do script CLI até que o guestconfig guest-configuration-assignment seja criado com êxito.
az guestconfig guest-configuration-assignment wait --name "SecureProtocol" --resource-group "myResourceGroupName" --vm-name "myVMName" --created
Pause a execução da próxima linha do script CLI até que o guestconfig guest-configuration-assignment seja excluído com êxito.
az guestconfig guest-configuration-assignment wait --name "SecureProtocol" --resource-group "myResourceGroupName" --vm-name "myVMName" --deleted
Parâmetros Opcionais
Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.
Aguarde até ser criado com 'provisioningState' em 'Succeeded'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Default value: | False |
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 |
Aguarde até ser excluído.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Default value: | False |
Aguarde até que o recurso exista.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Default value: | False |
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 |
Intervalo de sondagem em segundos.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Default value: | 30 |
O nome da atribuição de configuração de convidado.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
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 |
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 |
Espera máxima em segundos.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Default value: | 3600 |
Aguarde até ser atualizado com provisioningState em 'Succeeded'.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Wait Condition Arguments |
| Default value: | False |
O nome da máquina virtual.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Resource Id Arguments |
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Default value: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Default value: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Default value: | False |