Livros de gestão de serviços de autor

Importante

Esta versão da Service Management Automation (SMA) chegou ao fim do suporte, recomendamos que atualize para SMA 2022.

Os runbooks em Service Management Automation e Microsoft Automatização do Azure são Windows PowerShell fluxos de trabalho ou scripts PowerShell. Eles permitem automatizar processos administrativos para gerir e implementar servidores em nuvem ou qualquer outra função que um script do Windows PowerShell possa efetuar.

Não existem diferenças nos runbooks entre os dois sistemas e o mesmo runbook pode ser executado em qualquer um deles com funcionalidade idêntica. Quando o termo Automatização é utilizado neste guia, refere-se tanto à Automação de Gestão de Serviços como à Microsoft Automatização do Azure.

Os serviços adicionais fornecidos pela Automatização para trabalhar com Fluxos de Trabalho do Windows PowerShell incluem o seguinte:

  • Armazenamento e gestão centralizados de runbooks.

  • Arquitetura escalável para agendamento e execução de runbooks.

  • Recursos globais geridos centralmente e disponíveis para todos os runbooks.

  • Interface de utilizador para criação e teste de runbooks.

  • Conjunto de cmdlets para gerir e iniciar runbooks.

Criar ou importar um livro de corridas

Pode adicionar um runbook à Automação de Gestão de Serviços, criando-o no portal de gestão ou importando-o a partir de um ficheiro.

Criar um livro de bordo no Portal de Gestão

  1. No Portal de Gestão, clique, Novo, Serviços de Aplicações, Automação, Runbook, Quick Create.

  2. Introduza as informações necessárias e clique em Criar. O nome do runbook tem de começar por uma letra e pode ter letras, números, carateres de sublinhado e travessões.

  3. Se quiser editar o livro de recortes agora, clique em Editar Runbook. Caso contrário, clique em OK.

  4. O seu novo runbook aparecerá no separador Runbooks .

Importar um livro de bordo de um ficheiro

  1. No portal Gestão, selecione Automação e, em seguida, selecione uma Conta Demôm automação.

  2. Clique em Importar.

  3. Clique em procurar por Ficheiro e localize o ficheiro de script para importar.

  4. Se quiser editar o livro de recortes agora, clique em Editar Runbook. Caso contrário, clique em OK.

  5. O seu novo runbook aparecerá no separador Runbooks para a Conta Automação.

Importe um livro de bordo de um ficheiro de script com Windows PowerShell

Pode utilizar o cmdlet Import-SmaRunbook para criar um novo livro de bordo a partir de um ficheiro de script que contenha um fluxo de trabalho.

Os comandos de exemplo seguintes exemplificam como importar um ficheiro de script para um runbook existente e, depois, publicá-lo.

$webServer = 'https://MyServer'
$port = 9090
$runbookName = "Test-Runbook"
$scriptPath = "c:\runbooks\Test-Runbook.ps1"

Import-SmaRunbook -WebServiceEndpoint $webServer -Port $port -Path $scriptPath
Publish-SMARunbook -WebServiceEndpoint $webServer -Port $port -Name $runbookName

Editar um livro de execução

Cada runbook na Service Management Automation tem duas versões, Draft e Published. Para executar o runbook, começa por editar a versão de Rascunho do fluxo de trabalho e, depois, publica-o. A versão Publicada não pode ser editada.

Editar um livro de recortes com o Portal de Gestão

O Portal de Gestão inclui um editor que pode utilizar para ver e editar runbooks. Além de fornecer capacidades básicas de edição de texto, o editor fornece a capacidade de inserir automaticamente código para Ativos, Atividades e Runbooks Globais.

  1. No Portal de Gestão, selecione Automatização.

  2. Selecione o separador Runbooks .

  3. Clique no nome do runbook que pretende editar.

  4. Selecione o separador Autor .

  5. Clique em Draft na parte superior do ecrã ou no botão Editar na parte inferior do ecrã.

  6. Efetue a edição necessária.

  7. Clique em Guardar quando as suas edições estiverem completas.

  8. Clique em Publicar se quiser que a versão mais recente do rascunho do livro de execuções seja publicada.

Inserir código num Runbook

  1. Abra o runbook no editor do Portal de Gestão.

  2. Na parte inferior do ecrã, clique em Inserir e, em seguida, Runbook.

  3. Selecione o runbook a inserir a partir da coluna central e clique na seta para a direita.

  4. Se o runbook contiver parâmetros, estes serão apresentados para sua informação.

  5. Clique no botão Verificar.

  6. O código para executar o runbook selecionado será inserido no runbook atual.

  7. Se o livro de bordo necessitar de parâmetros, forneça um valor adequado no lugar do tipo de dados rodeado de aparelhos <>.

