Краткое руководство. Создание и развертывание спецификации шаблона с помощью файла Bicep

В этом кратком руководстве описывается создание и развертывание спецификации шаблона с помощью файла Bicep. Спецификация шаблона развертывается в группу ресурсов, чтобы пользователи в организации могли развертывать ресурсы в Microsoft Azure. Спецификации шаблонов позволяют предоставлять общий доступ к шаблонам развертывания без необходимости предоставления пользователям доступа на изменение файла Bicep. В этом примере спецификации шаблона файл Bicep используется для развертывания учетной записи хранения.

При создании спецификации шаблона файл Bicep транскомпилируется в нотацию объектов JavaScript (JSON). Спецификация шаблона использует JSON для развертывания ресурсов Azure. В настоящее время вы не можете использовать портал Azure для импорта файла Bicep и создания ресурса спецификации шаблона.

Необходимые компоненты

• Учетная запись Azure с активной подпиской. Создайте учетную запись бесплатно .
• Azure PowerShell версии 6.3.0 или более поздней или Azure CLI версии 2.27.0 или более поздней.
• Visual Studio Code с расширением Bicep.

Создание файла Bicep

Спецификация шаблона создается из локального файла Bicep. Скопируйте следующий пример и сохраните его на компьютере как main.bicep. В примерах используется путь C:\templates\main.bicep. Можно использовать другой путь, но потребуется изменить команды.

Следующий файл Bicep используется на вкладках PowerShell и CLI. На вкладке Файл Bicep используется другой шаблон, объединяющий Bicep и JSON для создания и развертывания спецификации шаблона.

@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@2022-09-01' = {
  name: storageAccountName
  location: location
  sku: {
    name: storageAccountType
  }
  kind: 'StorageV2'
  properties: {}
}

output storageAccountNameOutput string = storageAccount.name

Создание спецификации шаблона

Спецификация шаблона — это тип ресурсов с именем Microsoft.Resources/templateSpecs. Чтобы создать спецификацию шаблона, используйте Azure CLI, Azure PowerShell или файл Bicep.

В этом примере используется имя группы ресурсов templateSpecRG. Можно использовать другое имя, но потребуется изменить команды.

PowerShell

1. Создайте новую группу ресурсов, которая будет содержать спецификацию шаблона.

   New-AzResourceGroup `
     -Name templateSpecRG `
     -Location westus2
   

2. Создайте спецификацию шаблона в этой группе ресурсов. Задайте для новой спецификации шаблона имя storageSpec.

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

CLI

1. Создайте новую группу ресурсов, которая будет содержать спецификацию шаблона.

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

2. Создайте спецификацию шаблона в этой группе ресурсов. Задайте для новой спецификации шаблона имя storageSpec.

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

Bicep-файл

Спецификацию шаблона можно создать с помощью файла Bicep, но mainTemplateдолжен быть в формате JSON. Шаблон JSON не использует стандартный синтаксис JSON. Например, в нем нет запятых в конце строки, двойные кавычки заменяются одинарными, а символы обратной косой черты (\) используются для экранирования одинарных кавычек внутри выражений.

1. Скопируйте следующий шаблон и сохраните его на компьютере как 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': '2022-09-01'
             'name': '[variables(\'storageAccountName\')]'
             'location': '[parameters(\'location\')]'
             'sku': {
               'name': '[parameters(\'storageAccountType\')]'
             }
             'kind': 'StorageV2'
             'properties': {}
           }
         ]
         'outputs': {
           'storageAccountNameOutput': {
             'type': 'string'
             'value': '[variables(\'storageAccountName\')]'
           }
         }
       }
     }
   }
   

2. Создайте группу ресурсов с помощью Azure CLI или Azure PowerShell.

   New-AzResourceGroup `
     -Name templateSpecRG `
     -Location westus2
   

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

3. Создайте спецификацию шаблона в этой группе ресурсов. Имя спецификации шаблона storageSpec и номер версии 1.0 являются параметрами в файле Bicep.

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

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

Развертывание спецификации шаблона

Используйте спецификацию шаблона для развертывания учетной записи хранения. В этом примере используется имя группы ресурсов storageRG. Можно использовать другое имя, но потребуется изменить команды.

PowerShell

1. Создайте группу ресурсов, которая будет содержать новую учетную запись хранения.

   New-AzResourceGroup `
     -Name storageRG `
     -Location westus2
   

2. Получите ИД ресурса спецификации шаблона.

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

3. Разверните спецификацию шаблона.

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

4. Параметры указываются точно так же, как и при развертывании файла Bicep. Повторно разверните спецификацию шаблона с параметром для типа учетной записи хранения.

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

CLI

1. Создайте группу ресурсов, которая будет содержать новую учетную запись хранения.

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

2. Получите ИД ресурса спецификации шаблона.

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

   Примечание.

   Существует известная проблема при получении идентификатора спецификации шаблона и ее присвоении переменной в Windows PowerShell.

