Trezory/klíče Microsoft.KeyVault
Definice prostředku Bicep
Typ prostředku trezory nebo klíče je možné nasadit s operacemi, které cílí na:
- 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.
Poznámky
Pokyny k používání trezorů klíčů pro zabezpečené hodnoty najdete v tématu Správa tajných kódů pomocí bicepu.
Rychlý start k vytvoření tajného kódu najdete v tématu Rychlý start: Nastavení a načtení tajného kódu z 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.
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@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'
}
}
]
}
}
}
Hodnoty vlastností
trezory/klíče
| Název | Description | Hodnota |
|---|---|---|
| name | Název prostředku Přečtěte si, jak nastavit názvy a typy pro podřízené prostředky v Bicepu. |
string (povinné) |
| tags | Značky, které budou přiřazeny ke klíči. | Slovník názvů značek a hodnot. Viz Značky v šablonách |
| Nadřazené | V nástroji Bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost stačí 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 |
| properties | Vlastnosti klíče, který se má vytvořit. | Klíčové vlastnosti (povinné) |
Klíčové vlastnosti
| Název | Description | Hodnota |
|---|---|---|
| atributy | Atributy klíče. | KeyAttributes |
| curveName | Název eliptické křivky Platné hodnoty najdete v tématu JsonWebKeyCurveName. | P-256 'P-256K' 'P-384' 'P-521' |
| keyOps | Pole řetězců obsahující některou z těchto možností: Dešifrování 'šifrovat' 'import' 'release' 'sign' (sign) UnwrapKey 'verify' (ověřit) 'wrapKey' |
|
| Keysize | Velikost klíče v bitech Napří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 vydání v reakci. Použije se pro výstup i vstup. Vynecháno, pokud je prázdné | KeyReleasePolicy |
| rotationPolicy | V reakci na zásady obměně klíčů. Použije se pro výstup i vstup. Vynecháno, pokud je prázdné | RotationPolicy |
KeyAttributes
| Název | Description | Hodnota |
|---|---|---|
| enabled | Určuje, zda je objekt povolený. | bool |
| exp | Datum vypršení platnosti v sekundách od 1970-01-01T00:00:00Z. | int |
| Exportovatelný | Určuje, jestli je možné privátní klíč exportovat. | bool |
| Nbf | Není před datem v sekundách od 1970-01-01T00:00:00Z. | int |
KeyReleasePolicy
| Název | Description | Hodnota |
|---|---|---|
| Contenttype | Typ obsahu a verze zásad vydávání klíčů | řetězec |
| data | Objekt blob kóduje pravidla zásad, podle kterých je možné klíč uvolnit. | řetězec |
RotationPolicy
| Název | Description | Hodnota |
|---|---|---|
| atributy | Atributy zásad obměně klíčů. | KeyRotationPolicyAttributes |
| lifetimeActions | The lifetimeActions for key rotation action. | LifetimeAction[] |
KeyRotationPolicyAttributes
| Název | Description | Hodnota |
|---|---|---|
| expiryTime | Doba vypršení platnosti nové verze klíče. Měl by být ve ISO8601 formátu. Například: P90D, P1Y. | řetězec |
LifetimeAction
| Název | Description | Hodnota |
|---|---|---|
| action | Akce životnosti zásad obměně klíčůAkce. | Akce |
| Aktivační událost | Trigger životnosti zásad obměně klíčůAction. | Trigger |
Akce
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ akce. | 'notify' (oznámit) 'rotate' (otočit) |
Trigger
| Název | Description | Hodnota |
|---|---|---|
| časAfterVytvořit | Doba, po které se má klíč vytvořit, aby se klíč obměněl. Platí pouze pro otáčení. Bude ve formátu doby trvání ISO 8601. Například: P90D, P1Y. | řetězec |
| timeBeforeExpiry | Doba před vypršením platnosti klíče pro obměna nebo oznámení. Bude ve formátu doby trvání ISO 8601. Například: P90D, P1Y. | řetězec |
Šablony pro rychlý start
Následující šablony pro rychlý start nasadí tento typ prostředku.
| Template (Šablona) | Description |
|---|---|
Vytvoření klíče ve službě Azure Key Vault |
Tento modul umožňuje vytvořit klíč v existující službě Key Vault. |
| Š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 Key Vault. |
Definice prostředku šablony ARM
Typ prostředku trezorů nebo klíčů je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků – viz příkazy pro nasazení skupin prostředků.
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Poznámky
Pokyny k používání trezorů klíčů pro zabezpečené hodnoty najdete v tématu Správa tajných kódů pomocí nástroje Bicep.
Rychlý start k vytvoření tajného klíče najdete v tématu Rychlý start: Nastavení a načtení tajného klíče z 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.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.KeyVault/vaults/keys, přidejte do šablony následující kód JSON.
{
"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"
}
}
]
}
}
}
Hodnoty vlastností
trezory/klíče
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ prostředku | Microsoft.KeyVault/vaults/keys |
| apiVersion | Verze rozhraní API prostředku | '2023-07-01' |
| name | Název prostředku Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM. |
string (povinné) |
| tags | Značky, které budou přiřazeny ke klíči. | Slovník názvů značek a hodnot. Viz Značky v šablonách |
| properties | Vlastnosti klíče, který se má vytvořit. | Klíčové vlastnosti (povinné) |
Klíčové vlastnosti
| Název | Description | Hodnota |
|---|---|---|
| atributy | Atributy klíče. | KeyAttributes |
| curveName | Název eliptické křivky Platné hodnoty najdete v tématu JsonWebKeyCurveName. | P-256 'P-256K' 'P-384' 'P-521' |
| keyOps | Pole řetězců obsahující některou z těchto možností: Dešifrování 'šifrovat' 'import' 'release' 'sign' (sign) UnwrapKey 'verify' (ověřit) 'wrapKey' |
|
| Keysize | Velikost klíče v bitech Napří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 vydání v reakci. Použije se pro výstup i vstup. Vynecháno, pokud je prázdné | KeyReleasePolicy |
| rotationPolicy | V reakci na zásady obměně klíčů. Použije se pro výstup i vstup. Vynecháno, pokud je prázdné | RotationPolicy |
KeyAttributes
| Název | Description | Hodnota |
|---|---|---|
| enabled | Určuje, zda je objekt povolený. | bool |
| exp | Datum vypršení platnosti v sekundách od 1970-01-01T00:00:00Z. | int |
| Exportovatelný | Označuje, jestli je možné exportovat privátní klíč. | bool |
| Nbf | Není před datem v sekundách od 1970-01-01T00:00:00Z. | int |
KeyReleasePolicy
| Název | Description | Hodnota |
|---|---|---|
| Contenttype | Typ obsahu a verze zásad vydání klíče | řetězec |
| data | Objekt blob kóduje pravidla zásad, podle kterých se dá klíč uvolnit. | řetězec |
RotationPolicy
| Název | Description | Hodnota |
|---|---|---|
| atributy | Atributy zásad obměny klíčů. | KeyRotationPolicyAttributes |
| lifetimeActions | The lifetimeActions for key rotation action. | LifetimeAction[] |
KeyRotationPolicyAttributes
| Název | Description | Hodnota |
|---|---|---|
| expiryTime | Doba vypršení platnosti nové verze klíče. Měl by být ve formátu ISO8601. Například: P90D, P1Y. | řetězec |
LifetimeAction
| Název | Description | Hodnota |
|---|---|---|
| action | Akce životnosti zásad obměně klíčůAkce. | Akce |
| Aktivační událost | Trigger životnosti zásad obměně klíčůAction. | Trigger |
Akce
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ akce. | 'notify' (oznámit) 'rotate' (otočit) |
Trigger
| Název | Description | Hodnota |
|---|---|---|
| časAfterVytvořit | Doba, po které se má klíč vytvořit, aby se klíč obměněl. Platí pouze pro otáčení. Bude ve formátu doby trvání ISO 8601. Například: P90D, P1Y. | řetězec |
| timeBeforeExpiry | Doba před vypršením platnosti klíče pro obměna nebo oznámení. Bude ve formátu doby trvání ISO 8601. Například: P90D, P1Y. | řetězec |
Šablony pro rychlý start
Následující šablony pro rychlý start nasadí tento typ prostředku.
| Template (Šablona) | Description |
|---|---|
| Vytvoření klíče ve službě Azure Key Vault |
Tento modul umožňuje vytvořit klíč v existující službě Key Vault. |
| Š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 Key Vault. |
Definice prostředku Terraform (poskytovatel AzAPI)
Typ prostředku trezorů nebo klíčů je možné nasadit s operacemi, které cílí na:
- 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@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"
}
}
]
}
}
})
}
Hodnoty vlastností
trezory/klíče
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ prostředku | Microsoft.KeyVault/vaults/keys@2023-07-01 |
| name | Název prostředku | string (povinné) |
| parent_id | ID prostředku, který je nadřazený pro tento prostředek. | ID prostředku typu : trezory |
| tags | Značky, které budou přiřazeny ke klíči. | Slovník názvů a hodnot značek. |
| properties | Vlastnosti klíče, který se má vytvořit. | Vlastnosti klíče (povinné) |
Vlastnosti klíče
| Název | Description | Hodnota |
|---|---|---|
| atributy | Atributy klíče. | Klíčové zdroje |
| curveName | Název eliptické křivky. Platné hodnoty najdete v tématu JsonWebKeyCurveName. | "P-256" "P-256K" "P-384" "P-521" |
| keyOps | Pole řetězců obsahující některou z těchto možností: "decrypt" (dešifrovat) "encrypt" (šifrovat) "import" "release" "sign" (sign) "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 vydání v reakci. Použije se pro výstup i vstup. Vynecháno, pokud je prázdné | KeyReleasePolicy |
| rotationPolicy | V reakci na zásady obměně klíčů. Použije se pro výstup i vstup. Vynecháno, pokud je prázdné | RotationPolicy |
KeyAttributes
| Název | Description | Hodnota |
|---|---|---|
| enabled | Určuje, zda je objekt povolený. | bool |
| exp | Datum vypršení platnosti v sekundách od 1970-01-01T00:00:00Z. | int |
| Exportovatelný | Označuje, jestli je možné exportovat privátní klíč. | bool |
| Nbf | Není před datem v sekundách od 1970-01-01T00:00:00Z. | int |
KeyReleasePolicy
| Název | Description | Hodnota |
|---|---|---|
| Contenttype | Typ obsahu a verze zásad vydání klíče | řetězec |
| data | Objekt blob kóduje pravidla zásad, podle kterých se dá klíč uvolnit. | řetězec |
RotationPolicy
| Název | Description | Hodnota |
|---|---|---|
| atributy | Atributy zásad obměny klíčů. | KeyRotationPolicyAttributes |
| lifetimeActions | The lifetimeActions for key rotation action. | LifetimeAction[] |
KeyRotationPolicyAttributes
| Název | Description | Hodnota |
|---|---|---|
| expiryTime | Doba vypršení platnosti nové verze klíče. Měl by být ve formátu ISO8601. Například: P90D, P1Y. | řetězec |
LifetimeAction
| Název | Description | Hodnota |
|---|---|---|
| action | Akce životnosti zásad obměně klíčůAkce. | Akce |
| Aktivační událost | Aktivační událost životnosti zásad obměně klíčůAkce. | Trigger |
Akce
| Název | Description | Hodnota |
|---|---|---|
| typ | Typ akce. | "notify" "otočit" |
Trigger
| Název | Description | Hodnota |
|---|---|---|
| časAfterVytvořit | Doba trvání po vytvoření klíče k obměně klíče. Vztahuje se pouze na otáčení. Bude ve formátu doby trvání ISO 8601. Například: P90D, P1Y. | řetězec |
| timeBeforeExpiry | Doba trvání před vypršením platnosti klíče k obměně nebo oznámení. Bude ve formátu doby trvání ISO 8601. Například: P90D, P1Y. | řetězec |
Váš názor
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu: https://aka.ms/ContentUserFeedback.
Odeslat a zobrazit názory pro