Microsoft.KeyVault managedHSMs/keys 2022-11-01
- nejnovější
-
2024-04-01-preview -
2023-07-01 - 2023-02-01
- 11. 11. 2022
Definice prostředku Bicep
Typ prostředku managedHSMs/keys 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/managedHSMs/keys, přidejte do šablony následující bicep.
resource symbolicname 'Microsoft.KeyVault/managedHSMs/keys@2022-11-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'
}
}
Hodnoty vlastností
ManagedHsmAction
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 |
ManagedHsmKeyAttributes
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 |
ManagedHsmKeyCreateParametersTags
Jméno | Popis | Hodnota |
---|
ManagedHsmKeyProperties
Jméno | Popis | Hodnota |
---|---|---|
atributy | Atributy klíče. | ManagedHsmKeyAttributes |
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é. | ManagedHsmKeyReleasePolicy |
rotationPolicy | Zásady obměně klíčů v reakci. Použije se pro výstup i vstup. Vynecháno, pokud je prázdné. | ManagedHsmRotationPolicy |
ManagedHsmKeyReleasePolicy
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 |
ManagedHsmKeyRotationPolicyAttributes
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 |
ManagedHsmLifetimeAction
Jméno | Popis | Hodnota |
---|---|---|
akce | Akce akce akce životnosti zásad obměně klíčů | ManagedHsmAction |
spoušť | Aktivační událost životnosti zásad obměně klíčů. | ManagedHsmTrigger |
ManagedHsmRotationPolicy
Jméno | Popis | Hodnota |
---|---|---|
atributy | Atributy zásad obměny klíčů. | ManagedHsmKeyRotationPolicyAttributes |
lifetimeActions | Akce životnosti pro akci obměny klíčů. | ManagedHsmLifetimeAction[] |
ManagedHsmTrigger
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 |
Microsoft.KeyVault/managedHSMs/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: managedHSMs |
vlastnosti | Vlastnosti klíče, který se má vytvořit. | ManagedHsmKeyProperties (povinné) |
visačky | Značky prostředků | Slovník názvů a hodnot značek Viz Značky v šablonách |
Definice prostředku šablony ARM
Typ prostředku managedHSMs/keys 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/managedHSMs/keys, přidejte do šablony následující JSON.
{
"type": "Microsoft.KeyVault/managedHSMs/keys",
"apiVersion": "2022-11-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"
}
}
Hodnoty vlastností
ManagedHsmAction
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 |
ManagedHsmKeyAttributes
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 |
ManagedHsmKeyCreateParametersTags
Jméno | Popis | Hodnota |
---|
ManagedHsmKeyProperties
Jméno | Popis | Hodnota |
---|---|---|
atributy | Atributy klíče. | ManagedHsmKeyAttributes |
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é. | ManagedHsmKeyReleasePolicy |
rotationPolicy | Zásady obměně klíčů v reakci. Použije se pro výstup i vstup. Vynecháno, pokud je prázdné. | ManagedHsmRotationPolicy |
ManagedHsmKeyReleasePolicy
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 |
ManagedHsmKeyRotationPolicyAttributes
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 |
ManagedHsmLifetimeAction
Jméno | Popis | Hodnota |
---|---|---|
akce | Akce akce akce životnosti zásad obměně klíčů | ManagedHsmAction |
spoušť | Aktivační událost životnosti zásad obměně klíčů. | ManagedHsmTrigger |
ManagedHsmRotationPolicy
Jméno | Popis | Hodnota |
---|---|---|
atributy | Atributy zásad obměny klíčů. | ManagedHsmKeyRotationPolicyAttributes |
lifetimeActions | Akce životnosti pro akci obměny klíčů. | ManagedHsmLifetimeAction[] |
ManagedHsmTrigger
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 |
Microsoft.KeyVault/managedHSMs/keys
Jméno | Popis | Hodnota |
---|---|---|
apiVersion | Verze rozhraní API | '2022-11-01' |
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. | ManagedHsmKeyProperties (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/managedHSMs/keys |
Definice prostředku Terraformu (poskytovatel AzAPI)
Typ prostředku managedHSMs/keys 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/managedHSMs/keys, přidejte do šablony následující Terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/managedHSMs/keys@2022-11-01"
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í
ManagedHsmAction
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 |
ManagedHsmKeyAttributes
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 |
ManagedHsmKeyCreateParametersTags
Jméno | Popis | Hodnota |
---|
ManagedHsmKeyProperties
Jméno | Popis | Hodnota |
---|---|---|
atributy | Atributy klíče. | ManagedHsmKeyAttributes |
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é. | ManagedHsmKeyReleasePolicy |
rotationPolicy | Zásady obměně klíčů v reakci. Použije se pro výstup i vstup. Vynecháno, pokud je prázdné. | ManagedHsmRotationPolicy |
ManagedHsmKeyReleasePolicy
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 |
ManagedHsmKeyRotationPolicyAttributes
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 |
ManagedHsmLifetimeAction
Jméno | Popis | Hodnota |
---|---|---|
akce | Akce akce akce životnosti zásad obměně klíčů | ManagedHsmAction |
spoušť | Aktivační událost životnosti zásad obměně klíčů. | ManagedHsmTrigger |
ManagedHsmRotationPolicy
Jméno | Popis | Hodnota |
---|---|---|
atributy | Atributy zásad obměny klíčů. | ManagedHsmKeyRotationPolicyAttributes |
lifetimeActions | Akce životnosti pro akci obměny klíčů. | ManagedHsmLifetimeAction[] |
ManagedHsmTrigger
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 |
Microsoft.KeyVault/managedHSMs/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: managedHSMs |
vlastnosti | Vlastnosti klíče, který se má vytvořit. | ManagedHsmKeyProperties (povinné) |
visačky | Značky prostředků | Slovník názvů a hodnot značek |
typ | Typ prostředku | Microsoft.KeyVault/managedHSMs/keys@2022-11-01" |