Ćwiczenie — tworzenie i wdrażanie specyfikacji szablonu

Ukończone

Uwaga

Po pierwszym aktywowaniu piaskownicy i zaakceptowaniu warunków twoje konto Microsoft jest skojarzone z nowym katalogiem platformy Azure o nazwie Microsoft Learn Sandbox. Dodano cię również do specjalnej subskrypcji o nazwie Subskrypcja Concierge.

W firmie z toy twój zespół od jakiegoś czasu pracuje z platformą Azure i na co dzień utworzyłeś wiele szablonów, których używasz na co dzień. Decydujesz się na utworzenie jednego szablonu i utworzenie specyfikacji szablonu. Zaczynasz od szablonu używanego do tworzenia kont usługi Azure Cosmos DB.

Twój zespół zdecydował, że ciągła kopia zapasowa musi być skonfigurowana na wszystkich kontach usługi Azure Cosmos DB. Dlatego chcesz uwzględnić kopie zapasowe w domyślnej konfiguracji kont usługi Azure Cosmos DB, które są aprowidowane za pośrednictwem specyfikacji szablonu.

W tym ćwiczeniu opublikujesz szablon usługi Azure Cosmos DB jako specyfikację szablonu.

Podczas tego procesu wykonasz następujące czynności:

• Utwórz szablon, którego będziesz używać jako specyfikacji szablonu.
• Zaktualizuj szablon, aby upewnić się, że parametry są łatwe do zrozumienia i pracy z nim.
• Opublikuj specyfikację szablonu.
• Sprawdź specyfikację szablonu przy użyciu witryny Azure Portal.
• Wdróż specyfikację szablonu, aby ją przetestować.
• Zweryfikuj wdrożenie.

W tym ćwiczeniu jest używane rozszerzenie Bicep dla programu Visual Studio Code. Pamiętaj, aby zainstalować to rozszerzenie w programie Visual Studio Code.

Tworzenie szablonu

Zaczynasz od jednego z szablonów utworzonych przez zespół. Szablon wdraża konto usługi Azure Cosmos DB i konfiguruje je w celu włączenia ciągłej kopii zapasowej.

1. Otwórz Visual Studio Code.

2. Utwórz nowy plik o nazwie main.bicep.

3. Zapisz pusty plik, aby program Visual Studio Code ładował narzędzia Bicep.

   Możesz wybrać pozycję Plik>Zapisz jako lub wybrać Ctrl+S w systemie Windows (⌘+S w systemie macOS). Pamiętaj, gdzie zapisano plik. Na przykład możesz utworzyć folder scripts , aby go zapisać.

4. Skopiuj następujący kod do pliku main.bicep:

   param location string = resourceGroup().location
   param cosmosDBAccountName string = 'toy-${uniqueString(resourceGroup().id)}'
   
   resource cosmosDBAccount 'Microsoft.DocumentDB/databaseAccounts@2021-04-15' = {
     name: cosmosDBAccountName
     kind: 'GlobalDocumentDB'
     location: location
     properties: {
       consistencyPolicy: {
         defaultConsistencyLevel: 'Session'
       }
       locations: [
         {
           locationName: location
           failoverPriority: 0
           isZoneRedundant: false
         }
       ]
       databaseAccountOfferType: 'Standard'
       enableAutomaticFailover: false
       enableMultipleWriteLocations: false
       backupPolicy: {
         type: 'Continuous'
       }
     }
   }
   

   Zwróć uwagę, że ustawiono wartość backupPolicy Continuous. Ta wartość umożliwia skonfigurowanie usługi Azure Cosmos DB do tworzenia kopii zapasowych danych w sposób ciągły zamiast okresowo.

5. Zapisz plik.

1. Otwórz Visual Studio Code.

2. Utwórz nowy plik o nazwie azuredeploy.json.

3. Zapisz pusty plik, aby program Visual Studio Code ładował narzędzia szablonu usługi Azure Resource Manager (szablon arm).

   Możesz wybrać pozycję Plik>Zapisz jako lub wybrać Ctrl+S w systemie Windows (⌘+S w systemie macOS). Pamiętaj, gdzie zapisano plik. Na przykład możesz utworzyć folder scripts , aby go zapisać.

