readmes updated

ReneHezser · Sep 30, 2024 · b9ceb44 · b9ceb44
1 parent aabd4c0
commit b9ceb44
Show file tree

Hide file tree

Showing 152 changed files with 36,112 additions and 20 deletions.
diff --git a/avm/ptn/aca-lza/hosting-environment/README.md b/avm/ptn/aca-lza/hosting-environment/README.md
@@ -215,6 +215,41 @@ module hostingEnvironment 'br/public:avm/ptn/aca-lza/hosting-environment:<versio
 </details>
 <p>
 
+<details>
+
+<summary>via Bicep parameters file</summary>
+
+```bicep-params
+using 'br/public:avm/ptn/aca-lza/hosting-environment:<version>'
+
+// Required parameters
+param applicationGatewayCertificateKeyName = 'appgwcert'
+param enableApplicationInsights = true
+param enableDaprInstrumentation = false
+param spokeApplicationGatewaySubnetAddressPrefix = '10.1.3.0/24'
+param spokeInfraSubnetAddressPrefix = '10.1.0.0/23'
+param spokePrivateEndpointsSubnetAddressPrefix = '10.1.2.0/27'
+param spokeVNetAddressPrefixes = [
+  '10.1.0.0/22'
+]
+param vmAdminPassword = '<vmAdminPassword>'
+param vmAdminUsername = 'vmadmin'
+param vmJumpBoxSubnetAddressPrefix = '10.1.2.32/27'
+param vmLinuxSshAuthorizedKey = 'ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIC9QWdPia7CYYWWX/+eRrLKzGtQ+tjelZfDlbHy/Dg98 konstantinospantos@KonstaninossMBP.localdomain'
+param vmSize = 'Standard_B1s'
+// Non-required parameters
+param location = '<location>'
+param tags = {
+  environment: 'test'
+}
+param vmAuthenticationType = 'sshPublicKey'
+param vmJumpboxOSType = 'linux'
+param workloadName = '<workloadName>'
+```
+
+</details>
+<p>
+
 ### Example 2: _Using a hub and spoke deployment._
 
 This instance deploys the module including a Hub to peer to.
@@ -359,6 +394,48 @@ module hostingEnvironment 'br/public:avm/ptn/aca-lza/hosting-environment:<versio
 </details>
 <p>
 
+<details>
+
+<summary>via Bicep parameters file</summary>
+
+```bicep-params
+using 'br/public:avm/ptn/aca-lza/hosting-environment:<version>'
+
+// Required parameters
+param applicationGatewayCertificateKeyName = 'appgwcert'
+param enableApplicationInsights = true
+param enableDaprInstrumentation = false
+param spokeApplicationGatewaySubnetAddressPrefix = '10.1.3.0/24'
+param spokeInfraSubnetAddressPrefix = '10.1.0.0/23'
+param spokePrivateEndpointsSubnetAddressPrefix = '10.1.2.0/27'
+param spokeVNetAddressPrefixes = [
+  '10.1.0.0/22'
+]
+param vmAdminPassword = '<vmAdminPassword>'
+param vmAdminUsername = 'vmadmin'
+param vmJumpBoxSubnetAddressPrefix = '10.1.2.32/27'
+param vmLinuxSshAuthorizedKey = 'ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIC9QWdPia7CYYWWX/+eRrLKzGtQ+tjelZfDlbHy/Dg98 konstantinospantos@KonstaninossMBP.localdomain'
+param vmSize = 'Standard_B1s'
+// Non-required parameters
+param deployZoneRedundantResources = true
+param enableDdosProtection = true
+param environment = 'dev'
+param exposeContainerAppsWith = 'applicationGateway'
+param hubVirtualNetworkResourceId = '<hubVirtualNetworkResourceId>'
+param location = '<location>'
+param networkApplianceIpAddress = '<networkApplianceIpAddress>'
+param storageAccountType = 'Premium_LRS'
+param tags = {
+  environment: 'test'
+}
+param vmAuthenticationType = 'sshPublicKey'
+param vmJumpboxOSType = 'linux'
+param workloadName = '<workloadName>'
+```
+
+</details>
+<p>
+
 ### Example 3: _Using all the available options in WAF aligned values._
 
 This instance deploys the module with the all the available parameters in WAF aligned values.
@@ -495,6 +572,46 @@ module hostingEnvironment 'br/public:avm/ptn/aca-lza/hosting-environment:<versio
 </details>
 <p>
 
