Szybki start: tworzenie i wdrażanie specyfikacji szablonu za pomocą Bicep

Artykuł
09/26/2024

W tym przewodniku Szybki start opisano sposób tworzenia i wdrażania specyfikacji szablonu przy użyciu pliku Bicep. Specyfikacja szablonu jest wdrażana w grupie zasobów, aby osoby w organizacji mogły wdrażać zasoby na platformie Microsoft Azure. Specyfikacje szablonów umożliwiają udostępnianie szablonów wdrażania bez konieczności zapewniania użytkownikom dostępu do zmiany pliku Bicep. Ten przykład specyfikacji szablonu używa pliku Bicep do wdrożenia konta magazynu.

Podczas tworzenia specyfikacji szablonu plik Bicep jest transpilowany w formacie JavaScript Object Notation (JSON). Specyfikacja szablonu używa formatu JSON do wdrażania zasobów platformy Azure. Obecnie nie można użyć witryny Microsoft Azure Portal do zaimportowania pliku Bicep i utworzenia zasobu specyfikacji szablonu.

Wymagania wstępne

Konto platformy Azure z aktywną subskrypcją. Utwórz konto bezpłatnie.
Program Azure PowerShell w wersji 6.3.0 lub nowszej lub interfejsu wiersza polecenia platformy Azure w wersji 2.27.0 lub nowszej.
Program Visual Studio Code z rozszerzeniem Bicep.

Tworzenie pliku Bicep

Specyfikację szablonu można utworzyć na podstawie lokalnego pliku Bicep. Skopiuj poniższy przykład i zapisz go na komputerze jako main.bicep. W przykładach użyto ścieżki C:\templates\main.bicep. Możesz użyć innej ścieżki, ale musisz zmienić polecenia.

Poniższy plik Bicep jest używany na kartach programu PowerShell i interfejsu wiersza polecenia . Karta plik Bicep używa innego szablonu, który łączy kod Bicep i JSON w celu utworzenia i wdrożenia specyfikacji szablonu.

@allowed([
  'Premium_LRS'
  'Premium_ZRS'
  'Standard_GRS'
  'Standard_GZRS'
  'Standard_LRS'
  'Standard_RAGRS'
  'Standard_RAGZRS'
  'Standard_ZRS'
])
@description('Storage account type.')
param storageAccountType string = 'Standard_LRS'

@description('Location for all resources.')
param location string = resourceGroup().location

var storageAccountName = 'storage${uniqueString(resourceGroup().id)}'

resource storageAccount 'Microsoft.Storage/storageAccounts@2023-04-01' = {
  name: storageAccountName
  location: location
  sku: {
    name: storageAccountType
  }
  kind: 'StorageV2'
  properties: {}
}

output storageAccountNameOutput string = storageAccount.name

Tworzenie specyfikacji szablonu

Specyfikacja szablonu to typ zasobu o nazwie Microsoft.Resources/templateSpecs. Aby utworzyć specyfikację szablonu, użyj interfejsu wiersza polecenia platformy Azure, programu Azure PowerShell lub pliku Bicep.

W tym przykładzie użyto nazwy templateSpecRGgrupy zasobów . Możesz użyć innej nazwy, ale musisz zmienić polecenia.

Utwórz nową grupę zasobów, aby zawierała specyfikację szablonu.
```
New-AzResourceGroup `
  -Name templateSpecRG `
  -Location westus2
```

Utwórz specyfikację szablonu w tej grupie zasobów. Nadaj nowemu szablonowi nazwę storageSpec.

New-AzTemplateSpec `
  -Name storageSpec `
  -Version "1.0" `
  -ResourceGroupName templateSpecRG `
  -Location westus2 `
  -TemplateFile "C:\templates\main.bicep"

Utwórz nową grupę zasobów, aby zawierała specyfikację szablonu.
```
az group create \
  --name templateSpecRG \
  --location westus2
