Page Comparison

Proposed Naming Convention from Azure

...

Initial IdeasAccess to Resources

• Log in at portal.azure.com:

  • If you’ve been assigned a Unity ID (<____>@ncsu.edu), log in using that. If you’re a partner at another institution, check with Brian that you’ve been granted guess access through OIT to use your existing email.

• Always make sure to put new resource groups and resources in the CALS - PSA subscription, not the similar and easily missed CALS subscription.

• Resources should be stored within dedicated resource groups per project. There can be multiple services for a particular project within the RG, but there shouldn’t be resources that aren’t logically linked within the same RG.

  • Some resources spawn many sub-services when you create them, like VMs, which create a resource for the VM itself, a disk, and networking all named similarly. Be mindful of clutter when you’re documenting the lifecycle of a resource.

  • For example: A single database and an API to access it that’s running as a serverless function should be in an RG named <proj_name>-<db_type>-api.

• Document the creation or migration of an RG and resources in this page <link to be added> so that we can track ownership and when orphaned resources can be culled.

...

Naming Convention for Azure Resources

All resources should follow the following naming convention

<app-name>-<environment suffix>-<resource type abbreviation>

• Virtual machines

  • Type abbreviation: vm

  • Example: vm-tech-dashboard-prodproduction-eastus-001vm

• Databases

  • type Type abbreviations: Postgres → psql pgsql, MySQL → -> mysql

  • Example: psql-crown-prodproduction-eastus-001pgsql

• Azure functions

  • type Type abbreviation: func

  • Example: func-corrections-api-devdevelop-eastus-001func

• App service plans

  • type Type abbreviation: plan

  • Example: plan-ssurgo-api-stage-eastus-001plan

• Storage accounts

  • type Type abbreviation: st

  • Example: st-weeds-image-repo-prodproduction-eastus-001st

• Container registry

  • type Type abbreviation: cr

  • Example: cr-db-copies-prodproduction-eastus-001cr

Useful Links

...

1. https://docs.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/resource-naminghttps://docs.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/resource-abbreviations

2. https://docs.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/resource-tagging

3. https://docs.microsoft.com/en-us/azure/cloud-adoption-framework/decision-guides/resource-tagging/

4. https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/resource-name-rules