Partager via

az devops wiki

  • Référence

Remarque

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 commande wiki az devops. En savoir plus sur les extensions.

Gérer les Wikis.

Commandes

Nom Description Type Statut
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]
                      [--project]
                      [--repository]
                      [--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

--detect

Détectez automatiquement l’organisation.

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 l’organisation Azure DevOps. Vous pouvez configurer l’organisation par défaut à l’aide de az devops configure -d organization=ORG_URL. Obligatoire si la valeur n’est pas configurée par défaut ni récupérée via git config. 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 s’il n’est pas configuré par défaut ou récupéré via la configuration git.

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

valeurs acceptées: codewiki, projectwiki
valeur par défaut: 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 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 devops wiki delete

Supprimez un wiki.

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

Paramètres obligatoires

--wiki

Nom ou ID du wiki à supprimer.

Paramètres facultatifs

--detect

Détectez automatiquement l’organisation.

valeurs acceptées: false, true
--org --organization

URL de l’organisation Azure DevOps. Vous pouvez configurer l’organisation par défaut à l’aide de az devops configure -d organization=ORG_URL. Obligatoire si la valeur n’est pas configurée par défaut ni récupérée via git config. 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 s’il n’est pas configuré par défaut ou récupéré via la configuration git.

--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 devops wiki list

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

az devops wiki list [--detect {false, true}]
                    [--org]
                    [--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

--detect

Détectez automatiquement l’organisation.

valeurs acceptées: false, true
--org --organization

URL de l’organisation Azure DevOps. Vous pouvez configurer l’organisation par défaut à l’aide de az devops configure -d organization=ORG_URL. Obligatoire si la valeur n’est pas configurée par défaut ni récupérée via git config. 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 s’il n’est pas configuré par défaut ou récupéré via la configuration git.

--scope

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

valeurs acceptées: organization, project
valeur par défaut: project
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 devops wiki show

Afficher les détails d’un wiki.

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

Paramètres obligatoires

--wiki

Nom ou ID du wiki.

Paramètres facultatifs

--detect

Détectez automatiquement l’organisation.

valeurs acceptées: false, true
--open

Ouvrez le wiki dans votre navigateur web.

valeur par défaut: False
--org --organization

URL de l’organisation Azure DevOps. Vous pouvez configurer l’organisation par défaut à l’aide de az devops configure -d organization=ORG_URL. Obligatoire si la valeur n’est pas configurée par défaut ni récupérée via git config. 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 s’il n’est pas configuré par défaut ou récupéré via la configuration git.

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.