|
| 1 | +# Az Predictor module |
| 2 | + |
| 3 | +## Overview |
| 4 | + |
| 5 | +**[Az Predictor](https://www.powershellgallery.com/packages/Az.Tools.Predictor/)** is a PowerShell module that helps you navigate the cmdlets and parameters of the [Az module](https://www.powershellgallery.com/packages/Az) by providing context-aware suggestions in the PowerShell command line. |
| 6 | + |
| 7 | +Az Predictor is using the [subsystem plugin model](https://docs.microsoft.com/en-us/powershell/scripting/learn/experimental-features?view=powershell-7.1#pssubsystempluginmodel) available with PowerShell 7.1 and requires [PS Readline version 2.2.0](https://devblogs.microsoft.com/powershell/announcing-psreadline-2-1-with-predictive-intellisense/) to display the suggestions. |
| 8 | + |
| 9 | +Required configuration for Az Predictor: |
| 10 | + |
| 11 | +- [PowerShell 7.1](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.1) |
| 12 | +- [PSReadline 2.2.0-beta1](https://github.com/PowerShell/PSReadLine/releases/tag/v2.2.0-beta1) |
| 13 | + |
| 14 | +## Getting started |
| 15 | + |
| 16 | +### Installing the module |
| 17 | + |
| 18 | +1. Install [PowerShell 7.1](https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.1) |
| 19 | +2. Install [PSReadline 2.2.0-beta1](https://github.com/PowerShell/PSReadLine/releases/tag/v2.2.0-beta1) |
| 20 | + |
| 21 | + `Install-Module -Name PSReadline -AllowPrerelease` |
| 22 | + |
| 23 | +3. Install the Az.Tools.Predictor module |
| 24 | + |
| 25 | + `Install-Module -Name Az.Tools.Predictor` |
| 26 | + |
| 27 | +### Enabling Az Predictor |
| 28 | + |
| 29 | +> **Note**: It is recommended that you add the following steps in youre [PowerShell profile](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_profiles?view=powershell-7.1) (Microsoft.PowerShell_profile.ps1). |
| 30 | +
|
| 31 | +4. Import the module |
| 32 | + |
| 33 | + `Import-Module -Name Az.Tools.Predictor` |
| 34 | + |
| 35 | +5. Enable the plugin |
| 36 | + |
| 37 | + `Set-PSReadLineOption -PredictionSource HistoryAndPlugin` |
| 38 | + |
| 39 | +6. Set your preferred view for get the suggestions |
| 40 | + |
| 41 | + - Enable the list view: `Set-PSReadLineOption -PredictionViewStyle ListView` |
| 42 | + - Enable the inline view: `Set-PSReadLineOption -PredictionViewStyle InlineView` |
| 43 | + |
| 44 | +Az Predictor is also available in CloudShell. |
| 45 | + |
| 46 | +## Privacy and data collection |
| 47 | + |
| 48 | +### Privacy |
| 49 | + |
| 50 | +Az predictor takes the last two Az cmdlets to make the suggestions and ignores any cmdlet that is not part of the [Az PowerShell](https://www.powershellgallery.com/packages/Az) module. |
| 51 | +Only names of cmdlets and parameters are sent to our API to obtain the suggestion; all the parameters' values are discarded. The resource group name and location used are kept locally and reused in subsequent cmdlets for convenience but never sent to the API. |
| 52 | +In the preview version, the module generates and sends anonymized information about the current session to the API used for predictions that are used to assess the quality of the suggestions made. |
| 53 | + |
| 54 | +### Data collection |
| 55 | + |
| 56 | +The current version of Az Predictor collects anonymized information about its usage to identify common issues and improve experience with the future releases. |
| 57 | +Az Predictor does not collect any private or personal data. |
| 58 | + |
| 59 | +For example, the usage data helps identify inaccurate suggestions and issues like interferences with PSReadline. |
| 60 | +While we appreciate the insights this data provides, we also understand that not everyone wants to send usage data, and you can disable data collection with the [`Disable-AzDataCollection`](https://docs.microsoft.com/en-us/powershell/module/az.accounts/disable-azdatacollection) cmdlet. You can also read our [privacy statement](https://go.microsoft.com/fwlink/?LinkID=528096&clcid=0x409) to learn more. |
0 commit comments