Not
Bu sayfaya erişim yetkilendirme gerektiriyor. Oturum açmayı veya dizinleri değiştirmeyi deneyebilirsiniz.
Bu sayfaya erişim yetkilendirme gerektiriyor. Dizinleri değiştirmeyi deneyebilirsiniz.
Açıklamalar
Anahtar kasalarının güvenli değerler için kullanılmasına dair rehberlik için bkz. Manage secrets using Bicep.
Bir sır oluşturma hakkında hızlı bir başlangıç için bkz. Quickstart: Bir ARM şablonu kullanarak Azure Key Vault'dan bir sır ayarlayın ve alın.
Anahtar oluşturma hakkında hızlı bir başlangıç için bkz. Quickstart: ARM template kullanarak bir Azure anahtar kasası ve bir anahtar oluştur.
Bicep kaynak tanımı
Kasalar/anahtarlar kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- kaynak grupları
- Bkz. kaynak grubu dağıtım komutları
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Kaynak biçimi
Microsoft.KeyVault/vaults/keys kaynağı oluşturmak için aşağıdaki Bicep'i şablonunuza ekleyin.
resource symbolicname 'Microsoft.KeyVault/vaults/keys@2025-05-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
attributes: {
enabled: bool
exp: int
exportable: bool
nbf: int
}
curveName: 'string'
keyOps: [
'string'
]
keySize: int
kty: 'string'
release_policy: {
contentType: 'string'
data: 'string'
}
rotationPolicy: {
attributes: {
expiryTime: 'string'
}
lifetimeActions: [
{
action: {
type: 'string'
}
trigger: {
timeAfterCreate: 'string'
timeBeforeExpiry: 'string'
}
}
]
}
}
tags: {
{customized property}: 'string'
}
}
Özellik Değerleri
Microsoft.KeyVault/vaults/keys
| Ad | Açıklama | Değer |
|---|---|---|
| ad | Kaynak adı | dizgi Kısıtlama -ları: Desen = ^[a-zA-Z0-9-]{1,127}$ (gerekli) |
| ebeveyn | Bicep'te, bir çocuk kaynağın ana kaynağını belirtebilirsiniz. Bu özelliği yalnızca alt kaynak üst kaynağın dışında bildirildiğinde eklemeniz gerekir. Daha fazla bilgi için bkz. Alt kaynaküst kaynak dışında. |
Kaynak türü için sembolik ad: kasalar |
| Özellikler | Oluşturulacak anahtarın özellikleri. | KeyProperties (gerekli) |
| Etiketler | Kaynak etiketleri | Etiket adları ve değerleri sözlüğü. Bkz. şablonlardaki Etiketleri |
Eylem
| Ad | Açıklama | Değer |
|---|---|---|
| tür | Eylem türü. | 'BİLDİRİM' 'döndürme' |
Anahtar Öznitelikler
| Ad | Açıklama | Değer |
|---|---|---|
| Etkin | Nesnenin etkinleştirilip etkinleştirilmediğini belirler. | Bool |
| Exp | 1970-01-01T00:00:00Z tarihinden itibaren saniye olarak süre sonu tarihi. | Int |
| dışarı aktarılabilir | Özel anahtarın dışarı aktarılıp aktarılamadığını gösterir. | Bool |
| nbf (İngilizce) | 1970-01-01T00:00:00Z tarihinden itibaren saniyeler içinde önceki tarih değil. | Int |
KeyCreateParametersTags
| Ad | Açıklama | Değer |
|---|
Anahtar Özellikler
| Ad | Açıklama | Değer |
|---|---|---|
| Öznitelik | Anahtarın öznitelikleri. | KeyAttributes |
| eğri adı | Eliptik eğri adı. Geçerli değerler için bkz. JsonWebKeyCurveName. EC ve EC-HSM tuşları için varsayılan değer P-256'dır | 'P-256' 'P-256K' 'P-384' 'P-521' |
| anahtar Operasyonlar | Herhangi birini içeren dize dizisi: 'şifre çözme' 'şifrelemek' 'İçe Aktar' 'Serbest bırakmak' 'İşaret' 'unwrapKey' 'Doğrula' 'wrapKey' |
|
| anahtar boyutu | Bit cinsinden anahtar boyutu. Örneğin: RSA için 2048, 3072 veya 4096. RSA ve RSA-HSM anahtarları için varsayılan değer 2048'dir. Kendi anahtarını getir (BYOK), anahtar değişim anahtarları varsayılan olarak 4096 için özel durum yapıldı. | Int |
| kty | Anahtarın türü. Geçerli değerler için bkz. JsonWebKeyType. | 'AK' 'EC-HSM' 'RSA' 'RSA-HSM' |
| release_policy | Yanıt olarak önemli sürüm ilkesi. Hem çıkış hem de giriş için kullanılır. Boşsa atlanır | KeyReleasePolicy (Anahtar Yayın İlkesi) |
| rotationPolicy (Rotasyon İlkesi | Yanıt olarak anahtar döndürme ilkesi. Hem çıkış hem de giriş için kullanılır. Boşsa atlanır | Rotasyon Politikası |
KeyReleasePolicy (Anahtar Yayın İlkesi)
| Ad | Açıklama | Değer |
|---|---|---|
| içerik türü | Anahtar yayın ilkesinin içerik türü ve sürümü | dizgi |
| veri | Blob kodlaması, anahtarın hangi ilke kurallarının altında serbest bırakılabilmesini sağlar. | dizgi |
KeyRotationPolicyAttributes
| Ad | Açıklama | Değer |
|---|---|---|
| sona erme süresi | Yeni anahtar sürümü için süre sonu. ISO8601 biçimde olmalıdır. Örneğin: 'P90D', 'P1Y'. | dizgi |
Ömür Boyu Eylem
| Ad | Açıklama | Değer |
|---|---|---|
| eylem | Anahtar döndürme ilkesi lifetimeAction eylemi. | eylem |
| tetiklemek | Anahtar döndürme ilkesi lifetimeAction tetikleyicisi. | Tetikleyici |
Rotasyon Politikası
| Ad | Açıklama | Değer |
|---|---|---|
| Öznitelik | Anahtar döndürme ilkesinin öznitelikleri. | KeyRotationPolicyAttributes |
| ömür boyu Eylemler | Anahtar döndürme eylemi için lifetimeActions. | Ömür Boyu Eylem[] |
Tetiklemek
| Ad | Açıklama | Değer |
|---|---|---|
| timeAfterCreate | Anahtarı döndürmek için anahtar oluşturulduktan sonraki süre. Yalnızca döndürmek için geçerlidir. ISO 8601 süre biçiminde olacaktır. Örneğin: 'P90D', 'P1Y'. | dizgi |
| timeBeforeExpiration | Döndürmek veya bildirmek için anahtarın süresi dolmadan önceki süre. ISO 8601 süre biçiminde olacaktır. Örneğin: 'P90D', 'P1Y'. | dizgi |
Kullanım Örnekleri
Bicep Örnekleri
Key Vault Keys'in açılışına temel bir örnek.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource vault 'Microsoft.KeyVault/vaults@2023-02-01' = {
name: resourceName
location: location
properties: {
accessPolicies: []
enablePurgeProtection: true
enableSoftDelete: true
sku: {
family: 'A'
name: 'standard'
}
tenantId: deployer().tenantId
}
}
resource putAccesspolicy 'Microsoft.KeyVault/vaults/accessPolicies@2023-02-01' = {
parent: vault
name: 'add'
properties: {
accessPolicies: [
{
objectId: deployer().objectId
permissions: {
certificates: [
'ManageContacts'
]
keys: [
'Get'
'Create'
'Delete'
'List'
'Restore'
'Recover'
'UnwrapKey'
'WrapKey'
'Purge'
'Encrypt'
'Decrypt'
'Sign'
'Verify'
]
secrets: [
'Get'
]
storage: []
}
tenantId: deployer().tenantId
}
]
}
}
resource putKey 'Microsoft.KeyVault/vaults/keys@2023-02-01' = {
parent: vault
name: resourceName
properties: {
keyOps: [
'encrypt'
'decrypt'
'sign'
'verify'
'wrapKey'
'unwrapKey'
]
keySize: 2048
kty: 'RSA'
}
dependsOn: [
putAccesspolicy
]
}
Azure Doğrulanmış Modülleri
Aşağıdaki Azure Doğrulanmış Modüller bu kaynak türünü dağıtmak için kullanılabilir.
| Modül | Açıklama |
|---|---|
| Key Vault - Anahtar | Key Vault için AVM Child Modülü - Key |
Azure Hızlı Başlangıç Örnekleri
Aşağıdaki Azure Hızlı Başlat şablonları bu kaynak türünü dağıtmak için Bicep örnek içerir.
| Bicep Dosyası | Açıklama |
|---|---|
| Bu şablon, müşteri tarafından yönetilen bir anahtarla bir Depolama Hesabı açar ve şifreleme için oluşturulur ve bir Key Vault'a yerleştirilir. |
ARM şablonu kaynak tanımı
Kasalar/anahtarlar kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- kaynak grupları
- Bkz. kaynak grubu dağıtım komutları
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Kaynak biçimi
Microsoft.KeyVault/vaults/keys kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.
{
"type": "Microsoft.KeyVault/vaults/keys",
"apiVersion": "2025-05-01",
"name": "string",
"properties": {
"attributes": {
"enabled": "bool",
"exp": "int",
"exportable": "bool",
"nbf": "int"
},
"curveName": "string",
"keyOps": [ "string" ],
"keySize": "int",
"kty": "string",
"release_policy": {
"contentType": "string",
"data": "string"
},
"rotationPolicy": {
"attributes": {
"expiryTime": "string"
},
"lifetimeActions": [
{
"action": {
"type": "string"
},
"trigger": {
"timeAfterCreate": "string",
"timeBeforeExpiry": "string"
}
}
]
}
},
"tags": {
"{customized property}": "string"
}
}
Özellik Değerleri
Microsoft.KeyVault/vaults/keys
| Ad | Açıklama | Değer |
|---|---|---|
| apiVersiyonu | API sürümü | '2025-05-01' |
| ad | Kaynak adı | dizgi Kısıtlama -ları: Desen = ^[a-zA-Z0-9-]{1,127}$ (gerekli) |
| Özellikler | Oluşturulacak anahtarın özellikleri. | KeyProperties (gerekli) |
| Etiketler | Kaynak etiketleri | Etiket adları ve değerleri sözlüğü. Bkz. şablonlardaki Etiketleri |
| tür | Kaynak türü | 'Microsoft.KeyVault/vaults/keys' |
Eylem
| Ad | Açıklama | Değer |
|---|---|---|
| tür | Eylem türü. | 'BİLDİRİM' 'döndürme' |
Anahtar Öznitelikler
| Ad | Açıklama | Değer |
|---|---|---|
| Etkin | Nesnenin etkinleştirilip etkinleştirilmediğini belirler. | Bool |
| Exp | 1970-01-01T00:00:00Z tarihinden itibaren saniye olarak süre sonu tarihi. | Int |
| dışarı aktarılabilir | Özel anahtarın dışarı aktarılıp aktarılamadığını gösterir. | Bool |
| nbf (İngilizce) | 1970-01-01T00:00:00Z tarihinden itibaren saniyeler içinde önceki tarih değil. | Int |
KeyCreateParametersTags
| Ad | Açıklama | Değer |
|---|
Anahtar Özellikler
| Ad | Açıklama | Değer |
|---|---|---|
| Öznitelik | Anahtarın öznitelikleri. | KeyAttributes |
| eğri adı | Eliptik eğri adı. Geçerli değerler için bkz. JsonWebKeyCurveName. EC ve EC-HSM tuşları için varsayılan değer P-256'dır | 'P-256' 'P-256K' 'P-384' 'P-521' |
| anahtar Operasyonlar | Herhangi birini içeren dize dizisi: 'şifre çözme' 'şifrelemek' 'İçe Aktar' 'Serbest bırakmak' 'İşaret' 'unwrapKey' 'Doğrula' 'wrapKey' |
|
| anahtar boyutu | Bit cinsinden anahtar boyutu. Örneğin: RSA için 2048, 3072 veya 4096. RSA ve RSA-HSM anahtarları için varsayılan değer 2048'dir. Kendi anahtarını getir (BYOK), anahtar değişim anahtarları varsayılan olarak 4096 için özel durum yapıldı. | Int |
| kty | Anahtarın türü. Geçerli değerler için bkz. JsonWebKeyType. | 'AK' 'EC-HSM' 'RSA' 'RSA-HSM' |
| release_policy | Yanıt olarak önemli sürüm ilkesi. Hem çıkış hem de giriş için kullanılır. Boşsa atlanır | KeyReleasePolicy (Anahtar Yayın İlkesi) |
| rotationPolicy (Rotasyon İlkesi | Yanıt olarak anahtar döndürme ilkesi. Hem çıkış hem de giriş için kullanılır. Boşsa atlanır | Rotasyon Politikası |
KeyReleasePolicy (Anahtar Yayın İlkesi)
| Ad | Açıklama | Değer |
|---|---|---|
| içerik türü | Anahtar yayın ilkesinin içerik türü ve sürümü | dizgi |
| veri | Blob kodlaması, anahtarın hangi ilke kurallarının altında serbest bırakılabilmesini sağlar. | dizgi |
KeyRotationPolicyAttributes
| Ad | Açıklama | Değer |
|---|---|---|
| sona erme süresi | Yeni anahtar sürümü için süre sonu. ISO8601 biçimde olmalıdır. Örneğin: 'P90D', 'P1Y'. | dizgi |
Ömür Boyu Eylem
| Ad | Açıklama | Değer |
|---|---|---|
| eylem | Anahtar döndürme ilkesi lifetimeAction eylemi. | eylem |
| tetiklemek | Anahtar döndürme ilkesi lifetimeAction tetikleyicisi. | Tetikleyici |
Rotasyon Politikası
| Ad | Açıklama | Değer |
|---|---|---|
| Öznitelik | Anahtar döndürme ilkesinin öznitelikleri. | KeyRotationPolicyAttributes |
| ömür boyu Eylemler | Anahtar döndürme eylemi için lifetimeActions. | Ömür Boyu Eylem[] |
Tetiklemek
| Ad | Açıklama | Değer |
|---|---|---|
| timeAfterCreate | Anahtarı döndürmek için anahtar oluşturulduktan sonraki süre. Yalnızca döndürmek için geçerlidir. ISO 8601 süre biçiminde olacaktır. Örneğin: 'P90D', 'P1Y'. | dizgi |
| timeBeforeExpiration | Döndürmek veya bildirmek için anahtarın süresi dolmadan önceki süre. ISO 8601 süre biçiminde olacaktır. Örneğin: 'P90D', 'P1Y'. | dizgi |
Kullanım Örnekleri
Azure Quickstart Şablonları
Aşağıdaki Azure Hızlı başlat şablonları bu kaynak tipini dağıtır.
| Şablon | Açıklama |
|---|---|
| Bu şablon, müşteri tarafından yönetilen bir anahtarla bir Depolama Hesabı açar ve şifreleme için oluşturulur ve bir Key Vault'a yerleştirilir. | |
| Bu modül, mevcut bir KeyVault içinde anahtar oluşturmanıza olanak tanır. |
Terraform (AzAPI sağlayıcısı) kaynak tanımı
Kasalar/anahtarlar kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- Kaynak grupları
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Kaynak biçimi
Microsoft.KeyVault/vaults/keys kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/vaults/keys@2025-05-01"
name = "string"
parent_id = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
attributes = {
enabled = bool
exp = int
exportable = bool
nbf = int
}
curveName = "string"
keyOps = [
"string"
]
keySize = int
kty = "string"
release_policy = {
contentType = "string"
data = "string"
}
rotationPolicy = {
attributes = {
expiryTime = "string"
}
lifetimeActions = [
{
action = {
type = "string"
}
trigger = {
timeAfterCreate = "string"
timeBeforeExpiry = "string"
}
}
]
}
}
}
}
Özellik Değerleri
Microsoft.KeyVault/vaults/keys
| Ad | Açıklama | Değer |
|---|---|---|
| ad | Kaynak adı | dizgi Kısıtlama -ları: Desen = ^[a-zA-Z0-9-]{1,127}$ (gerekli) |
| ebeveyn_kimlik | Bu kaynağın üst öğesi olan kaynağın kimliği. | Tür kaynağı kimliği: kasalar |
| Özellikler | Oluşturulacak anahtarın özellikleri. | KeyProperties (gerekli) |
| Etiketler | Kaynak etiketleri | Etiket adları ve değerleri sözlüğü. |
| tür | Kaynak türü | "Microsoft.KeyVault/vaults/keys@2025-05-01" |
Eylem
| Ad | Açıklama | Değer |
|---|---|---|
| tür | Eylem türü. | 'BİLDİRİM' 'döndürme' |
Anahtar Öznitelikler
| Ad | Açıklama | Değer |
|---|---|---|
| Etkin | Nesnenin etkinleştirilip etkinleştirilmediğini belirler. | Bool |
| Exp | 1970-01-01T00:00:00Z tarihinden itibaren saniye olarak süre sonu tarihi. | Int |
| dışarı aktarılabilir | Özel anahtarın dışarı aktarılıp aktarılamadığını gösterir. | Bool |
| nbf (İngilizce) | 1970-01-01T00:00:00Z tarihinden itibaren saniyeler içinde önceki tarih değil. | Int |
KeyCreateParametersTags
| Ad | Açıklama | Değer |
|---|
Anahtar Özellikler
| Ad | Açıklama | Değer |
|---|---|---|
| Öznitelik | Anahtarın öznitelikleri. | KeyAttributes |
| eğri adı | Eliptik eğri adı. Geçerli değerler için bkz. JsonWebKeyCurveName. EC ve EC-HSM tuşları için varsayılan değer P-256'dır | 'P-256' 'P-256K' 'P-384' 'P-521' |
| anahtar Operasyonlar | Herhangi birini içeren dize dizisi: 'şifre çözme' 'şifrelemek' 'İçe Aktar' 'Serbest bırakmak' 'İşaret' 'unwrapKey' 'Doğrula' 'wrapKey' |
|
| anahtar boyutu | Bit cinsinden anahtar boyutu. Örneğin: RSA için 2048, 3072 veya 4096. RSA ve RSA-HSM anahtarları için varsayılan değer 2048'dir. Kendi anahtarını getir (BYOK), anahtar değişim anahtarları varsayılan olarak 4096 için özel durum yapıldı. | Int |
| kty | Anahtarın türü. Geçerli değerler için bkz. JsonWebKeyType. | 'AK' 'EC-HSM' 'RSA' 'RSA-HSM' |
| release_policy | Yanıt olarak önemli sürüm ilkesi. Hem çıkış hem de giriş için kullanılır. Boşsa atlanır | KeyReleasePolicy (Anahtar Yayın İlkesi) |
| rotationPolicy (Rotasyon İlkesi | Yanıt olarak anahtar döndürme ilkesi. Hem çıkış hem de giriş için kullanılır. Boşsa atlanır | Rotasyon Politikası |
KeyReleasePolicy (Anahtar Yayın İlkesi)
| Ad | Açıklama | Değer |
|---|---|---|
| içerik türü | Anahtar yayın ilkesinin içerik türü ve sürümü | dizgi |
| veri | Blob kodlaması, anahtarın hangi ilke kurallarının altında serbest bırakılabilmesini sağlar. | dizgi |
KeyRotationPolicyAttributes
| Ad | Açıklama | Değer |
|---|---|---|
| sona erme süresi | Yeni anahtar sürümü için süre sonu. ISO8601 biçimde olmalıdır. Örneğin: 'P90D', 'P1Y'. | dizgi |
Ömür Boyu Eylem
| Ad | Açıklama | Değer |
|---|---|---|
| eylem | Anahtar döndürme ilkesi lifetimeAction eylemi. | eylem |
| tetiklemek | Anahtar döndürme ilkesi lifetimeAction tetikleyicisi. | Tetikleyici |
Rotasyon Politikası
| Ad | Açıklama | Değer |
|---|---|---|
| Öznitelik | Anahtar döndürme ilkesinin öznitelikleri. | KeyRotationPolicyAttributes |
| ömür boyu Eylemler | Anahtar döndürme eylemi için lifetimeActions. | Ömür Boyu Eylem[] |
Tetiklemek
| Ad | Açıklama | Değer |
|---|---|---|
| timeAfterCreate | Anahtarı döndürmek için anahtar oluşturulduktan sonraki süre. Yalnızca döndürmek için geçerlidir. ISO 8601 süre biçiminde olacaktır. Örneğin: 'P90D', 'P1Y'. | dizgi |
| timeBeforeExpiration | Döndürmek veya bildirmek için anahtarın süresi dolmadan önceki süre. ISO 8601 süre biçiminde olacaktır. Örneğin: 'P90D', 'P1Y'. | dizgi |
Kullanım Örnekleri
Terraform Örnekleri
Key Vault Keys'in açılışına temel bir örnek.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
azurerm = {
source = "hashicorp/azurerm"
}
}
}
provider "azurerm" {
features {
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
data "azurerm_client_config" "current" {
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "vault" {
type = "Microsoft.KeyVault/vaults@2023-02-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
sku = {
family = "A"
name = "standard"
}
accessPolicies = []
enableSoftDelete = true
enablePurgeProtection = true
tenantId = data.azurerm_client_config.current.tenant_id
}
}
schema_validation_enabled = false
response_export_values = ["*"]
lifecycle {
ignore_changes = [body.properties.accessPolicies]
}
}
resource "azapi_resource_action" "put_accessPolicy" {
type = "Microsoft.KeyVault/vaults/accessPolicies@2023-02-01"
resource_id = "${azapi_resource.vault.id}/accessPolicies/add"
method = "PUT"
body = {
properties = {
accessPolicies = [
{
objectId = data.azurerm_client_config.current.object_id
permissions = {
certificates = [
"ManageContacts",
]
keys = [
"Get", "Create", "Delete", "List", "Restore", "Recover", "UnwrapKey", "WrapKey", "Purge", "Encrypt", "Decrypt", "Sign", "Verify"
]
secrets = [
"Get",
]
storage = [
]
}
tenantId = data.azurerm_client_config.current.tenant_id
},
]
}
}
response_export_values = ["*"]
}
data "azapi_resource_id" "key" {
type = "Microsoft.KeyVault/vaults/keys@2023-02-01"
parent_id = azapi_resource.vault.id
name = var.resource_name
}
resource "azapi_resource_action" "put_key" {
type = "Microsoft.KeyVault/vaults/keys@2023-02-01"
resource_id = data.azapi_resource_id.key.id
method = "PUT"
body = {
properties = {
keySize = 2048
kty = "RSA"
keyOps = ["encrypt", "decrypt", "sign", "verify", "wrapKey", "unwrapKey"]
}
}
response_export_values = ["*"]
depends_on = [azapi_resource_action.put_accessPolicy]
}