Trabalhar com módulos de integração

Artigo
11/01/2024

Um Módulo de Integração é um pacote que contém um Módulo do Windows PowerShell. Para obter informações sobre como escrever um módulo do Windows PowerShell, consulte escrevendo um módulo do Windows PowerShell. Um módulo de integração pode conter qualquer um dos tipos de módulos especificado em módulos do Windows PowerShell. Isso inclui módulos de Script (.psm1), módulos binários (.dll) e módulos de manifesto (.psd1). O pacote do módulo de integração é um arquivo compactado com o mesmo nome que o módulo e uma extensão .zip. Ele contém uma única pasta também com o nome do módulo. O módulo Windows PowerShell e quaisquer arquivos de suporte, incluindo um arquivo de manifesto (.psd1) se o módulo tiver um, devem estar contidos nessa pasta.

Se o módulo deve conter um tipo de conexão , ele também deve conter um arquivo com o nome <ModuleName>-Automation.json que especifica as propriedades do tipo de conexão. Este é um arquivo json com o formato a seguir.

{
   "ConnectionFields": [
   {
      "IsEncrypted":  false,
      "IsOptional":  false,
      "Name":  "ComputerName",
      "TypeName":  "System.String"
   },
   {
      "IsEncrypted":  false,
      "IsOptional":  true,
      "Name":  "Username",
      "TypeName":  "System.String"
   },
   {
      "IsEncrypted":  true,
      "IsOptional":  false,
      "Name":  "Password",
   "TypeName":  "System.String"
   }],
   "ConnectionTypeName":  "DataProtectionManager",
   "IntegrationModuleName":  "DataProtectionManager"
}

As etapas para criar e trabalhar com runbooks de Automação são diferentes dependendo se você está usando um portal de gerenciamento ou Windows PowerShell. As etapas básicas para várias operações comuns usando ambos os métodos são fornecidas nas seções a seguir.

Enumerar módulos instalados

Obter uma lista de módulos instalados no portal de gerenciamento

Selecione o workspace Automação.
Se você estiver usando o Azure, selecione uma conta de Automação.
Na parte superior da janela, selecione Ativos.
Inspecione os ativos na lista com um Tipo de Módulo.

Obter uma lista de módulos instalados usando o Windows PowerShell

Os comandos de exemplo a seguir recuperam todos os módulos instalados na Automação.

$webServer = 'https://MyWebServer'
$port = 9090
Get-SmaModule -WebServiceEndpoint $webServer -Port $port

Importar um módulo

Um módulo é um arquivo compactado com uma extensão .zip que contém uma pasta, que inclui um dos seguintes tipos de arquivo:

Um módulo (arquivo psm1)
Um manifesto de módulo (arquivo psd1)

Importar um módulo usando o portal de gerenciamento

Selecione o workspace Automação.
Na parte inferior da janela, selecione Importar módulo.
Selecione Procurar arquivo.
Selecione o arquivo do módulo e selecione OK.
Selecione o botão de marca de seleção na caixa de diálogo.

Importar um módulo usando o Windows PowerShell

Os comandos de exemplo a seguir mostram como importar um módulo.

$webServer = 'https://MyWebServer'
$port = 9090
$modulePath = 'C:\Modules\MyModule.psm1'
Import-SmaModule -WebServiceEndpoint $webServer -Port $port -Path $modulePath

Enumerar atividades em amModule

Obter uma lista de atividades em um módulo no portal de gerenciamento

Selecione o workspace Automação.
Se você estiver usando o Azure, selecione uma conta de Automação.
Na parte superior da janela, selecione Ativos.
Localize o módulo e selecione-o.
Role até a parte inferior da tela Detalhes do módulo e inspecione suas atividades.
Opcionalmente, selecione o ícone de lupa para filtrar atividades específicas.

Obter uma lista de atividades em um módulo usando o Windows PowerShell

Os comandos de exemplo a seguir mostram como recuperar as atividades em um módulo específico.

$webServer = 'https://MyWebServer'
$port = 9090
$moduleName = 'MyModule'
$module = Get-SmaModule -WebServiceEndpoint $webServer -Port $port -Name $moduleName
$module.Activities

Obter uma lista de atividades em todos os módulos usando o Windows PowerShell

Os comandos de exemplo a seguir mostram como recuperar as atividades em todos os módulos instalados na Automação.

$webServer = 'https://MyWebServer'
$port = 9090
$modules = Get-SmaModule -WebServiceEndpoint $webServer -Port $port
$modules | foreach {$_.Activities} | sort Name,ModuleName | ft Name,ModuleName,Description

Próximas etapas

Saiba mais sobre a automação do Gerenciamento de Serviços.
Saiba mais sobre operações de runbook.

Compartilhar via