Insira um ativo global num livro de execução

  1. Abra o runbook no editor do Portal de Gestão.

  2. Na parte inferior do ecrã, clique em Inserir e, em seguida, Definição.

  3. Na coluna 'Definição de Ação ', selecione o tipo de código que necessita

  4. Selecione-o nos elementos disponíveis na coluna central.

  5. Clique no botão Verificar.

Insira uma atividade num livro de recortes

  1. Abra o runbook no editor do Portal de Gestão.

  2. Na parte inferior do ecrã, clique em Inserir e, em seguida, Atividade.

  3. Na coluna Módulo de Integração , selecione o módulo que contém a atividade.

  4. No painel de atividades , selecione uma atividade.

  5. Na coluna Descrição , note a descrição da atividade. Opcionalmente, pode clicar em Ver a ajuda detalhada para lançar ajuda para a atividade no navegador.

  6. Clique na seta para a direita.

  7. Se a atividade contiver parâmetros, estes serão apresentados para sua informação.

  8. Clique no botão Verificar.

  9. O código para executar a atividade será inserido no runbook.

  10. Se a atividade necessitar de parâmetros, forneça um valor adequado no lugar do tipo de dados rodeado por aparelhos <>.

Editar um runbook Automation com

PowerShell

Para editar um runbook com o Windows PowerShell, tem de utilizar o editor que selecionou para editar o fluxo de trabalho e guardá-lo num ficheiro .ps1. Pode utilizar o cmdlet Get-SMARunbookDefinition para recuperar o conteúdo do livro de execução e, em seguida, editar-SMARunbook cmdlet para substituir o fluxo de trabalho existente por um modificado.

Para recuperar o conteúdo de um livro de bordo utilizando Windows PowerShell

Os comandos de exemplo seguintes exemplificam como obter o script de um runbook e guardá-lo num ficheiro de script. Neste exemplo, é obtida a versão de Rascunho. Também é possível obter a versão Publicada do runbook, embora essa versão não possa ser alterada.

$webServer = 'https://MyServer'
$port = 9090
$runbookName = "Test-Runbook"
$scriptPath = "c:\runbooks\Test-Runbook.ps1"

$runbookDefinition = Get-SMARunbookDefinition -WebServiceEndpoint $webServer -Port $port -Name $runbookName -Type Draft
$runbookContent = $runbookDefinition.Content

Out-File -InputObject $runbookContent -FilePath $scriptPath

Para alterar o conteúdo de um livro de bordo utilizando Windows PowerShell

Os comandos de exemplo seguintes exemplificam como substituir os conteúdos existentes de um runbook pelos conteúdos de um ficheiro de script que contenha um fluxo de trabalho.

$webServer = 'https://MyServer'
$port = 9090
$runbookName = "Test-Runbook"
$scriptPath = "c:\runbooks\Test-Runbook.ps1"

Edit-SmaRunbook -WebServiceEndpoint $webServer -Port $port -Name $runbookName -Path $scriptPath -Overwrite
Publish-SmaRunbook -WebServiceEndpoint $webServer -Port $port -Name $runbookName -Path $scriptPath

Editar um livro de marketing automation com PowerShell ISE

Windows PowerShell Ambiente Integrado de Scripts (ISE) é uma aplicação que lhe permite executar comandos e escrever, testar e depurar scripts. O Add-on SMA PowerShell ISE permite-lhe utilizar esta ferramenta para escrever e testar os runbooks de automação.

  1. Abra o ISE do Windows PowerShell.

  2. Se o addon SMA ISE não for apresentado no lado direito do ISE, abra o menu Add-ons e ative o add-on SMA ISE.

  3. Inscreva-se no SMA no separador Configuração .

  4. Selecione o separador Runbook . Devias ver uma lista de livros de SMA.

  5. Selecione o livro de execução que pretende editar e clique em Baixar. Isto descarrega uma cópia local do livro de regras da SMA.

  6. Clique em Abrir. Isto cria um novo separador com o livro de bordo.

  7. Faça as alterações necessárias ao livro de bordo.

  8. Clique em Upload Draft para enviar o livro de execução para SMA. Isto substituirá a versão de projeto existente do livro de corridas.

  9. Clique em Publicar Draft se quiser publicar a versão mais recente do rascunho do livro de execuções.

Publique o seu livro de execução

