Trezory Microsoft.KeyVault/ klíče 2021-11-01-preview

Článek
12/20/2024

nejnovější
2024-04-01-preview
2023-07-01
2023-02-01
11. 11. 2022
2022-07-07
2022-022-01-preview
11. 11. 2021 ve verzi Preview
10. 10. 2021
2021-06-01-preview
2021-04-01-preview
2020-04-01-preview
2019-09-09

Poznámky

Pokyny k používání trezorů klíčů pro zabezpečené hodnoty najdete v tématu Správa tajných kódů pomocíBicep .

Rychlý start k vytvoření tajného kódu najdete v tématu Rychlý start: Nastavení a načtení tajného kódu ze služby Azure Key Vault pomocí šablony ARM.

Rychlý start k vytvoření klíče najdete v tématu Rychlý start: Vytvoření trezoru klíčů Azure a klíče pomocí šablony ARM.

Definice prostředku Bicep

Typ prostředku trezorů/klíčů je možné nasadit s operacemi, které cílí:

skupiny prostředků – viz příkazy nasazení skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.KeyVault/vaults/keys, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.KeyVault/vaults/keys@2021-11-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'
  }
}

Hodnoty vlastností

Akce

Jméno	Popis	Hodnota
typ	Typ akce. Hodnota by se měla porovnávat bez rozlišování velkých a malých písmen.	"Oznámit" Otočit

KeyAttributes

Jméno	Popis	Hodnota
zpřístupněný	Určuje, zda je objekt povolen nebo není povolen.	Bool
Exp	Datum vypršení platnosti v sekundách od 1970-01-01T00:00:00Z.	Int
exportovatelný	Označuje, jestli je možné privátní klíč exportovat.	Bool
nbf	Před datem v sekundách od 1970-01-01T00:00:00Z.	Int

KeyCreateParametersTags

Jméno	Popis	Hodnota

KeyProperties

Jméno	Popis	Hodnota
atributy	Atributy klíče.	KeyAttributes
curveName	Název tři tečky. Platné hodnoty najdete v tématu JsonWebKeyCurveName.	"P-256" "P-256K" "P-384" "P-521"
keyOps		Řetězcové pole obsahující některou z těchto možností: Dešifrování Šifrovat Import "release" "sign" (znaménko) UnwrapKey "verify" (ověřit) WrapKey
keySize	Velikost klíče v bitech. Příklad: 2048, 3072 nebo 4096 pro RSA.	Int
kty	Typ klíče. Platné hodnoty najdete v tématu JsonWebKeyType.	"EC" EC-HSM RSA RSA-HSM
release_policy	Klíčové zásady vydané verze v reakci. Použije se pro výstup i vstup. Vynecháno, pokud je prázdné.	KeyReleasePolicy
rotationPolicy	Zásady obměně klíčů v reakci. Použije se pro výstup i vstup. Vynecháno, pokud je prázdné.	RotationPolicy

KeyReleasePolicy

Jméno	Popis	Hodnota
contentType	Typ obsahu a verze zásad vydání klíče	řetězec
data	Objekt blob kóduje pravidla zásad, ve kterých je možné klíč vydat.	řetězec

KeyRotationPolicyAttributes

Jméno	Popis	Hodnota
expiryTime	Čas vypršení platnosti nové verze klíče. Měla by být ve formátu ISO8601. Např: "P90D", "P1Y".	řetězec

LifetimeAction

Jméno	Popis	Hodnota
akce	Akce akce akce životnosti zásad obměně klíčů	akcí
spoušť	Aktivační událost životnosti zásad obměně klíčů.	triggeru

Microsoft.KeyVault/vaults/keys

Jméno	Popis	Hodnota
Jméno	Název prostředku	řetězec Omezení: Model = `^[a-zA-Z0-9-]{1,127}$` (povinné)
rodič	V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek. Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.	Symbolický název prostředku typu: trezory
vlastnosti	Vlastnosti klíče, který se má vytvořit.	keyProperties (povinné)
visačky	Značky prostředků	Slovník názvů a hodnot značek Viz Značky v šablonách

RotationPolicy

Jméno	Popis	Hodnota
atributy	Atributy zásad obměny klíčů.	keyRotationPolicyAttributes
lifetimeActions	Akce životnosti pro akci obměny klíčů.	LifetimeAction[]

Spoušť

Jméno	Popis	Hodnota
timeAfterCreate	Doba trvání po vytvoření klíče, která klíč otočí. Platí jenom pro otáčení. Bude ve formátu doby trvání ISO 8601. Např: "P90D", "P1Y".	řetězec
timeBeforeExpiry	Doba trvání před vypršením platnosti klíče, která se má otočit nebo upozornit. Bude ve formátu doby trvání ISO 8601. Např: "P90D", "P1Y".	řetězec

Ukázky rychlého startu

Následující ukázky rychlého startu nasadí tento typ prostředku.