```

Utwórz specyfikację szablonu w tej grupie zasobów. Nadaj nowemu szablonowi nazwę storageSpec.

az ts create \
  --name storageSpec \
  --version "1.0" \
  --resource-group templateSpecRG \
  --location westus2 \
  --template-file "C:\templates\main.bicep"

Specyfikację szablonu można utworzyć przy użyciu pliku Bicep, ale mainTemplate musi być w formacie JSON. Szablon JSON nie używa standardowej składni JSON. Na przykład nie ma przecinków końca wiersza, cudzysłowy podwójne są zastępowane pojedynczymi cudzysłowami, a ukośniki odwrotne (\) są używane do ucieczki pojedynczych cudzysłowów w wyrażeniach.

Skopiuj poniższy szablon i zapisz go na komputerze jako main.bicep.

param templateSpecName string = 'storageSpec'

param templateSpecVersionName string = '1.0'

@description('Location for all resources.')
param location string = resourceGroup().location

resource createTemplateSpec 'Microsoft.Resources/templateSpecs@2022-02-01' = {
  name: templateSpecName
  location: location
}

resource createTemplateSpecVersion 'Microsoft.Resources/templateSpecs/versions@2022-02-01' = {
  parent: createTemplateSpec
  name: templateSpecVersionName
  location: location
  properties: {
    mainTemplate: {
      '$schema': 'https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#'
      'contentVersion': '1.0.0.0'
      'metadata': {}
      'parameters': {
        'storageAccountType': {
          'type': 'string'
          'defaultValue': 'Standard_LRS'
          'metadata': {
            'description': 'Storage account type.'
          }
          'allowedValues': [
            'Premium_LRS'
            'Premium_ZRS'
            'Standard_GRS'
            'Standard_GZRS'
            'Standard_LRS'
            'Standard_RAGRS'
            'Standard_RAGZRS'
            'Standard_ZRS'
          ]
        }
        'location': {
          'type': 'string'
          'defaultValue': '[resourceGroup().location]'
          'metadata': {
            'description': 'Location for all resources.'
          }
        }
      }
      'variables': {
        'storageAccountName': '[format(\'{0}{1}\', \'storage\', uniqueString(resourceGroup().id))]'
      }
      'resources': [
        {
          'type': 'Microsoft.Storage/storageAccounts'
          'apiVersion': '2023-04-01'
          'name': '[variables(\'storageAccountName\')]'
          'location': '[parameters(\'location\')]'
          'sku': {
            'name': '[parameters(\'storageAccountType\')]'
          }
          'kind': 'StorageV2'
          'properties': {}
        }
      ]
      'outputs': {
        'storageAccountNameOutput': {
          'type': 'string'
          'value': '[variables(\'storageAccountName\')]'
        }
      }
    }
  }
}

Użyj programu Azure PowerShell lub interfejsu wiersza polecenia platformy Azure, aby utworzyć nową grupę zasobów.

New-AzResourceGroup `
  -Name templateSpecRG `
  -Location westus2

az group create \
  --name templateSpecRG \
  --location westus2

Utwórz specyfikację szablonu w tej grupie zasobów. Nazwa specyfikacji szablonu storageSpec i numer 1.0 wersji są parametrami w pliku Bicep.

New-AzResourceGroupDeployment `
  -ResourceGroupName templateSpecRG `
  -TemplateFile "C:\templates\main.bicep"

az deployment group create \
  --resource-group templateSpecRG \
  --template-file "C:\templates\main.bicep"

Wdrażanie specyfikacji szablonu

Użyj specyfikacji szablonu, aby wdrożyć konto magazynu. W tym przykładzie użyto nazwy storageRGgrupy zasobów . Możesz użyć innej nazwy, ale musisz zmienić polecenia.

Utwórz grupę zasobów zawierającą nowe konto magazynu.

New-AzResourceGroup `
  -Name storageRG `
  -Location westus2

Pobierz identyfikator zasobu specyfikacji szablonu.

$id = (Get-AzTemplateSpec -ResourceGroupName templateSpecRG -Name storageSpec -Version "1.0").Versions.Id

Wdróż specyfikację szablonu.

New-AzResourceGroupDeployment `
  -TemplateSpecId $id `
  -ResourceGroupName storageRG

Należy podać parametry dokładnie tak, jak w przypadku wdrożenia pliku Bicep. Ponownie wdróż specyfikację szablonu przy użyciu parametru dla typu konta magazynu.
```
New-AzResourceGroupDeployment `
  -TemplateSpecId $id `
  -ResourceGroupName storageRG `
  -storageAccountType Standard_GRS
```

