Difference between revisions of "Azure Automation"

From Hornbill
Jump to navigation Jump to search
(Replaced content with "This document can now be found at its new location in the [https://docs.hornbill.com/itom-packages/welcome Hornbill Document Library]. file:hornbill-document-librar...")
Tag: Replaced
Line 1: Line 1:
{{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT_Operations_Management|IT Operations Management]] > [[ITOM_Package_Library|ITOM Package Library]] > Azure Automation|[[:Category:ITOM|Index]]}}
+
This document can now be found at its new location in the [https://docs.hornbill.com/itom-packages/welcome Hornbill Document Library].
[[File:azure_logo.png|azure_logo.png|250px]]
 
{{IntroAndLinks|The Azure Automation package for Hornbill's IT Operations Management (ITOM) contains an administrative operation that can create Jobs from Runbooks on Azure Automation.
 
|
 
<!-- Related Links go here -->
 
:* [[IT_Operations_Management|IT Operations Management]]
 
:* [[Business_Process_Designer|Business Process Designer]]
 
:* [[Hornbill_KeySafe|KeySafe]]
 
}}
 
  
==Target Environment Requirements==
+
    [[file:hornbill-document-library.png|ITOM Package Reference|link=https://docs.hornbill.com/itom-packages/welcome]]
 
 
===Script Execution Machine Requirements===
 
 
 
* The Az PowerShell module needs to installed on the machine that will be executing the scripts;
 
* If the script execution policy on the machine executing these operations is set to Restricted, then this will need to be updated to something less restrictive. See the [https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-executionpolicy?view=powershell-6 PowerShell Documentation] for more information.
 
 
 
==KeySafe Configuration==
 
[[File:Itomtarget_keysafe.png|300px|right|link=https://wiki.hornbill.com/images/d/d2/Itomtarget_keysafe.png]]
 
[[File:Azure_keysafe.png|300px|right|link=https://wiki.hornbill.com/images/a/a8/Azure_keysafe.png]]
 
 
 
When creating SIS jobs for operations contained within this package, they need to be run on the target machine as a user who has the correct privileges within your environment, and will require an additional KeySafe Key to hold the account credentials to connect to Azure.
 
 
 
To create and securely store one or more Keys for operations within this package, in the admin console:
 
 
 
* Navigate to: System > Security > KeySafe;
 
* Click on + then select <code>Username + Password</code>;
 
* Give the KeySafe Key a Title (this is the name/identifier for the account as you will see it when creating an IT Automation Job, or adding an IT Automation node to a Business Process or Runbook);
 
* Optionally add a description;
 
* Populate the Username field with the domain or Azure username for the account being used;
 
* Populate the Password field with the password for the above account;
 
* Select Create Key to save.
 
 
 
Once you have created your KeySafe Keys, you can then use them when creating IT Automation Jobs from this package.
 
 
 
The Username + Password type key that contains the Azure account details should be added to the IT Automation Job as an Extra Credential, and its reference in the job '''must''' be '''credential1'''. 
 
 
 
See screenshots to the right for examples.
 
 
 
==Package Operations==
 
[[File:azure_job.png|300px|right|link=https://wiki.hornbill.com/images/e/e6/Azure_job.png]]
 
The Azure Automation package contains the following operations, than can be used to create ITOM Jobs directly, or included in your [[Business_Process_Designer|Business Processes]] and/or IT Operations Management Rubooks. 
 
 
 
===Create Job===
 
 
 
This operation can be used to create a Job from a Runbook in an Azure Automation account.
 
 
 
====Extra Credentials====
 
 
 
This operation requires an extra credential to be provided:
 
 
 
* Credential Reference: <code>credential1</code>
 
* Credential Keysafe Key Type: <code>Username + Password</code>
 
 
 
====Input Parameters====
 
 
 
* <code>Runbook</code> '''(MANDATORY)''' - The name of the Runbook which you with to create the Job using;
 
* <code>ResourceGroup</code> '''(MANDATORY)''' - The name of the Resource Group where the Automation Account resides
 
* <code>AutomationAccount</code> '''(MANDATORY)''' - The name of the Automation Account where the Runbook resides
 
* <code>TenantID</code> '''(MANDATORY)''' - The ID of the Azure Tenant
 
 
 
====Output Parameters====
 
 
 
* <code>errors</code> - Any errors returned by the operation.
 
* <code>outcome</code> - Outcome of the operation. Can be OK or FAIL.
 
* <code>jobId</code> - The ID of the Azure Automation job that was created
 
 
 
[[Category:ITOM]]
 

Revision as of 14:50, 12 February 2024

This document can now be found at its new location in the Hornbill Document Library.

   ITOM Package Reference