Soubor Bicep	Popis
šifrování účtu služby Azure Storage s využitím klíče spravovaného zákazníkem	Tato šablona nasadí účet úložiště s klíčem spravovaným zákazníkem pro šifrování, které se vygeneruje a umístí do služby Key Vault.

Definice prostředku šablony ARM

Typ prostředku trezorů/klíčů je možné nasadit s operacemi, které cílí:

skupiny prostředků – viz příkazy nasazení skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.KeyVault/vaults/keys, přidejte do šablony následující JSON.

{
  "type": "Microsoft.KeyVault/vaults/keys",
  "apiVersion": "2021-11-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"
  }
}

Hodnoty vlastností

Akce

Jméno	Popis	Hodnota
typ	Typ akce. Hodnota by se měla porovnávat bez rozlišování velkých a malých písmen.	"Oznámit" Otočit

KeyAttributes

Jméno	Popis	Hodnota
zpřístupněný	Určuje, zda je objekt povolen nebo není povolen.	Bool
Exp	Datum vypršení platnosti v sekundách od 1970-01-01T00:00:00Z.	Int
exportovatelný	Označuje, jestli je možné privátní klíč exportovat.	Bool
nbf	Před datem v sekundách od 1970-01-01T00:00:00Z.	Int

KeyCreateParametersTags

Jméno	Popis	Hodnota

KeyProperties

Jméno	Popis	Hodnota
atributy	Atributy klíče.	KeyAttributes
curveName	Název tři tečky. Platné hodnoty najdete v tématu JsonWebKeyCurveName.	"P-256" "P-256K" "P-384" "P-521"
keyOps		Řetězcové pole obsahující některou z těchto možností: Dešifrování Šifrovat Import "release" "sign" (znaménko) UnwrapKey "verify" (ověřit) WrapKey
keySize	Velikost klíče v bitech. Příklad: 2048, 3072 nebo 4096 pro RSA.	Int
kty	Typ klíče. Platné hodnoty najdete v tématu JsonWebKeyType.	"EC" EC-HSM RSA RSA-HSM
release_policy	Klíčové zásady vydané verze v reakci. Použije se pro výstup i vstup. Vynecháno, pokud je prázdné.	KeyReleasePolicy
rotationPolicy	Zásady obměně klíčů v reakci. Použije se pro výstup i vstup. Vynecháno, pokud je prázdné.	RotationPolicy

KeyReleasePolicy

Jméno	Popis	Hodnota
contentType	Typ obsahu a verze zásad vydání klíče	řetězec
data	Objekt blob kóduje pravidla zásad, ve kterých je možné klíč vydat.	řetězec

KeyRotationPolicyAttributes

Jméno	Popis	Hodnota
expiryTime	Čas vypršení platnosti nové verze klíče. Měla by být ve formátu ISO8601. Např: "P90D", "P1Y".	řetězec

LifetimeAction

Jméno	Popis	Hodnota
akce	Akce akce akce životnosti zásad obměně klíčů	akcí
spoušť	Aktivační událost životnosti zásad obměně klíčů.	triggeru

Microsoft.KeyVault/vaults/keys

Jméno	Popis	Hodnota
apiVersion	Verze rozhraní API	2021-11-01-preview
Jméno	Název prostředku	řetězec Omezení: Model = `^[a-zA-Z0-9-]{1,127}$` (povinné)
vlastnosti	Vlastnosti klíče, který se má vytvořit.	keyProperties (povinné)
visačky	Značky prostředků	Slovník názvů a hodnot značek Viz Značky v šablonách
typ	Typ prostředku	Microsoft.KeyVault/vaults/keys

RotationPolicy

Jméno	Popis	Hodnota
atributy	Atributy zásad obměny klíčů.	keyRotationPolicyAttributes
lifetimeActions	Akce životnosti pro akci obměny klíčů.	LifetimeAction[]

Spoušť

Jméno	Popis	Hodnota
timeAfterCreate	Doba trvání po vytvoření klíče, která klíč otočí. Platí jenom pro otáčení. Bude ve formátu doby trvání ISO 8601. Např: "P90D", "P1Y".	řetězec
timeBeforeExpiry	Doba trvání před vypršením platnosti klíče, která se má otočit nebo upozornit. Bude ve formátu doby trvání ISO 8601. Např: "P90D", "P1Y".	řetězec

Šablony pro rychlý start

Následující šablony pro rychlý start nasazují tento typ prostředku.

Šablona	Popis
šifrování účtu služby Azure Storage s využitím klíče spravovaného zákazníkem nasazení	Tato šablona nasadí účet úložiště s klíčem spravovaným zákazníkem pro šifrování, které se vygeneruje a umístí do služby Key Vault.
vytvoření klíče ve službě Azure KeyVault nasazení	Tento modul umožňuje vytvořit klíč v existující službě KeyVault.

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku trezorů/klíčů je možné nasadit s operacemi, které cílí:

skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.KeyVault,vaults/keys, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/keys@2021-11-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"
            }
          }
        ]
      }
    }
  })
}

