AzureResourceManagerTemplateDeployment@3 - ARM şablonu dağıtımı v3 görevi

Azure Resource Manager (ARM) şablonunu tüm dağıtım kapsamlarına dağıtmak için bu görevi kullanın.

Syntax

# ARM template deployment v3
# Deploy an Azure Resource Manager (ARM) template to all the deployment scopes.
- task: AzureResourceManagerTemplateDeployment@3
  inputs:
  # Azure Details
    deploymentScope: 'Resource Group' # 'Management Group' | 'Subscription' | 'Resource Group'. Required. Deployment scope. Default: Resource Group.
    azureResourceManagerConnection: # string. Alias: ConnectedServiceName. Required. Azure Resource Manager connection. 
    #subscriptionId: # string. Alias: subscriptionName. Required when deploymentScope != Management Group. Subscription. 
    #action: 'Create Or Update Resource Group' # 'Create Or Update Resource Group' | 'DeleteRG'. Required when deploymentScope = Resource Group. Action. Default: Create Or Update Resource Group.
    #resourceGroupName: # string. Required when deploymentScope = Resource Group. Resource group. 
    #location: # string. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Location. 
  # Template
    #templateLocation: 'Linked artifact' # 'Linked artifact' | 'URL of the file'. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Template location. Default: Linked artifact.
    #csmFileLink: # string. Required when templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template link. 
    #csmParametersFileLink: # string. Optional. Use when templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template parameters link. 
    #csmFile: # string. Required when templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template. 
    #csmParametersFile: # string. Optional. Use when templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template parameters. 
    #overrideParameters: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Override template parameters. 
    #deploymentMode: 'Incremental' # 'Incremental' | 'Complete' | 'Validation'. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment mode. Default: Incremental.
  # Advanced
    #deploymentName: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment name. 
    #deploymentOutputs: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment outputs. 
    #addSpnToEnvironment: false # boolean. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Access service principal details in override parameters. Default: false.
    #useWithoutJSON: false # boolean. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Use individual output values without JSON.Stringify applied. Default: false.

Girişler

deploymentScope - Dağıtım kapsamı
string. Gereklidir. İzin verilen değerler: Management Group, Subscription, Resource Group. Varsayılan değer: Resource Group.

Dağıtımın kapsamı. Dağıtım kapsamları hakkında daha fazla bilgi edinin.

azureResourceManagerConnection - Azure Resource Manager bağlantısı
Giriş diğer adı: ConnectedServiceName. string. Gereklidir.

Seçili dağıtım kapsamına erişimi olan Azure Resource Manager hizmeti bağlantısını belirtir.

subscriptionId - Abonelik
Giriş diğer adı: subscriptionName. string. olduğunda deploymentScope != Management Groupgereklidir.

Azure aboneliğini belirtir.

Önemli

Belirtilen değer abonelik adı değil abonelik kimliği olmalıdır.

action - Eylem
string. olduğunda deploymentScope = Resource Groupgereklidir. İzin verilen değerler: Create Or Update Resource Group, DeleteRG (Kaynak grubunu sil). Varsayılan değer: Create Or Update Resource Group.

Azure kaynakları veya kaynak grubunda gerçekleştirilecek eylem.

resourceGroupName - Kaynak grubu
string. olduğunda deploymentScope = Resource Groupgereklidir.

Kaynak grubunun adını sağlar.

location - Konum
string. olduğunda action = Create Or Update Resource Group || deploymentScope != Resource Groupgereklidir.

Kaynak Grubu dağıtım kapsamları: Kaynak grubunun dağıtılacağı konum. Kaynak grubu Azure aboneliğinde zaten varsa, bu değer yoksayılır. Diğer dağıtım kapsamları: Dağıtım meta verilerini depolama konumu.

templateLocation - Şablon konumu
string. olduğunda action = Create Or Update Resource Group || deploymentScope != Resource Groupgereklidir. İzin verilen değerler: Linked artifact, URL of the file. Varsayılan değer: Linked artifact.

Şablon ve Parametreler JSON dosyalarının konumu. Dosyalar bağlı kodun/derleme yapıtlarının bir parçasıysa Bağlantılı yapıt'ı seçin. Bağlantılı yapıtlar için Bicep dosyasının yolunu da belirtebilirsiniz. JSON dosyaları genel olarak erişilebilen http/https URL'lerinde bulunuyorsa dosyanın URL'sini seçin. Özel depolama hesabında depolanan bir dosyayı kullanmak için şablonun URL'sine paylaşılan erişim imzası (SAS) belirtecini alın ve ekleyin. Örnek: <blob_storage_url>/template.json?. Parametre dosyasını depolama hesabına yüklemek ve SAS belirteci oluşturmak için Azure dosya kopyalama görevini kullanabilir veya PowerShell veya Azure CLI kullanarak adımları izleyebilirsiniz.