3. Разверните спецификацию шаблона.

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

4. Параметры указываются точно так же, как и при развертывании файла Bicep. Повторно разверните спецификацию шаблона с параметром для типа учетной записи хранения.

   az deployment group create \
     --resource-group storageRG \
     --template-spec $id \
     --parameters storageAccountType="Standard_GRS"
   

Bicep-файл

Чтобы развернуть спецификацию шаблона с помощью файла Bicep, используйте модуль. Модуль ссылается на существующую спецификацию шаблона. Дополнительные сведения см. в разделе Файл в спецификации шаблона.

1. Скопируйте следующий модуль Bicep и сохраните его на компьютере как storage.bicep.

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

2. Замените <subscriptionId> в модуле. Чтобы получить идентификатор подписки, используйте Azure PowerShell или Azure CLI.

   (Get-AzContext).Subscription.Id
   

   az account show --query "id" --output tsv
   

3. Создайте группу ресурсов для учетной записи хранения с помощью Azure PowerShell или Azure CLI.

   New-AzResourceGroup `
     -Name storageRG `
     -Location westus2
   

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

4. Разверните спецификацию шаблона с помощью Azure PowerShell или Azure CLI.

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

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

5. Вы можете добавить параметр и повторно развернуть спецификацию шаблона с другим типом учетной записи хранения. Скопируйте пример и замените файл storage.bicep. Затем повторно разверните спецификацию шаблона.

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

Предоставление доступа

Если вы хотите позволить другим пользователям в организации развертывать спецификацию шаблона, необходимо предоставить им доступ на чтение. Роль читателя можно назначить группе Microsoft Entra для группы ресурсов, содержащей спецификации шаблонов, к которым требуется предоставить общий доступ. Дополнительные сведения см. в статье Учебник. Предоставление доступа группам к ресурсам Azure с помощью Azure PowerShell.

Обновление файла Bicep

После создания спецификации шаблона вы решили обновить файл Bicep. Чтобы продолжить работу с примерами на вкладках PowerShell или CLI, скопируйте пример и замените файл main.bicep.

Параметр storageNamePrefix задает значение префикса для имени учетной записи хранения. Переменная storageAccountName объединяет префикс с уникальной строкой.

@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

Обновление версии спецификации шаблона

Вместо создания спецификации шаблона для измененного шаблона добавьте новую версию с именем 2.0 в имеющуюся спецификацию шаблона. Пользователи могут выбрать любую версию для развертывания.

PowerShell

1. Создайте новую версию спецификации шаблона.

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

2. Чтобы развернуть новую версию, получите идентификатор ресурса для версии 2.0.

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

3. Разверните новую версию и используйте storageNamePrefix, чтобы указать префикс для имени учетной записи хранения.

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

CLI

1. Создайте новую версию спецификации шаблона.

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

2. Чтобы развернуть новую версию, получите идентификатор ресурса для версии 2.0.

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

3. Разверните новую версию и используйте storageNamePrefix, чтобы указать префикс для имени учетной записи хранения.

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

Bicep-файл

1. Создайте новую версию спецификации шаблона. Скопируйте пример и замените файл main.bicep.

   Параметр storageNamePrefix задает значение префикса для имени учетной записи хранения. Переменная storageAccountName объединяет префикс с уникальной строкой.

   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': '2022-09-01'
             'name': '[variables(\'storageAccountName\')]'
             'location': '[parameters(\'location\')]'
             'sku': {
               'name': '[parameters(\'storageAccountType\')]'
             }
             'kind': 'StorageV2'
             'properties': {}
           }
         ]
         'outputs': {
           'storageAccountNameOutput': {
             'type': 'string'
             'value': '[variables(\'storageAccountName\')]'
           }
         }
       }
     }
   }
   

2. Чтобы добавить новую версию в спецификацию шаблона, разверните шаблон с помощью Azure PowerShell или Azure CLI.

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

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

3. Скопируйте следующий модуль Bicep и сохраните его на компьютере как storage.bicep.

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

4. Замените <subscriptionId> в модуле. Чтобы получить идентификатор подписки, используйте Azure PowerShell или Azure CLI.

   (Get-AzContext).Subscription.Id
   

   az account show --query "id" --output tsv
   

5. Разверните спецификацию шаблона с помощью Azure PowerShell или Azure CLI.

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

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

Очистка ресурсов

Чтобы очистить ресурсы, развернутые в этом кратком руководстве, удалите обе созданные группы ресурсов. Будут удалены группа ресурсов, спецификации шаблонов и учетные записи хранения.

Удалите группы ресурсов с помощью Azure PowerShell или Azure CLI.

Remove-AzResourceGroup -Name "templateSpecRG"

Remove-AzResourceGroup -Name "storageRG"

az group delete --name templateSpecRG

az group delete --name storageRG

Следующие шаги

Спецификации шаблонов Azure Resource Manager в Bicep