Bıcep için en iyi yöntemler

Bu makalede, Bıcep dosyalarınızı geliştirirken izlenecek yöntemler önerilmektedir. Bu uygulamalar, Bıcep dosyanızı daha kolay anlaşılır ve kullanılabilir hale getirir.

Parametreler

  • Parametre bildirimleri için iyi adlandırma kullanın. İyi adlar, şablonlarınızı okumayı ve anlamayı kolay hale getirir. Açık, açıklayıcı adlar kullandığınızdan ve adlandırmada tutarlı olduğundan emin olun.

  • Şablonunuzun kullandığı parametreleri dikkatle düşünün. Dağıtımlar arasında değişen ayarlar için parametreleri kullanmayı deneyin. Değişkenler ve sabit kodlanmış değerler, dağıtımlar arasında değişmeyin ayarlar için kullanılabilir.

  • En az kullandığınız varsayılan değerler vardır. Varsayılan değerlerin dağıtılması için güvenli olduğundan emin olun. Örneğin, şablonu bir test ortamına dağıtmaya yönelik birisinin büyük bir maliyeti gereksiz bir şekilde gerçekleştirmemesi için düşük maliyetli fiyatlandırma katmanları ve SKU 'Ları kullanmayı göz önünde bulundurun.

  • Dekoratörü gelişigüzel bir şekilde kullanın @allowed . Bu dekoratörü çok geniş kullanıyorsanız, geçerli dağıtımları engelleyebilirsiniz. Azure hizmetleri SKU 'Ları ve boyutları eklerken izin verilen listeniz güncel olmayabilir. Örneğin, yalnızca Premium v3 SKU 'Larına izin verilmesi üretimde anlamlı olabilir, ancak üretim dışı ortamlarda aynı şablonu kullanmanızı önler.

  • Parametreleriniz için açıklama sağlamak iyi bir uygulamadır. Açıklamaları yararlı yapmayı deneyin ve şablonun parametre değerlerine ihtiyacı olan önemli bilgileri sağlayın.

    //Bazı bilgiler için de açıklamaları kullanabilirsiniz.

  • Parametre bildirimlerini şablon dosyasında herhangi bir yere koyabilirsiniz, ancak bicep kodunuzun okunması kolay bir şekilde dosyanın en üstüne koymak iyi bir fikir olsa da,

  • Adlandırmayı denetleyen parametrelerin en küçük ve en büyük karakter uzunluğunu belirtmek iyi bir uygulamadır. Bu sınırlamalar, daha sonra dağıtım sırasında hata oluşmasını önlemeye yardımcı olur.

Bıcep parametreleri hakkında daha fazla bilgi için bkz. bıcep Içindeki parametreler.

Değişkenler

  • Gibi değişken adlar için ortası büyük/küçük harf kullanın myVariableName .

  • Bir değişken tanımladığınızda, veri türü gerekli değildir. Değişkenler, çözümleme değerinden türü çıkarçıkar.

  • Bir değişken oluşturmak için Bıcep işlevlerini kullanabilirsiniz.

  • Bicep dosyanızda bir değişken tanımlandıktan sonra, değişkenin adını kullanarak değere başvurduktan sonra.

Bıcep değişkenleri hakkında daha fazla bilgi için bkz. bıcep Içindeki değişkenler.

Adlandırma

  • Uniquestring () işlevi , genel olarak benzersiz kaynak adları oluşturmak için kullanışlıdır. Aynı parametreleri sağladığınızda, her seferinde aynı dizeyi döndürür. Kaynak grubu KIMLIĞINI geçirmek, dizenin aynı kaynak grubundaki her dağıtımda aynı olduğu, ancak farklı kaynak gruplarına veya aboneliklerine dağıtırken farklı olduğu anlamına gelir.

  • Bazen uniqueString() işlev bir sayıyla başlayan dizeler oluşturur. Depolama hesapları gibi bazı Azure kaynakları, adlarının sayılarla başlamalarına izin vermez. Bu gereksinim, kaynak adları oluşturmak için dize ilişkilendirmeyi kullanmak iyi bir fikir olduğu anlamına gelir. Benzersiz dizeye bir ön ek ekleyebilirsiniz.

  • Kaynak adları oluşturmak için şablon ifadeleri kullanmak genellikle iyi bir fikirdir. Birçok Azure Kaynak türü, izin verilen karakterler ve adlarının uzunluğu hakkında kurallara sahiptir. Kaynak adlarının şablonda oluşturulmasına eklemek, şablonu kullanan herkesin bu kuralların kendisini takip etmek zorunda olmayacağı anlamına gelir.

