Skip to content

Commit 01a59c2

Browse files
authored
Merge pull request #28 from Azure/add-subscriptions-sample
Add sample file
2 parents c8b7032 + c7e7f30 commit 01a59c2

File tree

3 files changed

+16
-42
lines changed

3 files changed

+16
-42
lines changed

docs/wiki/1-Collect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Get-AzureServices.ps1 -scopeType resourceGroup -resourceGroupName <resource-grou
2323
Get-AzureServices.ps1 -scopeType subscription -subscriptionId <subscription-id>
2424
```
2525

26-
- 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:
2727

2828
```powershell
2929
Get-AzureServices.ps1 -multiSubscription -workloadFile <path-to-workload-file>

docs/wiki/Step-by-Step-Guide.md

Lines changed: 9 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,22 @@ _This page is a practical guide for running the Region Selection Toolkit, helpin
55
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)
66

77
## Running the Toolkit Step-by-Step
8+
89
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:
910

1011
### Authenticate and Set Context
12+
1113
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+
1215
- **Log in to Azure:** Run the following to authenticate to Azure
16+
1317
```powershell
1418
Connect-AzAccount
1519
```
1620

1721
## Run 1-Collect (Inventory Collection)
1822

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).
2024

2125
```powershell
2226
.\Get-AzureServices.ps1 -includeCost $true
@@ -28,7 +32,7 @@ Navigate to the `1-Collect` folder and run the script `Get-AzureServices.ps1` to
2832
.\Get-RessourcesFromAM.ps1 -filePath "C:\path\to\Assessment.xlsx" -outputFile "C:\path\to\summary.json"
2933
```
3034

31-
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.
3236

3337
> [!NOTE]
3438
> 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
3741

3842
This script will check the availability of the services in the target region based on the inventory collected in the previous step.
3943

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:
4145

4246
```powershell
4347
.\Get-AvailabilityInformation.ps1
@@ -55,7 +59,7 @@ Note that this functionality is not yet complete and is a work in progress. For
5559

5660
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.
5761

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).
5963

6064
```powershell
6165
$regions = @("Target-region")
@@ -78,45 +82,9 @@ Navigate to the `7-Report` folder and run the `Get-Report.ps1`, also specify the
7882
```powershell
7983
.\Get-Report.ps1 -availabilityInfoPath ..\2-AvailabilityCheck\Availability_Mapping_<Target-region>.json -costComparisonPath ..\3-CostInformation\region_comparison_prices.json
8084
```
85+
8186
The script generates an `.xlsx` file in the `7-report` folder, named `Availability_Report_CURRENTTIMESTAMP`.
8287

8388
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.
8489

8590
Please see [7-Report](https://github.com/Azure/AzRegionSelection/wiki/7-Report) for more details.
86-
87-
88-
89-
90-
91-
92-
93-
94-
95-
96-
97-
98-
99-
100-
101-
102-
103-
104-
105-
106-
107-
108-
109-
110-
111-
112-
113-
114-
115-
116-
117-
118-
119-
120-
121-
122-

docs/wiki/media/subscriptions.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"Subscriptions": [
3+
"cb9e547b-b77b-43ef-ab23-a9f0dffd858f",
4+
"a0a93165-a194-4dbe-9991-32c4c809cbdf"
5+
]
6+
}

0 commit comments

Comments
 (0)