Microsoft.KeyVault-valv/nycklar 2021-04-01-preview

Artikel
04/20/2024

Bicep-resursdefinition

Resurstypen valv/nycklar kan distribueras med åtgärder som mål:

Resursgrupper – Se kommandon för resursgruppsdistribution

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Kommentarer

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.

Resursformat

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@2021-04-01-preview' = {
  name: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    attributes: {
      enabled: bool
      exp: int
      nbf: int
    }
    curveName: 'string'
    keyOps: [
      'string'
    ]
    keySize: int
    kty: 'string'
    rotationPolicy: {
      attributes: {
        expiryTime: 'string'
      }
      lifetimeActions: [
        {
          action: {
            type: 'string'
          }
          trigger: {
            timeAfterCreate: 'string'
            timeBeforeExpiry: 'string'
          }
        }
      ]
    }
  }
}

Egenskapsvärden

valv/nycklar

Name	Beskrivning	Värde
name	Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep.	sträng (krävs)
tags	Taggarna som ska tilldelas till nyckeln.	Ordlista med taggnamn och värden. Se Taggar i mallar
parent	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 överordnad resurs.	Symboliskt namn för resurs av typen: valv
properties	Egenskaperna för nyckeln som ska skapas.	KeyProperties (krävs)

KeyProperties

Name	Beskrivning	Värde
Attribut	Attributen för nyckeln.	KeyAttributes
curveName	Namnet på den elliptiska kurvan. Giltiga värden finns i JsonWebKeyCurveName.	"P-256" "P-256K" "P-384" "P-521"
keyOps		Strängmatris som innehåller något av: "dekryptera" "kryptera" "import" 'sign' "unwrapKey" "verifiera" 'wrapKey'
Keysize	Nyckelstorleken i bitar. Exempel: 2048, 3072 eller 4096 för RSA.	int
kty	Typ av nyckel. Giltiga värden finns i JsonWebKeyType.	"EC" "EC-HSM" "RSA" "RSA-HSM"
rotationPolicy	Nyckelroteringsprincip som svar. Den används för både utdata och indata. Utelämnas om det är tomt	RotationPolicy

KeyAttributes

Name	Beskrivning	Värde
enabled	Avgör om objektet är aktiverat eller inte.	boolesk
exp	Förfallodatum i sekunder sedan 1970-01-01T00:00:00Z.	int
Nbf	Inte före datum i sekunder sedan 1970-01-01T00:00:00Z.	int

RotationPolicy

Name	Beskrivning	Värde
Attribut	Attributen för nyckelroteringsprincipen.	KeyRotationPolicyAttributes
lifetimeActions	LifetimeActions för nyckelroteringsåtgärden.	LifetimeAction[]

KeyRotationPolicyAttributes

Name	Beskrivning	Värde
expiryTime	Förfallotiden för den nya nyckelversionen. Den bör vara i ISO8601 format. T.ex. "P90D", "P1Y".	sträng

LifetimeAction

Name	Beskrivning	Värde
åtgärd	Åtgärden för nyckelroteringsprincipens livslängdÅtgärd.	Åtgärd
Utlösa	Utlösaren för nyckelroteringsprincipens livslängdÅtgärd.	Utlösare

Åtgärd

Name	Beskrivning	Värde
typ	Typen av åtgärd. Värdet ska jämföras skiftlägesokänsligt.	"Meddela" "Rotera"

Utlösare

Name	Beskrivning	Värde
timeAfterCreate	Tidsåtgången efter att nyckeln har skapats för att rotera nyckeln. Den bör vara i ISO8601 format. T.ex. "P90D", "P1Y".	sträng
timeBeforeExpiry	Tiden innan nyckeln upphör att gälla för att rotera nyckeln. Den bör vara i ISO8601 format. T.ex. "P90D", "P1Y".	sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall	Description
Skapa en nyckel i Azure KeyVault	I den här modulen kan du skapa en nyckel i ett befintligt KeyVault.
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 en Key Vault.

Resursdefinition för ARM-mall

Resurstypen valv/nycklar kan distribueras med åtgärder som mål:

Resursgrupper – Se kommandon för resursgruppsdistribution

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Kommentarer

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.

Resursformat