+<details>
+
+<summary>via Bicep parameters file</summary>
+
+```bicep-params
+using 'br/public:avm/ptn/aca-lza/hosting-environment:<version>'
+
+// Required parameters
+param applicationGatewayCertificateKeyName = 'appgwcert'
+param enableApplicationInsights = true
+param enableDaprInstrumentation = false
+param spokeApplicationGatewaySubnetAddressPrefix = '10.1.3.0/24'
+param spokeInfraSubnetAddressPrefix = '10.1.0.0/23'
+param spokePrivateEndpointsSubnetAddressPrefix = '10.1.2.0/27'
+param spokeVNetAddressPrefixes = [
+  '10.1.0.0/22'
+]
+param vmAdminPassword = '<vmAdminPassword>'
+param vmAdminUsername = 'vmadmin'
+param vmJumpBoxSubnetAddressPrefix = '10.1.2.32/27'
+param vmLinuxSshAuthorizedKey = 'ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIC9QWdPia7CYYWWX/+eRrLKzGtQ+tjelZfDlbHy/Dg98 konstantinospantos@KonstaninossMBP.localdomain'
+param vmSize = 'Standard_B1s'
+// Non-required parameters
+param deployZoneRedundantResources = true
+param enableDdosProtection = true
+param environment = 'dev'
+param exposeContainerAppsWith = 'applicationGateway'
+param location = '<location>'
+param storageAccountType = 'Premium_LRS'
+param tags = {
+  environment: 'test'
+}
+param vmAuthenticationType = 'sshPublicKey'
+param vmJumpboxOSType = 'linux'
+param workloadName = '<workloadName>'
+```
+
+</details>
+<p>
+
 ## Parameters
 
 **Required parameters**

