Definiowanie konwencji nazewnictwa
Dobra nazwa zasobu ułatwia szybkie identyfikowanie jego typu, skojarzonego obciążenia, środowiska i regionu świadczenia usługi Azure, w którym działa. W tym celu nazwy powinny być zgodne ze spójnym formatem — konwencją nazewnictwa — która składa się z ważnych informacji o każdym zasobie. Informacje w nazwach najlepiej zawierają informacje potrzebne do identyfikowania określonych wystąpień zasobów. Na przykład publiczny adres IP (PIP) dla produkcyjnego obciążenia programu SharePoint w regionie Zachodniego USA może być pip-sharepoint-prod-westus-001
.
Diagram 1: przykład składników w nazwie zasobu platformy Azure.
Notatka
Należy wziąć pod uwagę, że nie wszystkie zasoby platformy Azure mogą być zgodne z tymi samymi wzorcami. Upewnij się, że rozumiesz ograniczenia typów zasobów, z którymi pracujesz.
Aby dowiedzieć się więcej, zobacz Reguły nazewnictwa i ograniczenia dotyczące zasobów platformy Azure.
Zalecane składniki nazewnictwa
Podczas konstruowania konwencji nazewnictwa zidentyfikuj kluczowe informacje, które mają zostać przechwycone w nazwie zasobu. Różne informacje są istotne dla różnych typów zasobów, a nie wszystkie ustalone składniki nazewnictwa mogą być używane dla każdego typu zasobu. Ustanów standardową konwencję nazewnictwa dla środowiska, która jest łatwa do naśladowania, zwięzła i przydatna do rozpoznawania informacji istotnych dla wdrożonego zasobu.
Poniższa lista zawiera przykłady składników nazewnictwa przydatnych podczas tworzenia nazw zasobów:
Komponent nazewniczy | Opis |
---|---|
organizacja | Nazwa najwyższego poziomu organizacji, zwykle używana jako górna grupa zarządzania lub, w mniejszych organizacjach, część konwencji nazewnictwa. Przykład: contoso |
jednostka biznesowa lub dział | Dział najwyższego poziomu firmy, który jest właścicielem subskrypcji lub obciążenia, do którego należy zasób. W mniejszych organizacjach ten składnik może reprezentować jeden firmowy, najwyższy poziom elementu organizacyjnego. Przykłady: fin , mktg , product , it , corp |
typ zasobu | Skrót reprezentujący typ zasobu lub składnika platformy Azure. Ten składnik jest często prefiksem lub sufiksem w nazwie. Aby uzyskać więcej informacji, zobacz Zalecane skróty typów zasobów platformy Azure. Przykłady: rg , vm |
Obciążenie, aplikacja lub projekt | Nazwa obciążenia, aplikacji lub projektu, którego częścią jest zasób. Przykłady: navigator , emissions , sharepoint , hadoop |
Środowisko | Etap cyklu rozwoju dla obciążenia obsługiwanego przez zasób. Przykłady: prod , dev , qa , stage , test |
Regionu | Region lub dostawca usług w chmurze, w którym wdrożono zasób. Przykłady: westus , eastus2 , westeu , usva , ustx |
Instancja | Liczba wystąpień dla określonego zasobu, aby odróżnić je od innych zasobów, które mają tę samą konwencję nazewnictwa i składniki nazewnictwa. Przykłady, 01 , 001 |
Zagadnienia dotyczące nazewnictwa
Oprócz definiowania składników nazewnictwa należy również wziąć pod uwagę kolejność, w jakiej składniki nazewnictwa są wymienione i jakiego typu ograniczniki (jeśli istnieją) powinny być wyświetlane między składnikami. Uwzględnij również różne reguły nazewnictwa skojarzone z typami zasobów.
Zakres
Wszystkie typy zasobów platformy Azure mają zakres, który definiuje poziom tego zasobu. Ponadto zasób musi mieć unikatową nazwę w swoim zakresie.
Poziomy zakresu dla nazw zasobów platformy Azure:
globalne: unikatowe na całej platformie Azure.
Przykład: nazwa zasobów PaaS z publicznymi punktami końcowymi ip na całej platformie Azure, ponieważ ta nazwa jest początkową domyślną publiczną nazwą DNS.
grupa zasobów: unikatowa w grupie zasobów.
Przykład: wszystkie sieci wirtualne w grupie zasobów muszą mieć unikatową nazwę routingu w ramach tej grupy zasobów.
zasób: unikalny w ramach zasobu nadrzędnego.
Przykład: wszystkie podsieci w sieci wirtualnej muszą mieć unikatowe nazwy, aby uniknąć nakładania się segmentów.
Diagram 2: Poziomy zakresu dla nazw zasobów Azure.
Na przykład sieć wirtualna ma zakres grupy zasobów, co oznacza, że w określonej grupie zasobów może istnieć tylko jedna sieć o nazwie vnet-prod-westus-001
. Inne grupy zasobów mogą również mieć sieci wirtualne o nazwie vnet-prod-westus-001
, ale każda grupa zasobów może mieć tylko jedną z tą nazwą. Podsieci są ograniczone do sieci wirtualnych, więc każda podsieć w sieci wirtualnej musi mieć odrębną nazwę.
Niektóre nazwy zasobów mają zakres globalny, taki jak nazwa platformy jako usługi (PaaS), która ma publiczny punkt końcowy lub etykietę DNS maszyny wirtualnej. Zasób w zakresie globalnym musi mieć nazwę unikatową dla całej platformy Azure.
Reguły nazewnictwa platformy Azure
Reguły nazewnictwa platformy Azure różnią się w zależności od typu zasobu. Ważne jest, aby zrozumieć reguły nazewnictwa dla każdego typu zasobu, aby uniknąć nieporozumień i opóźnień.
Na przykład nazwy zasobów dla różnych typów zasobów mogą mieć różne limity długości. Zalecamy, aby nazwy składników były krótkie lub skracane, co pomoże zapobiec przekroczeniu limitów długości nazw zasobów.
Podczas konstruowania konwencji nazewnictwa zidentyfikuj kluczowe informacje, które mają zostać odzwierciedlone w nazwie zasobu. Różne informacje są istotne dla różnych typów zasobów.
Zalecenia dotyczące :
- Omówienie reguł i ograniczeń nazewnictwa: równoważenie kontekstu nazwy z jej zakresem i limitem długości jest ważne podczas opracowywania konwencji nazewnictwa. Aby uzyskać więcej informacji, zobacz Reguły nazewnictwa i ograniczenia dotyczące zasobów platformy Azure.
- Użyj zalecanych skrótów zasobów: skróty mogą pomóc zachować nazwy zasobów w granicach długości i ułatwić ich odczytywanie. Aby uzyskać więcej informacji, zobacz Zalecane skróty typów zasobów platformy Azure.
- Rozważ spójność nazewnictwa maszyn wirtualnych: jeśli pracujesz z maszynami wirtualnymi na platformie Azure, zalecamy zachowanie spójności nazw, mimo że nazwy maszyn wirtualnych na platformie Azure mogą być dłuższe niż dozwolona nazwa NetBIOS maszyny wirtualnej. Aby uzyskać więcej informacji oraz zapoznać się z innymi ograniczeniami, zobacz Konwencje nazewnictwa w usłudze Active Directory dla komputerów, domen, lokacji i jednostek organizacyjnych — nazwy komputerów.
- Użyj narzędzia Azure Naming Tool: Narzędzie Azure Naming Tool to narzędzie ułatwiające generowanie nazw zasobów platformy Azure na podstawie konwencji nazewnictwa. Aby uzyskać więcej informacji, zobacz Azure Naming Tool.
Przykładowe nazwy
Podczas definiowania konwencji nazewnictwa należy wziąć pod uwagę te przykłady. Przykłady są oparte na składnikach nazewnictwa i zagadnieniach opisanych w tym artykule.
Poniższe przykłady mają na celu przedstawienie wizualizacji konwencji nazewnictwa, ale rzeczywiste konwencje różnią się w zależności od organizacji. Aby uzyskać więcej przykładów, zobacz Azure Naming Tool.
Przykładowe nazwy: Ogólne
Typ zasobu | Zakres | Formatowanie i przykłady |
---|---|---|
Grupa zarządzania | Jednostka biznesowa i/lub środowisko |
mg-<jednostka biznesowa>[-<środowiska>] mg-mktg mg-hr mg-corp-prod mg-fin-client |
Subskrypcja | Konto/umowa Enterprise Agreement |
<jednostka biznesowa>- cel subskrypcji<>-<###> mktg-prod-001 corp-shared-001 fin-client-001 |
grupa zasobów | Subskrypcja |
>
>
<nazwa aplikacji lub usługi —<>—<###> rg-mktgsharepoint-prod-001 rg-acctlookupsvc-shared-001 rg-ad-dir-services-shared-001 |
wystąpienie zarządzania usługą API | Globalny |
apim — nazwa aplikacji lub usługi<> apim-navigator-prod |
zarządzana tożsamość | Grupa zasobów |
id—<nazwa aplikacji lub usługi>—>środowiska<— nazwa regionu<>—<###> id-appcn-keda-prod-eastus2-001 |
Przykładowe nazwy: Sieć
Typ zasobu | Zakres | Formatowanie i przykłady |
---|---|---|
sieć wirtualna | Grupa zasobów |
vnet-<cel subskrypcji>— region<>—<###> vnet-shared-eastus2-001 vnet-prod-westus-001 vnet-client-eastus2-001 |
podsieć | Sieć wirtualna |
snet-<cel subskrypcji>—<region>—<###> snet-shared-eastus2-001 snet-prod-westus-001 snet-client-eastus2-001 |
interfejsu sieciowego (NIC) |
Grupa zasobów |
nic—<##>—<nazwa maszyny wirtualnej>—<cel subskrypcji>-<###> nic-01-dc1-shared-001 nic-02-vmhadoop1-prod-001 nic-02-vmtest1-client-001 |
publiczny adres IP | Grupa zasobów |
—<nazwa maszyny wirtualnej lub nazwa aplikacji>—<środowisko>—<region>—<###> pip-dc1-shared-eastus2-001 pip-hadoop-prod-westus-001 |
Równoważnik obciążenia (zewnętrzny) | Grupa zasobów |
<nazwa aplikacji lub rola>—<środowisko>—<###> lbe-navigator-prod-001 lbe-sharepoint-dev-001 |
grupa zabezpieczeń sieci (NSG) | Podsieć lub karta sieciowa |
nsg — nazwa zasad<lub nazwa aplikacji>—<###> nsg-weballow-001 nsg-rdpallow-001 nsg-sqlallow-001 nsg-dnsblocked-001 |
brama sieci lokalnej | Brama wirtualna | lgw-shared-eastus2-001 lgw-prod-westus-001 lgw-client-eastus2-001 |
Brama sieci wirtualnej | Sieć wirtualna |
vgw-<cel subskrypcji>-<region>-<###> vgw-shared-eastus2-001 vgw-prod-westus-001 vgw-client-eastus2-001 |
połączenie sieci VPN | Grupa zasobów |
vcn-<subscription1 purpose>>—<region1>—<subscription2 purpose>>—<region2>— vcn-shared-eastus2-to-shared-westus vcn-prod-eastus2-to-prod-westus |
tabeli tras |
Grupa zasobów |
rt-<nazwa tabeli tras> rt-navigator rt-sharepoint |
etykieta DNS | Globalny |
<rekord DNS typu A dla maszyny wirtualnej>.<region>.cloudapp.azure.com dc1.westus.cloudapp.azure.com web1.eastus2.cloudapp.azure.com |
Przykładowe nazwy: Obliczenia i sieć Web
Typ zasobu | Zakres | Formatowanie i przykłady |
---|---|---|
maszyna wirtualna | Grupa zasobów |
<obciążenia, aplikacji lub>projektu —>środowiska<—<###> vm-sql-test-001 vm-hadoop-prod-001 vm-sharepoint-dev-001 |
Aplikacja internetowa | Globalny |
<obciążenia, aplikacji lub>projektu —>środowiska<—<###>.azurewebsites.net app-navigator-prod-001.azurewebsites.net app-accountlookup-dev-001.azurewebsites.net |
aplikacja funkcji | Globalny |
func-<obciążenia, aplikacji lub>projektu —>środowiska<—<###>.azurewebsites.net func-navigator-prod-001.azurewebsites.net func-accountlookup-dev-001.azurewebsites.net |
Przykładowe nazwy: Bazy danych
Typ zasobu | Zakres | Formatowanie i przykłady |
---|---|---|
baza danych Azure SQL | Azure SQL Server |
sqlbd — obciążenie<, aplikacja lub projekt>— środowisko<> sqldb-users-prod sqldb-users-dev |
bazy danych usługi Azure Cosmos DB | Globalny |
cosmos -<obciążenia, aplikacji lub projektu>-<środowiska> cosmos-navigator-prod cosmos-emissions-dev |
wystąpienia usługi Azure Cache for Redis | Globalny |
redis-<obciążenia, aplikacji lub projektu>-<środowiska> redis-navigator-prod redis-emissions-dev |
Przykładowe nazwy: Storage
Typ zasobu | Zakres | Formatowanie i przykłady |
---|---|---|
Konto magazynowe (ogólnego użycia) | Globalny |
obciążenie, aplikacja lub projekt<><###> stnavigatordata001 stemissionsoutput001 |
Azure StorSimple | Globalny |
<obciążenia, aplikacji lub środowiska><projektu> ssimpnavigatorprod ssimpemissionsdev |
usługi Azure Container Registry | Globalny |
<obciążenia, aplikacji lub środowiska><projektu><###> crnavigatorprod001 |
Przykładowe nazwy: sztuczna inteligencja i uczenie maszynowe
Typ zasobu | Zakres | Formatowanie i przykłady |
---|---|---|
Usługa wyszukiwania Azure AI | Global |
<obciążenia, aplikacji, projektu lub środowiska>—<> srch-navigator-prod srch-emissions-dev |
Azure OpenAI Service | Grupa zasobów |
obciążenie, aplikacja lub projekt<>—<środowisko> oai-navigator-prod oai-emissions-dev |
obszaru roboczego usługi Azure Machine Learning | Grupa zasobów |
<obciążenia, aplikacji lub projektu>—<środowiska> mlw-navigator-prod mlw-emissions-dev |
Przykładowe nazwy: Analiza i IoT
Typ zasobu | Zakres | Formatowanie i przykłady |
---|---|---|
Azure Analysis Services | Globalny |
nazwa aplikacji<środowisko><> asnavigatorprod asemissionsdev |
Azure Data Factory | Globalny |
obciążenia, aplikacji lub projektu><<—<środowiska> adf-navigator-prod adf-emissions-dev |
obszarów roboczych usługi Azure Synapse Analytics | Grupa zasobów |
<środowisko obciążenia, aplikacji lub>projektu –<> synw-navigator-prod synw-emissions-dev |
konto usługi Data Lake Storage | Globalny |
<obciążenia, aplikacji lub środowiska><projektu> dlsnavigatorprod dlsemissionsdev |
centrum IoT | Globalny |
obciążenia<, aplikacji lub projektu>— środowiska<> iot-navigator-prod iot-emissions-dev |
Przykładowe nazwy: Integracja
Typ zasobu | Zakres | Format i przykłady |
---|---|---|
przestrzeni nazw usługi |
Globalny |
sbns — obciążenie<, aplikacja lub>projektu — środowisko<>.servicebus.windows.net sbns-navigator-prod.servicebus.windows.net sbns-emissions-dev.servicebus.windows.net |
kolejki Service Bus | Service Bus |
<obciążenie, aplikacja lub projekt> sbq-navigator |
temat usługi Service Bus | Service Bus |
sbt-<obciążenia, aplikacji lub projekt> sbt-navigator |
Następny krok
Dobrym następnym krokiem jest zapoznanie się z zalecanymi skrótami zasobów platformy Azure. Skróty mogą pomóc zachować nazwy zasobów w granicach długości i ułatwić ich odczytywanie.