Administración de wikis con la CLI

Azure DevOps Services | Azure DevOps Server 2020

Obtenga información sobre los siguientes comandos de la CLI para administrar wikis.

Comandos:

Creación de una wiki

Para crear una wiki, escriba el az devops wiki create comando .

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

Parámetros opcionales

• --mapped-path:[Obligatorio para el tipo codewiki] Ruta de acceso asignada de la nueva wiki, por ejemplo, "/" para publicar desde la raíz del repositorio. --name: nombre de la nueva wiki.
• --project -p: opcional. Nombre o identificador del proyecto. Puede configurar el proyecto predeterminado mediante az devops configure -d project=NAME_OR_ID. Obligatorio si no está configurado como predeterminado o se selecciona a través de la configuración de Git.
• --repository -r: [Obligatorio para el tipo codewiki] Nombre o identificador del repositorio desde el que publicar la wiki.
• --subscription:opcional. Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
• --type --wiki-type:tipo de wiki que se creará. Valores aceptados: codewiki, projectwiki. Valor predeterminado: projectwiki.

Ejemplos

Cree una wiki de proyecto con nombre.

az devops wiki create --name myprojectwiki

Cree una wiki de código a partir de una carpeta en un repositorio de código.

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

Eliminación de una wiki

Para eliminar una wiki, escriba el az devops wiki delete comando .

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

Parámetros

• --wiki:obligatorio. Nombre o identificador de la wiki que se eliminará.
• --project -p: opcional. Nombre o identificador del proyecto. Puede configurar el proyecto predeterminado mediante az devops configure -d project=NAME_OR_ID. Obligatorio si no está configurado como predeterminado o se selecciona a través de la configuración de Git.
• --subscription:opcional. Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.
• --yes -y: opcional. No solicite confirmación.

Ejemplo

Elimine una wiki sin pedir confirmación.

az devops wiki delete --wiki myprojectwiki --yes

Enumeración de wikis

Para enumerar todos los wikis de un proyecto o una organización, escriba el az devops wiki list comando .

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

Parámetros opcionales

• --project -p: opcional. Nombre o identificador del proyecto.
• --scope:opcional. Enumerar los wikis en el nivel de proyecto u organización. Valores aceptados: organización, proyecto. Valor predeterminado: project.
• --subscription:opcional. Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Ejemplos

Enumera todas las wikis de un proyecto.

az devops wiki list

Enumera todos los wikis de la organización.

az devops wiki list --scope organization

Mostrar wiki

Para mostrar los detalles de una wiki, escriba el az devops wiki show comando .

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

Parámetros

• --wiki:obligatorio. Nombre o identificador de la wiki.
• --open: opcional. Abra la página wiki en el explorador web.
• --project -p: opcional. Nombre o identificador del proyecto.
• --subscription:opcional. Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Ejemplo

Muestre la wiki denominada "myprojectwiki" y abra la página wiki en el explorador web.

az devops wiki show --wiki myprojectwiki --open

Creación de una página wiki

Para agregar una nueva página wiki, escriba el az devops wiki page create comando .

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

Parámetros

• --path: obligatorio. Ruta de acceso de la página wiki.
• --wiki:obligatorio. Nombre o identificador de la wiki.
• --comment: opcional. Comente en el mensaje de confirmación de la operación de adición de archivos. Valor predeterminado: se ha agregado una nueva página mediante Azure DevOps CLI.
• --content: opcional. Contenido de la página wiki. Se omite si se especifica --file-path.
• --encoding: opcional. Codificación del archivo. Se usa con el parámetro --file-path.
• --file-path:opcional. Ruta de acceso de la entrada del archivo si se especifica contenido en el archivo.
• --project -p: opcional. Nombre o identificador del proyecto.
• --subscription: nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Ejemplos

Cree una nueva página con la ruta de acceso "mi página" en una wiki denominada "myprojectwiki" con contenido en línea.

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

Cree una nueva página con la ruta de acceso "mi página" en una wiki denominada "myprojectwiki" con contenido de un archivo.

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