Compartilhar via


Extensões de publicação

Depois de desenvolver sua extensão, você desejará publicá-la e disponibilizá-la para outras pessoas testarem ou usarem. Neste artigo, apresentamos algumas opções de publicação, juntamente com as etapas e requisitos, dependendo do público-alvo e da finalidade da publicação.

Opções de publicação

Há três opções principais para fontes de pacote configuráveis que o Windows Admin Center dá suporte:

  • Feed do NuGet público do Windows Admin Center da Microsoft
  • Seu próprio feed do NuGet privado
  • Compartilhamento de arquivos local ou de rede

Publicar no feed de extensão do Windows Admin Center

Por padrão, o Windows Admin Center está conectado a um feed do NuGet mantido pela equipe de produto do Windows Admin Center na Microsoft. Versões prévias antecipadas de novas extensões desenvolvidas pela Microsoft podem ser publicadas neste feed e disponibilizadas para os usuários do Windows Admin Center. Desenvolvedores externos que planejam criar e liberar extensões publicamente também podem enviar uma solicitação para Publicar sua extensão no feed de Windows Admin Center. Antes de publicar neste feed, os desenvolvedores externos terão que concordar com o Contrato de Editor de Extensão e a Política de Participação de Extensão do Windows Admin Center.

Publicar em um feed diferente do NuGet

Você também pode criar seu próprio feed do NuGet para publicar suas extensões usando uma das muitas opções diferentes para configurar uma fonte privada ou usar um serviço de hospedagem do NuGet. O feed do NuGet deve dar suporte à API do NuGet v2. Como o Windows Admin Center atualmente não dá suporte à autenticação de feed, o feed precisa ser configurado para permitir o acesso de leitura a qualquer pessoa.

Publicar em um compartilhamento de arquivos

Para restringir o acesso de sua extensão à sua organização ou a um grupo limitado de pessoas, use um compartilhamento de arquivos SMB como um feed de extensão. Ao usar um compartilhamento de arquivos para hospedar seu feed de extensão, as permissões de arquivo e pasta são aplicadas para gerenciar o acesso ao feed.

Preparar a extensão para liberar

Leia e considere os seguintes artigos de desenvolvimento:

Considere liberar como uma versão prévia

Se você estiver lançando uma versão prévia de sua extensão para fins de avaliação, recomendamos que:

  • Acrescente "(Versão prévia)" ao final do título da sua extensão no arquivo .nuspec
  • Explique as limitações na descrição da sua extensão no arquivo .nuspec

Criar um pacote de extensão

O Windows Admin Center utiliza pacotes e feeds do NuGet para distribuir e baixar extensões. Para que seu pacote seja enviado, você precisa gerar um pacote NuGet contendo seus plug-ins e extensões. Um único pacote pode conter uma extensão de interface do usuário e um plug-in do Gateway. A seção a seguir orienta você pelo processo.

Compilar sua extensão

Assim que você estiver pronto para começar a empacotar sua extensão, crie um diretório no sistema de arquivos, abra um console e insira o CD nele. Esse será o diretório raiz que usaremos para conter todos os diretórios nuspec e content que compõem nosso pacote. Chamaremos essa pasta de Pacote NuGet no restante deste artigo.

Extensões de interface do usuário

Para iniciar o processo de coleta de todo o conteúdo necessário para uma extensão de interface do usuário, execute "gulp build" em sua ferramenta e verifique se a compilação foi bem-sucedida. Esse processo empacota todos os componentes em uma pasta chamada "bundle" localizada no diretório raiz da extensão (no mesmo nível do diretório src). Copie esse diretório e todo o seu conteúdo para a pasta "Pacote NuGet".

Plug-ins do gateway

Usando sua infraestrutura de compilação (que pode ser tão simples quanto abrir o Visual Studio e selecionar o botão Build), compile e crie seu plug-in. Abra seu diretório de saída de compilação, copie a DLL ou DLLs que representam seu plug-in e coloque-os em uma nova pasta dentro do diretório "NuGet Package" chamado "package". Você não precisa copiar a DLL FeatureInterface, apenas a DLL ou DLLs que representam seu código.

