Skip to content

Commit b203ab8

Browse files
authored
Merge pull request #108085 from bernie-msft/azureresourcenaming_v1
Publish Azure Resource Naming Considerations
2 parents 8cb2aa8 + 817f52f commit b203ab8

File tree

4 files changed

+62
-98
lines changed

4 files changed

+62
-98
lines changed

.openpublishing.redirection.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4055,6 +4055,11 @@
40554055
"redirect_url": "/azure/azure-government/documentation-government-welcome",
40564056
"redirect_document_id": false
40574057
},
4058+
{
4059+
"source_path": "articles/azure-government/documentation-government-k8.md",
4060+
"redirect_url": "/azure/azure-government",
4061+
"redirect_document_id": false
4062+
},
40584063
{
40594064
"source_path": "articles/azure-portal/resource-group-portal-linked-resources.md",
40604065
"redirect_url": "/azure/azure-portal/azure-portal-dashboards",

articles/azure-government/TOC.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@
2424
- name: Create Virtual Machines
2525
href: documentation-government-quickstarts-vm.md
2626
- name: Concepts
27-
items:
27+
items:
28+
- name: Considerations for Naming Azure Resources
29+
href: documentation-government-concept-naming-resources.md
2830
- name: Guidance for developers
2931
href: documentation-government-developer-guide.md
3032
- name: Plan
@@ -51,8 +53,6 @@
5153
href: documentation-government-get-started-connect-to-storage.md
5254
- name: Use Cognitive Services API
5355
href: documentation-government-cognitiveservices.md
54-
- name: Deploy Kubernetes cluster
55-
href: documentation-government-k8.md
5656
- name: Integrate Azure AD Authentication
5757
href: documentation-government-aad-auth-qs.md
5858
- name: Use DISA CAP
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: Considerations for naming Azure resources | Microsoft Docs
3+
description: This article contains guidance on how customers should consider naming their Azure resources to prevent attribution to business/mission sensitive workloads.
4+
services: Azure-government
5+
cloud: gov
6+
author: bernie-msft
7+
manager: zakramer
8+
9+
ms.devlang: na
10+
ms.topic: article
11+
ms.tgt_pltfrm: na
12+
ms.service: azure-government
13+
ms.workload: Azure-government
14+
ms.date: 4/6/2020
15+
ms.author: beellis
16+
17+
---
18+
# Considerations for naming Azure resources
19+
Customers should not include sensitive or restricted information in Azure Resource Names because they may be stored or accessed outside the compliance boundary to facilitate support and troubleshooting.
20+
Azure Resource Names include information provided by you, or on your behalf, that is used to identify or configure Online Service resources, such as software, systems, or containers, but does **not** include customer-created content or metadata inside the resource (for example, database column/table names). Azure Resource Names include the names a customer assigns to Azure Resource Manager level objects and resources deployed in Azure. Examples include the names of resources such as:
21+
* VNets (Virtual Networks)
22+
* Virtual Hard Disks (VHDs)
23+
* Database Servers & Databases
24+
* Virtual Network Interface
25+
* Network Security Groups
26+
* Key Vaults
27+
28+
>[!NOTE]
29+
>The above examples are but a subset of the types of resources customers can name. This list is not meant to be fully exhaustive and the types of resources could change in the future as new cloud services are added.
30+
>
31+
32+
## Naming convention
33+
The names of Azure resources are part of a larger resource ID as follows:
34+
35+
`/subscriptions/<subscriptionID>/resourceGroups/<ResourceGroupName>/providers/<ResourceProvider>/<ResourceType>/<ResourceName>`
36+
37+
An example of a virtual machine resource ID is:
38+
39+
`/subscriptions/<subscriptionID>/resourceGroups/<ResourceGroupName>/providers/Microsoft.Compute/virtualMachines/<virtualMachineName>`
40+
41+
42+
## Naming considerations
43+
For all names that meet the criteria above, from the name of the larger resource group to the name of the end resources within it, customers should avoid names that are sensitive to business/mission functions. Customers should also avoid names that indicate customer regulatory requirements (e.g., [ITAR](https://docs.microsoft.com/microsoft-365/compliance/offering-itar?view=o365-worldwide), [CJIS](https://docs.microsoft.com/microsoft-365/compliance/offering-cjis?view=o365-worldwide), etc.), as applicable.
44+
45+
>[!NOTE]
46+
>Also consider naming of resource tags when reviewing the [Resource naming and tagging decision guide](https://docs.microsoft.com/azure/cloud-adoption-framework/decision-guides/resource-tagging/?toc=/azure/>azure-resource-manager/management/toc.json).
47+
>
48+
49+
Customers should understand and take into account the resource naming convention to help ensure operational security, as Microsoft personnel could use the full resource ID in the following example scenarios:
50+
51+
* Microsoft support personnel may use the full resource ID of resources during support events to ensure we're identifying the right resource within a customer's subscription to provide support for.
52+
* Microsoft product engineering personnel could use full resource IDs during routine monitoring of telemetry data to identify deviance from baseline/average system performance.
53+
* Proactive communication to customers about impacted resources during internally discovered incidents.
54+

articles/azure-government/documentation-government-k8.md

Lines changed: 0 additions & 95 deletions
This file was deleted.

0 commit comments

Comments
 (0)