Utwórz grupę zasobów zawierającą nowe konto magazynu.

az group create \
  --name storageRG \
  --location westus2

Pobierz identyfikator zasobu specyfikacji szablonu.
```
id=$(az ts show --name storageSpec --resource-group templateSpecRG --version "1.0" --query "id")
```
Uwaga

Istnieje znany problem z uzyskiwaniem identyfikatora specyfikacji szablonu i przypisywaniem go do zmiennej w programie Windows PowerShell.

Wdróż specyfikację szablonu.

az deployment group create \
  --resource-group storageRG \
  --template-spec $id

Należy podać parametry dokładnie tak, jak w przypadku wdrożenia pliku Bicep. Ponownie wdróż specyfikację szablonu przy użyciu parametru dla typu konta magazynu.
```
az deployment group create \
  --resource-group storageRG \
  --template-spec $id \
  --parameters storageAccountType="Standard_GRS"
```

Aby wdrożyć specyfikację szablonu przy użyciu pliku Bicep, użyj modułu. Moduł łączy się z istniejącą specyfikacją szablonu. Aby uzyskać więcej informacji, zobacz plik w specyfikacji szablonu.

Skopiuj następujący moduł Bicep i zapisz go na komputerze jako storage.bicep.

module deployTemplateSpec 'ts:<subscriptionId>/templateSpecRG/storageSpec:1.0' = {
  name: 'deployVersion1'
}

Zastąp <subscriptionId> element w module. Użyj programu Azure PowerShell lub interfejsu wiersza polecenia platformy Azure, aby uzyskać identyfikator subskrypcji.
```
(Get-AzContext).Subscription.Id
```
```
az account show --query "id" --output tsv
```
Użyj programu Azure PowerShell lub interfejsu wiersza polecenia platformy Azure, aby utworzyć nową grupę zasobów dla konta magazynu.
```
New-AzResourceGroup `
  -Name storageRG `
  -Location westus2
```
```
az group create \
  --name storageRG \
  --location westus2
```

Wdróż specyfikację szablonu przy użyciu programu Azure PowerShell lub interfejsu wiersza polecenia platformy Azure.

New-AzResourceGroupDeployment `
  -ResourceGroupName storageRG `
  -TemplateFile "C:\templates\storage.bicep"

az deployment group create \
  --resource-group storageRG \
  --template-file "C:\templates\storage.bicep"

Możesz dodać parametr i ponownie wdrożyć specyfikację szablonu przy użyciu innego typu konta magazynu. Skopiuj przykład i zastąp plik storage.bicep . Następnie ponownie wdróż wdrożenie specyfikacji szablonu.
```
module deployTemplateSpec 'ts:<subscriptionId>/templateSpecRG/storageSpec:1.0' = {
  name: 'deployVersion1'
  params: {
    storageAccountType: 'Standard_GRS'
  }
}
```

Przyznaj dostęp

Jeśli chcesz zezwolić innym użytkownikom w organizacji na wdrożenie specyfikacji szablonu, musisz udzielić im dostępu do odczytu. Rolę Czytelnik można przypisać do grupy Microsoft Entra dla grupy zasobów zawierającej specyfikacje szablonu, które chcesz udostępnić. Aby uzyskać więcej informacji, zobacz Samouczek: udzielanie grupie dostępu do zasobów platformy Azure przy użyciu programu Azure PowerShell.

