You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- To collect the inventory for multiple subscriptions, you will need to create a json file containing the subscription ids in scope. See [here](./subscriptions.json) for a sample json file. Once the file is created, run the script as follows:
26
+
- 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:
Copy file name to clipboardExpand all lines: docs/wiki/Step-by-Step-Guide.md
+9-41Lines changed: 9 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,18 +5,22 @@ _This page is a practical guide for running the Region Selection Toolkit, helpin
5
5
Before proceeding with this Step by Step Guide, make sure you’ve completed the prerequisites and initial setup in [Getting Started](https://github.com/Azure/AzRegionSelection/wiki/Setup-and-Prerequisites)
6
6
7
7
## Running the Toolkit Step-by-Step
8
+
8
9
Once your environment is ready and you have determined the input method, follow these steps to run the Region Selection Toolkit. It’s important to run the stages in order, as each stage uses data from the previous one. The steps below assume you’re using PowerShell:
9
10
10
11
### Authenticate and Set Context
12
+
11
13
Open a PowerShell prompt in the toolkit’s directory. If you’re in Azure Cloud Shell, you can navigate to the folder where you cloned the toolkit.
14
+
12
15
-**Log in to Azure:** Run the following to authenticate to Azure
16
+
13
17
```powershell
14
18
Connect-AzAccount
15
19
```
16
20
17
21
## Run 1-Collect (Inventory Collection)
18
22
19
-
Navigate to the `1-Collect` folder and run the script `Get-AzureServices.ps1` to collect the Azure resource inventory and properties, for yor relevant scope (resource group, subscription or multiple subscriptions).
23
+
Navigate to the `1-Collect` folder and run the script `Get-AzureServices.ps1` to collect the Azure resource inventory and properties, for yor relevant scope (resource group, subscription or multiple subscriptions). The below example is default behavior collecting resources from the current subscription, and including cost data. For examples on how to run the script for different scopes please see [1-Collect Examples](https://github.com/Azure/AzRegionSelection/wiki/1-Collect).
20
24
21
25
```powershell
22
26
.\Get-AzureServices.ps1 -includeCost $true
@@ -28,7 +32,7 @@ Navigate to the `1-Collect` folder and run the script `Get-AzureServices.ps1` to
The script will generate a `resources.json` and a `summary.json` file in the same directory. The `resources.json` file contains the full inventory of resources and their properties, while the `summary.json` file contains a summary of the resources collected. For examples on how to run the script for different scopes please see [1-Collect Examples](https://github.com/Azure/AzRegionSelection/wiki/1-Collect).
35
+
The script will generate a `resources.json` and a `summary.json` file in the same directory. The `resources.json` file contains the full inventory of resources and their properties, while the `summary.json` file contains a summary of the resources collected.
32
36
33
37
> [!NOTE]
34
38
> Before proceeding, make sure that the output files (`resources.json`, `summary.json` and a `CSV file`) are generated in the `1-Collect` folder.
@@ -37,7 +41,7 @@ The script will generate a `resources.json` and a `summary.json` file in the sa
37
41
38
42
This script will check the availability of the services in the target region based on the inventory collected in the previous step.
39
43
40
-
Navigate to the `2-AvailabilityCheck` folder and run `Get-AvailabilityInformation.ps1`. It will generate an `Availability_Mapping.json` Run the following script:
44
+
Navigate to the `2-AvailabilityCheck` folder and run `Get-AvailabilityInformation.ps1`. It will generate an `Availability_Mapping.json` Run the following script:
41
45
42
46
```powershell
43
47
.\Get-AvailabilityInformation.ps1
@@ -55,7 +59,7 @@ Note that this functionality is not yet complete and is a work in progress. For
55
59
56
60
The Azure public pricing API is used, meaning that, prices are **not** customer-specific, but are only used to calculate the relative cost difference between regions for each meter ID.
57
61
58
-
Navigate to the `3-CostInformation` folder and run the script using the `Perform-RegionComparison.ps1` script to do cost comparison with target Region(s).
62
+
Navigate to the `3-CostInformation` folder and run the script using the `Perform-RegionComparison.ps1` script to do cost comparison with target Region(s).
59
63
60
64
```powershell
61
65
$regions = @("Target-region")
@@ -78,45 +82,9 @@ Navigate to the `7-Report` folder and run the `Get-Report.ps1`, also specify the
The script generates an `.xlsx` file in the `7-report` folder, named `Availability_Report_CURRENTTIMESTAMP`.
82
87
83
88
Open the generated Excel file. The reports provide detailed information for each service. These reports help you analyze service availability and cost differences across different regions.
84
89
85
90
Please see [7-Report](https://github.com/Azure/AzRegionSelection/wiki/7-Report) for more details.
0 commit comments