Partage via

az automation configuration

  • Référence

Remarque

Cette référence fait partie de l’extension Automation pour Azure CLI (version 2.55.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande de configuration az automation. En savoir plus sur les extensions.

Gérer la configuration Dsc.

Commandes

Nom Description Type Statut
az automation configuration create

Créez la configuration identifiée par le nom de configuration.

 Extension GA
az automation configuration delete

Supprimez la configuration dsc identifiée par le nom de configuration.

 Extension GA
az automation configuration list

Répertorier une liste de configurations.

 Extension GA
az automation configuration show

Obtenez la configuration identifiée par le nom de configuration.

 Extension GA
az automation configuration show-content

Obtenez le script de configuration identifié par le nom de configuration.

 Extension GA
az automation configuration update

Mettez à jour la configuration identifiée par le nom de configuration.

 Extension GA

az automation configuration create

Créez la configuration identifiée par le nom de configuration.

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]

Exemples

Créer une configuration DSC qui configure un serveur

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

Paramètres obligatoires

--account --automation-account-name

Nom du compte Automation.

--configuration-name --name -n

Paramètres de création ou de mise à jour pour la configuration.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--description

Obtient ou définit la description de la configuration.

--location

Récupère ou définit l'emplacement de la ressource.

--log-progress

Obtient ou définit l’option du journal de progression.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--log-verbose

Obtient ou définit l’option de journal détaillé.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--parameters

Obtient ou définit les paramètres de configuration. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--source

Obtient ou définit la valeur du contenu. Cela est basé sur le type de source de contenu.

--source-hash

Obtient ou définit le hachage. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--source-type

Obtient ou définit le type de source de contenu.

valeurs acceptées: embeddedContent, uri
--source-version

Obtient ou définit la version du contenu.

--tags

Obtient ou définit les balises attachées à la ressource. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az automation configuration delete

Supprimez la configuration dsc identifiée par le nom de configuration.

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

Exemples

Supprimer la configuration DSC

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

Paramètres facultatifs

--account --automation-account-name

Nom du compte Automation.

--configuration-name --name -n

Nom de la configuration.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--yes -y

Ne pas demander de confirmation.

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az automation configuration list

Répertorier une liste de configurations.

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

Exemples

Répertorier toutes les configurations DSC

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

Paramètres obligatoires

--account --automation-account-name

Nom du compte Automation.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--filter

Filtre à appliquer à l'opération.

--inlinecount

Retournez les lignes totales.

--max-items

Nombre total d’éléments à retourner dans la sortie de la commande. Si le nombre total d’éléments disponibles est supérieur à la valeur spécifiée, un jeton est fourni dans la sortie de la commande. Pour reprendre la pagination, fournissez la valeur du jeton dans --next-token l’argument d’une commande suivante.

--next-token

Jeton pour spécifier où commencer la pagination. Il s’agit de la valeur du jeton d’une réponse tronquée précédemment.

--skip

Nombre de lignes à ignorer.

--top

Nombre de lignes à prendre.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az automation configuration show

Obtenez la configuration identifiée par le nom de configuration.

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

Exemples

Obtenir la configuration par son nom

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

Paramètres facultatifs

--account --automation-account-name

Nom du compte Automation.

--configuration-name --name -n

Nom de la configuration.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az automation configuration show-content

Obtenez le script de configuration identifié par le nom de configuration.

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

Exemples

Afficher le contenu du script de configuration DSC

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

Paramètres facultatifs

--account --automation-account-name

Nom du compte Automation.

--configuration-name --name -n

Nom de la configuration.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az automation configuration update

Mettez à jour la configuration identifiée par le nom de configuration.

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]

Exemples

Mettre à jour le script dans la configuration 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"
}
}
}"

Paramètres facultatifs

--account --automation-account-name

Nom du compte Automation.

--add

Ajoutez un objet à une liste d’objets en spécifiant un chemin d’accès et des paires clé-valeur. Exemple : --add property.listProperty <key=value, string ou JSON string>.

--configuration-name --name -n

Nom de la configuration.

--description

Obtient ou définit la description de la configuration.

--force-string

Lorsque vous utilisez « set » ou « add », conservez les littéraux de chaîne au lieu de tenter de convertir en JSON.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--location

Récupère ou définit l'emplacement de la ressource.

--log-progress

Obtient ou définit l’option du journal de progression.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--log-verbose

Obtient ou définit l’option de journal détaillé.

valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--parameters

Obtient ou définit les paramètres de configuration. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--remove

Supprimez une propriété ou un élément d’une liste. Exemple : --remove property.list OR --remove propertyToRemove.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--set

Mettez à jour un objet en spécifiant un chemin d’accès et une valeur de propriété à définir. Exemple : --set property1.property2=.

--source

Obtient ou définit la valeur du contenu. Cela est basé sur le type de source de contenu.

--source-hash

Obtient ou définit le hachage. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--source-type

Obtient ou définit le type de source de contenu.

valeurs acceptées: embeddedContent, uri
--source-version

Obtient ou définit la version du contenu.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--tags

Obtient ou définit les balises attachées à la ressource. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.