Extensões de publicação
Depois de desenvolver sua extensão, você vai querer 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 seu público e objetivo de publicação.
Opções de publicação
Há três opções principais para fontes de pacotes configuráveis suportadas pelo Windows Admin Center:
- Feed público do NuGet do Windows Admin Center da Microsoft
- O seu próprio feed NuGet privado
- Compartilhamento de arquivos local ou de rede
Publicação no feed de extensões do Windows Admin Center
Por padrão, o Windows Admin Center é conectado a um feed NuGet mantido pela equipe de produto do Windows Admin Center na Microsoft. As versões de pré-visualização antecipadas das novas extensões desenvolvidas pela Microsoft podem ser publicadas neste feed e disponibilizadas aos utilizadores do Windows Admin Center. Os desenvolvedores externos que planejam criar e lançar extensões publicamente também podem enviar uma solicitação para Publicar sua extensão no feed do Windows Admin Center. Antes de publicar neste feed, os programadores externos têm de concordar com o Contrato de Editor de Extensão do Windows Admin Center e com a Política de Participação de Extensão .
Publicação em um feed NuGet diferente
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 NuGet. O feed do NuGet deve suportar a API do NuGet v2. Como o Windows Admin Center atualmente não oferece suporte à autenticação de feed, o feed precisa ser configurado para permitir acesso de leitura a qualquer pessoa.
Publicação numa partilha de ficheiros
Para restringir o acesso da sua extensão à sua organização ou a um grupo limitado de pessoas, você pode usar 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.
Preparando sua extensão para lançamento
Certifique-se de ler e considerar os seguintes artigos de desenvolvimento:
Considere lançar como uma versão de pré-visualização
Se você estiver lançando uma versão de visualização da sua extensão para fins de avaliação, recomendamos que:
- Anexe "(Pré-visualização)" ao final do título da extensão no ficheiro
.nuspec
- Explique as limitações na descrição da extensão no arquivo
.nuspec
Criando um pacote de extensão
O Windows Admin Center utiliza pacotes e feeds NuGet para distribuir e baixar extensões. Para que seu pacote seja enviado, você precisa gerar um pacote NuGet contendo seus plugins e extensões. Um único pacote pode conter uma extensão de interface do usuário e um plug-in de gateway. A seção a seguir orienta você pelo processo.
Crie a sua extensão
Assim que estiver pronto para começar a empacotar sua extensão, crie um novo diretório no sistema de arquivos, abra um console e faça um CD nele. Este diretório é o diretório raiz que usamos para conter todos os diretórios nuspec e de conteúdo que compõem nosso pacote. Chamamos esta pasta Pacote NuGet para o restante do artigo.
Extensões da 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 certifique-se de que a compilação seja bem-sucedida. Este processo empacota todos os componentes juntos em uma pasta chamada "bundle" localizada no diretório raiz da sua extensão (no mesmo nível do diretório src). Copie este diretório e todo o seu conteúdo para a pasta "Pacote NuGet".
Gateway Plugins
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 construa seu plugin. Abra seu diretório de saída de compilação, copie a DLL ou DLLs que representam seu plug-in e coloque-as 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 relacionadas com o seu código.
Criar o arquivo nuspec
Para criar o pacote NuGet, você precisa primeiro criar um arquivo .nuspec
. Um arquivo .nuspec
é um manifesto XML que contém metadados do pacote NuGet. Este manifesto é usado tanto para construir o pacote quanto para fornecer informações aos consumidores. Coloque esse arquivo na raiz da pasta "Pacote NuGet".
Segue um exemplo de arquivo .nuspec
e a lista de propriedades necessárias ou recomendadas. Para obter o esquema completo, consulte o referência nuspec. Salve o arquivo .nuspec
na pasta raiz do seu projeto usando um nome de arquivo de sua escolha.
Importante
O valor <id>
no arquivo .nuspec
precisa corresponder ao valor "name"
no arquivo manifest.json
do seu projeto, 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>
Propriedades Necessárias ou Recomendadas
Nome da propriedade | Obrigatório / Recomendado | Descrição |
---|---|---|
Identificação | Necessário | Identificador exclusivo do pacote dentro do feed. Esse valor precisa corresponder ao valor "nome" no arquivo manifest.json do seu projeto. Consulte Escolhendo um identificador de pacote exclusivo para obter orientações. |
título | Necessário para publicação no feed do Windows Admin Center | Nome amigável para o pacote exibido no Gerenciador de extensões do Windows Admin Center. |
Versão | Necessário | Versão de extensão. Utilizar Versionamento Semântico (convenção SemVer) é recomendado, mas não obrigatório. |
Autores | Necessário | Se publicar em nome da sua empresa, use o nome da mesma. |
Descrição | Necessário | Forneça uma descrição da funcionalidade da extensão. |
iconUrl | Recomendado ao publicar no feed do Windows Admin Center | URL para o ícone a ser exibido no Gerenciador de extensões. |
projectUrl | Necessário para publicação no feed do 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. |
URL de licença | Necessário para publicação no feed do Windows Admin Center | URL para o contrato de licença de utilizador final da sua extensão. |
ficheiros | Necessário | Essas duas configurações configuram a estrutura de pastas que o Windows Admin Center espera para extensões de interface do usuário e plug-ins de gateway. |
Observação
A partir do Windows Admin Center 2410, o campo packageType
foi preterido e não deve ser usado. O uso continuado deste campo pode resultar na leitura incorreta do arquivo NuGet.
Criar o pacote de extensão NuGet
Usando o arquivo .nuspec
que criou, agora precisa criar o arquivo .nupkg
do pacote NuGet, que pode enviar e publicar no feed do NuGet.
- Baixe a ferramenta CLI nuget.exe do site de ferramentas do cliente NuGet.
- Execute
nuget.exe pack <>.nuspec file name>
para criar o arquivo.nupkg
.
Assine o seu pacote de extensão NuGet
Todos os arquivos .dll
incluídos em sua extensão precisam ser assinados com um certificado de uma autoridade de certificação (CA) confiável. Por padrão, os arquivos .dll
não assinados são impedidos de serem executados quando o Windows Admin Center está sendo executado no Modo de Produção.
Todos os ficheiros Javascript incluídos na sua extensão têm de ser assinados com um certificado de uma Autoridade de Certificação (CA) fidedigna.
O pacote NuGet de extensão também deve ser assinado para garantir a integridade do pacote. O Windows Admin Center usa um servidor Kestrel que carrega certificados TLS/SSL pelo nome do assunto do certificado. Verifique se apenas um certificado está instalado com um nome de entidade exclusivo e se o certificado é válido.
Quando você publica uma extensão no feed de extensões do Windows Admin Center da Microsoft, a Microsoft assina o pacote sobre sua assinatura.
Dica
Para verificar se o pacote está assinado corretamente, você pode usar o seguinte comando:
nuget.exe verify -All <packageName>.nuget
Teste seu pacote de extensão NuGet
Seu pacote de extensão está pronto para testes! Carregue o arquivo .nupkg
para um feed do NuGet ou copie-o para um compartilhamento de arquivos. Para exibir e baixar pacotes de um feed ou partilha de ficheiros diferente, precisa de alterar a configuração do feed para apontar para o feed ou partilha de ficheiros do NuGet. Ao testar, verifique se as propriedades são exibidas corretamente no Extension Manager e se você pode instalar e desinstalar a extensão com êxito.
Publicar sua extensão no feed do Windows Admin Center
Ao publicar no feed do Windows Admin Center, você pode disponibilizar sua extensão para qualquer usuário do Windows Admin Center. Como o SDK do Windows Admin Center ainda está em visualização, gostaríamos de trabalhar em estreita colaboração com você para ajudar a resolver problemas de desenvolvimento e ajudá-lo a oferecer um produto e uma experiência de qualidade aos seus usuários.
Antes de enviar uma solicitação de revisão de extensão para a Microsoft, você deve enviar um email para wacextensionrequest@microsoft.com expressando a intenção de publicar uma extensão no feed público. Fornecemos-lhe cópias do Contrato de Editor de Extensão e da Política de Participação de Extensão para rever e reconhecer por escrito.
Antes de lançar a versão inicial da sua extensão, recomendamos que você envie uma solicitação de revisão de extensão à Microsoft pelo menos 2-3 semanas antes do lançamento. Permitir 2-3 semanas antes do lançamento garante que temos tempo suficiente para rever e para que você faça quaisquer alterações em sua extensão, se necessário. Depois que sua extensão estiver pronta para ser publicada, você precisará enviá-la para nós para revisão. Se sua extensão for aprovada, nós a publicaremos no feed para você. Ao enviar à Microsoft seu pacote de extensão, você concorda em ficar vinculado aos termos do Contrato de Editor de Extensão e à Política de Participação de Extensão.
Depois, se você quiser liberar uma atualização para sua extensão, você precisa enviar outra solicitação de revisão. Dependendo do escopo da alteração, os tempos de resposta para revisões de atualização são geralmente mais curtos.
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 e-mail para wacextensionrequest@microsoft.com. Respondemos ao seu e-mail dentro de uma semana.
Windows Admin Center - Informações sobre o pedido de revisão de extensão:
- Nome e endereço de e-mail do proprietário/desenvolvedor da extensão (até 3 usuários). Se você estiver lançando uma extensão em nome da sua empresa, forneça o endereço de e-mail da sua empresa.
- Nome da empresa (apenas necessário se você estiver liberando uma extensão em nome da sua empresa)
- Nome da extensão
- Data limite de lançamento (estimativa)
- Para submissão de nova extensão - Descrição da extensão (recomendam-se esboços de design, maquetes de ecrã ou capturas de ecrã de produtos)
- 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 alterada significativamente)
Envie seu pacote de extensão para revisão e publicação
Certifique-se de seguir as instruções anteriores para criar um pacote de extensão e o arquivo .nuspec
está definido corretamente e os arquivos estão assinados. Também recomendamos que você tenha um site do projeto que inclua:
- Descrição detalhada da sua extensão, incluindo capturas de tela ou vídeo
- Endereço de e-mail ou recurso do site para receber comentários ou perguntas
Quando estiver pronto para publicar sua extensão, envie um e-mail para wacextensionrequest@microsoft.com. Nós fornecemos instruções sobre como nos enviar o seu pacote de extensão. Depois de recebermos o seu pacote, iremos analisá-lo. Depois que o pacote de extensão for aprovado, publicaremos no feed do Windows Admin Center.