Aracılığıyla paylaş


Azure PowerShell belgeleri stil kılavuzu

Bu makale, aşağıdaki GitHub depolarında bulunan Azure PowerShell kavramsal ve başvuru içeriğine odaklanır:

Sürüm

Microsoft Learn belgelerinin çoğundan farklı olarak azure-docs-powershell deposundaki Azure PowerShell içeriği, desteklenen birden çok sürüm için korunur. Desteklenen sürümlerle ilgili ayrıntılar için bkz. Azure PowerShell destek yaşam döngüsü.

Bir makale önizleme modülündeki cmdlet'lere başvuruyorsa, AzPreview modülü zaten yüklenmediği sürece bu modülün açıkça yüklenmesi gerekir. Bunun nedeni, Az PowerShell modülüne yalnızca genel kullanıma açık (GA) modüllerinin eklenmesidir.

Önemli

AzureRM PowerShell modülündeki komutları makalelerde kullanmayın. AzureRM kullanım dışıdır.

Önkoşullar

Her zaman önce Azure hizmeti önkoşullarını, ardından Azure PowerShell ve Azure Cloud Shell yönergelerini yerleştirin. Örneğin, "Bu öğreticideki yönergeleri tamamlamak için Microsoft.Authorization/roleAssignments/write izinleriniz olmalıdır" ifadesi ilk olarak belirtilmelidir.

Tüm komutlar Cloud Shell ile uyumlu değilse, kullanıcıya Az PowerShell modülünü yerel olarak yüklemesini sağlayın. H2 Önkoşulları bölümüne aşağıdaki metni ekleyin.

- This tutorial requires that you run Azure PowerShell locally:
  - [Install the latest version of the Az PowerShell module](/powershell/azure/install-azure-powershell).
  - Connect to your Azure account using the
    [Connect-AzAccount](/powershell/module/az.accounts/connect-azaccount) cmdlet.

Paragraftaki söz dizimi öğelerini biçimlendirme

Azure PowerShell belgelerinde komut söz dizimi öğelerini biçimlendirmek için PowerShell-Docs stil kılavuzunu ve Düzenleyici'nin denetim listesini izleyin.

Cmdlet adlarını bir paragraf içinde anarken cmdlet belgelerine bağlantı vermeyin. Bunun yerine, satır içi kod için bir stil olan cmdlet adını ters tırnak işaretleri (``) ile çevreleyin. Sayfanın alt kısmına bir kaynaklar bölümü ekleyin. Referanslar bölümünde cmdlet adlarını listeleyin ve ilişkili referans makalesine bağlantı verin. Örneğin:

This is an example of using the `Connect-AzAccount` and `Get-AzVM` cmdlets within a
paragraph.

## References

- [Connect-AzAccount](/powershell/module/az.accounts/connect-azaccount)
- [Get-AzVM](/powershell/module/az.compute/get-azvm)

Uyarı

Hiperlinkteki ayraçlar içindeki metni biçimlendirmeyin. Azure PowerShell içeriğine bağlanma hakkında daha fazla bilgi için bkz. diğer belgelere bağlanma.

Parametre sırası

Azure PowerShell cmdlet'inin parametreleri, cmdlet yardımı tarafından tanımlanan sırada görünmelidir. Cmdlet'in gerekli parametreleri sağlamanın birden çok yolu olabilir. Bunu yaptığınızda, gösterdiğiniz kullanım için parametre kümesini takip edin. Connect-AzAccount, bir cmdlet'i çağırmanın birden çok yolunu içeren bir örnektir.

Değişkenler

Değişkenleri birden çok kod bloğunda yeniden kullanmaktan kaçının.

Okuyucu makale adımlarını farklı oturumlarda tamamlayabilir. Kod blokları arasında değişkenlerin kullanılması, doğru ayarlanmadıkları takdirde hatalara neden olabilir. Değişkenleri adımlar arasında kullanmanız gerekiyorsa, değişkenlerin sonraki adımlarda yeniden kullanıldığını açıkça belirtin.

Yeni kaynaklar için parolaları rastgele belirleme

Kendisiyle ilişkilendirilmiş parolası olan bir kaynak oluşturuyorsanız, sabit kodlanmış parola kullanmayın. Parolaları kaynak denetimine, hatta örneklere göre denetlemek bir güvenlik riskidir.

Makalenizdeki Azure kaynakları düz metin parola gerektiriyorsa, kullanıcıların parolalarını tanımlamasına izin vermek için Read-Host kullanın. MaskInput parametresi, parolanın PowerShell'in geçmişine kaydedilmesini engeller.

$password = Read-Host 'Enter a Password' -MaskInput

Adlandırma çakışmalarını önleme

Azure Container Registry ve Key Vault gibi bazı Azure kaynaklarının etki alanı adlarına bağlı kaynakları vardır. Bu kaynakların genel olarak benzersiz bir adı olmalıdır. Bu nedenle, benzersizlik gerektiğinde adların bir parçası olarak rastgele bir değer kullanın. Bunu yapmazsanız, betikler birden çok kişi tarafından çalıştırıldığında gerekli kaynakları oluşturamaz. Rastgelelik çakışmayı engellemez, ancak bunu hafifletebilir.

Bir ada rastgele sayı eklemek için Get-Random kullanın, örneğin:

$newAcrName = "myacr-$(Get-Random)"

Etkileşimli kod parçacıkları

Etkileşimli kod parçacıkları ne zaman kullanılır?

Cloud Shell makalenizdeki her Azure PowerShell komutunu destekliyorsa kod bloklarınızı azurepowershell-interactive etiketleyip kod parçacıklarına Open Cloud Shell düğmesini ekleyin:

```azurepowershell-interactive
Get-AzResourceGroup | Select-Object -Property ResourceGroupName, Location
```

Etkileşimli kod parçacıklarını kullanmamanız gereken durumlar

Makalenizde Cloud Shell'de çalışmayan herhangi bir Azure PowerShell komutu varsa azurepowershell-interactive kullanmayın. Yalnızca azurepowershell kullanın. Örneğin, cloud shell'de Install-AzAksCliTool cmdlet desteklenmez:

Install-AzAksCliTool

Cloud Shell işlevsel komutlarını Cloud Shell'de çalışmayan komutlarla karıştırırsanız, yalnızca bazı komutlar çalışırken müşterileri sinirlendirme riskiyle karşı karşıyasınız. Bunun yerine, karışıklığı önlemeye yardımcı olmak için tüm kod blokları için azurepowershell dil etiketine bağlı kalın.

Cloud Shell'de oturum açarken kullanıcıların kimliği zaten doğrulandığından, yalnızca azurepowershell-interactiveiçeren kod blokları için Connect-AzAccount etiketini kullanmayın. Bunun yerine azurepowershell dil etiketini kullanın.

AzureRM'yi Az PowerShell modülüne güncelleştirme

AzureRM PowerShell modülünü kullanan komutları Az PowerShell modülüne güncelleştirme hakkında bilgi için bkz. Azure PowerShell'i AzureRM'den Az'a geçirme.