4. Skopiuj następujący kod do azuredeploy.json:

   {
     "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
     "contentVersion": "1.0.0.0",
     "parameters": {
       "location": {
         "type": "string",
         "defaultValue": "[resourceGroup().location]"
       },
       "cosmosDBAccountName": {
         "type": "string",
         "defaultValue": "[concat('toy-', uniqueString(resourceGroup().id))]"
       }
     },
     "resources": [
       {
         "type": "Microsoft.DocumentDB/databaseAccounts",
         "apiVersion": "2021-04-15",
         "name": "[parameters('cosmosDBAccountName')]",
         "kind": "GlobalDocumentDB",
         "location": "[parameters('location')]",
         "properties": {
           "consistencyPolicy": {
             "defaultConsistencyLevel": "Session"
           },
           "locations": [
             {
               "locationName": "[parameters('location')]",
               "failoverPriority": 0,
               "isZoneRedundant": false
             }
           ],
           "databaseAccountOfferType": "Standard",
           "enableAutomaticFailover": false,
           "enableMultipleWriteLocations": false,
           "backupPolicy": {
             "type": "Continuous"
           }
         }
       }
     ]
   }
   

   Zwróć uwagę, że dla parametru ustawiono backupPolicy wartość Continuous. Ta wartość umożliwia skonfigurowanie usługi Azure Cosmos DB do tworzenia kopii zapasowych danych w sposób ciągły zamiast okresowo.

5. Zapisz plik.

Ułatwiaj zrozumienie parametrów

Podczas pracy ze specyfikacjami szablonu ważne jest, aby wziąć pod uwagę sposób używania szablonu przez inne osoby. Ta recenzja jest szczególnie ważna w przypadku parametrów, ponieważ są one głównym sposobem interakcji innych osób z kodem. Parametry w szablonie zespołu nie zawierają opisów ani innych wskazówek dotyczących sposobu ich użycia, dlatego te informacje są dodawane tutaj.

1. Zaktualizuj definicję parametru location , dodając opis:

   @description('The Azure region into which the Cosmos DB resources should be deployed.')
   param location string = resourceGroup().location
   

2. Zaktualizuj definicję parametru cosmosDBAccountName , aby dodać opis i określić minimalną i maksymalną długość nazwy:

   @description('The name of the Cosmos DB account. This name must be globally unique, and it must only include lowercase letters, numbers, and hyphens.')
   @minLength(3)
   @maxLength(44)
   param cosmosDBAccountName string = 'toy-${uniqueString(resourceGroup().id)}'
   

3. Zapisz plik.

1. Zaktualizuj definicję parametru location , dodając opis:

   "location": {
     "type": "string",
     "defaultValue": "[resourceGroup().location]",
     "metadata": {
       "description": "The Azure region into which the Cosmos DB resources should be deployed."
     }
   },
   

2. Zaktualizuj definicję parametru cosmosDBAccountName , aby dodać opis i określić minimalną i maksymalną długość nazwy:

   "cosmosDBAccountName": {
     "type": "string",
     "defaultValue": "[concat('toy-', uniqueString(resourceGroup().id))]",
     "maxLength": 44,
     "minLength": 3,
     "metadata": {
       "description": "The name of the Cosmos DB account. This name must be globally unique, and it must only include lowercase letters, numbers, and hyphens."
     }
   }
   

3. Zapisz plik.

Logowanie się do platformy Azure

Aby wdrożyć ten szablon na platformie Azure, musisz zalogować się na konto platformy Azure z poziomu terminalu programu Visual Studio Code. Upewnij się, że zainstalowano interfejs wiersza polecenia platformy Azure i pamiętaj, aby zalogować się przy użyciu tego samego konta, które zostało użyte do aktywowania piaskownicy.

1. W menu Terminal wybierz polecenie New Terminal (Nowy terminal). Okno terminalu zwykle otwiera się w dolnej połowie ekranu.

