Git Product home page Git Product logo

graphical-runbook-tools's Introduction

graphical-runbook-tools

Contains a set of experimental tools that help with authoring and debugging graphical runbooks in Azure Automation.

GraphRunbook module

Installation

  1. Install from the PowerShell Gallery: Install-Module -Name GraphRunbook -Scope CurrentUser

  2. Most commands in the module also require the Microsoft Azure Automation Graphical Authoring SDK to be installed.

Commands

  • Show-GraphRunbookActivityTraces shows graphical runbook activity traces for an Azure Automation job. Activity tracing data is extremely helpful when testing and troubleshooting graphical runbooks in Azure Automation: it shows the execution order of activities, activity start and finish time, activity input and output data, and more. Azure Automation saves this data encoded in JSON in the job Verbose stream. Even though this data is very valuable, the raw JSON format may be hard to read, especially when activities input and output large and complex objects. Show-GraphRunbookActivityTraces command retrieves activity tracing data and displays it in a user-friendly tree structure.

  • Convert-GraphRunbookToPowerShellData converts a graphical runbook to PowerShell data. The resulting representation contains the entire runbook definition in a human-readable and PowerShell-readable text format. It can be used for inspecting and documenting runbooks, storing them in a source control system, comparing different versions, etc. Furthermore, the resulting representation is valid PowerShell code that constructs a data structure with all the runbook content, so you can save it in a .psd1 file, open it in any PowerShell editing tool, parse it with PowerShell, etc.

  • Get-GraphRunbookDependency inspects a graphical runbook and outputs the runbook dependencies: required modules, accessed Automation Assets (Certificates, Connections, Credentials, and Variables), and invoked runbooks.

Syntax and usage

  • Get-Help Show-GraphRunbookActivityTraces -Full
  • Get-Help Convert-GraphRunbookToPowerShellData -Full
  • Get-Help Get-GraphRunbookDependency -Full

graphical-runbook-tools's People

Contributors

anatolib avatar

Stargazers

Tyler M. Neher avatar Jonathon Stufflebeam avatar  avatar  avatar AEH312 avatar Cloud-Tareque avatar  avatar Shane Sims avatar  avatar

Watchers

James Cloos avatar Beth Cooper avatar Eamon O'Reilly avatar  avatar  avatar Azure Automation Product Team  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.