Response to FRs - Issues #267 and #290 - POC in RG Name and Deployment Snippets

infra-as-code/bicep/modules/customRoleDefinitions/README.md

@@ -49,40 +49,58 @@ Input parameter file `parameters/customRoleDefinitions.parameters.all.json` defi
 ### Azure CLI
 ```bash
 # For Azure global regions
-az deployment mg create \
-  --template-file infra-as-code/bicep/modules/customRoleDefinitions/customRoleDefinitions.bicep \
-  --parameters @infra-as-code/bicep/modules/customRoleDefinitions/parameters/customRoleDefinitions.parameters.all.json \
-  --location eastus \
-  --management-group-id alz
+
+$inputObject = @(
+  '--name',                ('CustomRoleDefsDeployment-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])),
+  '--parameters',          '@infra-as-code/bicep/modules/customRoleDefinitions/parameters/customRoleDefinitions.parameters.all.json',
+  '--location',            'eastus',
+  '--management-group-id', 'alz',
+  '--template-file',       "infra-as-code/bicep/modules/customRoleDefinitions/customRoleDefinitions.bicep"
+)
+az deployment mg create @inputObject
 ```
 OR
 ```bash
 # For Azure China regions
-az deployment mg create \
-  --template-file infra-as-code/bicep/modules/customRoleDefinitions/mc-customRoleDefinitions.bicep \
-  --parameters @infra-as-code/bicep/modules/customRoleDefinitions/parameters/customRoleDefinitions.parameters.all.json \
-  --location chinaeast2 \
-  --management-group-id alz
+
+$inputObject = @(
+  '--name',                ('CustomRoleDefsDeployment-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])),
+  '--parameters',          '@infra-as-code/bicep/modules/customRoleDefinitions/parameters/customRoleDefinitions.parameters.all.json',
+  '--location',            'chinaeast2',
+  '--management-group-id', 'alz',
+  '--template-file',       "infra-as-code/bicep/modules/customRoleDefinitions/mc-customRoleDefinitions.bicep"
+)
+az deployment mg create @inputObject
 ```
 
 ### PowerShell
 
 ```powershell
 # For Azure global regions
-New-AzManagementGroupDeployment `
-  -TemplateFile infra-as-code/bicep/modules/customRoleDefinitions/customRoleDefinitions.bicep `
-  -TemplateParameterFile infra-as-code/bicep/modules/customRoleDefinitions/parameters/customRoleDefinitions.parameters.all.json `
-  -Location eastus `
-  -ManagementGroupId alz
+
+$inputObject = @{
+  DeploymentName        = 'CustomRoleDefsDeployment-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])
+  ManagementGroupId     = 'alz'
+  Location              = 'eastus'
+  TemplateParameterFile = 'infra-as-code/bicep/modules/customRoleDefinitions/parameters/customRoleDefinitions.parameters.all.json'
+  TemplateFile          = "infra-as-code/bicep/modules/customRoleDefinitions/customRoleDefinitions.bicep"
+}
+
+New-AzManagementGroupDeployment @inputObject
 ```
 OR
 ```powershell
 # For Azure China regions
-New-AzManagementGroupDeployment `
-  -TemplateFile infra-as-code/bicep/modules/customRoleDefinitions/mc-customRoleDefinitions.bicep `
-  -TemplateParameterFile infra-as-code/bicep/modules/customRoleDefinitions/parameters/customRoleDefinitions.parameters.all.json `
-  -Location chinaeast2 `
-  -ManagementGroupId alz
+
+$inputObject = @{
+  DeploymentName        = 'CustomRoleDefsDeployment-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])
+  ManagementGroupId     = 'alz'
+  Location              = 'chinaeast2'
+  TemplateParameterFile = 'infra-as-code/bicep/modules/customRoleDefinitions/parameters/customRoleDefinitions.parameters.all.json'
+  TemplateFile          = "infra-as-code/bicep/modules/customRoleDefinitions/mc-customRoleDefinitions.bicep"
+}
+
+New-AzManagementGroupDeployment @inputObject
 ```
 
 ![Example Deployment Output](media/exampleDeploymentOutput.png "Example Deployment Output")

infra-as-code/bicep/modules/hubNetworking/README.md

@@ -93,15 +93,25 @@ There are two different sets of input parameters; one for deploying to Azure glo
 # For Azure global regions
 # Set Platform connectivity subscription ID as the the current subscription 
 ConnectivitySubscriptionId="[your platform connectivity subscription ID]"
+
 az account set --subscription $ConnectivitySubscriptionId
 
