[Feature Request]: Dependencies approach fixes and updates

[eriqua]

Description

This issue is about keeping track of minor suggested fixes/enhancements to the new self-contained testing approach.

The listed feedback is not intended to be blocking for the many open PRs converting module testing to the new dependencies approach, but still nice to have. Requires agreement on implementation.

Note: Best would be to integrate the following points into the release, however it would be fine for minor points to be postponed.

• [Testing] Update deploy.test.bicep formatting #2396

  In particular, section names and spacing e.g. use // Dependencies // instead of generic // Deployments // for the dependencies section.

• Discuss the need of a variables section in test templates #2397

  Should dependencies resource names be defined in a variables section or directly in the resource section? Adding variables would lead to a bigger file but wouls avoid duplication in case multiple occurrences of the same name are needed

• Align deployment names for the dependency files #2412

• Rename resourceGroupResources to nestedDependencies in all deploy.test.bicep #2413

  e.g., compute images need roleassignment at subscription scope

• (separate) Align resource naming accross all dependeny tests #2414

  Currently inconsistently using dashes (-) or not always using incremental number suffix (e.g. 001)
  Create consistent naming conventions for resources #1265. See started discussion here

• Update the deployment name of the nestedDependencies deployment block #2415

• Document the convention for the serviceShort value generation #2416

  Related tom/[Modules] Updated VirtualNetwork to new dependency approach #1884#discussion_r973764946)

• [Bug Report]: Fix replicated typos across deploy.test.bicep templates #2417

  • @description('Optional. The name of the resource group to deploy for a testing purposes.') should be @description('Optional. The name of the resource group to deploy for testing purposes.')

• Improve deployment scripts formatting (e.g. add synopsis). Discuss if scripts should be moved to the modules global folder if used more than once #2619

The issue is blocked by #1791 or at least by the merge of all currently open PRs.
Implement the changes as a bulk edit once all related PRs will be merged.