csmFileLink - Şablon bağlantısı
string. olduğunda templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Groupgereklidir.

Şablon dosyasının URL'sini belirtir. Örnek URL: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.json

Özel depolama hesabında depolanan bir şablonu dağıtmak için, şablonun URL'sine paylaşılan erişim imzası (SAS) belirtecini alın ve ekleyin. Örnek: <blob_storage_url>/template.json?<SAStoken>. Bir şablon dosyasını (veya bağlantılı şablonu) depolama hesabına yüklemek ve SAS belirteci oluşturmak için Azure dosya kopyalama görevini kullanın veya PowerShell veya Azure CLI kullanarak adımları izleyin.

Şablon parametrelerini kılavuzda görüntülemek için geçersiz kılma şablonu parametreleri metin kutusunun yanındaki öğesine tıklayın ... . Bu özellik, kaynakta CORS kurallarının etkinleştirilmesini gerektirir. Şablonlar bir Azure depolama blobundaysa CORS'yi etkinleştirmek için Çıkış Noktaları Arası Kaynak Paylaşımı'na bakın.

csmParametersFileLink - Şablon parametreleri bağlantısı
string. İsteğe bağlı. olduğunda templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Groupkullanın.

Parametre dosyasının URL'sini belirtir. Örnek URL: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.parameters.json

Özel depolama hesabında depolanan bir dosyayı kullanmak için şablonun URL'sine paylaşılan erişim imzası (SAS) belirtecini alın ve ekleyin. Örnek: <blob_storage_url>/template.json?<SAStoken>. Bir şablon dosyasını (veya bağlantılı şablonu) depolama hesabına yüklemek ve SAS belirteci oluşturmak için Azure dosya kopyalama görevini kullanın veya PowerShell veya Azure CLI kullanarak adımları izleyin.

Şablon parametrelerini kılavuzda görüntülemek için Şablon parametrelerini geçersiz kıl metin kutusunun yanındaki öğesine tıklayın ... . Bu özellik, kaynakta CORS kurallarının etkinleştirilmesini gerektirir. Şablonlar bir Azure depolama blobundaysa CORS'yi etkinleştirmek için Çıkış Noktaları Arası Kaynak Paylaşımı'na bakın.

csmFile - Şablon
string. olduğunda templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Groupgereklidir.

Azure Resource Manager şablonunu işaret eden yolu veya deseni belirtir. Azure Resource Manager şablonları hakkında daha fazla bilgi edinin. Hemen başlamak için bu örnek şablonu kullanın. Azure CLI sürüm > 2.20.0 olduğunda Bicep dosyalarını destekler.

csmParametersFile - Şablon parametreleri
string. İsteğe bağlı. olduğunda templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Groupkullanın.

Azure Resource Manager şablonu için parametre dosyasının yolunu veya desenini belirtin. Azure CLI sürüm > 2.47.0 olduğunda Bicep Param dosyalarını destekler.

overrideParameters - Şablon parametrelerini geçersiz kılma
string. İsteğe bağlı. olduğunda action = Create Or Update Resource Group || deploymentScope != Resource Groupkullanın.

Geçersiz kılınacak şablon parametrelerini belirtir.

Şablon parametrelerini kılavuzda görüntülemek için, Geçersiz Kılma Parametreleri metin kutusunun yanındaki öğesine tıklayın ... . Bu özellik, kaynakta CORS kurallarının etkinleştirilmesini gerektirir. Şablonlar Azure depolama blobundaysa CORS'yi etkinleştirmek için bu dizeye başvurun veya metin kutusuna geçersiz kılmak üzere şablon parametrelerini yazın.

Örnek: -storageName fabrikam -adminUsername $(vmusername) -adminPassword (ConvertTo-SecureString -String '$(password)' -AsPlainText -Force) -azureKeyVaultName $(fabrikamFibre).

Parametre değerinin birden çok sözcüğü varsa, değişkenleri kullanarak değeri geçiriyor olsanız bile sözcükleri tırnak içine alın. Örneğin, -name "parameter value" -name2 "$(var)". Nesne türü parametrelerini geçersiz kılmak için dizeli JSON nesnelerini kullanın. Örneğin, -options ["option1"] -map {"key1": "value1" }.

