Gérer des wikis avec l’interface CLI

Azure DevOps Services

Découvrez les commandes CLI suivantes pour la gestion des wikis.

Conditions préalables

Commandes

Créer un wiki

Pour créer un wiki, entrez la az devops wiki create commande.

az devops wiki create [--mapped-path]
                      [--name]
                      [--project]
                      [--repository]
                      [--subscription]
                      [--type {codewiki, projectwiki}]

Paramètres facultatifs

• --mapped-path: [Obligatoire pour le type codewiki] Chemin associé du nouveau wiki, par exemple, / pour publier à partir de la racine du dépôt.
• --name : nom du nouveau wiki.
• --project -p : facultatif. Nom ou ID du projet. Configurez le projet par défaut à l’aide de az devops configure -d project=NAME_OR_ID. Obligatoire s’il n’est pas configuré par défaut ou récupéré via la configuration git.
• --repository -r : [Obligatoire pour codewiki le type] Nom ou ID du référentiel à partir duquel publier le wiki.
• --subscription : facultatif. Nom ou ID de l’abonnement. Configurez l'abonnement par défaut à l'aide de az account set -s NAME_OR_ID.
• --type --wiki-type : type de wiki à créer. Valeurs acceptées : codewiki, projectwiki. Valeur par défaut : projectwiki.

Exemples

Créez un wiki de projet nommé.

az devops wiki create --name myprojectwiki

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

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

Supprimer un wiki

Pour supprimer un wiki, entrez la az devops wiki delete commande.

az devops wiki delete 
                      [--wiki]
                      [--project]
                      [--subscription]
                      [--yes]

Paramètres

• --wiki : obligatoire. Nom ou ID du wiki à supprimer.
• --project -p : facultatif. Nom ou ID du projet. Vous pouvez configurer le projet par défaut en utilisant az devops configure -d project=NAME_OR_ID. Obligatoire s’il n’est pas configuré par défaut ou récupéré via la configuration git.
• --subscription : facultatif. Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.
• --yes -y : facultatif. Ne demande pas de confirmation.

Exemple :

Supprimez un wiki sans invite de confirmation.

az devops wiki delete --wiki myprojectwiki --yes

Répertorier les wikis

Pour répertorier tous les wikis d’un projet ou d’une organisation, entrez la az devops wiki list commande.

az devops wiki list 
                    [--project]
                    [--scope {organization, project}]
                    [--subscription]

Paramètres facultatifs

• --project -p : facultatif. Nom ou ID du projet.
• --scope : facultatif. Répertoriez les wikis au niveau du projet ou de l’organisation. Valeurs acceptées : organization, project. Valeur par défaut : project.
• --subscription : facultatif. Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut à l’aide de az account set -s NAME_OR_ID.

Exemples

Répertoriez tous les wikis d’un projet.

az devops wiki list

Répertorier tous les wikis de l’organisation.

az devops wiki list --scope organization

Afficher le wiki

Pour afficher les détails d’un wiki, entrez la az devops wiki show commande.

az devops wiki show --wiki
                    [--open]
                    [--project]
                    [--subscription]

Paramètres

• --wiki : obligatoire. Nom ou ID du wiki.
• --open : facultatif. Ouvrez la page wiki dans votre navigateur web.
• --project -p : facultatif. Nom ou ID du projet.
• --subscription : facultatif. Nom ou ID de l’abonnement. Configurez l'abonnement par défaut à l'aide de az account set -s NAME_OR_ID.

Exemple :

Affichez le wiki nommé myprojectwiki et ouvrez la page wiki dans votre navigateur web.

az devops wiki show --wiki myprojectwiki --open

Créer une page wiki

Pour ajouter une nouvelle page wiki, entrez la az devops wiki page create commande.

az devops wiki page create --path
                           --wiki
                           [--comment]
                           [--content]
                           [--encoding {ascii, utf-16be, utf-16le, utf-8}]
                           [--file-path]
                           [--project]
                           [--subscription]

Paramètres

• --path : obligatoire. Chemin d’accès de la page wiki.
• --wiki : obligatoire. Nom ou ID du wiki.
• --comment : facultatif. Commentez le message de validation de l’opération d’ajout de fichier. Valeur par défaut : added a new page using Azure DevOps CLI.
• --content : facultatif. Contenu de la page wiki. Ignoré si --file-path elle est spécifiée.
• --encodage : facultatif. Encodage du fichier. Utilisé avec --file-path le paramètre.
• --file-path : facultatif. Chemin d’accès de l’entrée de fichier si le contenu est spécifié dans le fichier.
• --project -p : facultatif. Nom ou ID du projet.
• --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.

Exemples

Créez une page avec un chemin d’accès my page dans un wiki nommé myprojectwiki avec du contenu inline.

az devops wiki page create --path 'my page' --wiki myprojectwiki --content "Hello World"

Créez une page avec le chemin « ma page » dans un wiki nommé « myprojectwiki » avec du contenu à partir d’un fichier.

az devops wiki page create --path 'my page' --wiki myprojectwiki --file-path a.txt --encoding utf-8