Microsoft.KeyVault Vaults/Keys

Artikel
12/20/2024

Bemerkungen

Anleitungen zur Verwendung von Schlüsseltresorn für sichere Werte finden Sie unter Verwalten von geheimen Schlüsseln mithilfe von Bicep.

Eine Schnellstartanleitung zum Erstellen eines geheimen Schlüssels finden Sie unter Schnellstart: Festlegen und Abrufen eines geheimen Schlüssels aus Azure Key Vault mithilfe einer ARM-Vorlage.

Eine Schnellstartanleitung zum Erstellen eines Schlüssels finden Sie unter Schnellstart: Erstellen eines Azure-Schlüsseltresors und eines Schlüssels mithilfe der ARM-Vorlage.

Bicep-Ressourcendefinition

Der Ressourcentyp Tresore/Schlüssel kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.KeyVault/vaults/keys-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Bicep hinzu.

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

Eigenschaftswerte

Aktion

Name	Beschreibung	Wert
Art	Der Aktionstyp.	"notify" "drehen"

KeyAttributes

Name	Beschreibung	Wert
ermöglichte	Bestimmt, ob das Objekt aktiviert ist.	Bool
Exp	Ablaufdatum in Sekunden seit 1970-01-01T00:00:00Z.	Int
exportierbar	Gibt an, ob der private Schlüssel exportiert werden kann.	Bool
nbf	Nicht vor dem Datum in Sekunden seit 1970-01-01T00:00:00Z.	Int

KeyCreateParametersTags

Name	Beschreibung	Wert

KeyProperties

Name	Beschreibung	Wert
Attribute	Die Attribute des Schlüssels.	KeyAttributes-
curveName	Der Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName.	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		Zeichenfolgenarray, das eine der folgenden Elemente enthält: "entschlüsseln" "verschlüsseln" "import" "Release" "Zeichen" "unwrapKey" "verify" "wrapKey"
keySize	Die Schlüsselgröße in Bits. Beispiel: 2048, 3072 oder 4096 für RSA.	Int
kty	Der Typ des Schlüssels. Gültige Werte finden Sie unter JsonWebKeyType.	"EG" "EC-HSM" "RSA" "RSA-HSM"
release_policy	Schlüsselfreigaberichtlinie als Reaktion. Sie wird sowohl für die Ausgabe als auch für die Eingabe verwendet. Wird weggelassen, wenn leer	KeyReleasePolicy-
rotationPolicy	Schlüsseldrehungsrichtlinie als Reaktion. Sie wird sowohl für die Ausgabe als auch für die Eingabe verwendet. Wird weggelassen, wenn leer	RotationPolicy-

KeyReleasePolicy

Name	Beschreibung	Wert
contentType	Inhaltstyp und Version der Schlüsselveröffentlichungsrichtlinie	Schnur
Daten	Blobcodierung der Richtlinienregeln, unter denen der Schlüssel freigegeben werden kann.	Schnur

KeyRotationPolicyAttributes

Name	Beschreibung	Wert
expiryTime	Die Ablaufzeit für die neue Schlüsselversion. Er sollte im ISO8601 Format vorliegen. Beispiel: 'P90D', 'P1Y'.	Schnur

LifetimeAction

Name	Beschreibung	Wert
Aktion	Die Aktion der Lebensdauer der Schlüsseldrehungsrichtlinie.	Aktion
auslösen	Der Auslöser der Lebensdauer der Schlüsseldrehungsrichtlinie.	Trigger-

Microsoft.KeyVault/Vaults/Keys

Name	Beschreibung	Wert
Name	Der Ressourcenname	Schnur Zwänge: Pattern = `^[a-zA-Z0-9-]{1,127}$` (erforderlich)
Elternteil	In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.	Symbolischer Name für Ressource des Typs: Tresore
Eigenschaften	Die Eigenschaften des zu erstellenden Schlüssels.	KeyProperties- (erforderlich)
Schilder	Ressourcentags	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

RotationPolicy

Name	Beschreibung	Wert
Attribute	Die Attribute der Schlüsseldrehungsrichtlinie.	KeyRotationPolicyAttributes
lifetimeActions	Die lifetimeActions für die Tastendrehungsaktion.	LifetimeAction[]

Auslösen

Name	Beschreibung	Wert
timeAfterCreate	Die Zeitdauer nach der Schlüsselerstellung, um den Schlüssel zu drehen. Sie gilt nur für die Drehung. Er wird im ISO 8601-Dauerformat verwendet. Beispiel: 'P90D', 'P1Y'.	Schnur
timeBeforeExpiry	Die Zeitdauer vor dem Ablauf der Taste, um zu drehen oder zu benachrichtigen. Er wird im ISO 8601-Dauerformat verwendet. Beispiel: 'P90D', 'P1Y'.	Schnur

Schnellstartbeispiele

Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.

Bicep-Datei	Beschreibung
Azure Storage-Kontoverschlüsselung mit vom Kunden verwalteten Schlüsseln	Diese Vorlage stellt ein Speicherkonto mit einem vom Kunden verwalteten Schlüssel für die Verschlüsselung bereit, die generiert und in einem Key Vault platziert wird.

