Suporte dos portais para a CLI do Microsoft Power Platform

Observação

Desde o dia 12 de outubro de 2022, os portais do Power Apps passaram a ser Power Pages. Mais Informações: O Microsoft Power Pages já está disponível para todos (blog)
Em breve, migraremos e mesclaremos a documentação dos portais do Power Apps com a documentação do Power Pages.

A Microsoft Power Platform CLI (Interface de Linha de Comando) é uma interface de linha de comando de desenvolvedor simples e de parada única que capacita os desenvolvedores e fabricantes de aplicativos a criar componentes de código.

As ferramentas de CLI do Microsoft Power Platform são a primeira etapa em direção a uma história abrangente de gerenciamento do ciclo de vida do aplicativo (ALM), em que os desenvolvedores corporativos e ISVs podem criar, construir, depurar e publicar suas extensões e personalizações de forma rápida e eficiente. Para obter mais informações, consulte O que é Microsoft Power Platform CLI?

Com este recurso, os portais do Microsoft Power Apps dão suporte à CLI do Microsoft Power Platform para habilitar a CI/CD (Integração Contínua/Implantação Contínua) de configuração do portal. Agora você pode fazer o check-in da configuração do portal para o controle de origem e mover a configuração do portal para qualquer ambiente usando a CLI do Microsoft Power Platform.

Observação

Geralmente, este recurso está disponível a partir da CLI do Power Platform versão 1.9.8. Para saber como instalar a versão mais recente, consulte Instalar a CLI do Microsoft Power Platform.

Por que usar a CLI do Microsoft Power Platform para desenvolvimento de portais?

Com o suporte de portais para a CLI do Microsoft Power Platform, agora você pode usar o recurso tipo offline para personalização de portais, fazendo alterações no conteúdo dos portais. Quando todas as personalizações ou alterações forem salvas, carregue-as no portal. Quando você baixa o conteúdo de portais usando a CLI do Microsoft Power Platform, o conteúdo é estruturado nos formatos YAML e HTML para facilitar a personalização, possibilitando uma experiência favorável ao desenvolvimento.

Veja a seguir uma lista de recursos e funcionalidades dos quais os portais se beneficiam com o suporte à CLI do Microsoft Power Platform:

Facilidade de uso

  • Suporte para download/upload de dados do portal de/para o sistema de arquivos local

  • Baseie-se na ferramenta de CLI do Microsoft Power Platform.

Gerenciamento do ciclo de vida do aplicativo (ALM)

  • Rastreie as alterações na configuração do portal em uma organização

  • Mova arquivos de configuração entre organizações ou locatários

Pró-desenvolvimento e suporte empresarial

  • Ajuda na integração total com ferramentas de controle do código-fonte, como "git"

  • Configure facilmente pipelines de CI/CD

Instalar a CLI do Microsoft Power Platform

Para obter instruções passo a passo, consulte Instalar o Microsoft Power Platform CLI.

Tabelas com suporte

O suporte de portais para a CLI do Microsoft Power Platform está limitado às tabelas listadas abaixo.

adx_ad

adx_adplacement

adx_blog

adx_blogpost

adx_botconsumer

adx_communityforum

adx_communityforumaccesspermission

adx_contentsnippet

adx_entityform

adx_entityformmetadata

adx_entitylist

adx_entitypermission

adx_forumthreadtype

adx_pagetemplate

adx_poll

adx_polloption

adx_pollplacement

adx_portallanguage

adx_publishingstate

adx_redirect

adx_shortcut

adx_sitemarker

adx_sitesetting

adx_tag

adx_urlhistory

adx_webfile

adx_webform

adx_webformmetadata

adx_webformstep

adx_weblink

adx_weblinkset

adx_webpage

adx_webpageaccesscontrolrule

adx_webrole

adx_website

adx_websiteaccess

adx_websitebinding (apenas download)

adx_websitelanguage

adx_webtemplate

anotação

Importante

  • As tabelas personalizadas e as tabelas específicas de modelo de portal (como blog, comunidade ou portal de ideias) não são compatíveis com a personalização ao usar a CLI do Microsoft Power Platform.
  • Os anexos de arquivos de imagem para registros de anúncios (adx_ad) não são baixados usando a CLI do Power Platform. Como solução alternativa, use o campo URL da Imagem, ou adicione uma referência HTML ao campo Cópia para um registro do arquivo da Web contendo um arquivo de imagem.

Instalar e verificar a CLI do Microsoft Power Platform para portais

Para aprender a instalação da CLI do Microsoft Power Platform, vá para Instalar a CLI do Microsoft Power Platform.

Depois de instalar a CLI do Microsoft Power Platform, abra um prompt de comando e execute pac para verificar se a saída contém "paportal", o comando para os portais do Power Apps.

Confirmar o comando paportal na CLI do Microsoft Power Platform.

Os comandos da CLI do Microsoft Power Platform para portais

O comando da CLI do Microsoft Power Platform para portais é "paportal".

As seções a seguir fornecem mais detalhes sobre diferentes propriedades do comando "paportal".

Parâmetros

