Partager via

az devops wiki

Note

Cette référence fait partie de l’extension azure-devops pour Azure CLI (version 2.30.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une az devops wiki commande. Apprenez-en davantage sur les extensions.

Gérer les wikis.

Commandes

Nom Description Type État
az devops wiki create

Créez un wiki.

 Extension GA
az devops wiki delete

Supprimez un wiki.

 Extension GA
az devops wiki list

Répertoriez tous les wikis d’un projet ou d’une organisation.

 Extension GA
az devops wiki page

Gérer les pages wiki.

 Extension GA
az devops wiki page create

Ajoutez une nouvelle page.

 Extension GA
az devops wiki page delete

Supprimez une page.

 Extension GA
az devops wiki page show

Obtenez le contenu d’une page ou ouvrez une page.

 Extension GA
az devops wiki page update

Modifiez une page.

 Extension GA
az devops wiki show

Afficher les détails d’un wiki.

 Extension GA

az devops wiki create

Créez un wiki.

az devops wiki create [--detect {false, true}]
                      [--mapped-path]
                      [--name]
                      [--org --organization]
                      [--project]
                      [--repository]
                      [--type --wiki-type {codewiki, projectwiki}]
                      [--version]

Exemples

Créer un wiki de projet

az devops wiki create --name myprojectwiki

Créer un wiki de code à partir d’un dossier dans un référentiel de code

az devops wiki create --name WIKI_NAME --type codewiki --version BRANCH_NAME
--repository REPO_NAME --mapped-path PATH_TO_PUBLISH

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--detect

Détectez automatiquement l’organisation.

Propriété Valeur
Valeurs acceptées: false, true
--mapped-path

[Obligatoire pour le type codewiki] Chemin mappé du nouveau wiki, par exemple « / » à publier à partir de la racine du dépôt.

--name

Nom du nouveau wiki.

--org --organization

URL de organization Azure DevOps. Vous pouvez configurer l’organisation par défaut à l’aide d’az devops configure -d organization=ORG_URL. Obligatoire s’il n’est pas configuré comme valeur par défaut ou récupéré par le biais de la configuration git. Exemple : https://dev.azure.com/MyOrganizationName/.

--project -p

Nom ou ID du projet. Vous pouvez configurer le projet par défaut à l’aide de az devops configure -d project=NAME_OR_ID. Obligatoire si ce paramètre n’est pas configuré par défaut ou récupéré avec git config.

--repository -r

[Obligatoire pour le type codewiki] Nom ou ID du référentiel à partir duquel publier le wiki.

--type --wiki-type

Type de wiki à créer.

Propriété Valeur
Valeur par défaut: projectwiki
Valeurs acceptées: codewiki, projectwiki
--version -v

[Obligatoire pour le type codewiki] Nom de la branche référentiel à partir duquel publier le wiki de code.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az devops wiki delete

Supprimez un wiki.

az devops wiki delete --wiki
                      [--detect {false, true}]
                      [--org --organization]
                      [--project]
                      [--yes]

Paramètres obligatoires

--wiki

Nom ou ID du wiki à supprimer.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--detect

Détectez automatiquement l’organisation.

Propriété Valeur
Valeurs acceptées: false, true
--org --organization

URL de organization Azure DevOps. Vous pouvez configurer l’organisation par défaut à l’aide d’az devops configure -d organization=ORG_URL. Obligatoire s’il n’est pas configuré comme valeur par défaut ou récupéré par le biais de la configuration git. Exemple : https://dev.azure.com/MyOrganizationName/.

--project -p

Nom ou ID du projet. Vous pouvez configurer le projet par défaut à l’aide de az devops configure -d project=NAME_OR_ID. Obligatoire si ce paramètre n’est pas configuré par défaut ou récupéré avec git config.

--yes -y

N’invitez pas à confirmer.

Propriété Valeur
Valeur par défaut: False
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az devops wiki list

Répertoriez tous les wikis d’un projet ou d’une organisation.

az devops wiki list [--detect {false, true}]
                    [--org --organization]
                    [--project]
                    [--scope {organization, project}]

Exemples

Répertorier tous les wikis d’un projet

az devops wiki list

Répertorier tous les wikis de l’organisation

az devops wiki list --scope organization

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--detect

Détectez automatiquement l’organisation.

Propriété Valeur
Valeurs acceptées: false, true
--org --organization

URL de organization Azure DevOps. Vous pouvez configurer l’organisation par défaut à l’aide d’az devops configure -d organization=ORG_URL. Obligatoire s’il n’est pas configuré comme valeur par défaut ou récupéré par le biais de la configuration git. Exemple : https://dev.azure.com/MyOrganizationName/.

--project -p

Nom ou ID du projet. Vous pouvez configurer le projet par défaut à l’aide de az devops configure -d project=NAME_OR_ID. Obligatoire si ce paramètre n’est pas configuré par défaut ou récupéré avec git config.

--scope

Répertoriez les wikis au niveau du projet ou de l’organisation.

Propriété Valeur
Valeur par défaut: project
Valeurs acceptées: organization, project
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

az devops wiki show

Afficher les détails d’un wiki.

az devops wiki show --wiki
                    [--detect {false, true}]
                    [--open]
                    [--org --organization]
                    [--project]

Paramètres obligatoires

--wiki

Nom ou ID du wiki.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--detect

Détectez automatiquement l’organisation.

Propriété Valeur
Valeurs acceptées: false, true
--open

Ouvrez le wiki dans votre navigateur web.

Propriété Valeur
Valeur par défaut: False
--org --organization

URL de organization Azure DevOps. Vous pouvez configurer l’organisation par défaut à l’aide d’az devops configure -d organization=ORG_URL. Obligatoire s’il n’est pas configuré comme valeur par défaut ou récupéré par le biais de la configuration git. Exemple : https://dev.azure.com/MyOrganizationName/.

--project -p

Nom ou ID du projet. Vous pouvez configurer le projet par défaut à l’aide de az devops configure -d project=NAME_OR_ID. Obligatoire si ce paramètre n’est pas configuré par défaut ou récupéré avec git config.

Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

Propriété Valeur
Valeur par défaut: json
Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False