ARM-Vorlagenressourcendefinition

Der Ressourcentyp Tresore/Schlüssel kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.KeyVault/vaults/keys-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.

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

Eigenschaftswerte

Aktion

Name	Beschreibung	Wert
Art	Der Aktionstyp.	"notify" "drehen"

KeyAttributes

Name	Beschreibung	Wert
ermöglichte	Bestimmt, ob das Objekt aktiviert ist.	Bool
Exp	Ablaufdatum in Sekunden seit 1970-01-01T00:00:00Z.	Int
exportierbar	Gibt an, ob der private Schlüssel exportiert werden kann.	Bool
nbf	Nicht vor dem Datum in Sekunden seit 1970-01-01T00:00:00Z.	Int

KeyCreateParametersTags

Name	Beschreibung	Wert

KeyProperties

Name	Beschreibung	Wert
Attribute	Die Attribute des Schlüssels.	KeyAttributes-
curveName	Der Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName.	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		Zeichenfolgenarray, das eine der folgenden Elemente enthält: "entschlüsseln" "verschlüsseln" "import" "Release" "Zeichen" "unwrapKey" "verify" "wrapKey"
keySize	Die Schlüsselgröße in Bits. Beispiel: 2048, 3072 oder 4096 für RSA.	Int
kty	Der Typ des Schlüssels. Gültige Werte finden Sie unter JsonWebKeyType.	"EG" "EC-HSM" "RSA" "RSA-HSM"
release_policy	Schlüsselfreigaberichtlinie als Reaktion. Sie wird sowohl für die Ausgabe als auch für die Eingabe verwendet. Wird weggelassen, wenn leer	KeyReleasePolicy-
rotationPolicy	Schlüsseldrehungsrichtlinie als Reaktion. Sie wird sowohl für die Ausgabe als auch für die Eingabe verwendet. Wird weggelassen, wenn leer	RotationPolicy-

KeyReleasePolicy

Name	Beschreibung	Wert
contentType	Inhaltstyp und Version der Schlüsselveröffentlichungsrichtlinie	Schnur
Daten	Blobcodierung der Richtlinienregeln, unter denen der Schlüssel freigegeben werden kann.	Schnur

KeyRotationPolicyAttributes

Name	Beschreibung	Wert
expiryTime	Die Ablaufzeit für die neue Schlüsselversion. Er sollte im ISO8601 Format vorliegen. Beispiel: 'P90D', 'P1Y'.	Schnur

LifetimeAction

Name	Beschreibung	Wert
Aktion	Die Aktion der Lebensdauer der Schlüsseldrehungsrichtlinie.	Aktion
auslösen	Der Auslöser der Lebensdauer der Schlüsseldrehungsrichtlinie.	Trigger-

Microsoft.KeyVault/Vaults/Keys

Name	Beschreibung	Wert
apiVersion	Die API-Version	"2024-04-01-preview"
Name	Der Ressourcenname	Schnur Zwänge: Pattern = `^[a-zA-Z0-9-]{1,127}$` (erforderlich)
Eigenschaften	Die Eigenschaften des zu erstellenden Schlüssels.	KeyProperties- (erforderlich)
Schilder	Ressourcentags	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art	Der Ressourcentyp	"Microsoft.KeyVault/vaults/keys"

RotationPolicy

Name	Beschreibung	Wert
Attribute	Die Attribute der Schlüsseldrehungsrichtlinie.	KeyRotationPolicyAttributes
lifetimeActions	Die lifetimeActions für die Tastendrehungsaktion.	LifetimeAction[]

Auslösen

Name	Beschreibung	Wert
timeAfterCreate	Die Zeitdauer nach der Schlüsselerstellung, um den Schlüssel zu drehen. Sie gilt nur für die Drehung. Er wird im ISO 8601-Dauerformat verwendet. Beispiel: 'P90D', 'P1Y'.	Schnur
timeBeforeExpiry	Die Zeitdauer vor dem Ablauf der Taste, um zu drehen oder zu benachrichtigen. Er wird im ISO 8601-Dauerformat verwendet. Beispiel: 'P90D', 'P1Y'.	Schnur

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone	Beschreibung
Azure Storage-Kontoverschlüsselung mit vom Kunden verwalteten Schlüsseln	Diese Vorlage stellt ein Speicherkonto mit einem vom Kunden verwalteten Schlüssel für die Verschlüsselung bereit, die generiert und in einem Key Vault platziert wird.
Erstellen eines Schlüssels in Azure KeyVault	Mit diesem Modul können Sie einen Schlüssel in einem vorhandenen KeyVault erstellen.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp Tresore/Schlüssel kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.KeyVault/Vaults/Keys-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

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

Eigenschaftswerte

Aktion

Name	Beschreibung	Wert
Art	Der Aktionstyp.	"notify" "drehen"

KeyAttributes