Depois de ter criado o seu runbook, tem de o publicar para que o trabalhador do livro de bordo o possa executar. Cada runbook na Automação de Gestão de Serviços tem um Rascunho e uma versão publicada. Apenas a versão Publicada está disponível para ser executada e só a versão de Rascunho pode ser editada. A versão Publicada não é afetada por quaisquer alterações feitas à versão de Rascunho. Quando estiver pronto para disponibilizar a versão Draft, publica-a que substitui a versão publicada com a versão Draft.

Publique um livro de corridas utilizando o portal de gestão

  1. Selecione o espaço de trabalho da Automatização .

  2. Na parte superior do ecrã, selecione Runbooks.

  3. Localize o runbook a editar e clique no respetivo nome.

  4. No topo do ecrã, clique em Autor.

  5. Clique em Draft.

  6. Na parte inferior do ecrã, clique em Publicar.

  7. Clique em Sim para a mensagem de verificação.

Publique um livro de execução usando o PowerShell

Pode utilizar o cmdlet Publish-SmaRunbook para publicar runbooks com o Windows PowerShell. Os comandos de exemplo seguintes explicam como publicar runbooks.

$webServer = 'https://MyServer'
$port = 9090
$runbookPath = 'c:\runbooks\Sample-TestRunbook.ps1'
$runbookName = 'Test-Runbook'

Publish-SmaRunbook -WebServiceEndpoint $webServer -Port $port -Name $runbookName

Publique um livro de execução usando PowerShell ISE

Windows PowerShell Ambiente Integrado de Scripts (ISE) é uma aplicação que lhe permite executar comandos e escrever, testar e depurar scripts. O Add-on SMA PowerShell ISE permite-lhe utilizar esta ferramenta para escrever e testar os runbooks de automação.

  1. Abra o ISE do Windows PowerShell.

  2. Se o addon SMA ISE não for apresentado no lado direito do ISE, abra o menu Add-ons e ative o add-on SMA ISE.

  3. Inscreva-se no SMA no separador Configuração .

  4. Selecione o separador Runbook . Devias ver uma lista de livros de SMA.

  5. Selecione o runbook e clique em Publicar Draft para publicar a versão mais recente do rascunho do runbook.

Teste o seu livro de corridas

Pode testar a versão Draft de um runbook na Automação de Gestão de Serviços, deixando inalterada a versão publicada do livro de recortes. Isto permite-lhe verificar se o runbook está a funcionar corretamente antes de substituir a versão publicada.

Quando testa um runbook, o runbook de Rascunho é executado e todas as ações que executar são concluídas. Nenhum histórico de trabalho é criado, mas os fluxos de saídae aviso e erro são apresentados no Painel de Saída de Teste. As mensagens para o Fluxo Verbose só são apresentadas no Painel de Saída se a variável $VerbosePreference estiver definida para Continuar.

Ao testar um livro de corridas, ele ainda executa o fluxo de trabalho normalmente e executa quaisquer ações contra recursos no ambiente. Por este motivo, deverá testar apenas runbooks em recursos de não produção.

Teste um runbook em Gestão de Automação de Gestão de Serviços

Para testar um livro de execução, abra a versão Draft do runbook no Portal de Gestão. Clique no botão Teste na parte inferior do ecrã para iniciar o teste.

Pode parar ou suspender o runbook enquanto estiver a ser testado, através dos botões existentes por baixo do Painel de Resultados. Quando suspende o runbook, este conclui a atividade que estava em curso antes de ser suspenso. Depois de o runbook ter sido suspenso, pode pará-lo ou reiniciá-lo.

Teste um livro de execução usando PowerShell ISE

O addon PowerShell ISE fornece cmdlets que emulam as atividades padrão como Get-SMACredential e Set-SMAVariable, para que possa testar o livro de execução no computador local tal como qualquer outro script.

Os ativos globais e os seus valores são descarregados do grupo de automação para serem utilizados para testes locais. Pode inspecionar ou alterar estes valores no separador Ativos . Os valores encriptados são apresentados a laranja e os seus valores não são descarregados. Se quiser usar estes ativos em testes locais, então deve definir o seu valor localmente.

Para testar o livro de execução em SMA, clique em Test Draft em SMA. Será aberta uma nova janela. Clique em Iniciar Novo Trabalho para iniciar o teste. A saída será exibida na janela.

Amostras de livros de corrida de automação

Os seguintes runbooks enviam com a Automação de Gestão de Serviços como livros de amostra para ilustrar técnicas e boas práticas. Estão disponíveis para serem utilizados na extensão Dem automação no Windows Azure Pack para Windows Server.

