Verwalten von Wikis mit der CLI

  • Artikel

Azure DevOps Services

Lernen Sie die folgenden CLI-Befehle zum Verwalten von Wikis kennen.

Hinweis

Projektwikis können nicht mit der CLI gelöscht werden.

Befehle

Befehle Beschreibung
az devops wiki create Erstellen Sie ein Wiki.
az devops wiki delete Löschen sie ein Wiki.
az devops wiki list Alle Wikis in einem Projekt oder einer Organisation auflisten.
az devops wiki page Verwalten von Wiki-Seiten
az devops wiki page create Fügen Sie eine neue Seite hinzu.
az devops wiki page delete Löschen einer Seite.
az devops wiki page show Rufen Sie den Inhalt einer Seite ab, oder öffnen Sie eine Seite.
az devops wiki page update Bearbeiten Sie eine -Seite.
az devops wiki show Zeigen Sie die Details eines Wikis an.

Erstellen eines Wikis

Um ein Wiki zu erstellen, geben Sie den Befehl ein az devops wiki create .

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

Optionale Parameter

  • --mapped-path: [Erforderlich für codewiki Typ] Zugeordneter Pfad des neuen Wikis, / z. B. zum Veröffentlichen aus dem Stamm des Repositorys.
  • --name: Name des neuen Wikis.
  • --project -p: Optional. Name oder ID des Projekts. Konfigurieren des Standardprojekts mithilfe von az devops configure -d project=NAME_OR_ID. Erforderlich, wenn nicht als „Standard“ konfiguriert oder über „git config“ übernommen.
  • --repository -r: [Erforderlich für codewiki Typ] Name oder ID des Repositorys, aus dem das Wiki veröffentlicht werden soll.
  • --subscription: Optional. Der Name oder die ID des Abonnements. Konfigurieren Sie das Standardabonnement mithilfe von az account set -s NAME_OR_ID.
  • --type --wiki-type: Typ des zu erstellenden Wikis. Zulässige Werte: codewiki, projectwiki. Standardwert. projectwiki.

Beispiele

Erstellen Sie ein benanntes Projektwiki.

az devops wiki create --name myprojectwiki

Erstellen Sie ein Codewiki aus einem Ordner in einem Code-Repository.

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

Löschen eines Wikis

Um ein Wiki zu löschen, geben Sie den az devops wiki delete Befehl ein.

Hinweis

Sie können diesen Befehl nur verwenden, um ein Codewiki zu löschen, nicht um ein Projektwiki zu löschen.

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

Parameter

  • --wiki: Erforderlich. Name oder ID des zu löschenden Wikis.
  • --project -p: Optional. Name oder ID des Projekts. Sie können das Standardprojekt mit az devops configure -d project=NAME_OR_ID konfigurieren. Erforderlich, wenn nicht als „Standard“ konfiguriert oder über „git config“ übernommen.
  • --subscription: Optional. Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
  • --yes -y: Optional. Fordern Sie nicht zur Bestätigung auf.

Beispiel

Löschen Sie ein Wiki ohne Bestätigungsaufforderung.

az devops wiki delete --wiki myprojectwiki --yes

Wikis auflisten

Wenn Sie alle Wikis in einem Projekt oder einer Organisation auflisten möchten, geben Sie den Befehl ein az devops wiki list .

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

Optionale Parameter

  • --project -p: Optional. Name oder ID des Projekts.
  • --scope: Optional. Auflisten der Wikis auf Projekt- oder Organisationsebene. Zulässige Werte: organization, project. Standardwert. project.
  • --subscription: Optional. Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

Beispiele

Alle Wikis für ein Projekt auflisten.

az devops wiki list

Alle Wikis in der Organisation auflisten.

az devops wiki list --scope organization

Wiki anzeigen

Um Details eines Wikis anzuzeigen, geben Sie den Befehl ein az devops wiki show .

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

Parameter

  • --wiki: Erforderlich. Name oder ID des Wikis.
  • --open: Optional. Öffnen Sie die Wikiseite in Ihrem Webbrowser.
  • --project -p: Optional. Name oder ID des Projekts.
  • --subscription: Optional. Der Name oder die ID des Abonnements. Konfigurieren Sie das Standardabonnement mithilfe von az account set -s NAME_OR_ID.

Beispiel

Zeigen Sie das Wiki mit dem Namen myprojectwiki an, und öffnen Sie die Wiki-Seite in Ihrem Webbrowser.

az devops wiki show --wiki myprojectwiki --open

Erstellen einer Wiki-Seite

Um eine neue Wiki-Seite hinzuzufügen, geben Sie den Befehl ein az devops wiki page create .

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

Parameter

  • --path: Erforderlich. Pfad der Wiki-Seite.
  • --wiki: Erforderlich. Name oder ID des Wikis.
  • --comment: Optional. Kommentar in der Commit-Nachricht des Datei-Add-Vorgangs. Standardwert. added a new page using Azure DevOps CLI.
  • --content: Optional. Inhalt der Wikiseite. Wird ignoriert, wenn --file-path angegeben.
  • --encoding: Optional. Codierung der Datei. Wird mit --file-path Parametern verwendet.
  • --file-path: Optional. Pfad der Dateieingabe, wenn Inhalt in der Datei angegeben ist.
  • --project -p: Optional. Name oder ID des Projekts.
  • --subscription: Name oder ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

Beispiele

Erstellen Sie eine neue Seite mit Pfad my page in einem Wiki myprojectwiki mit Inlineinhalten.

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

Erstellen Sie eine neue Seite mit dem Pfad "meine Seite" in einem Wiki mit dem Namen "myprojectwiki" mit Inhalt aus einer Datei.

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