Kaynak tanımları

  • Karmaşık ifadeleri doğrudan kaynak özelliklerine katıştırmak yerine, ifadeleri içeren değişkenleri kullanın. Bu yaklaşım, Bıcep dosyanızı okumayı ve anlamayı daha kolay hale getirir. Kaynak tanımlarınızı mantığa göre karışıklık önler.

  • Kaynakların nasıl davrandığına ilişkin varsayımlar yapmak yerine kaynak özelliklerini çıkış olarak kullanmayı deneyin. Örneğin, URL 'YI bir App Service uygulamasına almanız gerekiyorsa, URL için bir dize oluşturmak yerine uygulamanın defaultHostname özelliğini kullanın. Bazı durumlarda bu varsayımlar farklı ortamlarda doğru değildir veya kaynaklar çalıştıkları şekilde değişir. Kaynağın kendi özelliklerini söylemeniz daha güvenlidir.

  • Her kaynak için son API sürümünü kullanmak iyi bir fikirdir. Azure hizmetlerindeki yeni özellikler bazen yalnızca daha yeni API sürümlerinde kullanılabilir.

  • Mümkün olduğunda, Bıcep dosyanızdaki Reference ve RESOURCEID işlevlerini kullanmaktan kaçının. Bıcep içindeki herhangi bir kaynağa simgesel adı kullanarak erişebilirsiniz. Örneğin, toyDesignDocumentsStorageAccount sembolik adına sahip bir depolama hesabı tanımlarsanız, ifadesini kullanarak kaynak KIMLIĞINE erişebilirsiniz toyDesignDocumentsStorageAccount.id . Sembolik adı kullanarak, kaynaklar arasında örtük bir bağımlılık oluşturursunuz.

  • Kaynak Bıcep dosyasında dağıtılmamışsa, anahtar sözcüğünü kullanarak kaynağa bir sembolik başvuru almaya devam edebilirsiniz existing .

Alt kaynaklar

  • Çok sayıda katmanı çok derin iç içe geçirmeyi önleyin. Çok fazla iç içe geçme, Bıcep kodunuzun okunmasını ve birlikte çalışmasını zorlaştırır.

  • Alt kaynaklar için kaynak adları oluşturmaktan kaçınmak en iyisidir. , Kaynaklarınız arasındaki ilişkileri anladığı zaman Bıcep 'nin sağladığı avantajları kaybedersiniz. parentBunun yerine özelliği veya iç içe geçme özelliğini kullanın.

Çıkışlar

  • Hassas veriler için çıkış oluşturmayın. Dağıtım geçmişine erişebilen herkes, çıkış değerlerine erişebilir. Gizli dizileri işlemek için uygun değildir.

  • Çıkış aracılığıyla özellik değerlerini geçirmek yerine, existing zaten mevcut olan kaynakların özelliklerini aramak için anahtar sözcüğünü kullanın. Bu şekilde, diğer kaynaklardan gelen anahtarları çıktılar aracılığıyla iletmek yerine bu şekilde aramak en iyi uygulamadır. En güncel verileri her zaman alacaksınız.

Bıcep çıkışları hakkında daha fazla bilgi için bkz. bıcep Içindeki çıkışlar.

Kiracı kapsamları

Kiracı kapsamındailke veya rol atamaları oluşturamazsınız. Ancak, tüm kuruluşunuz genelinde erişim vermeniz veya ilkeleri uygulamanız gerekiyorsa, bu kaynakları kök yönetim grubuna dağıtabilirsiniz.

Sonraki adımlar