Aktualizowanie pliku Bicep

Po utworzeniu specyfikacji szablonu podjęto decyzję o zaktualizowaniu pliku Bicep. Aby kontynuować pracę z przykładami na kartach programu PowerShell lub interfejsu wiersza polecenia , skopiuj przykład i zastąp plik main.bicep .

Parametr storageNamePrefix określa wartość prefiksu dla nazwy konta magazynu. Zmienna storageAccountName łączy prefiks z unikatowym ciągiem.

@allowed([
  'Premium_LRS'
  'Premium_ZRS'
  'Standard_GRS'
  'Standard_GZRS'
  'Standard_LRS'
  'Standard_RAGRS'
  'Standard_RAGZRS'
  'Standard_ZRS'
])
@description('Storage account type.')
param storageAccountType string = 'Standard_LRS'

@description('Location for all resources.')
param location string = resourceGroup().location

@maxLength(11)
@description('The storage account name prefix.')
param storageNamePrefix string = 'storage'

var storageAccountName = '${toLower(storageNamePrefix)}${uniqueString(resourceGroup().id)}'

resource storageAccount 'Microsoft.Storage/storageAccounts@2022-09-01' = {
  name: storageAccountName
  location: location
  sku: {
    name: storageAccountType
  }
  kind: 'StorageV2'
  properties: {}
}

output storageAccountNameOutput string = storageAccount.name

Aktualizowanie wersji specyfikacji szablonu

Zamiast tworzyć nową specyfikację szablonu dla poprawionego szablonu, dodaj nową wersję o nazwie 2.0 do istniejącej specyfikacji szablonu. Użytkownicy mogą wybrać wdrożenie jednej z tych wersji.

Utwórz nową wersję specyfikacji szablonu.

New-AzTemplateSpec `
  -Name storageSpec `
  -Version "2.0" `
  -ResourceGroupName templateSpecRG `
  -Location westus2 `
  -TemplateFile "C:\templates\main.bicep"

Aby wdrożyć nową wersję, pobierz identyfikator zasobu dla 2.0 wersji.

$id = (Get-AzTemplateSpec -ResourceGroupName templateSpecRG -Name storageSpec -Version "2.0").Versions.Id

Wdróż nową wersję i użyj elementu , storageNamePrefix aby określić prefiks nazwy konta magazynu.

New-AzResourceGroupDeployment `
  -TemplateSpecId $id `
  -ResourceGroupName storageRG `
  -storageNamePrefix "demo"

Utwórz nową wersję specyfikacji szablonu.

az ts create \
  --name storageSpec \
  --version "2.0" \
  --resource-group templateSpecRG \
  --location westus2 \
  --template-file "C:\templates\main.bicep"

Aby wdrożyć nową wersję, pobierz identyfikator zasobu dla 2.0 wersji.

id=$(az ts show --name storageSpec --resource-group templateSpecRG --version "2.0" --query "id")

Wdróż nową wersję i użyj elementu , storageNamePrefix aby określić prefiks nazwy konta magazynu.

az deployment group create \
   --resource-group storageRG \
   --template-spec $id \
   --parameters storageNamePrefix="demo"

Utwórz nową wersję specyfikacji szablonu. Skopiuj przykład i zastąp plik main.bicep .

Parametr storageNamePrefix określa wartość prefiksu dla nazwy konta magazynu. Zmienna storageAccountName łączy prefiks z unikatowym ciągiem.

param templateSpecName string = 'storageSpec'

param templateSpecVersionName string = '2.0'

@description('Location for all resources.')
param location string = resourceGroup().location

resource createTemplateSpec 'Microsoft.Resources/templateSpecs@2022-02-01' = {
  name: templateSpecName
  location: location
}

