Microsoft.KeyVault kasaları/anahtarları

Makale
04/18/2024

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üğü.

Açıklamalar

Güvenli değerler için anahtar kasalarını kullanma yönergeleri için bkz. Bicep kullanarak gizli dizileri yönetme.

Gizli dizi oluşturma hakkında hızlı başlangıç için bkz. Hızlı Başlangıç: ARM şablonu kullanarak Azure Key Vault'dan gizli dizi ayarlama ve alma.

Anahtar oluşturmaya yönelik hızlı başlangıç için bkz . Hızlı Başlangıç: ARM şablonunu kullanarak Azure anahtar kasası ve anahtar oluşturma.

Kaynak biçimi

Microsoft.KeyVault/vaults/keys kaynağı oluşturmak için şablonunuza aşağıdaki Bicep'i ekleyin.

resource symbolicname 'Microsoft.KeyVault/vaults/keys@2023-07-01' = {
  name: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  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

kasalar/anahtarlar

Ad	Açıklama	Değer
name	Kaynak adı Bicep'te alt kaynaklar için adları ve türleri ayarlamayı öğrenin.	dize (gerekli)
etiketler	Anahtara atanacak etiketler.	Etiket adlarının ve değerlerinin sözlüğü. Bkz . Şablonlardaki etiketler
Üst	Bicep'te bir alt kaynağın üst 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 . Üst kaynağın dışındaki alt kaynak.	Kaynak türü için sembolik ad: kasalar
properties	Oluşturulacak anahtarın özellikleri.	KeyProperties (gerekli)

KeyProperties

Ad	Açıklama	Değer
öznitelikler	Anahtarın öznitelikleri.	KeyAttributes
curveName	Üç nokta eğrisi adı. Geçerli değerler için bkz. JsonWebKeyCurveName.	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		Herhangi birini içeren dize dizisi: 'şifre çözme' 'encrypt' 'import' 'release' 'sign' 'unwrapKey' 'verify' 'wrapKey'
keySize	Bit cinsinden anahtar boyutu. Örneğin: RSA için 2048, 3072 veya 4096.	int
Kuş	Anahtarın türü. Geçerli değerler için bkz. JsonWebKeyType.	'EC' 'EC-HSM' 'RSA' 'RSA-HSM'
release_policy	Yanıt olarak anahtar yayın ilkesi. Hem çıkış hem de giriş için kullanılır. Boşsa atlanır	KeyReleasePolicy
rotationPolicy	Yanıt olarak anahtar döndürme ilkesi. Hem çıkış hem de giriş için kullanılır. Boşsa atlanır	RotationPolicy

KeyAttributes

Ad	Açıklama	Değer
enabled	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ılmadığını gösterir.	bool
nbf	1970-01-01T00:00:00Z'den beri saniyeler içinde tarih değil.	int

KeyReleasePolicy

Ad	Açıklama	Değer
Contenttype	Anahtar yayın ilkesinin içerik türü ve sürümü	string
veriler	Blob kodlaması, anahtarın altında serbest bırakılabildiği ilke kurallarını kodlar.	string

RotationPolicy

Ad	Açıklama	Değer
öznitelikler	Anahtar döndürme ilkesinin öznitelikleri.	KeyRotationPolicyAttributes
lifetimeActions	Anahtar döndürme eylemi için lifetimeActions.	LifetimeAction[]

KeyRotationPolicyAttributes

Ad	Açıklama	Değer
expiryTime	Yeni anahtar sürümü için süre sonu. ISO8601 biçimde olmalıdır. Örneğin: 'P90D', 'P1Y'.	string

LifetimeAction

Ad	Açıklama	Değer
action	Anahtar döndürme ilkesi lifetimeAction eylemi.	Eylem
Tetikleyici	Anahtar döndürme ilkesi lifetimeAction tetikleyicisi.	Tetikleyici

Eylem

Ad	Açıklama	Değer
tür	Eylem türü.	'bildirim' 'döndür'

Tetikleyici

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'.	string
timeBeforeExpiry	Anahtarın döndürülebilmesi veya bildirilmesi için süre dolmadan önceki süre. ISO 8601 süre biçiminde olacaktır. Örneğin: 'P90D', 'P1Y'.	string

Hızlı başlangıç şablonları

Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.

Şablon	Description
Azure KeyVault'ta Anahtar Oluşturma	Bu modül, mevcut bir KeyVault içinde anahtar oluşturmanıza olanak tanır.
Müşteri tarafından yönetilen anahtarla Azure Depolama Hesabı Şifrelemesi	Bu şablon, oluşturulan ve bir Key Vault içine yerleştirilen şifreleme için müşteri tarafından yönetilen anahtara sahip bir Depolama Hesabı dağıtır.

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üğü.

Açıklamalar

Güvenli değerler için anahtar kasalarını kullanma yönergeleri için bkz. Bicep kullanarak gizli dizileri yönetme.

Gizli dizi oluşturma hakkında hızlı başlangıç için bkz. Hızlı Başlangıç: ARM şablonu kullanarak Azure Key Vault gizli dizi ayarlama ve alma.

Anahtar oluşturma hakkında hızlı başlangıç için bkz . Hızlı Başlangıç: ARM şablonunu kullanarak Azure anahtar kasası ve anahtar oluşturma.

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": "2023-07-01",
  "name": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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

kasalar/anahtarlar

Ad	Açıklama	Değer
tür	Kaynak türü	'Microsoft.KeyVault/vaults/keys'
apiVersion	Kaynak API'sinin sürümü	'2023-07-01'
name	Kaynak adı Bkz. JSON ARM şablonlarında alt kaynaklar için adları ve türleri ayarlama.	dize (gerekli)
etiketler	Anahtara atanacak etiketler.	Etiket adlarının ve değerlerinin sözlüğü. Bkz . Şablonlardaki etiketler
properties	Oluşturulacak anahtarın özellikleri.	KeyProperties (gerekli)

KeyProperties

Ad	Açıklama	Değer
öznitelikler	Anahtarın öznitelikleri.	KeyAttributes
curveName	Üç nokta eğrisi adı. Geçerli değerler için bkz. JsonWebKeyCurveName.	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		Herhangi birini içeren dize dizisi: 'şifre çözme' 'encrypt' 'import' 'release' 'sign' 'unwrapKey' 'verify' 'wrapKey'
keySize	Bit cinsinden anahtar boyutu. Örneğin: RSA için 2048, 3072 veya 4096.	int
Kuş	Anahtarın türü. Geçerli değerler için bkz. JsonWebKeyType.	'EC' 'EC-HSM' 'RSA' 'RSA-HSM'
release_policy	Yanıt olarak anahtar yayın ilkesi. Hem çıkış hem de giriş için kullanılır. Boşsa atlanır	KeyReleasePolicy
rotationPolicy	Yanıt olarak anahtar döndürme ilkesi. Hem çıkış hem de giriş için kullanılır. Boşsa atlanır	RotationPolicy

KeyAttributes

Ad	Açıklama	Değer
enabled	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ılmadığını gösterir.	bool
nbf	1970-01-01T00:00:00Z'den bu yana saniye olarak tarihten önce değil.	int

KeyReleasePolicy

Ad	Açıklama	Değer
Contenttype	Anahtar yayın ilkesinin içerik türü ve sürümü	string
veriler	Blob kodlaması, anahtarın serbest bırakılabildiği ilke kurallarını belirtir.	string

RotationPolicy

Ad	Açıklama	Değer
öznitelikler	Anahtar döndürme ilkesinin öznitelikleri.	KeyRotationPolicyAttributes
lifetimeActions	Anahtar döndürme eylemi için lifetimeActions.	LifetimeAction[]

KeyRotationPolicyAttributes

Ad	Açıklama	Değer
expiryTime	Yeni anahtar sürümü için süre sonu. ISO8601 biçimde olmalıdır. Örneğin: 'P90D', 'P1Y'.	string

LifetimeAction

Ad	Açıklama	Değer
action	Anahtar döndürme ilkesi lifetimeAction eylemi.	Eylem
Tetikleyici	Anahtar döndürme ilkesi lifetimeAction tetikleyicisi.	Tetikleyici

Eylem

Ad	Açıklama	Değer
tür	Eylem türü.	'bildirim' 'döndür'

Tetikleyici

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'.	string
timeBeforeExpiry	Anahtarın döndürülebilmesi veya bildirilmesi için süre dolmadan önceki süre. ISO 8601 süre biçiminde olacaktır. Örneğin: 'P90D', 'P1Y'.	string

Hızlı başlangıç şablonları

Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.

Şablon	Description
Azure KeyVault'ta Anahtar Oluşturma	Bu modül, mevcut bir KeyVault içinde anahtar oluşturmanıza olanak tanır.
Müşteri tarafından yönetilen anahtarla Azure Depolama Hesabı Şifrelemesi	Bu şablon, oluşturulan ve bir Key Vault içine yerleştirilen şifreleme için müşteri tarafından yönetilen anahtara sahip bir Depolama Hesabı dağıtı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@2023-07-01"
  name = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    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

kasalar/anahtarlar

Ad	Açıklama	Değer
tür	Kaynak türü	"Microsoft.KeyVault/vaults/keys@2023-07-01"
name	Kaynak adı	dize (gerekli)
parent_id	Bu kaynağın üst öğesi olan kaynağın kimliği.	Kaynak türü: kasalar için kimlik
etiketler	Anahtara atanacak etiketler.	Etiket adlarının ve değerlerinin sözlüğü.
properties	Oluşturulacak anahtarın özellikleri.	KeyProperties (gerekli)

KeyProperties

Ad	Açıklama	Değer
öznitelikler	Anahtarın öznitelikleri.	KeyAttributes
curveName	Üç nokta eğrisi adı. Geçerli değerler için bkz. JsonWebKeyCurveName.	"P-256" "P-256K" "P-384" "P-521"
keyOps		Herhangi birini içeren dize dizisi: "şifre çözme" "şifrele" "içeri aktarma" "yayın" "sign" "unwrapKey" "verify" "wrapKey"
keySize	Bit cinsinden anahtar boyutu. Örneğin: RSA için 2048, 3072 veya 4096.	int
Kuş	Anahtarın türü. Geçerli değerler için bkz. JsonWebKeyType.	"EC" "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
rotationPolicy	Yanıt olarak anahtar döndürme ilkesi. Hem çıkış hem de giriş için kullanılır. Boşsa atlanır	RotationPolicy

KeyAttributes

Ad	Açıklama	Değer
enabled	Nesnenin etkin olup olmadığını 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ılmadığını gösterir.	bool
nbf	1970-01-01T00:00:00Z'den beri saniyeler içinde tarih değil.	int

KeyReleasePolicy

Ad	Açıklama	Değer
Contenttype	Anahtar yayın ilkesinin içerik türü ve sürümü	string
veriler	Blob kodlaması, anahtarın altında serbest bırakılabildiği ilke kurallarını kodlar.	string

RotationPolicy

Ad	Açıklama	Değer
öznitelikler	Anahtar döndürme ilkesinin öznitelikleri.	KeyRotationPolicyAttributes
lifetimeActions	Anahtar döndürme eylemi için lifetimeActions.	LifetimeAction[]

KeyRotationPolicyAttributes

Ad	Açıklama	Değer
expiryTime	Yeni anahtar sürümü için süre sonu. ISO8601 biçimde olmalıdır. Örneğin: 'P90D', 'P1Y'.	string

LifetimeAction

Ad	Açıklama	Değer
action	Anahtar döndürme ilkesi lifetimeAction eylemi.	Eylem
Tetikleyici	Anahtar döndürme ilkesi lifetimeAction tetikleyicisi.	Tetikleyici

Eylem

Ad	Açıklama	Değer
tür	Eylem türü.	"bildirim" "döndür"

Tetikleyici

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'.	string
timeBeforeExpiry	Anahtarın döndürülebilmesi veya bildirilmesi için süre dolmadan önceki süre. ISO 8601 süre biçiminde olacaktır. Örneğin: 'P90D', 'P1Y'.	string

Microsoft.KeyVault kasaları/anahtarları

Bicep kaynak tanımı

Açıklamalar

Kaynak biçimi

Özellik değerleri

kasalar/anahtarlar

KeyProperties

KeyAttributes

KeyReleasePolicy

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

Eylem

Tetikleyici

Hızlı başlangıç şablonları

ARM şablonu kaynak tanımı

Açıklamalar

Kaynak biçimi

Özellik değerleri

kasalar/anahtarlar

KeyProperties

KeyAttributes

KeyReleasePolicy

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

Eylem

Tetikleyici

Hızlı başlangıç şablonları

Terraform (AzAPI sağlayıcısı) kaynak tanımı

Kaynak biçimi

Özellik değerleri

kasalar/anahtarlar

KeyProperties

KeyAttributes

KeyReleasePolicy

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

Eylem

Tetikleyici

Geri Bildirim

Geri Bildirim

Ek kaynaklar