diff --git a/docs/wiki/1-Collect.md b/docs/wiki/1-Collect.md index 9a04946..22c71eb 100644 --- a/docs/wiki/1-Collect.md +++ b/docs/wiki/1-Collect.md @@ -23,7 +23,7 @@ Get-AzureServices.ps1 -scopeType resourceGroup -resourceGroupName ``` -- 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: +- 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: ```powershell Get-AzureServices.ps1 -multiSubscription -workloadFile diff --git a/docs/wiki/Step-by-Step-Guide.md b/docs/wiki/Step-by-Step-Guide.md index dce328e..baf2d30 100644 --- a/docs/wiki/Step-by-Step-Guide.md +++ b/docs/wiki/Step-by-Step-Guide.md @@ -5,18 +5,22 @@ _This page is a practical guide for running the Region Selection Toolkit, helpin 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) ## Running the Toolkit Step-by-Step + 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: ### Authenticate and Set Context + 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. + - **Log in to Azure:** Run the following to authenticate to Azure + ```powershell Connect-AzAccount ``` ## Run 1-Collect (Inventory Collection) -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). +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). ```powershell .\Get-AzureServices.ps1 -includeCost $true @@ -28,7 +32,7 @@ Navigate to the `1-Collect` folder and run the script `Get-AzureServices.ps1` to .\Get-RessourcesFromAM.ps1 -filePath "C:\path\to\Assessment.xlsx" -outputFile "C:\path\to\summary.json" ``` -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). +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. > [!NOTE] > 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 This script will check the availability of the services in the target region based on the inventory collected in the previous step. -Navigate to the `2-AvailabilityCheck` folder and run `Get-AvailabilityInformation.ps1`. It will generate an `Availability_Mapping.json` Run the following script: +Navigate to the `2-AvailabilityCheck` folder and run `Get-AvailabilityInformation.ps1`. It will generate an `Availability_Mapping.json` Run the following script: ```powershell .\Get-AvailabilityInformation.ps1 @@ -55,7 +59,7 @@ Note that this functionality is not yet complete and is a work in progress. For 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. -Navigate to the `3-CostInformation` folder and run the script using the `Perform-RegionComparison.ps1` script to do cost comparison with target Region(s). +Navigate to the `3-CostInformation` folder and run the script using the `Perform-RegionComparison.ps1` script to do cost comparison with target Region(s). ```powershell $regions = @("Target-region") @@ -78,45 +82,9 @@ Navigate to the `7-Report` folder and run the `Get-Report.ps1`, also specify the ```powershell .\Get-Report.ps1 -availabilityInfoPath ..\2-AvailabilityCheck\Availability_Mapping_.json -costComparisonPath ..\3-CostInformation\region_comparison_prices.json ``` + The script generates an `.xlsx` file in the `7-report` folder, named `Availability_Report_CURRENTTIMESTAMP`. 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. Please see [7-Report](https://github.com/Azure/AzRegionSelection/wiki/7-Report) for more details. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/wiki/media/subscriptions.json b/docs/wiki/media/subscriptions.json new file mode 100644 index 0000000..b108c7b --- /dev/null +++ b/docs/wiki/media/subscriptions.json @@ -0,0 +1,6 @@ +{ + "Subscriptions": [ + "cb9e547b-b77b-43ef-ab23-a9f0dffd858f", + "a0a93165-a194-4dbe-9991-32c4c809cbdf" + ] +} \ No newline at end of file