+# Set the top level MG Prefix in accordance to your environment. This example assumes default 'alz'.
+TopLevelMGPrefix="alz"
+
+ResourceGroupName="rg-$TopLevelMGPrefix-hub-networking-001"
+
+  $inputObject = @(
+  '--name',           ('HubNetworkingDeploy-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])),
+  '--resource-group', $ResourceGroupName,
+  '--parameters',     '@infra-as-code/bicep/modules/hubNetworking/parameters/hubNetworking.parameters.all.json',
+  '--template-file',  "infra-as-code/bicep/modules/hubNetworking/hubNetworking.bicep"
+)
+
 az group create --location eastus \
-   --name Hub_Networking_POC
+   --name $ResourceGroupName
 
-az deployment group create \
-   --resource-group HUB_Networking_POC  \
-   --template-file infra-as-code/bicep/modules/hubNetworking/hubNetworking.bicep \
-   --parameters @infra-as-code/bicep/modules/hubNetworking/parameters/hubNetworking.parameters.all.json
+az deployment group create @inputObject
 ```
 OR
 ```bash
@@ -110,13 +120,22 @@ OR
 ConnectivitySubscriptionId="[your platform connectivity subscription ID]"
 az account set --subscription $ConnectivitySubscriptionId
 
+# Set the top level MG Prefix in accordance to your environment. This example assumes default 'alz'.
+TopLevelMGPrefix="alz"
+
+ResourceGroupName="rg-$TopLevelMGPrefix-hub-networking-001"
+
+  $inputObject = @(
+  '--name',           ('HubNetworkingDeploy-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])),
+  '--resource-group', $ResourceGroupName,
+  '--parameters',     '@infra-as-code/bicep/modules/hubNetworking/parameters/mc-hubNetworking.parameters.all.json',
+  '--template-file',  "infra-as-code/bicep/modules/hubNetworking/hubNetworking.bicep"
+)
+
 az group create --location chinaeast2 \
-   --name Hub_Networking_POC
+   --name $ResourceGroupName
 
-az deployment group create \
-   --resource-group HUB_Networking_POC  \
-   --template-file infra-as-code/bicep/modules/hubNetworking/hubNetworking.bicep \
-   --parameters @infra-as-code/bicep/modules/hubNetworking/parameters/mc-hubNetworking.parameters.all.json
+az deployment group create @inputObject
 ```
 
 ### PowerShell
@@ -128,13 +147,26 @@ $ConnectivitySubscriptionId = "[your platform connectivity subscription ID]"
 
 Select-AzSubscription -SubscriptionId $ConnectivitySubscriptionId
 
-New-AzResourceGroup -Name 'Hub_Networking_POC' `
+# Set Platform management subscripion ID as the the current subscription 
+$ManagementSubscriptionId = "[your platform management subscription ID]"
+
+# Set the top level MG Prefix in accordance to your environment. This example assumes default 'alz'.
+$TopLevelMGPrefix = "alz"
+
+$ResourceGroupName = "rg-$TopLevelMGPrefix-hub-networking-001"
+
+# Parameters necessary for deployment
+$inputObject = @{
+  DeploymentName        = 'HubNetworkingDeploy-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])
+  ResourceGroupName     = $ResourceGroupName
+  TemplateParameterFile = "infra-as-code/bicep/modules/hubNetworking/parameters/hubNetworking.parameters.all.json"
+  TemplateFile          = "infra-as-code/bicep/modules/hubNetworking/hubNetworking.bicep"
+}
+
+New-AzResourceGroup -Name $ResourceGroupName `
   -Location 'eastus'
 
-New-AzResourceGroupDeployment `
-  -TemplateFile infra-as-code/bicep/modules/hubNetworking/hubNetworking.bicep `
-  -TemplateParameterFile infra-as-code/bicep/modules/hubNetworking/parameters/hubNetworking.parameters.all.json `
-  -ResourceGroupName 'Hub_Networking_POC'
+New-AzResourceGroupDeployment @inputObject
 ```
 OR
 ```powershell
@@ -144,13 +176,23 @@ $ConnectivitySubscriptionId = "[your platform connectivity subscription ID]"
 
 Select-AzSubscription -SubscriptionId $ConnectivitySubscriptionId
 
-New-AzResourceGroup -Name 'Hub_Networking_POC' `
+# Set the top level MG Prefix in accordance to your environment. This example assumes default 'alz'.
+$TopLevelMGPrefix = "alz"
+
+$ResourceGroupName = "rg-$TopLevelMGPrefix-hub-networking-001"
+
+# Parameters necessary for deployment
+$inputObject = @{
+  DeploymentName        = 'HubNetworkingDeploy-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])
+  ResourceGroupName     = $ResourceGroupName
+  TemplateParameterFile = "infra-as-code/bicep/modules/hubNetworking/parameters/mc-hubNetworking.parameters.all.json"
+  TemplateFile          = "infra-as-code/bicep/modules/hubNetworking/hubNetworking.bicep"
+}
+
+New-AzResourceGroup -Name $ResourceGroupName `
   -Location 'chinaeast2'
-
-New-AzResourceGroupDeployment `
-  -TemplateFile infra-as-code/bicep/modules/hubNetworking/hubNetworking.bicep `
-  -TemplateParameterFile infra-as-code/bicep/modules/hubNetworking/parameters/mc-hubNetworking.parameters.all.json `
-  -ResourceGroupName 'Hub_Networking_POC'
+
+New-AzResourceGroupDeployment @inputObject
 ```
 ## Example Output in Azure global regions
 

infra-as-code/bicep/modules/logging/README.md

@@ -72,16 +72,25 @@ There are separate input parameters files depending on which Azure cloud you are
 ManagementSubscriptionId="[your platform management subscription ID]"
 az account set --subscription $ManagementSubscriptionId
 
+# Set the top level MG Prefix in accordance to your environment. This example assumes default 'alz'.
+TopLevelMGPrefix="alz"
+
+ResourceGroupName="rg-$TopLevelMGPrefix-logging-001"
+
 # Create Resource Group - optional when using an existing resource group
 az group create \
-  --name alz-logging \
+  --name $ResourceGroupName \
   --location eastus
 
+  $inputObject = @(
+  '--name',           ('LoggingDeploy-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])),
+  '--resource-group', $ResourceGroupName,
+  '--parameters',     '@infra-as-code/bicep/modules/logging/parameters/logging.parameters.all.json',
+  '--template-file',  "infra-as-code/bicep/modules/logging/logging.bicep"
+)
+
 # Deploy Module 
-az deployment group create \
-  --template-file infra-as-code/bicep/modules/logging/logging.bicep \
-  --parameters @infra-as-code/bicep/modules/logging/parameters/logging.parameters.all.json \
-  --resource-group alz-logging
+az deployment group create @inputObject
 ```
 OR
 ```bash
@@ -90,16 +99,25 @@ OR
 ManagementSubscriptionId="[your platform management subscription ID]"
 az account set --subscription $ManagementSubscriptionId
 
+# Set the top level MG Prefix in accordance to your environment. This example assumes default 'alz'.
+TopLevelMGPrefix="alz"
+
+ResourceGroupName="rg-$TopLevelMGPrefix-logging-001"
+
 # Create Resource Group - optional when using an existing resource group
 az group create \
-  --name alz-logging \
+  --name $ResourceGroupName \
   --location chinaeast2
 
+  $inputObject = @(
+  '--name',           'LoggingDeploy-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63]),
+  '--resource-group', $ResourceGroupName,
+  '--parameters',     '@infra-as-code/bicep/modules/logging/parameters/mc-logging.parameters.all.json',
+  '--template-file',  "infra-as-code/bicep/modules/logging/logging.bicep"
+)
+
 # Deploy Module 
-az deployment group create \
-  --template-file infra-as-code/bicep/modules/logging/logging.bicep \
-  --parameters @infra-as-code/bicep/modules/logging/parameters/mc-logging.parameters.all.json \
-  --resource-group alz-logging
+az deployment group create @inputObject
 ```
 
 ### PowerShell
@@ -109,35 +127,55 @@ az deployment group create \
 # Set Platform management subscripion ID as the the current subscription 
 $ManagementSubscriptionId = "[your platform management subscription ID]"
 
+# Set the top level MG Prefix in accordance to your environment. This example assumes default 'alz'.
+$TopLevelMGPrefix = "alz"
+
+$ResourceGroupName = "rg-$TopLevelMGPrefix-logging-001"
+
+# Parameters necessary for deployment
+$inputObject = @{
+  DeploymentName        = 'LoggingDeploy-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])
+  ResourceGroupName     = $ResourceGroupName
+  TemplateParameterFile = "infra-as-code/bicep/modules/logging/parameters/logging.parameters.all.json"
+  TemplateFile          = "infra-as-code/bicep/modules/logging/logging.bicep"
+}
+
 Select-AzSubscription -SubscriptionId $ManagementSubscriptionId
 
 # Create Resource Group - optional when using an existing resource group
 New-AzResourceGroup `
-  -Name alz-logging `
+  -Name $ResourceGroupName `
   -Location eastus
 
-New-AzResourceGroupDeployment `
-  -TemplateFile infra-as-code/bicep/modules/logging/logging.bicep `
-  -TemplateParameterFile infra-as-code/bicep/modules/logging/parameters/logging.parameters.all.json `
-  -ResourceGroup alz-logging
+New-AzResourceGroupDeployment @inputObject
 ```
 OR
 ```powershell
 # For Azure China regions
 # Set Platform management subscripion ID as the the current subscription 
 $ManagementSubscriptionId = "[your platform management subscription ID]"
 
+# Set the top level MG Prefix in accordance to your environment. This example assumes default 'alz'.
+$TopLevelMGPrefix = "alz"
+
+$ResourceGroupName = "rg-$TopLevelMGPrefix-logging-001"
+
+# Parameters necessary for deployment
+$inputObject = @{
+  DeploymentName        = 'LoggingDeploy-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])
+  ResourceGroupName     = $ResourceGroupName
+  TemplateParameterFile = "infra-as-code/bicep/modules/logging/parameters/logging.parameters.all.json"
+  TemplateFile          = "infra-as-code/bicep/modules/logging/logging.bicep"
+}
+
 Select-AzSubscription -SubscriptionId $ManagementSubscriptionId
 
 # Create Resource Group - optional when using an existing resource group
 New-AzResourceGroup `
-  -Name alz-logging `
+  -Name $ResourceGroupName `
   -Location chinaeast2
 
-New-AzResourceGroupDeployment `
-  -TemplateFile infra-as-code/bicep/modules/logging/logging.bicep `
-  -TemplateParameterFile infra-as-code/bicep/modules/logging/parameters/mc-logging.parameters.all.json `
-  -ResourceGroup alz-logging
+New-AzResourceGroupDeployment @inputObject
 ```
 
 ## Bicep Visualizer

infra-as-code/bicep/modules/managementGroups/README.md

@@ -120,36 +120,54 @@ In this example, the management groups are created at the `Tenant Root Group` th
 ### Azure CLI
 ```bash
 # For Azure global regions
-az deployment tenant create \
-  --template-file infra-as-code/bicep/modules/managementGroups/managementGroups.bicep \
-  --parameters @infra-as-code/bicep/modules/managementGroups/parameters/managementGroups.parameters.all.json \
-  --location eastus
+
+$inputObject = @(
+  '--name',           ('MGDeployment-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])),
+  '--parameters',     '@infra-as-code/bicep/modules/managementGroups/parameters/managementGroups.parameters.all.json',
+  '--location',       'eastus',
+  '--template-file',  "infra-as-code/bicep/modules/managementGroups/managementGroups.bicep"
+)
+
+az deployment tenant create @inputObject
 ```
 OR
 ```bash
 # For Azure China regions
-az deployment tenant create \
-  --template-file infra-as-code/bicep/modules/managementGroups/managementGroups.bicep \
-  --parameters @infra-as-code/bicep/modules/managementGroups/parameters/managementGroups.parameters.all.json \
-  --location chinaeast2
+
+$inputObject = @(
+  '--name',           ('MGDeployment-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])),
+  '--parameters',     '@infra-as-code/bicep/modules/managementGroups/parameters/managementGroups.parameters.all.json',
+  '--location',       'chinaeast2',
+  '--template-file',  "infra-as-code/bicep/modules/managementGroups/managementGroups.bicep"
+)
+
+az deployment tenant create @inputObject
 ```
 
 ### PowerShell
 
 ```powershell
 # For Azure global regions
-New-AzTenantDeployment `
-  -TemplateFile infra-as-code/bicep/modules/managementGroups/managementGroups.bicep `
-  -TemplateParameterFile infra-as-code/bicep/modules/managementGroups/parameters/managementGroups.parameters.all.json `
-  -Location eastus
+
+$inputObject = @{
+  DeploymentName        = 'MGDeployment-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])
+  TemplateParameterFile = 'infra-as-code/bicep/modules/managementGroups/parameters/managementGroups.parameters.all.json'
+  Location              = 'EastUS'
+  TemplateFile          = "infra-as-code/bicep/modules/managementGroups/managementGroups.bicep"
+}
+New-AzTenantDeployment @inputObject
 ```
 OR
 ```powershell
 # For Azure China regions
-New-AzTenantDeployment `
-  -TemplateFile infra-as-code/bicep/modules/managementGroups/managementGroups.bicep `
-  -TemplateParameterFile infra-as-code/bicep/modules/managementGroups/parameters/managementGroups.parameters.all.json `
-  -Location chinaeast2  
+
+$inputObject = @{
+  DeploymentName        = 'MGDeployment-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])
+  TemplateParameterFile = 'infra-as-code/bicep/modules/managementGroups/parameters/managementGroups.parameters.all.json'
+  Location              = 'chinaeast2'
+  TemplateFile          = "infra-as-code/bicep/modules/managementGroups/managementGroups.bicep"
+}
+New-AzTenantDeployment @inputObject
 ```
 
 ![Example Deployment Output](media/exampleDeploymentOutput.png "Example Deployment Output")