From 90e7f301aa93f4089b632c1e7b92f3685c0961f3 Mon Sep 17 00:00:00 2001 From: Ahmad Abdalla <28486158+ahmadabdalla@users.noreply.github.com> Date: Tue, 24 Oct 2023 09:51:34 +1100 Subject: [PATCH] [Modules] Hotfix for the App Service Plan module to fix the conditional parameter description (#4144) * Quick fix to the App Service Plan Module * Updated parameter description --- modules/web/serverfarm/README.md | 4 ++-- modules/web/serverfarm/main.bicep | 2 +- modules/web/serverfarm/main.json | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/modules/web/serverfarm/README.md b/modules/web/serverfarm/README.md index 63e124fbc3..65ce8f30ab 100644 --- a/modules/web/serverfarm/README.md +++ b/modules/web/serverfarm/README.md @@ -161,7 +161,7 @@ module serverfarm 'br:bicep/modules/web.serverfarm:1.0.0' = { | Parameter | Type | Description | | :-- | :-- | :-- | -| [`reserved`](#parameter-reserved) | bool | When creating a Linux App Service Plan, the reserved field must be set to true, and when creating a Windows/app App Service Plan the reserved field must be set to false. | +| [`reserved`](#parameter-reserved) | bool | Defaults to false when creating Windows/app App Service Plan. Required if creating a Linux App Service Plan and must be set to true. | **Optional parameters** @@ -308,7 +308,7 @@ If true, apps assigned to this App Service plan can be scaled independently. If ### Parameter: `reserved` -When creating a Linux App Service Plan, the reserved field must be set to true, and when creating a Windows/app App Service Plan the reserved field must be set to false. +Defaults to false when creating Windows/app App Service Plan. Required if creating a Linux App Service Plan and must be set to true. - Required: No - Type: bool - Default: `False` diff --git a/modules/web/serverfarm/main.bicep b/modules/web/serverfarm/main.bicep index 342503d5f1..05345e30c2 100644 --- a/modules/web/serverfarm/main.bicep +++ b/modules/web/serverfarm/main.bicep @@ -26,7 +26,7 @@ param location string = resourceGroup().location ]) param kind string = 'Windows' -@description('Conditional. When creating a Linux App Service Plan, the reserved field must be set to true, and when creating a Windows/app App Service Plan the reserved field must be set to false.') +@description('Conditional. Defaults to false when creating Windows/app App Service Plan. Required if creating a Linux App Service Plan and must be set to true.') param reserved bool = false @description('Optional. The Resource ID of the App Service Environment to use for the App Service Plan.') diff --git a/modules/web/serverfarm/main.json b/modules/web/serverfarm/main.json index a7e447770f..f479b9e5e9 100644 --- a/modules/web/serverfarm/main.json +++ b/modules/web/serverfarm/main.json @@ -6,7 +6,7 @@ "_generator": { "name": "bicep", "version": "0.22.6.54827", - "templateHash": "4349826726843363999" + "templateHash": "17683178516724577324" }, "name": "App Service Plans", "description": "This module deploys an App Service Plan.", @@ -145,7 +145,7 @@ "type": "bool", "defaultValue": false, "metadata": { - "description": "Conditional. When creating a Linux App Service Plan, the reserved field must be set to true, and when creating a Windows/app App Service Plan the reserved field must be set to false." + "description": "Conditional. Defaults to false when creating Windows/app App Service Plan. Required if creating a Linux App Service Plan and must be set to true." } }, "appServiceEnvironmentId": {