Megosztás a következőn keresztül:


Microsoft.KeyVault-tárolók/kulcsok

Megjegyzések

A kulcstartók biztonságos értékekhez való használatáról a Titkos kulcsok kezelése a Bicephasználatával című témakörben talál útmutatást.

A titkos kulcsok létrehozásáról rövid útmutató: Titkos kulcs beállítása és lekérése az Azure Key Vaultból ARM-sablonnal.

A kulcsok létrehozásáról rövid útmutató: Azure-kulcstartó és kulcs létrehozása ARM-sablonnal.

Bicep-erőforrásdefiníció

A tárolók/kulcsok erőforrástípusa üzembe helyezhető a célműveletekkel:

Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplócímű témakörben találja.

Erőforrás formátuma

Microsoft.KeyVault/vaults/keys erőforrás létrehozásához adja hozzá a következő Bicep-et a sablonhoz.

resource symbolicname 'Microsoft.KeyVault/vaults/keys@2024-12-01-preview' = {
  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'
  }
}

Tulajdonságértékek

Akció

Név Leírás Érték
típus A művelet típusa. "értesítés"
"forgatás"

KeyAttributes

Név Leírás Érték
Engedélyezve Meghatározza, hogy az objektum engedélyezve van-e. Bool
Exp Lejárati dátum másodpercben 1970-01-01T00:00:00Z óta. Int
Exportálható Azt jelzi, hogy a titkos kulcs exportálható-e. Bool
nbf 1970-01-01T00:00:00Z. Int

KeyCreateParametersTags

Név Leírás Érték

KeyProperties

Név Leírás Érték
Attribútumok A kulcs attribútumai. KeyAttributes
curveName Az elliptikus görbe neve. Érvényes értékekért lásd: JsonWebKeyCurveName. Az EC és EC-HSM kulcsok alapértelmezett értéke a P-256 "P-256"
"P-256K"
"P-384"
"P-521"
keyOps Sztringtömb, amely a következők bármelyikét tartalmazza:
"visszafejtés"
"titkosítás"
"importálás"
"kiadás"
"sign"
'unwrapKey'
"ellenőrzés"
'wrapKey'
keySize A kulcs mérete bitekben. Például: 2048, 3072 vagy 4096 RSA esetén. Az RSA és RSA-HSM kulcsok alapértelmezett értéke 2048. Kivételt képez a saját kulcs (BYOK) használata, a kulcscserélő kulcsok alapértelmezett értéke 4096. Int
kty A kulcs típusa. Érvényes értékekért lásd: JsonWebKeyType. "EK"
"EC-HSM"
'RSA'
"RSA-HSM"
release_policy Kulcskiadási szabályzat válaszként. A kimenethez és a bemenethez egyaránt használható. Kihagyva, ha üres KeyReleasePolicy
rotációPolicy Kulcsforgatási szabályzat válaszként. A kimenethez és a bemenethez egyaránt használható. Kihagyva, ha üres RotationPolicy

KeyReleasePolicy

Név Leírás Érték
contentType A kulcskiadási szabályzat tartalomtípusa és verziója húr
adat Blobkódolás azokat a szabályzatszabályokat, amelyek alatt a kulcs kibocsátható. húr

KeyRotationPolicyAttributes

Név Leírás Érték
expiryTime Az új kulcsverzió lejárati ideje. ISO8601 formátumban kell lennie. Például: 'P90D', 'P1Y'. húr

LifetimeAction

Név Leírás Érték
akció A kulcsforgatási szabályzat élettartamának műveleteAction. művelet
kivált A kulcsforgatási szabályzat élettartamának eseményindítójaAction. trigger

Microsoft.KeyVault/vaults/keys

Név Leírás Érték
név Az erőforrás neve húr

Korlátok:
Minta = ^[a-zA-Z0-9-]{1,127}$ (kötelező)
szülő A Bicepben megadhatja a gyermekerőforrás szülőerőforrását. Ezt a tulajdonságot csak akkor kell hozzáadnia, ha a gyermekerőforrás a szülőerőforráson kívül van deklarálva.

További információ: szülőerőforráson kívüli gyermekerőforrás.
A típus erőforrásának szimbolikus neve: tárolók
kellékek A létrehozandó kulcs tulajdonságai. KeyProperties (kötelező)
Címkék Erőforráscímkék Címkenevek és -értékek szótára. sablonok címkéinek megtekintése

Rotációspolicy

Név Leírás Érték
Attribútumok A kulcsforgatási szabályzat attribútumai. KeyRotationPolicyAttributes
lifetimeActions A kulcsforgatási művelet élettartam-művelete. LifetimeAction[]

Kivált

Név Leírás Érték
timeAfterCreate A kulcs létrehozása után a kulcs elforgatásának időtartama. Csak forgatásra vonatkozik. Iso 8601-es időtartam formátumban lesz. Például: 'P90D', 'P1Y'. húr
timeBeforeExpiry A kulcs elforgatásához vagy értesítéséhez való lejárat előtti időtartam. Iso 8601-es időtartam formátumban lesz. Például: 'P90D', 'P1Y'. húr

