Microsoft.KeyVault-valv/nycklar 2024-11-01
Vägledning om hur du använder nyckelvalv för säkra värden finns i Hantera hemligheter med hjälp av Bicep.
En snabbstart om hur du skapar en hemlighet finns i Snabbstart: Ange och hämta en hemlighet från Azure Key Vault med hjälp av en ARM-mall.
En snabbstart om hur du skapar en nyckel finns i Snabbstart: Skapa ett Azure-nyckelvalv och en nyckel med hjälp av ARM-mallen.
Resurstypen valv/nycklar kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Om du vill skapa en Microsoft.KeyVault/vaults/keys-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.KeyVault/vaults/keys@2024-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'
}
}
Namn | Beskrivning | Värde |
---|---|---|
typ | Typ av åtgärd. | "meddela" "rotera" |
Namn | Beskrivning | Värde |
---|---|---|
Aktiverat | Avgör om objektet är aktiverat eller inte. | Bool |
Exp | Förfallodatum i sekunder sedan 1970-01-01T00:00:00Z. | Int |
Exporteras | Anger om den privata nyckeln kan exporteras. | Bool |
nbf | Inte före datum i sekunder sedan 1970-01-01T00:00:00Z. | Int |
Namn | Beskrivning | Värde |
---|
Namn | Beskrivning | Värde |
---|---|---|
Attribut | Nyckelns attribut. | KeyAttributes |
curveName | Det elliptiska kurvnamnet. Giltiga värden finns i JsonWebKeyCurveName. Standardvärdet för EC- och EC-HSM nycklar är P-256 | "P-256" "P-256K" "P-384" "P-521" |
keyOps | Strängmatris som innehåller något av: "dekryptera" "kryptera" "import" "release" "sign" "unwrapKey" "verifiera" "wrapKey" |
|
keySize | Nyckelstorleken i bitar. Till exempel: 2048, 3072 eller 4096 för RSA. Standardvärdet för RSA- och RSA-HSM nycklar är 2048. Undantag som gjorts för BYOK (Bring Your Own Key), nyckelutbytesnycklar som standard är 4096. | Int |
kty | Typ av nyckel. Giltiga värden finns i JsonWebKeyType. | "EG" "EC-HSM" "RSA" "RSA-HSM" |
release_policy | Viktig versionsprincip som svar. Den används för både utdata och indata. Utelämnas om det är tomt | KeyReleasePolicy |
rotationPolicy | Nyckelroteringsprincip som svar. Den används för både utdata och indata. Utelämnas om det är tomt | RotationPolicy |
Namn | Beskrivning | Värde |
---|---|---|
contentType | Innehållstyp och version av viktig versionsprincip | sträng |
data | Blobkodning av de principregler som nyckeln kan släppas under. | sträng |
Namn | Beskrivning | Värde |
---|---|---|
expiryTime | Förfallotiden för den nya nyckelversionen. Den ska vara i ISO8601 format. T.ex. "P90D", "P1Y". | sträng |
Namn | Beskrivning | Värde |
---|---|---|
handling | Åtgärden för nyckelrotationsprincipens livslängdÅtgärd. | åtgärd |
utlösa | Utlösaren för nyckelrotationsprincipens livslängdÅtgärd. | utlösare |
Namn | Beskrivning | Värde |
---|---|---|
Namn | Resursnamnet | sträng Begränsningar: Mönster = ^[a-zA-Z0-9-]{1,127}$ (krävs) |
förälder | I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför den överordnade resursen. |
Symboliskt namn för resurs av typen: valv |
Egenskaper | Egenskaperna för nyckeln som ska skapas. | KeyProperties (krävs) |
Taggar | Resurstaggar | Ordlista med taggnamn och värden. Se taggar i mallar |
Namn | Beskrivning | Värde |
---|---|---|
Attribut | Attributen för nyckelrotationsprincipen. | KeyRotationPolicyAttributes |
lifetimeActions | LifetimeActions för nyckelrotation. | LifetimeAction[] |
Namn | Beskrivning | Värde |
---|---|---|
timeAfterCreate | Tidsåtgången efter att nyckeln har skapats för att rotera nyckeln. Det gäller endast för rotation. Den kommer att vara i ISO 8601-varaktighetsformat. T.ex. "P90D", "P1Y". | sträng |
timeBeforeExpiry | Tidsåtgången innan nyckeln upphör att roteras eller meddelas. Den kommer att vara i ISO 8601-varaktighetsformat. T.ex. "P90D", "P1Y". | sträng |
Följande snabbstartsexempel distribuerar den här resurstypen.
Bicep-fil | Beskrivning |
---|---|
Azure Storage-kontokryptering med kundhanterad nyckel | Den här mallen distribuerar ett lagringskonto med en kundhanterad nyckel för kryptering som genereras och placeras i ett Nyckelvalv. |
Resurstypen valv/nycklar kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Om du vill skapa en Microsoft.KeyVault/vaults/keys-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.KeyVault/vaults/keys",
"apiVersion": "2024-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"
}
}
Namn | Beskrivning | Värde |
---|---|---|
typ | Typ av åtgärd. | "meddela" "rotera" |
Namn | Beskrivning | Värde |
---|---|---|
Aktiverat | Avgör om objektet är aktiverat eller inte. | Bool |
Exp | Förfallodatum i sekunder sedan 1970-01-01T00:00:00Z. | Int |
Exporteras | Anger om den privata nyckeln kan exporteras. | Bool |
nbf | Inte före datum i sekunder sedan 1970-01-01T00:00:00Z. | Int |
Namn | Beskrivning | Värde |
---|
Namn | Beskrivning | Värde |
---|---|---|
Attribut | Nyckelns attribut. | KeyAttributes |
curveName | Det elliptiska kurvnamnet. Giltiga värden finns i JsonWebKeyCurveName. Standardvärdet för EC- och EC-HSM nycklar är P-256 | "P-256" "P-256K" "P-384" "P-521" |
keyOps | Strängmatris som innehåller något av: "dekryptera" "kryptera" "import" "release" "sign" "unwrapKey" "verifiera" "wrapKey" |
|
keySize | Nyckelstorleken i bitar. Till exempel: 2048, 3072 eller 4096 för RSA. Standardvärdet för RSA- och RSA-HSM nycklar är 2048. Undantag som gjorts för BYOK (Bring Your Own Key), nyckelutbytesnycklar som standard är 4096. | Int |
kty | Typ av nyckel. Giltiga värden finns i JsonWebKeyType. | "EG" "EC-HSM" "RSA" "RSA-HSM" |
release_policy | Viktig versionsprincip som svar. Den används för både utdata och indata. Utelämnas om det är tomt | KeyReleasePolicy |
rotationPolicy | Nyckelroteringsprincip som svar. Den används för både utdata och indata. Utelämnas om det är tomt | RotationPolicy |
Namn | Beskrivning | Värde |
---|---|---|
contentType | Innehållstyp och version av viktig versionsprincip | sträng |
data | Blobkodning av de principregler som nyckeln kan släppas under. | sträng |
Namn | Beskrivning | Värde |
---|---|---|
expiryTime | Förfallotiden för den nya nyckelversionen. Den ska vara i ISO8601 format. T.ex. "P90D", "P1Y". | sträng |
Namn | Beskrivning | Värde |
---|---|---|
handling | Åtgärden för nyckelrotationsprincipens livslängdÅtgärd. | åtgärd |
utlösa | Utlösaren för nyckelrotationsprincipens livslängdÅtgärd. | utlösare |
Namn | Beskrivning | Värde |
---|---|---|
apiVersion | API-versionen | '2024-11-01' |
Namn | Resursnamnet | sträng Begränsningar: Mönster = ^[a-zA-Z0-9-]{1,127}$ (krävs) |
Egenskaper | Egenskaperna för nyckeln som ska skapas. | KeyProperties (krävs) |
Taggar | Resurstaggar | Ordlista med taggnamn och värden. Se taggar i mallar |
typ | Resurstypen | "Microsoft.KeyVault/vaults/keys" |
Namn | Beskrivning | Värde |
---|---|---|
Attribut | Attributen för nyckelrotationsprincipen. | KeyRotationPolicyAttributes |
lifetimeActions | LifetimeActions för nyckelrotation. | LifetimeAction[] |
Namn | Beskrivning | Värde |
---|---|---|
timeAfterCreate | Tidsåtgången efter att nyckeln har skapats för att rotera nyckeln. Det gäller endast för rotation. Den kommer att vara i ISO 8601-varaktighetsformat. T.ex. "P90D", "P1Y". | sträng |
timeBeforeExpiry | Tidsåtgången innan nyckeln upphör att roteras eller meddelas. Den kommer att vara i ISO 8601-varaktighetsformat. T.ex. "P90D", "P1Y". | sträng |
Följande snabbstartsmallar distribuerar den här resurstypen.
Mall | Beskrivning |
---|---|
Azure Storage-kontokryptering med kundhanterad nyckel |
Den här mallen distribuerar ett lagringskonto med en kundhanterad nyckel för kryptering som genereras och placeras i ett Nyckelvalv. |
Skapa en nyckel i Azure KeyVault |
Med den här modulen kan du skapa en nyckel i en befintlig KeyVault. |
Resurstypen valv/nycklar kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Om du vill skapa en Microsoft.KeyVault/vaults/keys-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/vaults/keys@2024-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"
}
}
]
}
}
})
}
Namn | Beskrivning | Värde |
---|---|---|
typ | Typ av åtgärd. | "meddela" "rotera" |
Namn | Beskrivning | Värde |
---|---|---|
Aktiverat | Avgör om objektet är aktiverat eller inte. | Bool |
Exp | Förfallodatum i sekunder sedan 1970-01-01T00:00:00Z. | Int |
Exporteras | Anger om den privata nyckeln kan exporteras. | Bool |
nbf | Inte före datum i sekunder sedan 1970-01-01T00:00:00Z. | Int |
Namn | Beskrivning | Värde |
---|
Namn | Beskrivning | Värde |
---|---|---|
Attribut | Nyckelns attribut. | KeyAttributes |
curveName | Det elliptiska kurvnamnet. Giltiga värden finns i JsonWebKeyCurveName. Standardvärdet för EC- och EC-HSM nycklar är P-256 | "P-256" "P-256K" "P-384" "P-521" |
keyOps | Strängmatris som innehåller något av: "dekryptera" "kryptera" "import" "release" "sign" "unwrapKey" "verifiera" "wrapKey" |
|
keySize | Nyckelstorleken i bitar. Till exempel: 2048, 3072 eller 4096 för RSA. Standardvärdet för RSA- och RSA-HSM nycklar är 2048. Undantag som gjorts för BYOK (Bring Your Own Key), nyckelutbytesnycklar som standard är 4096. | Int |
kty | Typ av nyckel. Giltiga värden finns i JsonWebKeyType. | "EG" "EC-HSM" "RSA" "RSA-HSM" |
release_policy | Viktig versionsprincip som svar. Den används för både utdata och indata. Utelämnas om det är tomt | KeyReleasePolicy |
rotationPolicy | Nyckelroteringsprincip som svar. Den används för både utdata och indata. Utelämnas om det är tomt | RotationPolicy |
Namn | Beskrivning | Värde |
---|---|---|
contentType | Innehållstyp och version av viktig versionsprincip | sträng |
data | Blobkodning av de principregler som nyckeln kan släppas under. | sträng |
Namn | Beskrivning | Värde |
---|---|---|
expiryTime | Förfallotiden för den nya nyckelversionen. Den ska vara i ISO8601 format. T.ex. "P90D", "P1Y". | sträng |
Namn | Beskrivning | Värde |
---|---|---|
handling | Åtgärden för nyckelrotationsprincipens livslängdÅtgärd. | åtgärd |
utlösa | Utlösaren för nyckelrotationsprincipens livslängdÅtgärd. | utlösare |
Namn | Beskrivning | Värde |
---|---|---|
Namn | Resursnamnet | sträng Begränsningar: Mönster = ^[a-zA-Z0-9-]{1,127}$ (krävs) |
parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: valv |
Egenskaper | Egenskaperna för nyckeln som ska skapas. | KeyProperties (krävs) |
Taggar | Resurstaggar | Ordlista med taggnamn och värden. |
typ | Resurstypen | "Microsoft.KeyVault/vaults/keys@2024-11-01" |
Namn | Beskrivning | Värde |
---|---|---|
Attribut | Attributen för nyckelrotationsprincipen. | KeyRotationPolicyAttributes |
lifetimeActions | LifetimeActions för nyckelrotation. | LifetimeAction[] |
Namn | Beskrivning | Värde |
---|---|---|
timeAfterCreate | Tidsåtgången efter att nyckeln har skapats för att rotera nyckeln. Det gäller endast för rotation. Den kommer att vara i ISO 8601-varaktighetsformat. T.ex. "P90D", "P1Y". | sträng |
timeBeforeExpiry | Tidsåtgången innan nyckeln upphör att roteras eller meddelas. Den kommer att vara i ISO 8601-varaktighetsformat. T.ex. "P90D", "P1Y". | sträng |