Microsoft.KeyVault managedHSMs/keys 2022-11-01

Artikel
04/20/2024

Bicep-Ressourcendefinition

Der Ressourcentyp managedHSMs/keys kann mit Vorgängen bereitgestellt werden, für die Folgendes gilt:

Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen

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

Ressourcenformat

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

resource symbolicname 'Microsoft.KeyVault/managedHSMs/keys@2022-11-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'
          }
        }
      ]
    }
  }
}

Eigenschaftswerte

managedHSMs/keys

Name	BESCHREIBUNG	Wert
name	Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep.	Zeichenfolge (erforderlich)
tags	Die Tags, die dem Schlüssel zugewiesen werden.	Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen.
parent	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 vom Typ: managedHSMs
properties	Die Eigenschaften des zu erstellenden Schlüssels.	ManagedHsmKeyProperties (erforderlich)

ManagedHsmKeyProperties

Name	BESCHREIBUNG	Wert
attributes	Die Attribute des Schlüssels.	ManagedHsmKeyAttributes
curveName	Der Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName.	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		Zeichenfolgenarray, das eines der folgenden Elemente enthält: "entschlüsseln" "verschlüsseln" "Import" "Release" "Sign" "unwrapKey" "überprüfen" "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 Antwort. Sie wird sowohl für die Ausgabe als auch für die Eingabe verwendet. Ausgelassen, wenn leer	ManagedHsmKeyReleasePolicy
rotationPolicy	Als Reaktion auf die Schlüsselrotationsrichtlinie. Sie wird sowohl für die Ausgabe als auch für die Eingabe verwendet. Ausgelassen, wenn leer	ManagedHsmRotationPolicy

ManagedHsmKeyAttributes

Name	BESCHREIBUNG	Wert
enabled	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 Datum in Sekunden seit 1970-01-01T00:00:00Z.	INT

ManagedHsmKeyReleasePolicy

Name	BESCHREIBUNG	Wert
contentType	Inhaltstyp und Version der Schlüsselfreigaberichtlinie	Zeichenfolge
data	Blobcodierung der Richtlinienregeln, unter denen der Schlüssel freigegeben werden kann.	Zeichenfolge

ManagedHsmRotationPolicy

Name	BESCHREIBUNG	Wert
attributes	Die Attribute der Schlüsselrotationsrichtlinie.	ManagedHsmKeyRotationPolicyAttributes
lifetimeActions	Die lifetimeActions-Aktion für die Schlüsselrotationsaktion.	ManagedHsmLifetimeAction[]

ManagedHsmKeyRotationPolicyAttributes

Name	BESCHREIBUNG	Wert
expiryTime	Die Ablaufzeit für die neue Schlüsselversion. Es sollte in ISO8601 Format vorliegen. Z. B. 'P90D', 'P1Y'.	Zeichenfolge

ManagedHsmLifetimeAction

Name	BESCHREIBUNG	Wert
action	Die Aktion der Lebensdauer der SchlüsselrotationsrichtlinieAction.	ManagedHsmAction
Trigger (trigger)	Der Trigger der Lebensdauer der SchlüsselrotationsrichtlinieAction.	ManagedHsmTrigger

ManagedHsmAction

Name	BESCHREIBUNG	Wert
type	Der Typ der Aktion. Bei dem Wert sollte die Groß-/Kleinschreibung nicht beachtet werden.	"Benachrichtigen" "Rotieren"

ManagedHsmTrigger

Name	BESCHREIBUNG	Wert
timeAfterCreate	Die Zeitdauer nach der Schlüsselerstellung zum Rotieren des Schlüssels. Sie gilt nur für rotieren. Es wird im ISO 8601-Dauerformat vorliegen. Z. B. 'P90D', 'P1Y'.	Zeichenfolge
timeBeforeExpiry	Die Zeitdauer vor dem Ablauf des Schlüssels, um sich zu rotieren oder zu benachrichtigen. Es wird im ISO 8601-Dauerformat vorliegen. Z. B. 'P90D', 'P1Y'.	Zeichenfolge

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp managedHSMs/keys kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle

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

Ressourcenformat

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

{
  "type": "Microsoft.KeyVault/managedHSMs/keys",
  "apiVersion": "2022-11-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"
          }
        }
      ]
    }
  }
}

Eigenschaftswerte

managedHSMs/keys

Name	BESCHREIBUNG	Wert
type	Ressourcentyp	"Microsoft.KeyVault/managedHSMs/keys"
apiVersion	Die Ressourcen-API-Version	'2022-11-01'
name	Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen.	Zeichenfolge (erforderlich)
tags	Die Tags, die dem Schlüssel zugewiesen werden.	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
properties	Die Eigenschaften des zu erstellenden Schlüssels.	ManagedHsmKeyProperties (erforderlich)