deploymentMode - Dağıtım modu
string. olduğunda action = Create Or Update Resource Group || deploymentScope != Resource Groupgereklidir. İzin verilen değerler: Incremental, Complete, Validation (Yalnızca doğrulama). Varsayılan değer: Incremental.

Mod, Incremental dağıtımları kaynak grubuna yönelik artımlı güncelleştirmeler olarak işler. Kaynak grubunda var olan ancak şablonda belirtilmeyen değişmemiş kaynakları bırakır.

Complete modu, şablonunuzda olmayan kaynakları siler. Tam mod, artımlı moddan görece daha uzun sürer. Görev zaman aşımına uğradıysa zaman aşımını artırmayı veya moda geçmeyi Incremental göz önünde bulundurun.

Uyarı

Tamamlanma modu, kaynak grubundaki şablonda belirtilmeyen tüm mevcut kaynakları siler. Dağıttığınız kaynak grubunun şablonda belirtilmeyen gerekli kaynakları içermediğini gözden geçirin. Validate modu, gerçek kaynakları oluşturmadan önce şablonla ilgili sorunları bulmanıza olanak tanır.

Not

Hiçbir Validate kaynak dağıtılmasa bile mod her zaman bir kaynak grubu oluşturur. Dağıtım modları hakkında daha fazla bilgi edinin.

deploymentName - Dağıtım adı
string. İsteğe bağlı. olduğunda action = Create Or Update Resource Group || deploymentScope != Resource Groupkullanın.

Oluşturulacak kaynak grubu dağıtımının adını belirtir.

deploymentOutputs - Dağıtım çıkışları
string. İsteğe bağlı. olduğunda action = Create Or Update Resource Group || deploymentScope != Resource Groupkullanın.

Çıkış değişkeni için, geçerli dağıtım nesnesinin çıkışlar bölümünü dize biçiminde içeren bir ad sağlar. JSON nesnesini ayrıştırmak ve tek tek çıkış değerlerine erişmek için PowerShell cmdlet'ini kullanabilirsiniz ConvertFrom-Json . Dağıtım çıkışları hakkında daha fazla bilgi edinin.

addSpnToEnvironment - Geçersiz kılma parametrelerindeki hizmet sorumlusu ayrıntılarına erişme
boolean. İsteğe bağlı. olduğunda action = Create Or Update Resource Group || deploymentScope != Resource Groupkullanın. Varsayılan değer: false.

Betiğin yürütme ortamı olarak seçilen Azure uç noktasının hizmet sorumlusu kimliğini ve anahtarını ekler. ve $servicePrincipalKey değişkenleri $servicePrincipalId gibi -key $servicePrincipalKeygeçersiz kılma parametrelerinde olabilir.

useWithoutJSON - JSON olmadan tek tek çıkış değerlerini kullanın. Stringify uygulandı
boolean. İsteğe bağlı. olduğunda action = Create Or Update Resource Group || deploymentScope != Resource Groupkullanın. Varsayılan değer: false.

Tek tek çıkış değerleri JSON aracılığıyla dönüştürülüyor. Varsayılan olarak stringify. Çıkış değerlerini JSON aracılığıyla dönüştürmeden olduğu gibi kullanmak istiyorsanız. Stringify, bu seçeneği etkinleştirin. Daha fazla ayrıntı için buna bakın.

Görev denetim seçenekleri

Tüm görevlerde görev girişlerine ek olarak denetim seçenekleri vardır. Daha fazla bilgi için bkz . Denetim seçenekleri ve ortak görev özellikleri.

Çıkış değişkenleri

Yok.

Açıklamalar

Not

Bu görev, Azure CLI sürüm > 2.20.0 olduğunda Bicep dosyalarını destekler.

• Tüm dağıtım kapsamlarında dağıtım desteği eklendi.
  • VM ile ilgili tüm eylemler kaldırıldı.

Gereksinimler

Gereksinim	Açıklama
İşlem hattı türleri	YAML, Klasik derleme, Klasik sürüm
Üzerinde çalıştırılır	Agent, DeploymentGroup
Talep	Hiçbiri
Özellikler	Bu görev, işteki sonraki görevler için herhangi bir talebi karşılamaz.
Komut kısıtlamaları	Herhangi biri
Ayarlanabilir değişkenler	Herhangi biri
Aracı sürümü	2.119.1 veya üzeri
Görev kategorisi	Dağıtma