Skip to content
10 changes: 5 additions & 5 deletions docs/wiki/1-Collect.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,25 @@ Run the `Get-AzureServices.ps1` script with your target scope. For example:
- To include Cost Information add parameter `-includeCost $true`. If you include this parameter, it will also generate a CSV file in the same directory. This CSV file can be used later in `3-CostInformation`. Note: This might take some time depending on how long it takes to download the cost information.

```powershell
Get-AzureServices.ps1 -includeCost $true
.\Get-AzureServices.ps1 -includeCost $true
```

- To collect the inventory for a single resource group, cost not included, run the script as follows:

```powershell
Get-AzureServices.ps1 -scopeType resourceGroup -resourceGroupName <resource-group-name> -subscriptionId <subscription-id>
.\Get-AzureServices.ps1 -scopeType resourceGroup -resourceGroupName <resource-group-name> -subscriptionId <subscription-id>
```

- To collect the inventory for a single subscription, cost not included, run the script as follows:

```powershell
Get-AzureServices.ps1 -scopeType subscription -subscriptionId <subscription-id>
.\Get-AzureServices.ps1 -scopeType subscription -subscriptionId <subscription-id>
```

- To collect the inventory for multiple subscriptions, you will need to create a json file containing the subscription ids in scope. See [here](https://github.com/Azure/AzRegionSelection/wiki/media/subscriptions.json) for a sample json file. Once the file is created, run the script as follows:
- To collect the inventory for multiple subscriptions, you will need to create a `subscriptions.json` file containing the subscription ids in scope. See [here](https://github.com/Azure/AzRegionSelection/wiki/media/subscriptions.json) for a sample json file. Once the file is created, run the script as follows:

```powershell
Get-AzureServices.ps1 -multiSubscription -workloadFile <path-to-workload-file>
.\Get-AzureServices.ps1 -scopeType multiSubscription -workloadFile subscriptions.json -includeCost $true
```

### If using an Azure Migrate export:
Expand Down
21 changes: 14 additions & 7 deletions docs/wiki/2-AvailabilityCheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Note that this functionality is not yet complete and is a work in progress. Curr
The `Get-AvailabilityInformation.ps1` script only needs to be run once to collect the availability information for all regions, which takes a little while. Run the following script:

```powershell
Get-AvailabilityInformation.ps1
.\Get-AvailabilityInformation.ps1
```
It will generate a number of json files in the same directory the important one is the `Availability_Mapping.json`

Expand All @@ -22,16 +22,23 @@ It will generate a number of json files in the same directory the important one
To check the availability of the resources in scope in a specific region run following script:

```powershell
Get-Region.ps1 -Region <Target-region>
.\Get-Region.ps1 -Region <Target-region>
```
This will generate `Availability_Mapping_<Region>.json` in the same directory.

## Multiple Regions
To generate a report for multiple regions, you need to create one `Availability_Mapping_<Region>.json` file per region.
Run the following command for each region:
```powershell
.\Get-Region.ps1 -Region <Target-region>
```

## Example:
```powershell
Get-AvailabilityInformation.ps1
.\Get-AvailabilityInformation.ps1
# Wait for the script to complete, this may take a while.
Get-Region.ps1 -region <target-region1>
# Example1: Get-Region.ps1 -region "east us"
# Example2: Get-Region.ps1 -region "west us"
# Example3: Get-Region.ps1 -region "sweden central"
.\Get-Region.ps1 -region <target-region>
# Example1: Get-Region.ps1 -region eastus
# Example2: Get-Region.ps1 -region westus
# Example3: Get-Region.ps1 -region swedencentral
```
2 changes: 1 addition & 1 deletion docs/wiki/3-CostInformation.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Instructions for use:
2. Ensure the `resources.json` file is present (from the running of the collector script).
2. Run the script using `.\Perform-RegionComparison.ps1`. The script will generate output files in the current folder.

#### Example
### Multiple Regions Example

```powershell
$regions = @("eastus", "brazilsouth", "australiaeast")
Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/Step-by-Step-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ $regions = @("Target-region")
```

```powershell
.\Perform-RegionComparison.ps1 -regions $regions -outputFormat json -resourceFile ..\1-Collect\resources.json
.\Perform-RegionComparison.ps1 -regions $regions -outputFormat json -resourceFile ..\1-Collect\resources.json
```

This will generate `region_comparison_prices.json` file
Expand Down