2. Jeśli w oknie terminalu jest wyświetlana powłoka bash po prawej stronie, oznacza to, że prawidłowa powłoka jest już otwarta. Alternatywnie, jeśli po prawej stronie zostanie wyświetlona ikona powłoki bash, możesz ją wybrać, aby uruchomić powłokę.

   

   Jeśli zostanie wyświetlona powłoka inna niż powłoka bash , wybierz strzałkę listy rozwijanej powłoki, a następnie wybierz pozycję Git Bash.

   

3. W terminalu przejdź do katalogu, w którym zapisano szablon. Jeśli na przykład szablon został zapisany w folderze templates , możesz użyć następującego polecenia:

   cd templates
   

Instalowanie aplikacji Bicep

Uruchom następujące polecenie, aby upewnić się, że masz najnowszą wersję aplikacji Bicep:

az bicep install && az bicep upgrade

Logowanie się do platformy Azure

1. W terminalu programu Visual Studio Code zaloguj się do platformy Azure, uruchamiając następujące polecenie:

   az login
   

2. W przeglądarce, która zostanie otwarta, zaloguj się do konta platformy Azure. W terminalu programu Visual Studio Code zostanie wyświetlona lista subskrypcji skojarzonych z tym kontem. Wybierz subskrypcję o nazwie Subskrypcja Concierge.

   Jeśli ostatnio użyto więcej niż jednej piaskownicy, terminal może wyświetlić więcej niż jedno wystąpienie subskrypcji Concierge. W tym przypadku użyj dwóch następnych kroków, aby ustawić jedną jako domyślną subskrypcję.

   1. Pobierz identyfikatory subskrypcji Concierge.

        az account list \
         --refresh \
         --query "[?contains(name, 'Concierge Subscription')].id" \
         --output table
      

   2. Ustaw domyślną subskrypcję przy użyciu identyfikatora subskrypcji. Zastąp ciąg {your subscription ID} najnowszym identyfikatorem subskrypcji Concierge.

      az account set --subscription {your subscription ID}
      

Ustawianie domyślnej grupy zasobów

W przypadku korzystania z interfejsu wiersza polecenia platformy Azure możesz ustawić domyślną grupę zasobów i pominąć parametr z pozostałych poleceń interfejsu wiersza polecenia platformy Azure w tym ćwiczeniu. Ustaw wartość domyślną na grupę zasobów utworzoną dla Ciebie w środowisku piaskownicy.

az configure --defaults group="<rgn>[sandbox resource group name]</rgn>"

Aby wdrożyć ten szablon na platformie Azure, zaloguj się do konta platformy Azure z poziomu terminalu programu Visual Studio Code. Upewnij się, że zainstalowano program Azure PowerShell i zaloguj się do tego samego konta, na którym aktywowano piaskownicę.

1. W menu Terminal wybierz polecenie New Terminal (Nowy terminal). Okno terminalu zwykle otwiera się w dolnej połowie ekranu.

2. Jeśli w oknie terminalu jest wyświetlany program pwsh lub powershell po prawej stronie, oznacza to, że prawidłowa powłoka jest już otwarta. Alternatywnie, jeśli po prawej stronie zostanie wyświetlona ikona powłoki programu PowerShell, możesz ją wybrać, aby uruchomić powłokę.

   

   Jeśli zostanie wyświetlona powłoka inna niż pwsh lub powershell , wybierz strzałkę listy rozwijanej powłoki, a następnie wybierz pozycję PowerShell.

   

3. W terminalu przejdź do katalogu, w którym zapisano szablon. Jeśli na przykład szablon został zapisany w folderze templates , możesz użyć tego polecenia:

   Set-Location -Path templates
   

Instalowanie interfejsu wiersza polecenia Bicep

Aby użyć aplikacji Bicep z poziomu programu Azure PowerShell, zainstaluj interfejs wiersza polecenia Bicep.

Logowanie się na platformie Azure przy użyciu programu Azure PowerShell

1. W terminalu programu Visual Studio Code uruchom następujące polecenie:

   Connect-AzAccount
   

   Zostanie otwarta przeglądarka umożliwiająca zalogowanie się do konta platformy Azure. Przeglądarka może zostać otwarta w tle.