ManagedHsmKeyProperties

Name	BESCHREIBUNG	Wert
attributes	Die Attribute des Schlüssels.	ManagedHsmKeyAttributes
curveName	Der Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName.	'P-256' 'P-256K' 'P-384' 'P-521'
keyOps		Zeichenfolgenarray, das eines der folgenden Elemente enthält: "entschlüsseln" "verschlüsseln" "Import" "Release" "Sign" "unwrapKey" "überprüfen" "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 Antwort. Sie wird sowohl für die Ausgabe als auch für die Eingabe verwendet. Ausgelassen, wenn leer	ManagedHsmKeyReleasePolicy
rotationPolicy	Als Reaktion auf die Schlüsselrotationsrichtlinie. Sie wird sowohl für die Ausgabe als auch für die Eingabe verwendet. Ausgelassen, wenn leer	ManagedHsmRotationPolicy

ManagedHsmKeyAttributes

Name	BESCHREIBUNG	Wert
enabled	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 Datum in Sekunden seit 1970-01-01T00:00:00Z.	INT

ManagedHsmKeyReleasePolicy

Name	BESCHREIBUNG	Wert
contentType	Inhaltstyp und Version der Schlüsselfreigaberichtlinie	Zeichenfolge
data	Blobcodierung der Richtlinienregeln, unter denen der Schlüssel freigegeben werden kann.	Zeichenfolge

ManagedHsmRotationPolicy

Name	BESCHREIBUNG	Wert
attributes	Die Attribute der Schlüsselrotationsrichtlinie.	ManagedHsmKeyRotationPolicyAttributes
lifetimeActions	Die aktion lifetimeActions für die Schlüsselrotation.	ManagedHsmLifetimeAction[]

ManagedHsmKeyRotationPolicyAttributes

Name	BESCHREIBUNG	Wert
expiryTime	Die Ablaufzeit für die neue Schlüsselversion. Es sollte in ISO8601 Format vorliegen. Beispiel: 'P90D', 'P1Y'.	Zeichenfolge

ManagedHsmLifetimeAction

Name	BESCHREIBUNG	Wert
action	Die Aktion der Lebensdauer der SchlüsselrotationsrichtlinieAction.	ManagedHsmAction
Trigger (trigger)	Der Trigger der Lebensdauer der SchlüsselrotationsrichtlinieAction.	ManagedHsmTrigger

ManagedHsmAction

Name	BESCHREIBUNG	Wert
type	Der Typ der Aktion. Der Wert sollte ohne Berücksichtigung der Groß-/Kleinschreibung verglichen werden.	"Benachrichtigen" "Rotieren"

ManagedHsmTrigger

Name	BESCHREIBUNG	Wert
timeAfterCreate	Die Zeitdauer nach der Schlüsselerstellung zum Rotieren des Schlüssels. Sie gilt nur für das Rotieren. Es wird im ISO 8601-Dauerformat vorliegen. Beispiel: 'P90D', 'P1Y'.	Zeichenfolge
timeBeforeExpiry	Die Zeitdauer vor dem Ablauf des Schlüssels, um rotieren oder benachrichtigen zu können. Es wird im ISO 8601-Dauerformat vorliegen. Beispiel: 'P90D', 'P1Y'.	Zeichenfolge

Terraform-Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp managedHSMs/keys kann mit Vorgängen bereitgestellt werden, für die Folgendes gilt:

Ressourcengruppen

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

Ressourcenformat

Um eine Microsoft.KeyVault/managedHSMs/keys-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.

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

Eigenschaftswerte

managedHSMs/keys

Name	BESCHREIBUNG	Wert
type	Der Ressourcentyp	"Microsoft.KeyVault/managedHSMs/keys@2022-11-01"
name	Der Ressourcenname	Zeichenfolge (erforderlich)
parent_id	Die ID der Ressource, die das übergeordnete Element für diese Ressource ist.	ID für Ressource vom Typ: managedHSMs
tags	Die Tags, die dem Schlüssel zugewiesen werden.	Wörterbuch der Tagnamen und -werte.
properties	Die Eigenschaften des zu erstellenden Schlüssels.	ManagedHsmKeyProperties (erforderlich)

ManagedHsmKeyProperties

