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

infra-as-code/bicep/CRML/containerRegistry/README.md

@@ -10,20 +10,20 @@ Module deploys the following resources:
 
 The module requires the following inputs:
 
- Parameter | Type | Default | Description | Requirement | Example
------------ | ---- | ------- |----------- | ----------- | -------
- parAcrName | string | acr${uniqueString(resourceGroup().id)} | Name of Azure Container Registry to deploy | 5-50 char | acr5cix6w3rcizn
- parACRSku | string | Basic | SKU of Azure Container Registry to deploy to Azure | Basic or Standard or Premium | Basic
- parLocation | string | resourceGroup().location | Location where Public Azure Container Registry will be deployed | Valid Azure Region | eastus2
- parTags | object | none | Tags to be appended to resource | none | {"Environment" : "Development"}
+ | Parameter   | Type   | Default                                | Description                                                     | Requirement                  | Example                         |
+ | ----------- | ------ | -------------------------------------- | --------------------------------------------------------------- | ---------------------------- | ------------------------------- |
+ | parAcrName  | string | acr${uniqueString(resourceGroup().id)} | Name of Azure Container Registry to deploy                      | 5-50 char                    | acr5cix6w3rcizn                 |
+ | parACRSku   | string | Basic                                  | SKU of Azure Container Registry to deploy to Azure              | Basic or Standard or Premium | Basic                           |
+ | parLocation | string | resourceGroup().location               | Location where Public Azure Container Registry will be deployed | Valid Azure Region           | eastus2                         |
+ | parTags     | object | none                                   | Tags to be appended to resource                                 | none                         | {"Environment" : "Development"} |
 
 ## Outputs
 
 The module will generate the following outputs:
 
-Output | Type | Example
------- | ---- | --------
-outLoginServer | string | acr5cix6w3rcizna.azurecr.io
+| Output         | Type   | Example                     |
+| -------------- | ------ | --------------------------- |
+| outLoginServer | string | acr5cix6w3rcizna.azurecr.io |
 
 ## Deployment
 
@@ -36,26 +36,41 @@ We will take the default values and not pass any parameters.
 ### Azure CLI
 
 ```bash
-az group create --location eastus2 \
+dateYMD=$(date +%Y%m%dT%H%M%S%NZ)
+NAME="alz-ContainerRegistry-${dateYMD}"
+RESOURCEGROUP="Bicep_ACR"
+PARAMETERS="@infra-as-code/bicep/CRML/containerRegistry/parameters/containerRegistry.parameters.all.json"
+TEMPLATEFILE="infra-as-code/bicep/CRML/containerRegistry/containerRegistry.bicep"
+
+az group create --location eastus \
    --name Bicep_ACR
 
-az deployment group create \
-   --resource-group Bicep_Acr  \
-   --template-file infra-as-code/bicep/CRML/containerRegistry/containerRegistry.bicep \
-   --parameters @infra-as-code/bicep/CRML/containerRegistry/parameters/containerRegistry.parameters.all.json
+$inputObject = @(
+'--name',           ('alz-ContainerRegistry-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])),
+'--resource-group', 'Bicep_ACR',
+'--parameters',     '@infra-as-code/bicep/CRML/containerRegistry/parameters/containerRegistry.parameters.all.json',
+'--template-file',  "infra-as-code/bicep/CRML/containerRegistry/containerRegistry.bicep",
+)
+
+az deployment group create --name ${NAME:0:63} --resource-group $RESOURCEGROUP --parameters $PARAMETERS --template-file $TEMPLATEFILE
 ```
 
 ### PowerShell
 
 ```powershell
 New-AzResourceGroup -Name 'Bicep_ACR' `
-  -Location 'EastUs2'
-
-New-AzResourceGroupDeployment `
-  -TemplateFile infra-as-code/bicep/CRML/containerRegistry/containerRegistry.bicep `
-  -TemplateParameterFile infra-as-code/bicep/CRML/containerRegistry/parameters/containerRegistry.parameters.all.json
+  -Location 'EastUs'
+
+  $inputObject = @{
+  DeploymentName        = 'alz-ContainerRegistry-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])
+  ResourceGroupName     = 'Bicep_ACR'
+  TemplateParameterFile = 'infra-as-code/bicep/CRML/containerRegistry/parameters/containerRegistry.parameters.all.json'
+  TemplateFile          = "infra-as-code/bicep/CRML/containerRegistry/containerRegistry.bicep"
+}
+
+New-AzResourceGroupDeployment @inputObject
 ```
 
 ## Bicep Visualizer
 
-![Bicep Visualizer](media/bicepVisualizer.png "Bicep Visualizer")
+![Bicep Visualizer](media/bicepVisualizer.png "Bicep Visualizer")

infra-as-code/bicep/CRML/subscriptionAlias/README.md

@@ -38,20 +38,31 @@ In this example, the Subscription is created upon an EA Account through a tenant
 > For the below examples we assume you have downloaded or cloned the Git repo as-is and are in the root of the repository as your selected directory in your terminal of choice.
 
 ### Azure CLI
+**NOTE: As there is some PowerShell code within the CLI, there is a requirement to execute the deployments in a cross-platform terminal which has PowerShell installed.**
 ```bash
