Desenvolver uma extensão de ferramenta

  • Artigo
  • Aplica-se a:
    ✅ Windows Admin Center, ✅ Windows Admin Center Preview

Uma extensão de ferramenta é a forma principal que os usuários usam para interagir com o Windows Admin Center e gerenciar uma conexão, como um servidor ou cluster. Ao clicar em uma conexão na tela inicial do Windows Admin Center e se conectar, você receberá uma lista de ferramentas no painel de navegação à esquerda. Quando você clica em uma ferramenta, a extensão de ferramenta da interface do usuário é carregada e exibida no painel à direita.

Quando uma extensão de ferramenta é carregada, ela pode executar chamadas WMI ou scripts do PowerShell em um servidor de destino ou cluster e exibir informações na interface do usuário ou executar comandos com base na entrada do usuário. Extensões de ferramenta definem quais soluções devem ser exibidas, resultando em um conjunto diferente de ferramentas para cada solução.

Observação

Não está familiarizado com os diferentes tipos de extensão? Saiba mais sobre a arquitetura de extensibilidade e os tipos de extensão.

Prepare o seu ambiente

Caso ainda não tenha feito isso, prepare seu ambiente instalando dependências e pré-requisitos globais necessários para todos os projetos.

Criar uma extensão de ferramenta nova com o SDK do Windows Admin Center

Depois de instalar todas as dependências, você estará pronto para criar sua extensão de ferramenta. Crie ou navegue até uma pasta que contenha seus arquivos de projeto, abra um prompt de comando e defina essa pasta como o diretório de trabalho. Usando o SDK do Windows Admin Center que foi instalado anteriormente, crie uma extensão com a seguinte sintaxe:

wac create --company "{!Company Name}" --tool "{!Tool Name}" --version latest
Valor Explicação Exemplo
{!Company Name} Nome da sua empresa (com espaços) Contoso Inc
{!Tool Name} O nome da sua ferramenta (com espaços) Manage Foo Works

Aqui está um uso de exemplo:

wac create --company "Contoso Inc" --tool "Manage Foo Works" --version latest

Isso cria uma nova pasta dentro do diretório de trabalho atual usando o nome especificado para a ferramenta, copia todos os arquivos de modelo necessários para o projeto e configura os arquivos com o mesmo nome de empresa e da ferramenta.

Observação

O sinalizador --version neste comando especifica qual versão do SDK do Windows Admin Center você gostaria de direcionar. Leia sobre como direcionar uma versão diferente do SDK do Windows Admin Center para manter sua extensão atualizada com as alterações mais recentes do SDK e da plataforma.

Em seguida, altere o diretório para a pasta que acabou de ser criada e instale as dependências locais necessárias executando o seguinte comando:

npm install

Depois que isso for concluído, você configurará tudo o que precisa para carregar sua nova extensão em Windows Admin Center.

Adicionar conteúdo à sua extensão

Agora que você criou uma extensão com o SDK do Windows Admin Center, está pronto para personalizar o conteúdo. Confira estes guias para obter exemplos do que você pode fazer:

Ainda mais exemplos podem ser encontrados em nosso Guia do Desenvolvedor. O Guia do Desenvolvedor é uma extensão de solução totalmente funcional que pode ser carregada em Windows Admin Center e contém uma coleção avançada de exemplos de funcionalidade e de ferramentas que você pode procurar e usar em sua extensão.

Habilite a extensão Guia do Desenvolvedor na página Avançado das configurações do Windows Admin Center.

Personalizar o ícone da extensão

Você pode personalizar o ícone mostrado para sua extensão na lista de ferramentas. Para fazer isso, modifique todas as entradas icon em manifest.json para sua extensão:

"icon": "{!icon-uri}",
Valor Explicação URI de exemplo
{!icon-uri} O local do recurso de ícone assets/foo-icon.svg

OBSERVAÇÃO: atualmente, os ícones personalizados não ficam visíveis ao carregar lateralmente a extensão no modo de desenvolvimento. Como solução alternativa, remova o conteúdo de target conforme a seguir:

"target": "",

Essa configuração é válida somente para o carregamento lateral no modo de desenvolvimento, portanto, é importante preservar o valor contido em target e restaurá-lo antes de publicar sua extensão.

Compilar e carregar a extensão lateralmente

Em seguida, compile e carregue a extensão no Windows Admin Center. Abra uma janela Comando, altere o diretório para o diretório de origem e você estará pronto para criar.

  • Compilar e servir com gulp:

    gulp build
gulp serve --port 4201

Observe que você precisa escolher uma porta que está atualmente gratuita. Certifique-se de não tentar usar a porta que está em execução no Windows Admin Center.

Seu projeto pode ser transferido por sideload em uma instância local do Windows Admin Center para teste ao anexar o projeto servido localmente no Windows Admin Center.

  • Iniciar o Windows Admin Center em um navegador da Web

  • Abrir o depurador (F12)

  • Abra o Console e digite o seguinte comando:

    MsftSme.sideLoad("http://localhost:4201")

  • Atualizar o navegador da Web

Seu projeto agora estará visível na lista Ferramentas com (sideloaded) ao lado do nome.