2. Po zalogowaniu się na platformie Azure w terminalu zostanie wyświetlona lista subskrypcji skojarzonych z tym kontem. Jeśli aktywowano piaskownicę, zostanie wyświetlona subskrypcja o nazwie Subskrypcja Concierge. Wybierz go w pozostałej części ćwiczenia.

   Jeśli ostatnio użyto więcej niż jednej piaskownicy, terminal może wyświetlić więcej niż jedno wystąpienie subskrypcji Concierge. W tym przypadku użyj dwóch następnych kroków, aby ustawić jedną jako domyślną subskrypcję.

   1. Uzyskaj identyfikator subskrypcji. Uruchomienie następującego polecenia zawiera listę subskrypcji i ich identyfikatorów. Concierge SubscriptionWyszukaj ciąg , a następnie skopiuj identyfikator z drugiej kolumny. Wygląda to mniej więcej tak: aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e.

      Get-AzSubscription
      

   2. Zmień aktywną subskrypcję na Subskrypcja Concierge. Pamiętaj, aby zastąpić ciąg {Identyfikator subskrypcji} skopiowaną wartością.

      $context = Get-AzSubscription -SubscriptionId {Your subscription ID}
      Set-AzContext $context
      

Ustawianie domyślnej grupy zasobów

Możesz ustawić domyślną grupę zasobów i pominąć parametr z pozostałych poleceń programu Azure PowerShell w tym ćwiczeniu. Ustaw tę wartość domyślną na grupę zasobów utworzoną dla Ciebie w środowisku piaskownicy.

Set-AzDefault -ResourceGroupName <rgn>[sandbox resource group name]</rgn>

Aby wdrożyć ten szablon na platformie Azure, musisz zalogować się na konto platformy Azure z poziomu terminalu programu Visual Studio Code. Upewnij się, że zainstalowano interfejs wiersza polecenia platformy Azure i pamiętaj, aby zalogować się przy użyciu tego samego konta, które zostało użyte do aktywowania piaskownicy.

1. W menu Terminal wybierz polecenie New Terminal (Nowy terminal). Okno terminalu zwykle otwiera się w dolnej połowie ekranu.

2. Jeśli w oknie terminalu jest wyświetlana powłoka bash po prawej stronie, oznacza to, że prawidłowa powłoka jest już otwarta. Alternatywnie, jeśli po prawej stronie zostanie wyświetlona ikona powłoki bash, możesz ją wybrać, aby uruchomić powłokę.

   

   Jeśli zostanie wyświetlona powłoka inna niż powłoka bash , wybierz strzałkę listy rozwijanej powłoki, a następnie wybierz pozycję Git Bash.

   

3. W terminalu przejdź do katalogu, w którym zapisano szablon. Jeśli na przykład szablon został zapisany w folderze templates , możesz użyć następującego polecenia:

   cd templates
   

Logowanie się do platformy Azure

1. W terminalu programu Visual Studio Code zaloguj się do platformy Azure, uruchamiając następujące polecenie:

   az login
   

2. W przeglądarce, która zostanie otwarta, zaloguj się do konta platformy Azure. W terminalu programu Visual Studio Code zostanie wyświetlona lista subskrypcji skojarzonych z tym kontem. Wybierz subskrypcję o nazwie Subskrypcja Concierge.

   Jeśli ostatnio użyto więcej niż jednej piaskownicy, terminal może wyświetlić więcej niż jedno wystąpienie subskrypcji Concierge. W tym przypadku użyj dwóch następnych kroków, aby ustawić jedną jako domyślną subskrypcję.

   1. Pobierz identyfikatory subskrypcji Concierge.

        az account list \
         --refresh \
         --query "[?contains(name, 'Concierge Subscription')].id" \
         --output table
      

   2. Ustaw domyślną subskrypcję przy użyciu identyfikatora subskrypcji. Zastąp ciąg {your subscription ID} najnowszym identyfikatorem subskrypcji Concierge.

      az account set --subscription {your subscription ID}
      

Ustawianie domyślnej grupy zasobów

