[AVM Module Issue]: avm/res/sql/server module documentation

[jikuja]

Check for previous/existing GitHub issues

• [X] I have checked for previous/existing GitHub issues

Issue Type?

Feature Request

Module Name

avm/res/sql/server

(Optional) Module Version

No response

Description

I propose follwing documentation additions for avm/res/sql/server

Network

• publicNetworkAccess has not to be Disabled to use firewallRules
• Error message: Status Message: Unable to create or modify firewall rules when public network interface for the server is disabled. To manage server or database level firewall rules, please enable the public network interface. (Code:DenyPublicEndpointEnabled)
  • I personally used too much time to understand that publicNetworkAccess is actually enableFirewallRules but PG's lingo is just weird

Audit settings

• Should be documented
• Should be documented that storageAccountResourceId can be only null when isAzureMonitorTargetEnabled is true
  • Error message: Status Message: Invalid parameter 'storageEndpoint'. Value should be a blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). (Code:DataSecurityInvalidUserSuppliedParameter)

Administrator configs

After my initial failures I did following testing:

X = passed suitable value

administratorLogin	administratorLoginPassword	administrators	AAD only	AD SID	AD login	result
X	X	Yes	false	X	X	success
not given	not given	Yes	false	X	X	fail(1)
not given	not given	Yes	true	X	X	success
X	X	No	-	-	-	success
X	not given	Yes	true	X	X	fail(2)
not given	X	Yes	true	X	X	fail(1)

(1) Invalid value given for parameter Login. Specify a valid parameter value. (Code: InvalidParameterValue) (2) - Invalid value given for parameter Password. Specify a valid parameter value. (Code:InvalidParameterValue)

Documentation does not mention that internal login and password must be supplied if azureADOnlyAuthentication = false Only following is available on docs: The administrator username for the server. Required if no administrators object for AAD authentication is provided.

The error message RP is providing is really misleading because administrators object has login property but resource properties has administratorLogin

(Optional) Correlation Id

No response

[microsoft-github-policy-service[bot]]

[!IMPORTANT] The "Needs: Triage :mag:" label must be removed once the triage process is complete!

[!TIP] For additional guidance on how to triage this issue/PR, see the BRM Issue Triage documentation.

[avm-team-linter[bot]]

@jikuja, thanks for submitting this issue for the avm/res/sql/server module!

[!IMPORTANT] A member of the @Azure/avm-res-sql-server-module-owners-bicep or @Azure/avm-res-sql-server-module-contributors-bicep team will review it soon!