diff --git a/avm/ptn/ai-platform/baseline/README.md b/avm/ptn/ai-platform/baseline/README.md
@@ -142,6 +142,25 @@ module baseline 'br/public:avm/ptn/ai-platform/baseline:<version>' = {
 </details>
 <p>
 
+<details>
+
+<summary>via Bicep parameters file</summary>
+
+```bicep-params
+using 'br/public:avm/ptn/ai-platform/baseline:<version>'
+
+// Required parameters
+param name = '<name>'
+// Non-required parameters
+param virtualMachineConfiguration = {
+  adminPassword: '<adminPassword>'
+  adminUsername: 'localAdminUser'
+}
+```
+
+</details>
+<p>
+
 ### Example 2: _Using large parameter set_
 
 This instance deploys the module with most of its features enabled.
@@ -410,6 +429,123 @@ module baseline 'br/public:avm/ptn/ai-platform/baseline:<version>' = {
 </details>
 <p>
 
+<details>
+
+<summary>via Bicep parameters file</summary>
+
+```bicep-params
+using 'br/public:avm/ptn/ai-platform/baseline:<version>'
+
+// Required parameters
+param name = 'aipbmax'
+// Non-required parameters
+param applicationInsightsConfiguration = {
+  name: 'appi-aipbmax'
+}
+param bastionConfiguration = {
+  disableCopyPaste: true
+  enabled: true
+  enableFileCopy: true
+  enableIpConnect: true
+  enableKerberos: true
+  enableShareableLink: true
+  name: 'bas-aipbmax'
+  networkSecurityGroupResourceId: '<networkSecurityGroupResourceId>'
+  scaleUnits: 3
+  sku: 'Standard'
+  subnetAddressPrefix: '10.1.1.0/26'
+}
+param containerRegistryConfiguration = {
+  name: 'craipbmax'
+  trustPolicyStatus: 'disabled'
+}
+param keyVaultConfiguration = {
+  enablePurgeProtection: false
+  name: '<name>'
+}
+param logAnalyticsConfiguration = {
+  name: 'log-aipbmax'
+}
+param managedIdentityName = '<managedIdentityName>'
+param storageAccountConfiguration = {
+  allowSharedKeyAccess: true
+  name: 'staipbmax'
+  sku: 'Standard_GRS'
+}
+param virtualMachineConfiguration = {
+  adminPassword: '<adminPassword>'
+  adminUsername: 'localAdminUser'
+  enableAadLoginExtension: true
+  enableAzureMonitorAgent: true
+  enabled: true
+  encryptionAtHost: false
+  imageReference: {
+    offer: 'dsvm-win-2022'
+    publisher: 'microsoft-dsvm'
+    sku: 'winserver-2022'
+    version: 'latest'
+  }
+  maintenanceConfigurationResourceId: '<maintenanceConfigurationResourceId>'
+  name: '<name>'
+  nicConfigurationConfiguration: {
+    ipConfigName: 'ipcfg-aipbmax'
+    name: 'nic-aipbmax'
+    networkSecurityGroupResourceId: '<networkSecurityGroupResourceId>'
+    privateIPAllocationMethod: 'Dynamic'
+  }
+  osDisk: {
+    caching: 'ReadOnly'
+    createOption: 'FromImage'
+    deleteOption: 'Delete'
+    diskSizeGB: 256
+    managedDisk: {
+      storageAccountType: 'Standard_LRS'
+    }
+    name: 'disk-aipbmax'
+  }
+  patchMode: 'AutomaticByPlatform'
+  size: 'Standard_DS1_v2'
+  zone: 0
+}
+param virtualNetworkConfiguration = {
+  addressPrefix: '10.1.0.0/16'
+  enabled: true
+  name: 'vnet-aipbmax'
+  subnet: {
+    addressPrefix: '10.1.0.0/24'
+    name: 'snet-aipbmax'
+    networkSecurityGroupResourceId: '<networkSecurityGroupResourceId>'
+  }
+}
+param workspaceConfiguration = {
+  computes: [
+    {
+      computeType: 'ComputeInstance'
+      description: 'Default'
+      location: '<location>'
+      name: '<name>'
+      properties: {
+        vmSize: 'STANDARD_DS11_V2'
+      }
+      sku: 'Standard'
+    }
+  ]
+  name: 'hub-aipbmax'
+  networkIsolationMode: 'AllowOnlyApprovedOutbound'
+  networkOutboundRules: {
+    rule1: {
+      category: 'UserDefined'
+      destination: 'pypi.org'
+      type: 'FQDN'
+    }
+  }
+  projectName: 'project-aipbmax'
+}
+```
+
+</details>
+<p>
+
 ### Example 3: _Without virtual machine_
 
 This instance deploys the module with a virtual network, but no virtual machine or Azure Bastion host.
@@ -470,6 +606,27 @@ module baseline 'br/public:avm/ptn/ai-platform/baseline:<version>' = {
 </details>
 <p>
 
+<details>
+
+<summary>via Bicep parameters file</summary>
+
+```bicep-params
+using 'br/public:avm/ptn/ai-platform/baseline:<version>'
+
+// Required parameters
+param name = '<name>'
+// Non-required parameters
+param bastionConfiguration = {
+  enabled: false
+}
+param virtualMachineConfiguration = {
+  enabled: false
+}
+```
+
+</details>
+<p>
+
 ### Example 4: _Without virtual network_
 
 This instance deploys the module without a virtual network, virtual machine or Azure Bastion host.
@@ -522,6 +679,24 @@ module baseline 'br/public:avm/ptn/ai-platform/baseline:<version>' = {
 </details>
 <p>
 
+<details>
+
+<summary>via Bicep parameters file</summary>
+
+```bicep-params
+using 'br/public:avm/ptn/ai-platform/baseline:<version>'
+
+// Required parameters
+param name = '<name>'
+// Non-required parameters
+param virtualNetworkConfiguration = {
+  enabled: false
+}
+```
+
+</details>
+<p>
+
 ### Example 5: _WAF-aligned_
 
 This instance deploys the module in alignment with the best-practices of the Azure Well-Architected Framework.
@@ -628,6 +803,48 @@ module baseline 'br/public:avm/ptn/ai-platform/baseline:<version>' = {
 </details>
 <p>
 
+<details>
+
+<summary>via Bicep parameters file</summary>
+
+```bicep-params
+using 'br/public:avm/ptn/ai-platform/baseline:<version>'
+
+// Required parameters
+param name = '<name>'
+// Non-required parameters
+param managedIdentityName = '<managedIdentityName>'
+param tags = {
+  Env: 'test'
+  'hidden-title': 'This is visible in the resource name'
+}
+param virtualMachineConfiguration = {
+  adminPassword: '<adminPassword>'
+  adminUsername: 'localAdminUser'
+  enableAadLoginExtension: true
+  enableAzureMonitorAgent: true
+  maintenanceConfigurationResourceId: '<maintenanceConfigurationResourceId>'
+  patchMode: 'AutomaticByPlatform'
+  zone: 1
+}
+param workspaceConfiguration = {
+  networkIsolationMode: 'AllowOnlyApprovedOutbound'
+  networkOutboundRules: {
+    rule: {
+      category: 'UserDefined'
+      destination: {
+        serviceResourceId: '<serviceResourceId>'
+        subresourceTarget: 'blob'
+      }
+      type: 'PrivateEndpoint'
+    }
+  }
+}
+```
+
+</details>
+<p>
+
 ## Parameters
 
 **Required parameters**