Használati példák

Azure gyorsútmutató-minták

Az alábbi Azure rövid útmutatósablonok bicep-mintákat tartalmaznak az erőforrástípus üzembe helyezéséhez.

Bicep-fájl Leírás
Azure Storage-fióktitkosítás ügyfél által felügyelt kulccsal Ez a sablon egy ügyfél által felügyelt kulccsal rendelkező tárfiókot helyez üzembe a kulcstartóban létrehozott és elhelyezett titkosításhoz.

ARM-sablon erőforrásdefiníciója

A tárolók/kulcsok erőforrástípusa üzembe helyezhető a célműveletekkel:

Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplócímű témakörben találja.

Erőforrás formátuma

Microsoft.KeyVault/vaults/keys erőforrás létrehozásához adja hozzá a következő JSON-t a sablonhoz.

{
  "type": "Microsoft.KeyVault/vaults/keys",
  "apiVersion": "2024-12-01-preview",
  "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"
  }
}

Tulajdonságértékek

Akció

Név Leírás Érték
típus A művelet típusa. "értesítés"
"forgatás"

KeyAttributes

Név Leírás Érték
Engedélyezve Meghatározza, hogy az objektum engedélyezve van-e. Bool
Exp Lejárati dátum másodpercben 1970-01-01T00:00:00Z óta. Int
Exportálható Azt jelzi, hogy a titkos kulcs exportálható-e. Bool
nbf 1970-01-01T00:00:00Z. Int

KeyCreateParametersTags

Név Leírás Érték

KeyProperties

Név Leírás Érték
Attribútumok A kulcs attribútumai. KeyAttributes
curveName Az elliptikus görbe neve. Érvényes értékekért lásd: JsonWebKeyCurveName. Az EC és EC-HSM kulcsok alapértelmezett értéke a P-256 "P-256"
"P-256K"
"P-384"
"P-521"
keyOps Sztringtömb, amely a következők bármelyikét tartalmazza:
"visszafejtés"
"titkosítás"
"importálás"
"kiadás"
"sign"
'unwrapKey'
"ellenőrzés"
'wrapKey'
keySize A kulcs mérete bitekben. Például: 2048, 3072 vagy 4096 RSA esetén. Az RSA és RSA-HSM kulcsok alapértelmezett értéke 2048. Kivételt képez a saját kulcs (BYOK) használata, a kulcscserélő kulcsok alapértelmezett értéke 4096. Int
kty A kulcs típusa. Érvényes értékekért lásd: JsonWebKeyType. "EK"
"EC-HSM"
'RSA'
"RSA-HSM"
release_policy Kulcskiadási szabályzat válaszként. A kimenethez és a bemenethez egyaránt használható. Kihagyva, ha üres KeyReleasePolicy
rotációPolicy Kulcsforgatási szabályzat válaszként. A kimenethez és a bemenethez egyaránt használható. Kihagyva, ha üres RotationPolicy

KeyReleasePolicy

Név Leírás Érték
contentType A kulcskiadási szabályzat tartalomtípusa és verziója húr
adat Blobkódolás azokat a szabályzatszabályokat, amelyek alatt a kulcs kibocsátható. húr

KeyRotationPolicyAttributes

Név Leírás Érték
expiryTime Az új kulcsverzió lejárati ideje. ISO8601 formátumban kell lennie. Például: 'P90D', 'P1Y'. húr

LifetimeAction

Név Leírás Érték
akció A kulcsforgatási szabályzat élettartamának műveleteAction. művelet
kivált A kulcsforgatási szabályzat élettartamának eseményindítójaAction. trigger

Microsoft.KeyVault/vaults/keys

Név Leírás Érték
apiVersion Az API verziója '2024-12-01-preview"
név Az erőforrás neve húr

Korlátok:
Minta = ^[a-zA-Z0-9-]{1,127}$ (kötelező)
kellékek A létrehozandó kulcs tulajdonságai. KeyProperties (kötelező)
Címkék Erőforráscímkék Címkenevek és -értékek szótára. sablonok címkéinek megtekintése
típus Az erőforrás típusa "Microsoft.KeyVault/vaults/keys"

Rotációspolicy

Név Leírás Érték
Attribútumok A kulcsforgatási szabályzat attribútumai. KeyRotationPolicyAttributes
lifetimeActions A kulcsforgatási művelet élettartam-művelete. LifetimeAction[]

Kivált

Név Leírás Érték
timeAfterCreate A kulcs létrehozása után a kulcs elforgatásának időtartama. Csak forgatásra vonatkozik. Iso 8601-es időtartam formátumban lesz. Például: 'P90D', 'P1Y'. húr
timeBeforeExpiry A kulcs elforgatásához vagy értesítéséhez való lejárat előtti időtartam. Iso 8601-es időtartam formátumban lesz. Például: 'P90D', 'P1Y'. húr

Használati példák

Azure gyorsútmutató-sablonok

Az alábbi Azure rövid útmutatósablonok üzembe helyezni ezt az erőforrástípust.

