Skip to content

Commit 024dcc5

Browse files
committed
Publish Azure Resource Naming Considerations
1 parent 23c205d commit 024dcc5

File tree

3 files changed

+52
-98
lines changed

3 files changed

+52
-98
lines changed

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: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
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.assetid: 9790239d-b18b-468d-b539-fb868a85a868
10+
ms.service: Azure-government
11+
ms.devlang: na
12+
ms.topic: article
13+
ms.tgt_pltfrm: na
14+
ms.workload: Azure-government
15+
ms.date: 3/17/2020
16+
ms.author: beellis
17+
18+
---
19+
# Considerations for Naming Azure Resources
20+
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.
21+
Azure Resource Names are a subset of Object Metadata that includes 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 object metadata inside the resource (for example, database column/table names). Azure Resource Names include the names a customer assigns to ARM-level objects and resources deployed in Azure. Examples include the names of resources such as:
22+
* vNETs (Virtual Networks)
23+
* Virtual Hard Disks (VHDs)
24+
* Database Servers & Databases
25+
* Virtual Network Interface
26+
* Network Security Groups
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+
## Azure Resource 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/en-us/microsoft-365/compliance/offering-itar?view=o365-worldwide), [CJIS](https://docs.microsoft.com/en-us/microsoft-365/compliance/offering-cjis?view=o365-worldwide), etc.), as applicable.
44+
45+
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:
46+
47+
* 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.
48+
* Microsoft product engineering personnel could use full resource IDs during routine monitoring of telemetry data to identify deviance from baseline/average system performance.
49+
* Proactive communication to customers about impacted resources during internally discovered incidents.

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

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

0 commit comments

Comments
 (0)