W przypadku korzystania z interfejsu wiersza polecenia platformy Azure możesz ustawić domyślną grupę zasobów i pominąć parametr z pozostałych poleceń interfejsu wiersza polecenia platformy Azure w tym ćwiczeniu. Ustaw wartość domyślną na grupę zasobów utworzoną dla Ciebie w środowisku piaskownicy.

az configure --defaults group="<rgn>[sandbox resource group name]</rgn>"

Aby wdrożyć ten szablon na platformie Azure, zaloguj się do konta platformy Azure z poziomu terminalu programu Visual Studio Code. Upewnij się, że zainstalowano program Azure PowerShell i zaloguj się do tego samego konta, na którym aktywowano piaskownicę.

1. W menu Terminal wybierz polecenie New Terminal (Nowy terminal). Okno terminalu zwykle otwiera się w dolnej połowie ekranu.

2. Jeśli w oknie terminalu jest wyświetlany program pwsh lub powershell po prawej stronie, oznacza to, że prawidłowa powłoka jest już otwarta. Alternatywnie, jeśli po prawej stronie zostanie wyświetlona ikona powłoki programu PowerShell, możesz ją wybrać, aby uruchomić powłokę.

   

   Jeśli zostanie wyświetlona powłoka inna niż pwsh lub powershell , wybierz strzałkę listy rozwijanej powłoki, a następnie wybierz pozycję PowerShell.

   

3. W terminalu przejdź do katalogu, w którym zapisano szablon. Jeśli na przykład szablon został zapisany w folderze templates , możesz użyć tego polecenia:

   Set-Location -Path templates
   

Logowanie się na platformie Azure przy użyciu programu Azure PowerShell

1. W terminalu programu Visual Studio Code uruchom następujące polecenie:

   Connect-AzAccount
   

   Zostanie otwarta przeglądarka umożliwiająca zalogowanie się do konta platformy Azure. Przeglądarka może zostać otwarta w tle.

2. Po zalogowaniu się na platformie Azure w terminalu zostanie wyświetlona lista subskrypcji skojarzonych z tym kontem. Jeśli aktywowano piaskownicę, zostanie wyświetlona subskrypcja o nazwie Subskrypcja Concierge. Wybierz go w pozostałej części ćwiczenia.

   Jeśli ostatnio użyto więcej niż jednej piaskownicy, terminal może wyświetlić więcej niż jedno wystąpienie subskrypcji Concierge. W tym przypadku użyj dwóch następnych kroków, aby ustawić jedną jako domyślną subskrypcję.

   1. Uzyskaj identyfikator subskrypcji. Uruchomienie następującego polecenia zawiera listę subskrypcji i ich identyfikatorów. Concierge SubscriptionWyszukaj ciąg , a następnie skopiuj identyfikator z drugiej kolumny. Wygląda to mniej więcej tak: aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e.

      Get-AzSubscription
      

   2. Zmień aktywną subskrypcję na Subskrypcja Concierge. Pamiętaj, aby zastąpić ciąg {Identyfikator subskrypcji} skopiowaną wartością.

      $context = Get-AzSubscription -SubscriptionId {Your subscription ID}
      Set-AzContext $context
      

Ustawianie domyślnej grupy zasobów

Możesz ustawić domyślną grupę zasobów i pominąć parametr z pozostałych poleceń programu Azure PowerShell w tym ćwiczeniu. Ustaw tę wartość domyślną na grupę zasobów utworzoną dla Ciebie w środowisku piaskownicy.

Set-AzDefault -ResourceGroupName <rgn>[sandbox resource group name]</rgn>

Publikowanie szablonu jako specyfikacji szablonu

Opublikuj specyfikację szablonu przy użyciu tego polecenia cmdlet programu Azure PowerShell w terminalu programu Visual Studio Code:

New-AzTemplateSpec `
  -ResourceGroupName <rgn>[sandbox resource group name]</rgn> `
  -Name ToyCosmosDBAccount `
  -Location westus `
  -DisplayName 'Cosmos DB account' `
  -Description "This template spec creates a Cosmos DB account that meets our company's requirements." `
  -Version '1.0' `
  -TemplateFile main.bicep

New-AzTemplateSpec `
  -ResourceGroupName <rgn>[sandbox resource group name]</rgn> `
  -Name ToyCosmosDBAccount `
  -Location westus `
  -DisplayName 'Cosmos DB account' `
  -Description "This template spec creates a Cosmos DB account that meets our company's requirements." `
  -Version '1.0' `
  -TemplateFile azuredeploy.json