-az deployment tenant create \
-  --template-file infra-as-code/bicep/CRML/subscriptionAlias/subscriptionAlias.bicep \
-  --parameters @infra-as-code/bicep/CRML/subscriptionAlias/parameters/subscriptionAlias.parameters.all.json \
-  --location eastus
+
+$inputObject = @(
+  '--name',           ('alz-SubscriptionAlias-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])),
+  '--parameters',     '@infra-as-code/bicep/CRML/subscriptionAlias/parameters/subscriptionAlias.parameters.all.json',
+  '--location',       'EastUS',
+  '--template-file',  "infra-as-code/bicep/CRML/subscriptionAlias/subscriptionAlias.bicep"
+)
+
+az deployment tenant create @inputObject
 ```
 
 ### PowerShell
 
 ```powershell
-New-AzTenantDeployment `
-  -TemplateFile infra-as-code/bicep/CRML/subscriptionAlias/subscriptionAlias.bicep `
-  -TemplateParameterFile infra-as-code/bicep/CRML/subscriptionAlias/parameters/subscriptionAlias.parameters.all.json `
-  -Location eastus
+
+$inputObject = @{
+  DeploymentName        = 'alz-SubscriptionAlias-{0}' -f (-join (Get-Date -Format 'yyyyMMddTHHMMssffffZ')[0..63])
+  TemplateParameterFile = 'infra-as-code/bicep/CRML/subscriptionAlias/parameters/subscriptionAlias.parameters.all.json'
+  Location              = 'EastUS'
+  TemplateFile          = "infra-as-code/bicep/CRML/subscriptionAlias/subscriptionAlias.bicep"
+}
+
+New-AzTenantDeployment @inputObject
 ```
 
 ### Output Screenshot

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

@@ -47,42 +47,69 @@ Input parameter file `parameters/customRoleDefinitions.parameters.all.json` defi
 > For the examples below we assume you have downloaded or cloned the Git repo as-is and are in the root of the repository as your selected directory in your terminal of choice.
 
 ### 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
+
+# Management Group ID
+MGID="alz"
+
+# Chosen Azure Region
+LOCATION="eastus"
+
+dateYMD=$(date +%Y%m%dT%H%M%S%NZ)
+NAME="alz-CustomRoleDefsDeployment-${dateYMD}"
+PARAMETERS="@infra-as-code/bicep/modules/customRoleDefinitions/parameters/customRoleDefinitions.parameters.all.json"
+TEMPLATEFILE="infra-as-code/bicep/modules/customRoleDefinitions/customRoleDefinitions.bicep"
+
+az deployment mg create --name ${NAME:0:63} --parameters $PARAMETERS --location $LOCATION --management-group-id $MGID --template-file $TEMPLATEFILE
 ```
 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
+
+# Management Group ID
+MGID="alz"
+
+# Chosen Azure Region
+LOCATION="chinaeast2"
+
+dateYMD=$(date +%Y%m%dT%H%M%S%NZ)
+NAME="alz-CustomRoleDefsDeployment-${dateYMD}"
+PARAMETERS="@infra-as-code/bicep/modules/customRoleDefinitions/parameters/customRoleDefinitions.parameters.all.json"
+TEMPLATEFILE="infra-as-code/bicep/modules/customRoleDefinitions/mc-customRoleDefinitions.bicep"
+
+az deployment mg create --name ${NAME:0:63} --parameters $PARAMETERS --location $LOCATION --management-group-id $MGID --template-file $TEMPLATEFILE
 ```
 
 ### 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        = 'alz-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        = 'alz-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

@@ -97,32 +97,47 @@ There are two different sets of input parameters; one for deploying to Azure glo
 ### Azure CLI
 ```bash
 # 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"
+
+dateYMD=$(date +%Y%m%dT%H%M%S%NZ)
+NAME="alz-HubNetworkingDeploy-${dateYMD}"
+GROUP="rg-$TopLevelMGPrefix-hub-networking-001"
+PARAMETERS="@infra-as-code/bicep/modules/hubNetworking/parameters/hubNetworking.parameters.all.json"
+TEMPLATEFILE="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 --name ${NAME:0:63} --resource-group $GROUP --parameters $PARAMETERS --template-file $TEMPLATEFILE
 ```
 OR
 ```bash
 # For Azure China 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"
+
+dateYMD=$(date +%Y%m%dT%H%M%S%NZ)
+NAME="alz-HubNetworkingDeploy-${dateYMD}"
+GROUP="rg-$TopLevelMGPrefix-hub-networking-001"
+PARAMETERS="@infra-as-code/bicep/modules/hubNetworking/parameters/mc-hubNetworking.parameters.all.json"
+TEMPLATEFILE="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 --name ${NAME:0:63} --resource-group $GROUP --parameters $PARAMETERS --template-file $TEMPLATEFILE
 ```
 
 ### PowerShell
@@ -134,13 +149,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        = 'alz-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
@@ -150,13 +178,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        = 'alz-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