Name	Beschreibung	Wert
ermöglichte	Bestimmt, ob das Objekt aktiviert ist.	Bool
Exp	Ablaufdatum in Sekunden seit 1970-01-01T00:00:00Z.	Int
exportierbar	Gibt an, ob der private Schlüssel exportiert werden kann.	Bool
nbf	Nicht vor dem Datum in Sekunden seit 1970-01-01T00:00:00Z.	Int

KeyCreateParametersTags

Name	Beschreibung	Wert

KeyProperties

Name	Beschreibung	Wert
Attribute	Die Attribute des Schlüssels.	KeyAttributes-
curveName	Der Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName.	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		Zeichenfolgenarray, das eine der folgenden Elemente enthält: "entschlüsseln" "verschlüsseln" "import" "Release" "Zeichen" "unwrapKey" "verify" "wrapKey"
keySize	Die Schlüsselgröße in Bits. Beispiel: 2048, 3072 oder 4096 für RSA.	Int
kty	Der Typ des Schlüssels. Gültige Werte finden Sie unter JsonWebKeyType.	"EG" "EC-HSM" "RSA" "RSA-HSM"
release_policy	Schlüsselfreigaberichtlinie als Reaktion. Sie wird sowohl für die Ausgabe als auch für die Eingabe verwendet. Wird weggelassen, wenn leer	KeyReleasePolicy-
rotationPolicy	Schlüsseldrehungsrichtlinie als Reaktion. Sie wird sowohl für die Ausgabe als auch für die Eingabe verwendet. Wird weggelassen, wenn leer	RotationPolicy-

KeyReleasePolicy

Name	Beschreibung	Wert
contentType	Inhaltstyp und Version der Schlüsselveröffentlichungsrichtlinie	Schnur
Daten	Blobcodierung der Richtlinienregeln, unter denen der Schlüssel freigegeben werden kann.	Schnur

KeyRotationPolicyAttributes

Name	Beschreibung	Wert
expiryTime	Die Ablaufzeit für die neue Schlüsselversion. Er sollte im ISO8601 Format vorliegen. Beispiel: 'P90D', 'P1Y'.	Schnur

LifetimeAction

Name	Beschreibung	Wert
Aktion	Die Aktion der Lebensdauer der Schlüsseldrehungsrichtlinie.	Aktion
auslösen	Der Auslöser der Lebensdauer der Schlüsseldrehungsrichtlinie.	Trigger-

Microsoft.KeyVault/Vaults/Keys

Name	Beschreibung	Wert
Name	Der Ressourcenname	Schnur Zwänge: Pattern = `^[a-zA-Z0-9-]{1,127}$` (erforderlich)
parent_id	Die ID der Ressource, die das übergeordnete Element für diese Ressource ist.	ID für Ressource vom Typ: Vaults
Eigenschaften	Die Eigenschaften des zu erstellenden Schlüssels.	KeyProperties- (erforderlich)
Schilder	Ressourcentags	Wörterbuch der Tagnamen und -werte.
Art	Der Ressourcentyp	"Microsoft.KeyVault/vaults/keys@2024-04-01-preview"

RotationPolicy

Name	Beschreibung	Wert
Attribute	Die Attribute der Schlüsseldrehungsrichtlinie.	KeyRotationPolicyAttributes
lifetimeActions	Die lifetimeActions für die Tastendrehungsaktion.	LifetimeAction[]

Auslösen

Name	Beschreibung	Wert
timeAfterCreate	Die Zeitdauer nach der Schlüsselerstellung, um den Schlüssel zu drehen. Sie gilt nur für die Drehung. Er wird im ISO 8601-Dauerformat verwendet. Beispiel: 'P90D', 'P1Y'.	Schnur
timeBeforeExpiry	Die Zeitdauer vor dem Ablauf der Taste, um zu drehen oder zu benachrichtigen. Er wird im ISO 8601-Dauerformat verwendet. Beispiel: 'P90D', 'P1Y'.	Schnur

Freigeben über

Microsoft.KeyVault Vaults/Keys

Bemerkungen

Bicep-Ressourcendefinition

Ressourcenformat

Eigenschaftswerte

Aktion

KeyAttributes

KeyCreateParametersTags

KeyProperties

KeyReleasePolicy

KeyRotationPolicyAttributes

LifetimeAction

Microsoft.KeyVault/Vaults/Keys

RotationPolicy

Auslösen

Schnellstartbeispiele

ARM-Vorlagenressourcendefinition

Ressourcenformat

Eigenschaftswerte

Aktion

KeyAttributes

KeyCreateParametersTags

KeyProperties

KeyReleasePolicy

KeyRotationPolicyAttributes

LifetimeAction

Microsoft.KeyVault/Vaults/Keys

RotationPolicy

Auslösen

Schnellstartvorlagen

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Ressourcenformat

Eigenschaftswerte

Aktion

KeyAttributes

KeyCreateParametersTags

KeyProperties

KeyReleasePolicy

KeyRotationPolicyAttributes

LifetimeAction

Microsoft.KeyVault/Vaults/Keys

RotationPolicy

Auslösen

Feedback

Zusätzliche Ressourcen