Criar o arquivo nuspec

Para criar o pacote NuGet, primeiro é necessário criar um arquivo .nuspec. Um arquivo .nuspec é um manifesto XML que contém metadados do pacote NuGet. Esse manifesto é usado para compilar o pacote e fornecer informações aos consumidores. Coloque esse arquivo na raiz da pasta "Pacote NuGet".

Aqui está um exemplo de arquivo .nuspec e a lista de propriedades necessárias ou recomendadas. Para obter o esquema completo, veja a referência nuspec. Salve o arquivo .nuspec na pasta raiz do projeto com um nome de arquivo de sua escolha.

Importante

O valor <id> no arquivo .nuspec precisa corresponder ao valor "name" no arquivo manifest.json do projeto ou, caso contrário, sua extensão publicada não será carregada com êxito no Windows Admin Center.

<?xml version="1.0">
<package>
  <metadata>
    <id>contoso.project.extension</id>
    <version>1.0.0</version>
    <title>Contoso Hello Extension</title>
    <authors>Contoso</authors>
    <owners>Contoso</owners>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <projectUrl>https://msft-sme.myget.org/feed/windows-admin-center-feed/package/nuget/contoso.sme.hello-extension</projectUrl>
    <licenseUrl>http://YourLicenseLink</licenseUrl>
    <iconUrl>http://YourLogoLink</iconUrl>
    <description>Hello World extension by Contoso</description>
    <copyright>(c) Contoso. All rights reserved.</copyright>
    <tags></tags>
  </metadata>
  <files>
    <file src="bundle\**\*.*" target="ux" />
    <file src="package\**\*.*" target="gateway" />
  </files>
</package>
Nome da propriedade Obrigatório/Recomendado Descrição
packageType Obrigatório Use WindowsAdminCenterExtension, que é o tipo de pacote NuGet definido para extensões do Windows Admin Center.
ID Obrigatório Identificador de pacote exclusivo dentro do feed. Esse valor precisa corresponder ao valor "name" no arquivo manifest.json do projeto. Consulte Escolhendo um identificador de pacote exclusivo para ver diretrizes.
título Necessário para publicação no feed de Windows Admin Center Nome amigável para o pacote exibido no Gerenciador de Extensões do Windows Admin Center.
version Obrigatório Versão da extensão. O uso do Controle de Versão Semântico (convenção SemVer) é recomendado, mas não é necessário.
authors Obrigatório Se estiver publicando em nome de sua empresa, use o nome da sua empresa.
descrição Obrigatório Forneça uma descrição da funcionalidade da extensão.
iconUrl Recomendado ao publicar no feed do Windows Admin Center URL do ícone a ser exibido no Gerenciador de Extensões.
projectUrl Necessário para publicação no feed de Windows Admin Center URL para o site da sua extensão. Se você não tiver um site separado, use a URL da página da Web do pacote no feed do NuGet.
licenseUrl Necessário para publicação no feed de Windows Admin Center URL para o contrato de licença do usuário final da sua extensão.
files Obrigatório Essas duas configurações definem a estrutura de pastas que o Windows Admin Center espera para extensões de interface do usuário e plug-ins de Gateway.

Compilar o pacote NuGet de extensão

Usando o arquivo .nuspec criado acima, agora você criará o arquivo .nupkg do pacote NuGet, que pode ser carregado e publicado no feed do NuGet.

  1. Baixe a ferramenta nuget.exe da CLI do site de ferramentas de cliente do NuGet.
  2. Execute nuget.exe pack <>.nuspec file name> para criar o arquivo .nupkg.

Assinar o pacote NuGet de extensão

Todos os arquivos .dll incluídos em sua extensão devem ser assinados com um certificado de uma autoridade de certificação (CA) confiável. Por padrão, os arquivos .dll não assinados serão impedidos de serem executados quando o Windows Admin Center estiver em execução no Modo de Produção.

Recomendamos que você assine o pacote NuGet de extensão para garantir a integridade do pacote.

Observação