Om du vill skapa en Resurs för Microsoft.KeyVault/vaults/keys lägger du till följande JSON i mallen.

{
  "type": "Microsoft.KeyVault/vaults/keys",
  "apiVersion": "2021-04-01-preview",
  "name": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "attributes": {
      "enabled": "bool",
      "exp": "int",
      "nbf": "int"
    },
    "curveName": "string",
    "keyOps": [ "string" ],
    "keySize": "int",
    "kty": "string",
    "rotationPolicy": {
      "attributes": {
        "expiryTime": "string"
      },
      "lifetimeActions": [
        {
          "action": {
            "type": "string"
          },
          "trigger": {
            "timeAfterCreate": "string",
            "timeBeforeExpiry": "string"
          }
        }
      ]
    }
  }
}

Egenskapsvärden

valv/nycklar

Name	Beskrivning	Värde
typ	Resurstypen	"Microsoft.KeyVault/vaults/keys"
apiVersion	Resurs-API-versionen	"2021-04-01-preview"
name	Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.	sträng (krävs)
tags	Taggarna som ska tilldelas till nyckeln.	Ordlista med taggnamn och värden. Se Taggar i mallar
properties	Egenskaperna för nyckeln som ska skapas.	KeyProperties (krävs)

KeyProperties

Name	Beskrivning	Värde
Attribut	Attributen för nyckeln.	KeyAttributes
curveName	Namnet på den elliptiska kurvan. Giltiga värden finns i JsonWebKeyCurveName.	"P-256" "P-256K" "P-384" "P-521"
keyOps		Strängmatris som innehåller något av: "dekryptera" "kryptera" "import" "sign" "unwrapKey" "verifiera" "wrapKey"
Keysize	Nyckelstorleken i bitar. Exempel: 2048, 3072 eller 4096 för RSA.	int
kty	Typ av nyckel. Giltiga värden finns i JsonWebKeyType.	"EG" "EC-HSM" "RSA" "RSA-HSM"
rotationPolicy	Nyckelroteringsprincip som svar. Den används för både utdata och indata. Utelämnas om det är tomt	RotationPolicy

KeyAttributes

Name	Beskrivning	Värde
enabled	Avgör om objektet är aktiverat eller inte.	boolesk
exp	Förfallodatum i sekunder sedan 1970-01-01T00:00:00Z.	int
Nbf	Inte före datum i sekunder sedan 1970-01-01T00:00:00Z.	int

RotationPolicy

Name	Beskrivning	Värde
Attribut	Attributen för nyckelroteringsprincipen.	KeyRotationPolicyAttributes
lifetimeActions	LifetimeActions för nyckelrotationsåtgärd.	LifetimeAction[]

KeyRotationPolicyAttributes

Name	Beskrivning	Värde
expiryTime	Förfallotiden för den nya nyckelversionen. Den bör vara i ISO8601 format. T.ex. "P90D", "P1Y".	sträng

LifetimeAction

Name	Beskrivning	Värde
åtgärd	Åtgärden för nyckelroteringsprincipens livslängdÅtgärd.	Åtgärd
Utlösa	Utlösaren för nyckelrotationsprincipens livslängdÅtgärd.	Utlösare

Åtgärd

Name	Beskrivning	Värde
typ	Typen av åtgärd. Värdet bör jämföras skiftlägesokänsligt.	"Meddela" "Rotera"

Utlösare

Name	Beskrivning	Värde
timeAfterCreate	Tidsåtgången efter att nyckeln har skapats för att rotera nyckeln. Den bör vara i ISO8601 format. T.ex. "P90D", "P1Y".	sträng
timeBeforeExpiry	Tidsåtgången innan nyckeln upphör att gälla för att rotera nyckeln. Den bör vara i ISO8601 format. T.ex. "P90D", "P1Y".	sträng

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall	Description
Skapa en nyckel i Azure KeyVault	Med den här modulen kan du skapa en nyckel i en befintlig KeyVault.
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 en Key Vault.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen valv/nycklar kan distribueras med åtgärder som mål:

Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

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@2021-04-01-preview"
  name = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      attributes = {
        enabled = bool
        exp = int
        nbf = int
      }
      curveName = "string"
      keyOps = [
        "string"
      ]
      keySize = int
      kty = "string"
      rotationPolicy = {
        attributes = {
          expiryTime = "string"
        }
        lifetimeActions = [
          {
            action = {
              type = "string"
            }
            trigger = {
              timeAfterCreate = "string"
              timeBeforeExpiry = "string"
            }
          }
        ]
      }
    }
  })
}

