ARM 템플릿 및 Azure PowerShell을 사용하여 리소스 배포
이 문서는 ARM 템플릿(Azure Resource Manager 템플릿)과 함께 Azure PowerShell을 사용하여 Azure에 리소스를 배포하는 방법을 설명합니다. Azure 솔루션 배포 및 관리 개념에 익숙하지 않은 경우 템플릿 배포 개요를 참조하세요.
팁
ARM 템플릿과 동일한 기능을 제공하고 구문이 사용하기 더 쉽기 때문에 Bicep를 권장합니다. 자세한 내용은 Bicep 및 Azure PowerShell을 사용하여 리소스 배포를 참조하세요.
필수 조건
배포할 템플릿이 필요합니다. 템플릿이 없는 경우 Azure 빠른 시작 템플릿 리포지토리에서 예제 템플릿을 다운로드하고 저장합니다. 이 문서에 사용된 로컬 파일 이름은 C:\MyTemplates\azuredeploy.json입니다.
Azure PowerShell을 설치하고 Azure에 연결해야 합니다.
- 로컬 컴퓨터에 Azure PowerShell cmdlet을 설치합니다. 자세한 내용은 Azure PowerShell 시작을 참조하세요.
- Connect-AZAccount를 사용하여 Azure에 연결합니다. Azure 구독이 여러 개인 경우 Set-AzContext를 실행해야 할 수도 있습니다. 자세한 내용은 여러 Azure 구독 사용을 참조하세요.
PowerShell이 설치되어 있지 않으면 Azure Cloud Shell을 사용할 수 있습니다. 자세한 내용은 Azure Cloud Shell에서 ARM 템플릿 배포를 참조하세요.
필요한 사용 권한
Bicep 파일 또는 ARM 템플릿을 배포하려면 배포하는 리소스에 대한 쓰기 액세스 및 Microsoft.Resources/deployments 리소스 형식의 모든 작업에 대한 액세스가 필요합니다. 예를 들어 가상 머신을 배포하려면 Microsoft.Compute/virtualMachines/write
및 Microsoft.Resources/deployments/*
권한이 필요합니다. 가상 작업에는 동일한 사용 권한 요구 사항이 있습니다.
역할 및 사용 권한 목록은 Azure 기본 제공 역할을 참조하세요.
배포 범위
리소스 그룹, 구독, 관리 그룹 또는 테넌트를 배포 대상으로 지정할 수 있습니다. 배포의 범위에 따라 다른 명령을 사용합니다.
리소스 그룹에 배포하려면 New-AzResourceGroupDeployment를 사용합니다.
New-AzResourceGroupDeployment -ResourceGroupName <resource-group-name> -TemplateFile <path-to-template>
구독에 배포하려면
New-AzDeployment
cmdlet의 별칭인 New-AzSubscriptionDeployment를 사용합니다.New-AzSubscriptionDeployment -Location <location> -TemplateFile <path-to-template>
구독 수준 배포에 대한 자세한 내용은 구독 수준에서 리소스 그룹 및 리소스 만들기를 참조하세요.
관리 그룹에 배포하려면 New-AzManagementGroupDeployment를 사용합니다.
New-AzManagementGroupDeployment -Location <location> -TemplateFile <path-to-template>
관리 그룹 수준 배포에 대한 자세한 내용은 관리 그룹 수준에서 리소스 만들기를 참조하세요.
테넌트에 배포하려면 New-AzTenantDeployment를 사용합니다.
New-AzTenantDeployment -Location <location> -TemplateFile <path-to-template>
테넌트 수준 배포에 대한 자세한 내용은 테넌트 수준에서 리소스 만들기를 참조하세요.
모든 범위에서 템플릿을 배포하는 사용자는 리소스를 만드는 데 필요한 권한이 있어야 합니다.
배포 이름
ARM 템플릿을 배포할 때 배포 이름을 지정할 수 있습니다. 해당 이름은 배포 기록에서 배포를 검색하는 데 도움이 될 수 있습니다. 배포에 이름을 제공하지 않으면 템플릿 파일의 이름이 사용됩니다. 예를 들어, azuredeploy.json
이라는 템플릿을 배포하고 배포 이름을 지정하지 않으면 배포 이름은 azuredeploy
로 지정됩니다.
배포를 실행할 때마다 리소스 그룹의 배포 기록에 항목이 배포 이름과 함께 추가됩니다. 다른 배포를 실행하고 동일한 이름을 지정하는 경우 이전 항목이 현재 배포로 바뀝니다. 배포 기록에서 고유한 항목을 유지하려면 각 배포에 고유한 이름을 지정합니다.
고유한 이름을 만들려면 임의의 번호를 할당하면 됩니다.
$suffix = Get-Random -Maximum 1000
$deploymentName = "ExampleDeployment" + $suffix
또는 날짜 값을 추가할 수 있습니다.
$today=Get-Date -Format "MM-dd-yyyy"
$deploymentName="ExampleDeployment"+"$today"
같은 배포 이름의 동일한 리소스 그룹에 동시 배포를 실행하는 경우 마지막 배포만 완료됩니다. 완료되지 않은 동일한 이름의 배포는 마지막 배포로 대체됩니다. 예를 들어 storage1
이라는 스토리지 계정을 배포하는 newStorage
라는 배포를 실행하는 동시에 storage2
라는 스토리지 계정을 배포하는 newStorage
라는 다른 배포를 실행하는 경우 스토리지 계정을 하나만 배포합니다. 결과 스토리지 계정의 이름은 storage2
입니다.
그러나 storage1
이라는 스토리지 계정을 배포하는 newStorage
라는 배포를 실행하고 배포가 완료된 직후에 storage2
라는 스토리지 계정을 배포하는 newStorage
라는 다른 배포를 실행하면 두 개의 스토리지 계정이 배포됩니다. 하나는 storage1
이고 다른 하나는 storage2
입니다. 그러나 배포 기록에는 하나의 항목만 기록됩니다.
각 배포에 고유한 이름을 지정하는 경우 충돌 없이 동시에 실행할 수 있습니다. storage1
이라는 스토리지 계정을 배포하는 newStorage1
이라는 배포를 실행하는 동시에 storage2
라는 스토리지 계정을 배포하는 newStorage2
라는 다른 배포를 실행하면 두 개의 스토리지 계정이 배포되고 배포 기록에 두 개의 항목이 기록됩니다.
동시 배포와의 충돌을 방지하고 배포 기록에서 고유한 항목이 기록되게 하려면 각 배포에 고유한 이름을 지정합니다.
로컬 템플릿 배포
로컬 컴퓨터 또는 외부에 저장된 템플릿을 배포할 수 있습니다. 이 섹션에서는 로컬 템플릿 배포에 대해 설명합니다.
존재하지 않는 리소스 그룹에 배포하는 경우 리소스 그룹을 만듭니다. 리소스 그룹의 이름은 영숫자, 마침표, 밑줄, 하이픈 및 괄호만 포함할 수 있습니다. 최대 90자까지 가능합니다. 이름은 마침표로 끝날 수 없습니다.
New-AzResourceGroup -Name ExampleGroup -Location "Central US"
로컬 템플릿을 배포하려면 배포 명령에 -TemplateFile
매개 변수를 사용합니다. 다음 예제에서는 템플릿에서 제공되는 매개 변수 값을 설정하는 방법을 보여 줍니다.
New-AzResourceGroupDeployment `
-Name ExampleDeployment `
-ResourceGroupName ExampleGroup `
-TemplateFile <path-to-template>
배포를 완료하는 데 몇 분 정도 걸릴 수 있습니다.
원격 템플릿 배포
로컬 컴퓨터에 ARM 템플릿을 저장하는 대신, 외부 위치에 저장할 수 있습니다. 원본 제어 리포지토리(예: GitHub)에 템플릿을 저장할 수 있습니다. 또는 조직에서 공유 액세스에 대한 Azure Storage 계정에 저장할 수 있습니다.
참고 항목
템플릿을 배포하거나 프라이빗 GitHub 리포지토리에 저장된 연결된 템플릿을 참조하려면 사용자 지정 및 보안 Azure Portal 제품 만들기에 설명된 사용자 지정 솔루션을 참조하세요. Azure Key Vault에서 GitHub 토큰을 가져오는 Azure 함수를 만들 수 있습니다.
존재하지 않는 리소스 그룹에 배포하는 경우 리소스 그룹을 만듭니다. 리소스 그룹의 이름은 영숫자, 마침표, 밑줄, 하이픈 및 괄호만 포함할 수 있습니다. 최대 90자까지 가능합니다. 이름은 마침표로 끝날 수 없습니다.
New-AzResourceGroup -Name ExampleGroup -Location "Central US"
외부 템플릿을 배포하려면 -TemplateUri
매개 변수를 사용합니다.
New-AzResourceGroupDeployment `
-Name remoteTemplateDeployment `
-ResourceGroupName ExampleGroup `
-TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json
앞의 예제에서는 템플릿에 중요한 데이터가 포함되어 있지 않으므로 대부분의 시나리오에 적합한 이 템플릿에 대해 공개적으로 액세스할 수 있는 URI가 필요합니다. 중요한 데이터(예: 관리자 암호)를 지정해야 하는 경우 해당 값을 안전한 매개 변수로 전달합니다. 그러나 템플릿에 대한 액세스를 관리하려는 경우 템플릿 사양을 사용하는 것이 좋습니다.
스토리지 계정에 저장된 상대 경로를 사용하여 원격 연결된 템플릿을 배포하려면 QueryString
을 사용하여 SAS 토큰을 지정합니다.
New-AzResourceGroupDeployment `
-Name linkedTemplateWithRelativePath `
-ResourceGroupName "myResourceGroup" `
-TemplateUri "https://stage20210126.blob.core.windows.net/template-staging/mainTemplate.json" `
-QueryString "$sasToken"
자세한 내용은 연결된 템플릿에 상대 경로 사용을 참조하세요.
템플릿 사양 배포
로컬 또는 원격 템플릿을 배포하는 대신 템플릿 사양을 만들 수 있습니다. 템플릿 사양은 ARM 템플릿이 포함된 Azure 구독의 리소스입니다. 이를 통해 조직의 사용자와 템플릿을 쉽고 안전하게 공유할 수 있습니다. Azure RBAC(역할 기반 액세스 제어)를 사용하여 템플릿 사양에 대한 액세스 권한을 부여합니다. 이 기능은 현재 미리 보기로 제공됩니다.
다음 예제에서는 템플릿 사양을 만들고 배포하는 방법을 보여 줍니다.
먼저 ARM 템플릿을 제공하여 템플릿 사양을 만듭니다.
New-AzTemplateSpec `
-Name storageSpec `
-Version 1.0 `
-ResourceGroupName templateSpecsRg `
-Location westus2 `
-TemplateJsonFile ./mainTemplate.json
그런 다음 템플릿 사양의 ID를 가져와서 배포합니다.
$id = (Get-AzTemplateSpec -Name storageSpec -ResourceGroupName templateSpecsRg -Version 1.0).Versions.Id
New-AzResourceGroupDeployment `
-ResourceGroupName demoRG `
-TemplateSpecId $id
자세한 내용은 Azure Resource Manager 템플릿 사양을 참조하세요.
변경 미리 보기
템플릿을 배포하기 전에 템플릿이 환경에 적용할 변경사항을 미리 볼 수 있습니다. 가상 작업을 사용하여 템플릿이 예상대로 변경사항을 적용하는지 확인합니다. 가상 작업은 템플릿의 오류도 확인합니다.
매개 변수 값 전달
매개 변수 값을 전달하려면 인라인 매개 변수 또는 매개 변수 파일을 사용할 수 있습니다. 매개 변수 파일은 Bicep 매개 변수 파일 또는 JSON 매개 변수 파일일 수 있습니다.
인라인 매개 변수입니다.
인라인 매개 변수를 전달하려면 New-AzResourceGroupDeployment
명령을 사용하여 매개 변수 이름을 제공합니다. 예를 들어, 문자열 및 배열을 템플릿에 전달하려면 다음을 사용합니다.
$arrayParam = "value1", "value2"
New-AzResourceGroupDeployment -ResourceGroupName testgroup `
-TemplateFile <path-to-template> `
-exampleString "inline string" `
-exampleArray $arrayParam
매개 변수를 사용하여 템플릿에 TemplateParameterObject
대한 매개 변수가 포함된 해시 테이블을 통과할 수 있습니다.
$params = @{
exampleString = "inline string"
exampleArray = "value1", "value2"
}
New-AzResourceGroupDeployment -ResourceGroupName testgroup `
-TemplateFile <path-to-bicep> `
-TemplateParameterObject $params
파일의 콘텐츠를 가져와서 해당 콘텐츠를 인라인 매개 변수로 제공할 수도 있습니다.
$arrayParam = "value1", "value2"
New-AzResourceGroupDeployment -ResourceGroupName testgroup `
-TemplateFile <path-to-template> `
-exampleString $(Get-Content -Path c:\MyTemplates\stringcontent.txt -Raw) `
-exampleArray $arrayParam
파일에서 매개 변수 값을 가져오면 구성 값을 제공해야 하는 경우에 유용합니다. 예를 들어, Linux 가상 머신에 대한 Cloud-Init 값을 제공할 수 있습니다.
개체의 배열을 전달해야 하는 경우 PowerShell에서 해시 테이블을 만들고 배열에 추가합니다. 배포하는 동안 해당 배열을 매개 변수로 전달합니다.
$hash1 = @{ Name = "firstSubnet"; AddressPrefix = "10.0.0.0/24"}
$hash2 = @{ Name = "secondSubnet"; AddressPrefix = "10.0.1.0/24"}
$subnetArray = $hash1, $hash2
New-AzResourceGroupDeployment -ResourceGroupName testgroup `
-TemplateFile <path-to-template> `
-exampleArray $subnetArray
JSON 매개 변수 파일
매개 변수를 스크립트에 인라인 값으로 전달하는 것보다는, 매개 변수 값이 포함된 JSON 파일을 사용하는 것이 더 쉬울 수 있습니다. 매개 변수 파일은 로컬 파일이거나 액세스 가능한 URI가 있는 외부 파일일 수 있습니다.
매개 변수 파일에 대한 자세한 내용은 Resource Manager 매개 변수 파일 만들기를 참조하세요.
로컬 매개 변수 파일을 전달하려면 TemplateParameterFile
매개 변수를 사용하세요.
New-AzResourceGroupDeployment `
-Name ExampleDeployment `
-ResourceGroupName ExampleResourceGroup `
-TemplateFile <path-to-template> `
-TemplateParameterFile c:\MyTemplates\storage.parameters.json
외부 매개 변수 파일을 전달하려면 TemplateParameterUri
매개 변수를 사용하세요.
New-AzResourceGroupDeployment `
-Name ExampleDeployment `
-ResourceGroupName ExampleResourceGroup `
-TemplateUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json `
-TemplateParameterUri https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.parameters.json
매개 변수 파일에 대한 자세한 내용은 Resource Manager 매개 변수 파일 만들기를 참조하세요.
Bicep 매개 변수 파일
Azure PowerShell 버전 10.4.0 이상 및 Bicep CLI 버전 0.22.6 이상에서는 Bicep 매개 변수 파일을 활용하여 ARM 템플릿 파일을 배포할 수 있습니다. Bicep 매개 변수 파일 내의 using
문을 사용하면 -TemplateParameterFile
스위치에 대한 Bicep 매개 변수 파일을 지정할 때 -TemplateFile
스위치를 제공할 필요가 없습니다.
다음 예제에서는 storage.bicepparam이라는 매개 변수 파일을 보여 줍니다. 파일은 명령이 실행되는 동일한 디렉터리에 있습니다.
New-AzResourceGroupDeployment `
-Name ExampleDeployment `
-ResourceGroupName ExampleResourceGroup `
-TemplateParameterFile storage.bicepparam
Bicep 매개 변수 파일에 대한 자세한 내용은 Bicep 매개 변수 파일을 참조하세요.
다음 단계
- 오류 발생 시 성공적인 배포로 롤백하려면 오류 발생 시 성공적인 배포로 롤백을 참조하세요.
- 리소스 그룹에 있지만 템플릿에 정의되지 않은 리소스를 처리하는 방법을 지정하려면 Azure Resource Manager 배포 모드를 참조하세요.
- 템플릿에서 매개 변수를 정의하는 방법을 이해하려면 ARM 템플릿의 구조 및 구문 이해를 참조하세요.
- SAS 토큰이 필요한 템플릿을 배포하는 데 관한 내용은 SAS 토큰으로 프라이빗 ARM 템플릿 배포를 참조하세요.