Manifesto da carga de trabalho no Kit de Ferramentas de Extensibilidade

O manifesto da carga de trabalho (WorkloadManifest.xml) é a configuração no nível da carga de trabalho para sua carga de trabalho. Ele informa ao Fabric quem é sua carga de trabalho e como alcançar o front-end para que o host possa inicializar com segurança. Ele complementa, mas não substitui, as definições de produto e item:

  • Os metadados do produto (para descoberta e publicação) residem em Product.json.
  • Os tipos de item e seus comportamentos residem nos manifestos do item e nos arquivos JSON.

O que o manifesto da carga de trabalho define

  • Identidade da carga de trabalho: WorkloadName ([Organização].[ WorkloadId]) e Version (versão semântica). A parte WorkloadId não pode exceder 32 caracteres.
  • Modelo de hospedagem: HostingType (use FERemote)
  • Aplicativo de Microsoft Entra front-end: AADFEApp>AppId
  • Pontos de extremidade front-end: ServiceEndpoint entradas com Name (por exemplo, Frontend), Url (localhost em desenvolvimento; domínio de produção deve ser um subdomínio do seu domínio Entra verificado) e IsEndpointResolutionService. Consulte Os Requisitos Gerais de Publicação para restrições de domínio.
  • Relaxamento opcional do sandbox: EnableSandboxRelaxation somente quando são necessários recursos especiais do iFrame (como iniciar downloads de arquivos)

Práticas recomendadas

  • Mantenha as versões consistentes entre seu aplicativo e manifesto
  • Declarar as permissões mínimas necessárias (princípio de privilégio mínimo)
  • Validar o manifesto como parte da CI

Estrutura

Elementos-chave no Manifesto e o que eles significam:

  • Elemento raiz com uma versão de esquema (por exemplo, SchemaVersion="2.0.0").
  • Workload nó com os seguintes atributos:
    • WorkloadName — identificador exclusivo no formulário [Organization].[WorkloadId] (por exemplo, Org.MyWorkload). A parte WorkloadId não pode exceder 32 caracteres. Se você não pretende publicar em outros locatários, pode usar Org.[WorkloadId]. Para publicação entre locatários, registre um WorkloadName completo no Fabric.
    • HostingType — indica a hospedagem da carga de trabalho; use FERemote.
  • Version node — versão semântica do pacote de carga de trabalho.
  • RemoteServiceConfiguration > CloudServiceConfiguration Contendo:
    • Cloud (por exemplo, Public).
    • AADFEApp > AppId — contém a ID do aplicativo Microsoft Entra front-end.
    • EnableSandboxRelaxation — defina-o para true se você precisar de recursos especiais de iFrame (por exemplo, iniciando downloads de arquivo). Mantenha false como padrão para segurança.
    • Endpoints > ServiceEndpoint entradas com:
      • Name (por exemplo, Frontend).
      • Url — em que o front-end está hospedado. Use https://localhost:port para desenvolvimento. Em produção, o domínio deve ser um subdomínio de um domínio do Entra verificado. Consulte os Requisitos Gerais de Publicação para obter restrições de domínio completas.
      • IsEndpointResolutionService.

Criar resultado e espaços reservados

No Starter-Kit, preenche os espaços reservados sempre que o Manifesto é criado com base na configuração no arquivo de ambiente. O manifesto final é criado no diretório build/Manifest. Usar espaços reservados e preenchê-los dos ambientes permite criar ambientes diferentes sem alterar os arquivos ou os scripts. A saída de build é usada por:

  • DevGateway: registre sua instância de desenvolvimento local com o Fabric para que seu aplicativo possa ser carregado dentro do portal do Fabric durante o desenvolvimento.
  • DevServer: que está fornecendo as informações para o Fabric
  • Portal de Administração: para teste e produção, faça o upload do pacote de manifesto por meio do Portal de Administração do Fabric como parte da publicação. Consulte Publicar sua carga de trabalho.

Limites de pasta de back-end

A pasta back-end (BE) tem as seguintes restrições:

  • Aceita apenas .xml arquivos. Qualquer outro tipo de arquivo resulta em um erro de upload.
  • Pode conter um WorkloadManifest.xml arquivo (obrigatório).
  • Pode conter até 10 Item.xml arquivos. Ter mais de 10 arquivos de item resulta em um erro de upload.

Confira Visão geral do Manifest para obter limites de pacote completos.

Saiba Mais

  • Arquitetura