Wiki's beheren met de CLI
Azure DevOps Services-
Meer informatie over de volgende CLI-opdrachten voor het beheren van wiki's.
Notitie
U kunt projectwiki's niet verwijderen met de CLI.
Voorwaarden
Categorie | Eisen |
---|---|
Projecttoegang | Lid van het project waar de wiki zich bevindt. Als u geen toegang hebt, vraagt u dit aan bij de projectbeheerder. |
machtigingen | Lid van de Inzenders groep. |
Toegangsniveaus | Minimaal Basic-toegang. |
Opdrachten
Opdrachten | beschrijving |
---|---|
az devops wiki create | Een wiki maken. |
az devops wiki verwijderen | Een wiki verwijderen. |
az devops wiki list | Alle wiki's in een project of organisatie weergeven. |
az devops wiki page | Wikipagina's beheren. |
az devops wiki page create | Voeg een nieuwe pagina toe. |
az devops wiki page verwijderen | Een pagina verwijderen. |
az devops wiki page show | De inhoud van een pagina ophalen of een pagina openen. |
az devops wiki page update | Een pagina bewerken. |
az devops wiki show | De details van een wiki weergeven. |
Een wiki maken
Als u een wiki wilt maken, voert u de opdracht az devops wiki create
in.
az devops wiki create [--mapped-path]
[--name]
[--project]
[--repository]
[--subscription]
[--type {codewiki, projectwiki}]
Optionele parameters
-
--mapped-path: [Vereist voor
codewiki
type] Gemapt pad van de nieuwe wiki, bijvoorbeeld/
om te publiceren vanuit de hoofdmap van de repository. - --name: naam van de nieuwe wiki.
-
--project -p: Optioneel. Naam of id van het project. Configureer het standaardproject met behulp van
az devops configure -d project=NAME_OR_ID
. Vereist indien niet geconfigureerd als standaard of opgehaald via git-configuratie. -
--repository -r: [Vereist voor
codewiki
type] Naam of id van de opslagplaats waaruit de wiki moet worden gepubliceerd. -
--subscription: Optioneel. Naam of id van abonnement. Configureer het standaardabonnement met behulp van
az account set -s NAME_OR_ID
. -
--type --wiki-type: type wiki dat moet worden gemaakt. Geaccepteerde waarden:
codewiki
,projectwiki
. Standaardwaarde:projectwiki
.
Voorbeelden
Maak een benoemde projectwiki.
az devops wiki create --name myprojectwiki
Een codewiki maken op basis van een map in een codeopslagplaats.
az devops wiki create --name WIKI_NAME --type codewiki
--repository REPO_NAME --mapped-path PATH_TO_PUBLISH
Een wiki verwijderen
Als u een wiki wilt verwijderen, voert u de opdracht az devops wiki delete
in.
Notitie
U kunt deze opdracht alleen gebruiken om een codewiki te verwijderen, niet om een projectwiki te verwijderen.
az devops wiki delete
[--wiki]
[--project]
[--subscription]
[--yes]
Parameters
- --wiki: Vereist. Naam of id van de wiki die u wilt verwijderen.
-
--project -p: Optioneel. Naam of id van het project. U kunt het standaardproject configureren met behulp van
az devops configure -d project=NAME_OR_ID
. Vereist indien niet geconfigureerd als standaard of opgehaald via git-configuratie. -
--subscription: Optioneel. Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van
az account set -s NAME_OR_ID
. - --yes -y: Optioneel. Vraag niet om bevestiging.
Voorbeeld
Verwijder een wiki zonder een bevestigingsprompt.
az devops wiki delete --wiki myprojectwiki --yes
Wiki's weergeven
Als u alle wiki's in een project of organisatie wilt weergeven, voert u de opdracht az devops wiki list
in.
az devops wiki list
[--project]
[--scope {organization, project}]
[--subscription]
Optionele parameters
- --project -p: Optioneel. Naam of id van het project.
-
--scope: Optioneel. Vermeld de wiki's op project- of organisatieniveau. Geaccepteerde waarden:
organization
,project
. Standaardwaarde:project
. -
--subscription: Optioneel. Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van
az account set -s NAME_OR_ID
.
Voorbeelden
Geef alle wiki's voor een project weer.
az devops wiki list
Geef alle wiki's in de organisatie weer.
az devops wiki list --scope organization
Wiki weergeven
Als u details van een wiki wilt weergeven, voert u de opdracht az devops wiki show
in.
az devops wiki show --wiki
[--open]
[--project]
[--subscription]
Parameters
- --wiki: Vereist. Naam of id van de wiki.
- --open: Optioneel. Open de wikipagina in uw webbrowser.
- --project -p: Optioneel. Naam of id van het project.
-
--subscription: Optioneel. Naam of id van abonnement. Configureer het standaardabonnement met behulp van
az account set -s NAME_OR_ID
.
Voorbeeld
De wiki met de naam myprojectwiki
weergeven en de wikipagina openen in uw webbrowser.
az devops wiki show --wiki myprojectwiki --open
Een wikipagina maken
Als u een nieuwe wikipagina wilt toevoegen, voert u de opdracht az devops wiki page create
in.
az devops wiki page create --path
--wiki
[--comment]
[--content]
[--encoding {ascii, utf-16be, utf-16le, utf-8}]
[--file-path]
[--project]
[--subscription]
Parameters
- --path: Vereist. Pad van de wikipagina.
- --wiki: Vereist. Naam of id van de wiki.
-
--comment: Optioneel. Opmerking in het doorvoerbericht van de bewerking voor het toevoegen van bestanden. Standaardwaarde:
added a new page using Azure DevOps CLI
. -
--content: Optioneel. Inhoud van de wikipagina. Genegeerd wanneer
--file-path
is opgegeven. -
--codering: Optioneel. Codering van het bestand. Wordt gebruikt met de
--file-path
parameter. - --file-path: Optioneel. Pad van de bestandsinvoer als inhoud is opgegeven in het bestand.
- --project -p: Optioneel. Naam of id van het project.
-
--subscription: naam of id van het abonnement. U kunt het standaardabonnement configureren met behulp van
az account set -s NAME_OR_ID
.
Voorbeelden
Maak een nieuwe pagina met pad my page
in een wiki met de naam myprojectwiki
met inline-inhoud.
az devops wiki page create --path 'my page' --wiki myprojectwiki --content "Hello World"
Maak een nieuwe pagina met het pad 'mijn pagina' in een wiki met de naam 'myprojectwiki' met inhoud uit een bestand.
az devops wiki page create --path 'my page' --wiki myprojectwiki --file-path a.txt --encoding utf-8