Hodnoty vlastností

Akce

Jméno	Popis	Hodnota
typ	Typ akce. Hodnota by se měla porovnávat bez rozlišování velkých a malých písmen.	"Oznámit" Otočit

KeyAttributes

Jméno	Popis	Hodnota
zpřístupněný	Určuje, zda je objekt povolen nebo není povolen.	Bool
Exp	Datum vypršení platnosti v sekundách od 1970-01-01T00:00:00Z.	Int
exportovatelný	Označuje, jestli je možné privátní klíč exportovat.	Bool
nbf	Před datem v sekundách od 1970-01-01T00:00:00Z.	Int

KeyCreateParametersTags

Jméno	Popis	Hodnota

KeyProperties

Jméno	Popis	Hodnota
atributy	Atributy klíče.	KeyAttributes
curveName	Název tři tečky. Platné hodnoty najdete v tématu JsonWebKeyCurveName.	"P-256" "P-256K" "P-384" "P-521"
keyOps		Řetězcové pole obsahující některou z těchto možností: Dešifrování Šifrovat Import "release" "sign" (znaménko) UnwrapKey "verify" (ověřit) WrapKey
keySize	Velikost klíče v bitech. Příklad: 2048, 3072 nebo 4096 pro RSA.	Int
kty	Typ klíče. Platné hodnoty najdete v tématu JsonWebKeyType.	"EC" EC-HSM RSA RSA-HSM
release_policy	Klíčové zásady vydané verze v reakci. Použije se pro výstup i vstup. Vynecháno, pokud je prázdné.	KeyReleasePolicy
rotationPolicy	Zásady obměně klíčů v reakci. Použije se pro výstup i vstup. Vynecháno, pokud je prázdné.	RotationPolicy

KeyReleasePolicy

Jméno	Popis	Hodnota
contentType	Typ obsahu a verze zásad vydání klíče	řetězec
data	Objekt blob kóduje pravidla zásad, ve kterých je možné klíč vydat.	řetězec

KeyRotationPolicyAttributes

Jméno	Popis	Hodnota
expiryTime	Čas vypršení platnosti nové verze klíče. Měla by být ve formátu ISO8601. Např: "P90D", "P1Y".	řetězec

LifetimeAction

Jméno	Popis	Hodnota
akce	Akce akce akce životnosti zásad obměně klíčů	akcí
spoušť	Aktivační událost životnosti zásad obměně klíčů.	triggeru

Microsoft.KeyVault/vaults/keys

Jméno	Popis	Hodnota
Jméno	Název prostředku	řetězec Omezení: Model = `^[a-zA-Z0-9-]{1,127}$` (povinné)
parent_id	ID prostředku, který je nadřazený pro tento prostředek.	ID prostředku typu: trezory
vlastnosti	Vlastnosti klíče, který se má vytvořit.	keyProperties (povinné)
visačky	Značky prostředků	Slovník názvů a hodnot značek
typ	Typ prostředku	Microsoft.KeyVault/vaults/keys@2021-11-01-preview

RotationPolicy

Jméno	Popis	Hodnota
atributy	Atributy zásad obměny klíčů.	keyRotationPolicyAttributes
lifetimeActions	Akce životnosti pro akci obměny klíčů.	LifetimeAction[]

Spoušť

Jméno	Popis	Hodnota
timeAfterCreate	Doba trvání po vytvoření klíče, která klíč otočí. Platí jenom pro otáčení. Bude ve formátu doby trvání ISO 8601. Např: "P90D", "P1Y".	řetězec
timeBeforeExpiry	Doba trvání před vypršením platnosti klíče, která se má otočit nebo upozornit. Bude ve formátu doby trvání ISO 8601. Např: "P90D", "P1Y".	řetězec

Sdílet prostřednictvím

Trezory Microsoft.KeyVault/ klíče 2021-11-01-preview

Poznámky

Definice prostředku Bicep

Formát prostředku

Hodnoty vlastností

Akce

KeyAttributes

KeyCreateParametersTags

KeyProperties

KeyReleasePolicy

KeyRotationPolicyAttributes

LifetimeAction

Microsoft.KeyVault/vaults/keys

RotationPolicy

Spoušť

Ukázky rychlého startu

Definice prostředku šablony ARM

Formát prostředku

Hodnoty vlastností

Akce

KeyAttributes

KeyCreateParametersTags

KeyProperties

KeyReleasePolicy

KeyRotationPolicyAttributes

LifetimeAction

Microsoft.KeyVault/vaults/keys

RotationPolicy

Spoušť

Šablony pro rychlý start

Definice prostředku Terraformu (poskytovatel AzAPI)

Formát prostředku

Hodnoty vlastností

Akce

KeyAttributes

KeyCreateParametersTags

KeyProperties

KeyReleasePolicy

KeyRotationPolicyAttributes

LifetimeAction

Microsoft.KeyVault/vaults/keys

RotationPolicy

Spoušť

Váš názor

Další materiály