Name	BESCHREIBUNG	Wert
attributes	Die Attribute des Schlüssels.	ManagedHsmKeyAttributes
curveName	Der Name der elliptischen Kurve. Gültige Werte finden Sie unter JsonWebKeyCurveName.	"P-256" "P-256K" "P-384" "P-521"
keyOps		Zeichenfolgenarray, das eines der folgenden Elemente enthält: "entschlüsseln" "verschlüsseln" "Import" "Release" "sign" "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.	"EC" "EC-HSM" "RSA" "RSA-HSM"
release_policy	Schlüsselfreigaberichtlinie als Antwort. Sie wird sowohl für die Ausgabe als auch für die Eingabe verwendet. Ausgelassen, wenn leer	ManagedHsmKeyReleasePolicy
rotationPolicy	Als Reaktion auf die Schlüsselrotationsrichtlinie. Sie wird sowohl für die Ausgabe als auch für die Eingabe verwendet. Ausgelassen, wenn leer	ManagedHsmRotationPolicy

ManagedHsmKeyAttributes

Name	BESCHREIBUNG	Wert
enabled	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 Datum in Sekunden seit 1970-01-01T00:00:00Z.	INT

ManagedHsmKeyReleasePolicy

Name	BESCHREIBUNG	Wert
contentType	Inhaltstyp und Version der Schlüsselfreigaberichtlinie	Zeichenfolge
data	Blobcodierung der Richtlinienregeln, unter denen der Schlüssel freigegeben werden kann.	Zeichenfolge

ManagedHsmRotationPolicy

Name	BESCHREIBUNG	Wert
attributes	Die Attribute der Schlüsselrotationsrichtlinie.	ManagedHsmKeyRotationPolicyAttributes
lifetimeActions	Die lifetimeActions-Aktion für die Schlüsselrotationsaktion.	ManagedHsmLifetimeAction[]

ManagedHsmKeyRotationPolicyAttributes

Name	BESCHREIBUNG	Wert
expiryTime	Die Ablaufzeit für die neue Schlüsselversion. Es sollte in ISO8601 Format vorliegen. Z. B. 'P90D', 'P1Y'.	Zeichenfolge

ManagedHsmLifetimeAction

Name	BESCHREIBUNG	Wert
action	Die Aktion der Lebensdauer der SchlüsselrotationsrichtlinieAction.	ManagedHsmAction
Trigger (trigger)	Der Trigger der Lebensdauer der SchlüsselrotationsrichtlinieAction.	ManagedHsmTrigger

ManagedHsmAction

Name	BESCHREIBUNG	Wert
type	Der Typ der Aktion. Bei dem Wert sollte die Groß-/Kleinschreibung nicht beachtet werden.	"Benachrichtigen" "Rotieren"

ManagedHsmTrigger

Name	BESCHREIBUNG	Wert
timeAfterCreate	Die Zeitdauer nach der Schlüsselerstellung zum Rotieren des Schlüssels. Sie gilt nur für rotieren. Es wird im ISO 8601-Dauerformat vorliegen. Z. B. 'P90D', 'P1Y'.	Zeichenfolge
timeBeforeExpiry	Die Zeitdauer vor dem Ablauf des Schlüssels, um sich zu rotieren oder zu benachrichtigen. Es wird im ISO 8601-Dauerformat vorliegen. Z. B. 'P90D', 'P1Y'.	Zeichenfolge

Freigeben über

Microsoft.KeyVault managedHSMs/keys 2022-11-01

Bicep-Ressourcendefinition

Ressourcenformat

Eigenschaftswerte

managedHSMs/keys

ManagedHsmKeyProperties

ManagedHsmKeyAttributes

ManagedHsmKeyReleasePolicy

ManagedHsmRotationPolicy

ManagedHsmKeyRotationPolicyAttributes

ManagedHsmLifetimeAction

ManagedHsmAction

ManagedHsmTrigger

Ressourcendefinition mit einer ARM-Vorlage

Ressourcenformat

Eigenschaftswerte

managedHSMs/keys

ManagedHsmKeyProperties

ManagedHsmKeyAttributes

ManagedHsmKeyReleasePolicy

ManagedHsmRotationPolicy

ManagedHsmKeyRotationPolicyAttributes

ManagedHsmLifetimeAction

ManagedHsmAction

ManagedHsmTrigger

Terraform-Ressourcendefinition (AzAPI-Anbieter)

Ressourcenformat

Eigenschaftswerte

managedHSMs/keys

ManagedHsmKeyProperties

ManagedHsmKeyAttributes

ManagedHsmKeyReleasePolicy

ManagedHsmRotationPolicy

ManagedHsmKeyRotationPolicyAttributes

ManagedHsmLifetimeAction

ManagedHsmAction

ManagedHsmTrigger

Feedback

Zusätzliche Ressourcen