Nome do runbook Description
Sample-Deleting-VMCloud-Subscription Demonstra um cenário útil para acionar um runbook quando um utilizador elimina uma subscrição de Nuvens da VM.
Sample-Managing-Azure Mostra como ligar a uma subscrição do Windows Azure e executar operações básicas utilizando o módulo do Windows Azure PowerShell.
Sample-Managing-ConfigurationManager Demonstra a capacidade da Automatização de Gestão de Serviços de ligar-se a Configuration Manager.
Sample-Managing-DataProtectionManager Demonstra como estabelecer ligação com um servidor Data Protection Manager (DPM) e visualizar informações sobre os discos que se encontram no servidor DPM.
Sample-Managing-MySQLServers Demonstra como obter um token de segurança que depois será utilizado para obter uma lista de servidores anfitriões.
Sample-Managing-OperationsManager Demonstra a capacidade da Automatização de Gestão de Serviços para ligar ao Gestor de Operações do Centro de Sistema.
Sample-Managing-Orchestrator Mostra como estabelecer ligação com o System Center Orchestrator e iniciar um runbook do Orchestrator para tirar partido da infraestrutura existente.
Sample-Managing-Plans Demonstra como criar um novo plano e adicionar o serviço SQL Server com uma quota definida ao novo plano.
Sample-Managing-ServiceBusClouds Demonstra como estabelecer ligação com um servidor de Nuvem de Service Bus e ver informações sobre os espaços de nomes criados.
Sample-Managing-SQLServers Demonstra como criar um novo grupo de servidores e adicionar um servidor de alojamento de SQL.
Sample-Managing-UserAccounts Demonstra como criar um Utilizador no Windows Azure Pack para Windows Server, que será criado no Windows Azure Pack, e aparecer no portal de gestão para a extensão dos administradores. No entanto, este utilizador deve também ser integrado no fornecedor de autenticação (por exemplo, AuthSite) para aceder ao portal de gestão dos inquilinos, que não está incluído nesta amostra.
Sample-Managing-VirtualMachineManager Demonstra como estabelecer ligação com um servidor Virtual Machine Manager (VMM) e ver informações sobre a licença de servidor do VMM.
Sample-Managing-VMClouds Demonstra como aceder a informações sobre a ligação à base de dados de um servidor do Service Provider Foundation e a informações sobre os objetos de servidor do VMM geridos pelo Service Provider Foundation.
Sample-Managing-WebSiteCloud Demonstra como estabelecer ligação com um servidor de controlador de Nuvens de Web Site e ver informações sobre os servidores implementados de Nuvens de Web Site.
Sample-Modify-VMCloud-Subscription Demonstra um cenário útil para acionar um runbook quando o inquilino ou o administrador suspende ou ativa uma subscrição de Nuvens da VM.
Sample-Using-Activities Demonstra a capacidade da Automatização de Gestão de Serviços para utilizar atividades
Sample-Using-Checkpoints Demonstra a capacidade de utilizar postos de controlo na Automatização de Gestão de Serviços.
Sample-Using-Connections Demonstra a capacidade da Automatização de Gestão de Serviços utilizar ligações para se ligar a sistemas remotos.
Sample-Using-Credentials Demonstra a capacidade da Automatização de Gestão de Serviços para utilizar credenciais e produz o utilizador que o runbook de Automação de Gestão de Serviços está a funcionar como. Em seguida, estabelece ligação com o servidor 'ServerName' e devolve o utilizador especificado por 'SampleCredential' que está a aceder ao servidor.
Sample-Using-Modules Demonstra a importação de módulos em runbooks e devolve o número de módulos já importados no servidor 'ServerName'. Em seguida, importa o módulo especificado por 'ModulePath' e devolve a nova contagem de módulos e informações correspondentes ao módulo recentemente importado.
Sample-Using-RunbookParameters Demonstra como utilizar os parâmetros de entrada para runbooks e também como especificar se são necessários parâmetros, fornecer valores de parâmetros predefinidos e utilizar valores de parâmetros mais tarde no fluxo de trabalho.
Sample-Using-Runbooks Demonstra como chamar um runbook a partir de outro runbook.
Sample-Using-SuspendWorkflow Demonstra como forçar a suspensão de um runbook. Isto pode ser útil se for necessário um passo manual antes da continuação de um runbook, tal como receber a aprovação de aceitação de uma pessoa específica. Uma vez concluído o passo manual, o runbook suspenso seria retomado manualmente para continuar o runbook.
Sample-Using-Variables Demonstra a capacidade da Automatização de Gestão de Serviços para utilizar variáveis.
Sample-Using-VMCloud-Automation Demonstra um cenário útil para acionar um runbook no início de um evento do Service Provider Foundation.

Passos seguintes