ARM 템플릿 JSON을 Bicep으로 디컴파일링

아티클
03/20/2024

이 문서에서는 ARM 템플릿(Azure Resource Manager 템플릿)을 Bicep 파일로 디컴파일하는 방법을 설명합니다. 변환 명령을 실행하려면 Bicep CLI 설치가 되어 있어야 합니다.

참고 항목

Visual Studio Code에서 기존 리소스에서 가져와 리소스 선언을 직접 만들 수 있습니다. 자세한 내용은 Bicep 명령을 참조하세요.

Visual Studio Code를 사용하여 JSON을 Bicep으로 붙여넣을 수 있습니다. 디컴파일 명령을 자동으로 실행합니다. 자세한 내용은 JSON을 Bicep으로 붙여넣기를 참조하세요.

ARM 템플릿을 디컴파일하면 Bicep 개발을 시작할 수 있습니다. ARM 템플릿 라이브러리가 있고 향후 개발을 위해 Bicep을 사용하려는 경우 Bicep으로 디컴파일할 수 있습니다. 그러나 Bicep 파일은 Bicep에 대한 모범 사례를 구현하기 위해 수정이 필요할 수 있습니다.

이 문서에서는 Azure CLI에서 decompile 명령을 실행하는 방법을 보여줍니다. Azure CLI를 사용하지 않는 경우 명령을 시작할 때 az 없이 명령을 실행합니다. 예를 들어 az bicep decompile은 bicep decompile이 됩니다.

JSON에서 Bicep으로 디컴파일

ARM 템플릿 JSON을 Bicep으로 디컴파일하려면 다음을 사용합니다.

az bicep decompile --file main.json

이 명령은 main.json과 동일한 디렉터리에 main.bicep이라는 파일을 만듭니다. main.bicep이 동일한 디렉터리에 있는 경우 --force 스위치를 사용하여 기존 Bicep 파일을 덮어씁니다.

Bicep으로 디컴파일 명령을 사용하여 Visual Studio Code에서 ARM 템플릿 JSON을 Bicep으로 디컴파일할 수도 있습니다. 자세한 내용은 Visual Studio Code를 참조하세요.

주의

디컴파일이 파일을 변환하려고 하지만 ARM 템플릿 JSON에서 Bicep으로의 매핑이 보장되지 않습니다. 생성된 Bicep 파일에서 경고 및 오류를 수정해야 할 수 있습니다. 또는 정확한 변환을 수행할 수 없는 경우 디컴파일이 실패할 수 있습니다. 문제 또는 부정확한 변환을 보고하려면 문제를 만듭니다.

디컴파일 및 빌드 명령은 기능적으로 동일한 템플릿을 생성합니다. 그러나 구현은 정확하게 일치하지 않을 수 있습니다. 템플릿을 JSON에서 Bicep으로 변환한 다음 다시 JSON으로 변환하면 원래 템플릿과 구문이 다른 템플릿이 생성될 수 있습니다. 배포되었을 때, 변환된 템플릿은 동일한 결과를 생성합니다.

변환 문제 수정

다음 ARM 템플릿이 있다고 가정합니다.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "storageAccountType": {
      "type": "string",
      "defaultValue": "Standard_LRS",
      "allowedValues": [
        "Standard_LRS",
        "Standard_GRS",
        "Standard_ZRS",
        "Premium_LRS"
      ],
      "metadata": {
        "description": "Storage Account type"
      }
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]",
      "metadata": {
        "description": "Location for all resources."
      }
    }
  },
  "variables": {
    "storageAccountName": "[concat('store', 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": {
    "storageAccountName": {
      "type": "string",
      "value": "[variables('storageAccountName')]"
    }
  }
}

디컴파일하면 다음과 같은 결과가 나타납니다.

@allowed([
  'Standard_LRS'
  'Standard_GRS'
  'Standard_ZRS'
  'Premium_LRS'
])
@description('Storage Account type')
param storageAccountType string = 'Standard_LRS'

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

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

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

output storageAccountName string = storageAccountName

디컴파일된 파일은 작동하지만 일부 이름은 변경해야 할 수도 있습니다. 변수 var storageAccountName_var에는 비정상적인 명명 규칙이 있습니다. 다음과 같이 변경해 보겠습니다.

var uniqueStorageName = 'store${uniqueString(resourceGroup().id)}'

파일 전체에서 이름을 바꾸려면 이름을 마우스 오른쪽 단추로 클릭한 다음, 기호 이름 바꾸기를 선택합니다. F2 바로 가기 키를 사용할 수도 있습니다.

리소스에는 변경하려는 기호 이름이 있습니다. 기호 이름에 storageAccountName 대신 exampleStorage를 사용합니다.

resource exampleStorage 'Microsoft.Storage/storageAccounts@2023-04-01' = {

전체 파일은 다음과 같습니다.

@allowed([
  'Standard_LRS'
  'Standard_GRS'
  'Standard_ZRS'
  'Premium_LRS'
])
@description('Storage Account type')
param storageAccountType string = 'Standard_LRS'

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

var uniqueStorageName = 'store${uniqueString(resourceGroup().id)}'

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

output storageAccountName string = uniqueStorageName

템플릿 내보내기 및 변환

리소스 그룹의 템플릿을 내보낸 다음, 템플릿을 decompile 명령에 직접 전달할 수 있습니다. 다음 예시에서는 내보낸 템플릿을 디컴파일하는 방법을 보여 줍니다.

az group export --name "your_resource_group_name" > main.json
az bicep decompile --file main.json

Export-AzResourceGroup -ResourceGroupName "your_resource_group_name" -Path ./main.json
bicep decompile main.json

나란히 보기

Bicep 플레이그라운드를 사용하면 동등한 ARM 템플릿과 Bicep 파일을 나란히 볼 수 있습니다. 샘플 템플릿을 선택하여 두 버전을 모두 볼 수 있습니다. 또는 디컴파일을 선택하여 자체 ARM 템플릿을 업로드하고 동등한 Bicep 파일을 볼 수 있습니다.

다음 단계

모든 Bicep CLI 명령에 대해 알아보려면 Bicep CLI 명령을 참조하세요.

다음을 통해 공유