Administración de wikis con la CLI

Servicios de Azure DevOps

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

Nota

No se pueden eliminar wikis del proyecto con la CLI.

Prerrequisitos

Categoría	Requisitos
Acceso al proyecto	Miembro del proyecto donde se encuentra la wiki. Si no tiene acceso, solicítelo al administrador del proyecto.
Permisos	Miembro del grupo de colaboradores .
Niveles de acceso	Al menos acceso Básico.

Comandos

Comandos	descripción
az devops wiki create	Cree una wiki.
az devops wiki delete	Eliminar una wiki.
az devops wiki list	Enumere todas las wikis de un proyecto o una organización.
az devops wiki page	Administrar páginas wiki.
az devops wiki page create	Agregue una nueva página.
az devops wiki page delete	Eliminar una página.
az devops wiki page show	Obtiene el contenido de una página o abre una página.
az devops wiki page update	Edite una página.
az devops wiki show	Muestra los detalles de una wiki.

Creación de una wiki

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

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. Configure el proyecto predeterminado mediante az devops configure -d project=NAME_OR_ID. Obligatorio si no está configurado como predeterminado o seleccionado a través de la configuración de Git.
• --repository -r: [Obligatorio para codewiki tipo] Nombre o identificador del repositorio desde el que publicar la wiki.
• --subscription: opcional. Nombre o identificador de la suscripción. Configure la suscripción predeterminada mediante az account set -s NAME_OR_ID.
• --type --wiki-type: Tipo de wiki que se va a 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

Eliminar una wiki

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

Nota

Solo puede usar este comando para eliminar una wiki de código, no para eliminar una wiki del proyecto.

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

Parámetros

• --wiki: Obligatorio. Nombre o identificador de la wiki que se va a 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 seleccionado 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 pida confirmación.

Ejemplo

Elimina una wiki sin una solicitud de confirmación.

az devops wiki delete --wiki myprojectwiki --yes

Enumerar wikis

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

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

Parámetros opcionales

• --project -p: opcional. Nombre o identificador del proyecto.
• --scope: opcional. Enumere las wikis en el nivel de proyecto o organización. Valores aceptados: organization, project. 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

Enumerar todas las wikis de un proyecto.

az devops wiki list

Enumere todas las wikis de la organización.

az devops wiki list --scope organization

Mostrar wiki

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

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

Crear una página wiki

Para agregar una nueva página wiki, escriba el comando 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]

Parámetros

• --path: Obligatorio. Ruta de acceso de la página wiki.
• --wiki: Obligatorio. Nombre o identificador de la wiki.
• --comment: opcional. Comentario en el mensaje de confirmación de la operación de adición de archivos. Valor predeterminado: added a new page using 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 del archivo de entrada 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 my page en una wiki llamada myprojectwiki con contenido en línea.

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

Crear una nueva página con la ruta 'mi página' en una wiki llamada 'myprojectwiki' con contenido proveniente de un archivo.

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