Se você planeja sua extensão com suporte ao Controle de Aplicativos do Windows Defender, seu pacote e todos os arquivos dentro devem ser assinados. Saiba mais sobre como assinar com o Controle de Aplicativos do Windows Defender.

Testar o pacote NuGet de extensão

Seu pacote de extensão agora está pronto para teste! Carregue o arquivo .nupkg em um feed do NuGet ou copie-o para um compartilhamento de arquivos. Para exibir e baixar pacotes de um feed ou compartilhamento de arquivos diferente, você precisará alterar a configuração do feed para apontar para o feed do NuGet ou o compartilhamento de arquivos. Ao testar, verifique se as propriedades são exibidas corretamente no Gerenciador de Extensões e se é possível instalar e desinstalar a extensão com êxito.

Publicar sua extensão no feed do Windows Admin Center

Ao publicar no feed Windows Admin Center, é possível disponibilizar sua extensão para qualquer usuário do Windows Admin Center. Como o SDK do Windows Admin Center ainda está em pré-visualização, gostaríamos de trabalhar em estreita colaboração com você para ajudar a resolver problemas de desenvolvimento e ajudá-lo a fornecer um produto e uma experiência de qualidade para seus usuários.

Antes de enviar uma solicitação de revisão de extensão para a Microsoft, envie um email para wacextensionrequest@microsoft.com expressar a intenção de publicar uma extensão no feed público. Fornecemos a você cópias do Contrato de Editor de Extensão e da Política de Participação de Extensão para revisão e reconhecimento por escrito.

Antes de lançar a versão inicial de sua extensão, recomendamos que você envie uma solicitação de revisão de extensão à Microsoft pelo menos 2 a 3 semanas antes do lançamento. A permissão de 2 a 3 semanas antes do lançamento garante que tenhamos tempo suficiente para revisar e para você fazer alterações em sua extensão, se necessário. Depois que sua extensão estiver pronta para ser publicada, você precisará enviá-la para análise. Se sua extensão for aprovada, a publicaremos no feed para você. Ao enviar à Microsoft seu pacote de extensão, você concorda em estar vinculado aos termos do Contrato do Publicador de Extensão e à Política de Participação de Extensão.

Posteriormente, se você quiser liberar uma atualização para sua extensão, precisará enviar outra solicitação de revisão. Dependendo do escopo da alteração, o tempo de retorno para revisões de atualização geralmente deve ser menor.

Enviar uma solicitação de revisão de extensão para a Microsoft

Para enviar uma solicitação de revisão de extensão, forneça as seguintes informações e envie como um email para wacextensionrequest@microsoft.com. Responderemos ao seu email dentro de uma semana.

Windows Admin Center – Informações sobre a solicitação de revisão de extensão:

  • Nome e endereço de email do proprietário/desenvolvedor da extensão (até três usuários). Se você estiver lançando uma extensão em nome de sua empresa, forneça o endereço de email da sua empresa.
  • Nome da empresa (necessário somente se você estiver lançando uma extensão em nome de sua empresa)
  • Nome da extensão
  • Data de destino da versão (estimativa)
  • Para envio de nova extensão – descrição da extensão (recomendamos armações de arame de design inicial, maquetes de tela ou capturas de tela do produto)
  • Para revisão de atualização de extensão – Descrição das alterações (inclua capturas de tela do produto se a interface do usuário for significativamente alterada)

Enviar seu pacote de extensão para revisão e publicação

Siga as instruções acima para criar um pacote de extensão, ver se o arquivo .nuspec está definido corretamente e se os arquivos estão assinados. Também recomendamos que você tenha um site de projeto, incluindo:

  • Descrição detalhada da sua extensão, incluindo capturas de tela ou vídeo
  • Endereço de email ou recurso do site para receber comentários ou perguntas

Quando estiver pronto para publicar sua extensão, envie um email para wacextensionrequest@microsoft.com. Fornecemos instruções sobre como enviar seu pacote de extensão. Depois de recebermos seu pacote, vamos revisá-lo. Depois que o pacote de extensão for aprovado, publicaremos no feed de Windows Admin Center.