Nome da Propriedade Descrição Exemplo
lista Lista todos os sites do portal do ambiente atual do Dataverse. pac paportal list
fazer download Baixe o conteúdo do site do portal do ambiente atual do Dataverse. Ele tem os seguintes parâmetros:
- path: caminho em que o conteúdo do site será baixado (alias: -p)
- webSiteId: ID do site do portal para download (alias: -id)
- overwrite: (opcional) verdadeiro para substituir o conteúdo existente; falso para falhar se a pasta já tiver o conteúdo do site (alias: -o)
pac paportal download --path "C:\portals" --webSiteId f88b70cc-580b-4f1a-87c3-41debefeb902
carregar Carregue o conteúdo do site do portal no ambiente atual do Dataverse. Ele tem o seguinte parâmetro:
- path: caminho em que o conteúdo do site é armazenado (alias: -p)
-deploymentProfile: carregue os dados do portal com detalhes do ambiente definidos por meio de variáveis de perfil no arquivo deployment-profiles/[nome-do-perfil].deployment.yaml
pac paportal upload --path "C:\portals\starter-portal" --deploymentProfile "profile-name"
Usar o perfil de implantação

A opção deploymentProfile permite definir um conjunto de variáveis para o ambiente no formato YAML. Por exemplo, você pode ter perfis de implementação diferentes (como dev, test, prod) que possuem detalhes de esquema diferentes definidos no perfil.

Se você estiver criando um perfil de teste, você pode criar um arquivo em deployment-profiles com o nome "test.deployment.yml" (ou seja, <profileTag>.deployment.yml). E você pode executar o comando com a tag (<profileTag>) para usar este perfil:

pac paportal upload --path "C:\portals\starter-portal" --deploymentProfile test

Neste arquivo, você pode ter o nome da tabela (entidade) com a ID da tabela, lista de atributos e os valores que você deseja substituir ao enviar a configuração do portal usando o parâmetro deploymentProfile.

Além disso, você pode usar a variável OS para acessar as variáveis de ambiente do sistema operacional.

Aqui está um exemplo deste arquivo YAML do perfil "test.deployment.yml" que tem detalhes de esquema exclusivos:

adx_sitesetting:
    - adx_sitesettingid: 4ad86900-b5d7-43ac-1234-482529724970
      adx_value: ${OS.FacebookAppId} 
      adx_name: Authentication/OpenAuth/Facebook/AppId
    - adx_sitesettingid: 5ad86900-b5d7-43ac-8359-482529724979
      adx_value: contoso_sample
      adx_name: Authentication/OpenAuth/Facebook/Secret
adx_contentsnippet:
    - adx_contentsnippetid: b0a1bc03-0df1-4688-86e8-c67b34476510
      adx_name: PowerBI/contoso/sales
      adx_value:  https://powerbi.com/group/contoso/sales

Observação

Para saber mais sobre todos os comandos usados na CLI, além dos portais, vá para Comandos comuns na CLI do Microsoft Power Platform.

Arquivos de manifesto

Quando você faz download do conteúdo do site usando o comando da CLI pac paportal download, juntamente com o download do conteúdo do site, ele também gerará dois arquivos de manifesto:

  • Arquivo de manifesto do ambiente (org-url-manifest.yml)
  • Excluir arquivo de manifesto de rastreamento (manifest.yml)

Arquivo de manifesto do ambiente (org-url-manifest.yml)

O arquivo de manifesto do ambiente é gerado toda vez que o comando pac paportal download é executado.

Após cada download, a ferramenta PAC CLI lê o arquivo de manifesto do ambiente existente e atualiza as entradas excluídas no ambiente, ou criará o arquivo de manifesto do ambiente se ele não existir.

Quando você executa o comando pac paportal upload para carregar o conteúdo do site do portal. Ele lê o arquivo de manifesto do ambiente e identifica as alterações feitas desde o último download e carrega apenas o conteúdo atualizado. Isso ajuda a otimizar o processo de upload, pois apenas o conteúdo atualizado do site é carregado, em vez de carregar todo o conteúdo em cada comando de upload.

O arquivo de manifesto do ambiente será somente leitura quando se conectar ao mesmo ambiente (o URL do ambiente corresponder ao nome do arquivo), para evitar alterações acidentais.

Excluir arquivo de manifesto de rastreamento (manifest.yml)

Este arquivo é usado para rastrear os registros excluídos do ambiente.

Quando o conteúdo do site é baixado com o comando pac paportal download, isso adicionará os registros excluídos do arquivo de manifesto do ambiente (org-url-manifest.yml) ao arquivo manifest.yml. Quando você carrega o conteúdo do site usando o comando pac paportal upload, ele excluirá os arquivos do ambiente (mesmo para um ambiente diferente). Este arquivo não é excluído e é usado independentemente do ambiente em que você está conectado.

Observação

Para excluir os registros de conteúdo do site em um ambiente e também excluir os mesmos registros de conteúdo em outro ambiente usando a PAC CLI, você precisará executar o comando pac paportal download antes e depois da exclusão do conteúdo do registro do site. O manifest.yml rastreará essas alterações e removerá os registros correspondentes no ambiente de destino quando o comando pac paportal upload for executado.

Usar a extensão do Visual Studio Code

Você também pode usar a Extensão do VS Code do Power Platform para beneficiar a linguagem Liquid integrada do IntelliSense, a assistência de conclusão de código, as dicas e a interação com a CLI do Microsoft Power Platform por meio do Terminal integrado do VS Code. Mais informações: Usar a extensão do Visual Studio Code (versão preliminar)

Considerações adicionais

  • Um erro será relatado se o caminho do arquivo exceder a limitação do tamanho máximo. Mais informações: Limitação máxima do tamanho do caminho no Windows
  • Para registros duplicados, como um nome de página da Web duplicado, a CLI do Microsoft Power Platform cria duas pastas diferentes — uma com o nome da página da Web e a outra com o mesmo nome prefixado com um código hash. Por exemplo, “My-page” e “My-page-hash-code”.

Próximas etapas

Tutorial: Usar a CLI do Microsoft Power Platform com portais

Consulte também