Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tksh164/aprl-helper-scripts

The helper scripts to utilize the Azure Proactive Resiliency Library (APRL). The scripts allow batch execution of the APRL's queries.
https://github.com/tksh164/aprl-helper-scripts

aprl azure powershell resiliency scripts tools

Last synced: about 1 month ago
JSON representation

The helper scripts to utilize the Azure Proactive Resiliency Library (APRL). The scripts allow batch execution of the APRL's queries.

Host: GitHub
URL: https://github.com/tksh164/aprl-helper-scripts
Owner: tksh164
License: mit
Created: 2023-12-09T14:28:09.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-01-13T12:29:59.000Z (12 months ago)
Last Synced: 2024-01-14T09:14:35.137Z (12 months ago)
Topics: aprl, azure, powershell, resiliency, scripts, tools
Language: PowerShell
Homepage:
Size: 1.24 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# APRL helper scripts

The helper scripts to utilize the [Azure Proactive Resiliency Library (APRL)](https://github.com/Azure/Azure-Proactive-Resiliency-Library). The scripts allow batch execution of the APRL's queries and PowerShell scripts.

## Helper scripts

Three helper scripts have different purposes.

- **getaprl.ps1**: Downloads the APRL contents from the [APRL GitHub repository](https://github.com/Azure/Azure-Proactive-Resiliency-Library). After downloading, this script extracts Azure Resource Graph (ARG) queries and PowerShell scripts, also stores it into the `queries` folder in the current directory. The `queries` folder will be created if it does not exist.

- **runaprl.ps1**: Executes the downloaded ARG queries and PowerShell scripts in the `queries` folder against your Azure subscription.

- You must have completed [Connect-AzAccount](https://learn.microsoft.com/en-us/powershell/module/az.accounts/connect-azaccount) and [Set-AzContext](https://learn.microsoft.com/en-us/powershell/module/az.accounts/set-azcontext) correctly before run this script.

- This script requires [Az.ResourceGraph](https://www.powershellgallery.com/packages/Az.ResourceGraph), [Az.Accounts](https://www.powershellgallery.com/packages/Az.Accounts) and [Az.Resources](https://www.powershellgallery.com/packages/Az.Resources) modules. You can install those modules by the following command if you have not installed these modules.

```powershell
Install-Module -Name 'Az.ResourceGraph', 'Az.Accounts', 'Az.Resources' -Repository 'PSGallery' -Scope AllUsers -Force
```

- **saveascsv.ps1**: Saves the outputs from `runaprl.ps1` as a CSV file. This is a script for convenience to save the output into a CSV file. The default output file path is `./results.csv`.

## Prerequisites

- One of the following PowerShell.
- [Latest PowerShell](https://github.com/PowerShell/PowerShell) (Recommended)
- Windows PowerShell 5.1
- The scripts tested on Windows, but the scripts may be run on other platforms as well. Feedback is welcome.

## Quick start

1. Download the APRL's contents onto your local filesystem. After running the following command, the APRL's ARG queries & PowerShell scripts are stored in the `queries` folder in the current directory.

```powershell
PS C:\aprl> .\getaprl.ps1
```

2. Execute the APRL's ARG queries & PowerShell scripts in the `queries` folder, and save the result to the `./results.csv` file.

```powershell
PS C:\aprl> .\runaprl.ps1 | .\saveascsv.ps1
```

## Usage examples

### getaprl.ps1

- **Example 1:** Download the APRL's contents onto your local filesystem.

```powershell
PS C:\aprl> .\getaprl.ps1
```

### runaprl.ps1 and saveascsv.ps1

- **Example 1:** Execute the APRL's ARG queries and PowerShell scripts without saving the result to a file.

```powershell
PS C:\aprl> .\runaprl.ps1
```

- **Example 2:** Execute the APRL's ARG queries and PowerShell scripts, then save the result to a CSV file using the standard PowerShell cmdlets.

```powershell
PS C:\aprl> .\runaprl.ps1 | ConvertTo-Csv -NoTypeInformation | Out-File -LiteralPath './results.csv' -Encoding utf8 -Force
```

- **Example 3:** Execute the APRL's ARG queries and PowerShell scripts, then save the result to a CSV file using the `saveascsv.ps1` script. The `saveascsv.ps1` script is convenient (less typing) than use standard PowerShell cmdlets.

```powershell
PS C:\aprl> .\runaprl.ps1 | .\saveascsv.ps1
```

- **Example 4:** Execute the APRL's ARG queries and PowerShell scripts, then showing the result in a grid view. This is convenient for interacting with the results using UI, or copy and paste to Excel, etc.

```powershell
PS C:\aprl> .\runaprl.ps1 | Out-GridView
```

![](docs/media/runaprl-gridview.gif)

**NOTE:** The [Out-GridView](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/out-gridview) cmdlet available on Windows Desktop only. A similar cmdlet for cross-platform version is provided by the [ConsoleGuiTools](https://www.powershellgallery.com/packages/Microsoft.PowerShell.ConsoleGuiTools) module in the PowerShell Gallery.

## License

Disclaimer: The codes stored herein are my own personal codes and do not related my employer's any way.