Tweaked the parameters descriptions

This commit is contained in:
Alexander (Sasha) Nosov
2023-02-14 09:03:00 -08:00
parent 8087083d56
commit a4759802cb
2 changed files with 6 additions and 4 deletions
@@ -29,11 +29,11 @@ The script accepts the following command line parameters:
| **Parameter**                                         | **Value**                                                                       | **Description** |
|:--|:--|:--|
|-SubId|subscription_id *or* a file_name|Optional: subscription id or a .csv file with the list of subscriptions<sup>1</sup>|
|-SubId|subscription_id *or* a file_name|Optional: subscription id or a .csv file with the list of subscriptions<sup>1</sup>. If not specified all subscriptions will be scanned|
|-ResourceGroup |resource_group_name|Optional: Limit the scope to a specific resource group|
|-MachineName |machine_name|Optional: Limit the scope to a specific machine|
|-LicenceType | "Paid" (default), "PAYG" or "LicenseOnly"| Specifies the license type value |
|-All|\$True or \$False (default)|Optional: Set the new license type value only if undefined|
|-All|\$True or \$False (default)|Optional. Set the new license type for all installed extensions. By default the value is set only if license type is undefined.|
<sup>1</sup>You can create a .csv file using the following command and then edit to remove the subscriptions you don't want to scan.
```PowerShell
@@ -8,11 +8,13 @@
#
# The script accepts the following command line parameters:
#
# -SubId [subscription_id] | [csv_file_name] (Limit scope to specific subscriptions. Accepts a .csv file with the list of subscriptions)
# -SubId [subscription_id] | [csv_file_name] (Limit scope to specific subscriptions. Accepts a .csv file with the list of subscriptions.
# If not specified all subscriptions will be scanned)
# -ResourceGroup [resource_goup] (Limit scope to a specific resoure group)
# -MachineName [machine_name] (Limit scope to a specific machine)
# -LicenseType [license_type_value] (Specific LT value)
# -All (Optional. Set the new license type value only if undefined)
# -All (Optional. Set the new license type on all installed extensions.
# By default the value is set only if license type is undefined undefined)
#
# The script uses a function ConvertTo-HashTable that was created by Adam Bertram (@adam-bertram).
# The function was originally published on this site: https://4sysops.com/archives/convert-json-to-a-powershell-hash-table/