resource createTemplateSpecVersion 'Microsoft.Resources/templateSpecs/versions@2022-02-01' = {
  parent: createTemplateSpec
  name: templateSpecVersionName
  location: location
  properties: {
    mainTemplate: {
      '$schema': 'https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#'
      'contentVersion': '1.0.0.0'
      'metadata': {}
      'parameters': {
        'storageAccountType': {
          'type': 'string'
          'defaultValue': 'Standard_LRS'
          'metadata': {
            'description': 'Storage account type.'
          }
          'allowedValues': [
            'Premium_LRS'
            'Premium_ZRS'
            'Standard_GRS'
            'Standard_GZRS'
            'Standard_LRS'
            'Standard_RAGRS'
            'Standard_RAGZRS'
            'Standard_ZRS'
          ]
        }
        'location': {
          'type': 'string'
          'defaultValue': '[resourceGroup().location]'
          'metadata': {
            'description': 'Location for all resources.'
          }
        }
        'storageNamePrefix': {
          'type': 'string'
          'defaultValue': 'storage'
          'metadata': {
            'description': 'The storage account name prefix.'
          }
          'maxLength': 11
        }
      }
      'variables': {
        'storageAccountName': '[format(\'{0}{1}\', toLower(parameters(\'storageNamePrefix\')), uniqueString(resourceGroup().id))]'
      }
      'resources': [
        {
          'type': 'Microsoft.Storage/storageAccounts'
          'apiVersion': '2023-04-01'
          'name': '[variables(\'storageAccountName\')]'
          'location': '[parameters(\'location\')]'
          'sku': {
            'name': '[parameters(\'storageAccountType\')]'
          }
          'kind': 'StorageV2'
          'properties': {}
        }
      ]
      'outputs': {
        'storageAccountNameOutput': {
          'type': 'string'
          'value': '[variables(\'storageAccountName\')]'
        }
      }
    }
  }
}

Aby dodać nową wersję do specyfikacji szablonu, wdróż szablon przy użyciu programu Azure PowerShell lub interfejsu wiersza polecenia platformy Azure.

New-AzResourceGroupDeployment `
  -ResourceGroupName templateSpecRG `
  -TemplateFile "C:\templates\main.bicep"

az deployment group create \
  --resource-group templateSpecRG \
  --template-file "C:\templates\main.bicep"

Skopiuj następujący moduł Bicep i zapisz go na komputerze jako storage.bicep.

module deployTemplateSpec 'ts:<subscriptionId>/templateSpecRG/storageSpec:2.0' = {
  name: 'deployVersion2'
  params: {
    storageNamePrefix: 'demo'
  }
}

Zastąp <subscriptionId> element w module. Użyj programu Azure PowerShell lub interfejsu wiersza polecenia platformy Azure, aby uzyskać identyfikator subskrypcji.
```
(Get-AzContext).Subscription.Id
```
```
az account show --query "id" --output tsv
```

Wdróż specyfikację szablonu przy użyciu programu Azure PowerShell lub interfejsu wiersza polecenia platformy Azure.

New-AzResourceGroupDeployment `
  -ResourceGroupName storageRG `
  -TemplateFile "C:\templates\storage.bicep"

az deployment group create \
  --resource-group storageRG \
  --template-file "C:\templates\storage.bicep"

Czyszczenie zasobów

Aby wyczyścić zasoby wdrożone w tym przewodniku Szybki start, usuń obie grupy zasobów. Grupa zasobów, specyfikacje szablonu i konta magazynu zostaną usunięte.

Użyj programu Azure PowerShell lub interfejsu wiersza polecenia platformy Azure, aby usunąć grupy zasobów.

Remove-AzResourceGroup -Name "templateSpecRG"

Remove-AzResourceGroup -Name "storageRG"

az group delete --name templateSpecRG

az group delete --name storageRG

Następne kroki

Specyfikacje szablonu usługi Azure Resource Manager w aplikacji Bicep

Udostępnij za pośrednictwem