Egenskapsvärden

valv/nycklar

Name	Beskrivning	Värde
typ	Resurstypen	"Microsoft.KeyVault/vaults/keys@2021-04-01-preview"
name	Resursnamnet	sträng (krävs)
parent_id	ID:t för resursen som är överordnad för den här resursen.	ID för resurs av typen: valv
tags	Taggarna som ska tilldelas till nyckeln.	Ordlista med taggnamn och värden.
properties	Egenskaperna för nyckeln som ska skapas.	KeyProperties (krävs)

KeyProperties

Name	Beskrivning	Värde
Attribut	Attributen för nyckeln.	KeyAttributes
curveName	Namnet på den elliptiska kurvan. Giltiga värden finns i JsonWebKeyCurveName.	"P-256" "P-256K" "P-384" "P-521"
keyOps		Strängmatris som innehåller något av: "dekryptera" "kryptera" "import" "sign" "unwrapKey" "verifiera" "wrapKey"
Keysize	Nyckelstorleken i bitar. Exempel: 2048, 3072 eller 4096 för RSA.	int
kty	Typ av nyckel. Giltiga värden finns i JsonWebKeyType.	"EC" "EC-HSM" "RSA" "RSA-HSM"
rotationPolicy	Nyckelroteringsprincip som svar. Den används för både utdata och indata. Utelämnas om det är tomt	RotationPolicy

KeyAttributes

Name	Beskrivning	Värde
enabled	Avgör om objektet är aktiverat eller inte.	boolesk
exp	Förfallodatum i sekunder sedan 1970-01-01T00:00:00Z.	int
Nbf	Inte före datum i sekunder sedan 1970-01-01T00:00:00Z.	int

RotationPolicy

Name	Beskrivning	Värde
Attribut	Attributen för nyckelroteringsprincipen.	KeyRotationPolicyAttributes
lifetimeActions	LifetimeActions för nyckelrotationsåtgärd.	LifetimeAction[]

KeyRotationPolicyAttributes

Name	Beskrivning	Värde
expiryTime	Förfallotiden för den nya nyckelversionen. Den bör vara i ISO8601 format. T.ex. "P90D", "P1Y".	sträng

LifetimeAction

Name	Beskrivning	Värde
åtgärd	Åtgärden för nyckelroteringsprincipens livslängdÅtgärd.	Åtgärd
Utlösa	Utlösaren för nyckelrotationsprincipens livslängdÅtgärd.	Utlösare

Åtgärd

Name	Beskrivning	Värde
typ	Typen av åtgärd. Värdet bör jämföras skiftlägesokänsligt.	"Meddela" "Rotera"

Utlösare

Name	Beskrivning	Värde
timeAfterCreate	Tidsåtgången efter att nyckeln har skapats för att rotera nyckeln. Den bör vara i ISO8601 format. T.ex. "P90D", "P1Y".	sträng
timeBeforeExpiry	Tidsåtgången innan nyckeln upphör att gälla för att rotera nyckeln. Den bör vara i ISO8601 format. T.ex. "P90D", "P1Y".	sträng

Dela via

Microsoft.KeyVault-valv/nycklar 2021-04-01-preview

Bicep-resursdefinition

Kommentarer

Resursformat

Egenskapsvärden

valv/nycklar

KeyProperties

KeyAttributes

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

Åtgärd

Utlösare

Snabbstartsmallar

Resursdefinition för ARM-mall

Kommentarer

Resursformat

Egenskapsvärden

valv/nycklar

KeyProperties

KeyAttributes

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

Åtgärd

Utlösare

Snabbstartsmallar

Resursdefinition för Terraform (AzAPI-provider)

Resursformat

Egenskapsvärden

valv/nycklar

KeyProperties

KeyAttributes

RotationPolicy

KeyRotationPolicyAttributes

LifetimeAction

Åtgärd

Utlösare

Feedback

Feedback

Ytterligare resurser