Freigeben über


Microsoft.KeyVault managedHSMs/keys 2023-07-01

Bicep-Ressourcendefinition

Der Ressourcentyp "managedHSMs/keys" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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 ihrer Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.KeyVault/managedHSMs/keys@2023-07-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'
  }
}

Eigenschaftswerte

ManagedHsmAction

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

ManagedHsmKeyAttributes

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

ManagedHsmKeyCreateParametersTags

Name Beschreibung Wert

ManagedHsmKeyProperties

Name Beschreibung Wert
Attribute 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 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 ManagedHsmKeyReleasePolicy
rotationPolicy Schlüsseldrehungsrichtlinie als Reaktion. Sie wird sowohl für die Ausgabe als auch für die Eingabe verwendet. Wird weggelassen, wenn leer ManagedHsmRotationPolicy

ManagedHsmKeyReleasePolicy

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

ManagedHsmKeyRotationPolicyAttributes

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

ManagedHsmLifetimeAction

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

ManagedHsmRotationPolicy

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

ManagedHsmTrigger

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

Microsoft.KeyVault/managedHSMs/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 vom Typ: managedHSMs
Eigenschaften Die Eigenschaften des zu erstellenden Schlüssels. ManagedHsmKeyProperties (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "managedHSMs/keys" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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": "2023-07-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"
  }
}

Eigenschaftswerte

ManagedHsmAction

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

ManagedHsmKeyAttributes

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

ManagedHsmKeyCreateParametersTags

Name Beschreibung Wert

ManagedHsmKeyProperties

Name Beschreibung Wert
Attribute 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 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 ManagedHsmKeyReleasePolicy
rotationPolicy Schlüsseldrehungsrichtlinie als Reaktion. Sie wird sowohl für die Ausgabe als auch für die Eingabe verwendet. Wird weggelassen, wenn leer ManagedHsmRotationPolicy

ManagedHsmKeyReleasePolicy

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

ManagedHsmKeyRotationPolicyAttributes

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

ManagedHsmLifetimeAction

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

ManagedHsmRotationPolicy

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

ManagedHsmTrigger

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

Microsoft.KeyVault/managedHSMs/keys

Name Beschreibung Wert
apiVersion Die API-Version '2023-07-01'
Name Der Ressourcenname Schnur

Zwänge:
Pattern = ^[a-zA-Z0-9-]{1,127}$ (erforderlich)
Eigenschaften Die Eigenschaften des zu erstellenden Schlüssels. ManagedHsmKeyProperties (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art Der Ressourcentyp "Microsoft.KeyVault/managedHSMs/keys"

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "managedHSMs/keys" 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/managedHSMs/keys-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

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

Eigenschaftswerte

ManagedHsmAction

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

ManagedHsmKeyAttributes

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

ManagedHsmKeyCreateParametersTags

Name Beschreibung Wert

ManagedHsmKeyProperties

Name Beschreibung Wert
Attribute 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 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 ManagedHsmKeyReleasePolicy
rotationPolicy Schlüsseldrehungsrichtlinie als Reaktion. Sie wird sowohl für die Ausgabe als auch für die Eingabe verwendet. Wird weggelassen, wenn leer ManagedHsmRotationPolicy

ManagedHsmKeyReleasePolicy

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

ManagedHsmKeyRotationPolicyAttributes

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

ManagedHsmLifetimeAction

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

ManagedHsmRotationPolicy

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

ManagedHsmTrigger

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

Microsoft.KeyVault/managedHSMs/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: managedHSMs
Eigenschaften Die Eigenschaften des zu erstellenden Schlüssels. ManagedHsmKeyProperties (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte.
Art Der Ressourcentyp "Microsoft.KeyVault/managedHSMs/keys@2023-07-01"