Opublikuj specyfikację szablonu przy użyciu tego polecenia interfejsu wiersza polecenia platformy Azure w terminalu programu Visual Studio Code:

az ts create \
  --name ToyCosmosDBAccount \
  --location westus \
  --display-name "Cosmos DB account" \
  --description "This template spec creates a Cosmos DB account that meets our company's requirements." \
  --version 1.0 \
  --template-file main.bicep

az ts create \
  --name ToyCosmosDBAccount \
  --location westus \
  --display-name "Cosmos DB account" \
  --description "This template spec creates a Cosmos DB account that meets our company's requirements." \
  --version 1.0 \
  --template-file azuredeploy.json

Weryfikowanie specyfikacji szablonu przy użyciu witryny Azure Portal

1. Przejdź do witryny Azure Portal i upewnij się, że jesteś w subskrypcji piaskownicy:

   1. Wybierz swój awatar w prawym górnym rogu strony.
   2. Wybierz pozycję Przełącz katalog. Z listy wybierz katalog Microsoft Learn Sandbox.

2. Na panelu po lewej stronie wybierz pozycję Grupy zasobów.

3. Wybierz pozycję [nazwa grupy zasobów piaskownicy]. Zwróć uwagę, że specyfikacja szablonu znajduje się na liście zasobów:

   

4. Wybierz pozycję ToyCosmosDBAccount , aby otworzyć specyfikację szablonu. Wersje i plik szablonu są widoczne.

   

Wdrażanie specyfikacji szablonu

Dla uproszczenia specyfikację szablonu można wdrożyć w tej samej grupie zasobów piaskownicy, w której jest przechowywana sama specyfikacja szablonu. Zwykle specyfikacje szablonu są zachowywane w innej grupie zasobów. Jednak kroki są takie same w obu przypadkach.

1. Pobierz identyfikator zasobu wersji specyfikacji szablonu, uruchamiając następujące polecenie programu Azure PowerShell:

   $templateSpecVersionResourceId = (`
      Get-AzTemplateSpec `
         -ResourceGroupName <rgn>[sandbox resource group name]</rgn> `
         -Name ToyCosmosDBAccount `
         -Version 1.0 `
      ).Versions[0].Id
   

   Zwróć uwagę, że używasz Versions właściwości . Podczas wdrażania specyfikacji szablonu należy odwołać się do identyfikatora zasobu określonej wersji specyfikacji szablonu do użycia.

2. Wdróż specyfikację szablonu przy użyciu tego polecenia programu Azure PowerShell w terminalu programu Visual Studio Code:

   New-AzResourceGroupDeployment -TemplateSpecId $templateSpecVersionResourceId
   

1. Pobierz identyfikator zasobu wersji specyfikacji szablonu, uruchamiając następujące polecenie interfejsu wiersza polecenia platformy Azure:

   id=$(az ts show \ 
    --name ToyCosmosDBAccount \
    --resource-group "<rgn>[sandbox resource group name]</rgn>" \
    --version "1.0" \
    --query "id")
   

2. Wdróż specyfikację szablonu przy użyciu tego polecenia interfejsu wiersza polecenia platformy Azure w terminalu programu Visual Studio Code:

   az deployment group create --template-spec $id
   

Ukończenie wdrożenia może potrwać minutę lub dwie.

Weryfikowanie wdrożenia

1. W przeglądarce wróć do witryny Azure Portal. Przejdź do grupy zasobów.

2. Obok pozycji Wdrożenia wybierz link 1 Powodzenie, aby wyświetlić szczegóły wdrożenia.

   

3. Wybierz wdrożenie.

   

   Nazwa wdrożenia może wyglądać inaczej niż w przykładzie.

4. Wybierz pozycję Szczegóły wdrożenia, aby ją rozwinąć. Upewnij się, że konto usługi Azure Cosmos DB zostało wdrożone.