Sablon Leírás
Azure Storage-fióktitkosítás ügyfél által felügyelt kulccsal

Üzembe helyezés az Azure
Ez a sablon egy ügyfél által felügyelt kulccsal rendelkező tárfiókot helyez üzembe a kulcstartóban létrehozott és elhelyezett titkosításhoz.
Kulcs létrehozása az Azure KeyVault

Üzembe helyezés az Azure
Ez a modul lehetővé teszi egy kulcs létrehozását egy meglévő KeyVaultban.

Terraform (AzAPI-szolgáltató) erőforrásdefiníciója

A tárolók/kulcsok erőforrástípusa üzembe helyezhető a célműveletekkel:

  • erőforráscsoportok

Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplócímű témakörben találja.

Erőforrás formátuma

Microsoft.KeyVault/vaults/keys erőforrás létrehozásához adja hozzá a következő Terraformot a sablonhoz.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/keys@2024-12-01-preview"
  name = "string"
  tags = {
    {customized property} = "string"
  }
  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"
            }
          }
        ]
      }
    }
  })
}

Tulajdonságértékek

Akció

Név Leírás Érték
típus A művelet típusa. "értesítés"
"forgatás"

KeyAttributes

Név Leírás Érték
Engedélyezve Meghatározza, hogy az objektum engedélyezve van-e. Bool
Exp Lejárati dátum másodpercben 1970-01-01T00:00:00Z óta. Int
Exportálható Azt jelzi, hogy a titkos kulcs exportálható-e. Bool
nbf 1970-01-01T00:00:00Z. Int

KeyCreateParametersTags

Név Leírás Érték

KeyProperties

Név Leírás Érték
Attribútumok A kulcs attribútumai. KeyAttributes
curveName Az elliptikus görbe neve. Érvényes értékekért lásd: JsonWebKeyCurveName. Az EC és EC-HSM kulcsok alapértelmezett értéke a P-256 "P-256"
"P-256K"
"P-384"
"P-521"
keyOps Sztringtömb, amely a következők bármelyikét tartalmazza:
"visszafejtés"
"titkosítás"
"importálás"
"kiadás"
"sign"
'unwrapKey'
"ellenőrzés"
'wrapKey'
keySize A kulcs mérete bitekben. Például: 2048, 3072 vagy 4096 RSA esetén. Az RSA és RSA-HSM kulcsok alapértelmezett értéke 2048. Kivételt képez a saját kulcs (BYOK) használata, a kulcscserélő kulcsok alapértelmezett értéke 4096. Int
kty A kulcs típusa. Érvényes értékekért lásd: JsonWebKeyType. "EK"
"EC-HSM"
'RSA'
"RSA-HSM"
release_policy Kulcskiadási szabályzat válaszként. A kimenethez és a bemenethez egyaránt használható. Kihagyva, ha üres KeyReleasePolicy
rotációPolicy Kulcsforgatási szabályzat válaszként. A kimenethez és a bemenethez egyaránt használható. Kihagyva, ha üres RotationPolicy

KeyReleasePolicy

Név Leírás Érték
contentType A kulcskiadási szabályzat tartalomtípusa és verziója húr
adat Blobkódolás azokat a szabályzatszabályokat, amelyek alatt a kulcs kibocsátható. húr

KeyRotationPolicyAttributes

Név Leírás Érték
expiryTime Az új kulcsverzió lejárati ideje. ISO8601 formátumban kell lennie. Például: 'P90D', 'P1Y'. húr

LifetimeAction

Név Leírás Érték
akció A kulcsforgatási szabályzat élettartamának műveleteAction. művelet
kivált A kulcsforgatási szabályzat élettartamának eseményindítójaAction. trigger

Microsoft.KeyVault/vaults/keys

Név Leírás Érték
név Az erőforrás neve húr

Korlátok:
Minta = ^[a-zA-Z0-9-]{1,127}$ (kötelező)
parent_id Annak az erőforrásnak az azonosítója, amely az erőforrás szülője. Típus típusú erőforrás azonosítója: tárolók
kellékek A létrehozandó kulcs tulajdonságai. KeyProperties (kötelező)
Címkék Erőforráscímkék Címkenevek és -értékek szótára.
típus Az erőforrás típusa "Microsoft.KeyVault/vaults/keys@2024-12-01-preview"

Rotációspolicy

Név Leírás Érték
Attribútumok A kulcsforgatási szabályzat attribútumai. KeyRotationPolicyAttributes
lifetimeActions A kulcsforgatási művelet élettartam-művelete. LifetimeAction[]

Kivált

Név Leírás Érték
timeAfterCreate A kulcs létrehozása után a kulcs elforgatásának időtartama. Csak forgatásra vonatkozik. Iso 8601-es időtartam formátumban lesz. Például: 'P90D', 'P1Y'. húr
timeBeforeExpiry A kulcs elforgatásához vagy értesítéséhez való lejárat előtti időtartam. Iso 8601-es időtartam formátumban lesz. Például: 'P90D', 'P1Y'. húr