Microsoft.KeyVault-Tresore/Schlüssel
Bicep-Ressourcendefinition
Der Ressourcentyp Tresore/Schlüssel kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Hinweise
Eine Anleitung zur Verwendung von Schlüsseltresoren für sichere Werte finden Sie unter Verwalten von Geheimnissen mithilfe von Bicep.
Eine Schnellstartanleitung zum Erstellen eines Geheimnisses finden Sie unter Schnellstart: Festlegen und Abrufen eines Geheimnisses 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 einer ARM-Vorlage.
Ressourcenformat
Um eine Microsoft.KeyVault/vaults/keys-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.KeyVault/vaults/keys@2023-07-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
vaults/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: Tresore |
| properties | Die Eigenschaften des zu erstellenden Schlüssels. | KeyProperties (erforderlich) |
KeyProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| attributes | 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 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 | KeyReleasePolicy |
| rotationPolicy | Als Reaktion auf die Schlüsselrotationsrichtlinie. Sie wird sowohl für die Ausgabe als auch für die Eingabe verwendet. Ausgelassen, wenn leer | RotationPolicy |
KeyAttributes
| 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 |
KeyReleasePolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| contentType | Inhaltstyp und Version der Schlüsselfreigaberichtlinie | Zeichenfolge |
| data | Blobcodierung der Richtlinienregeln, unter denen der Schlüssel freigegeben werden kann. | Zeichenfolge |
RotationPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| attributes | Die Attribute der Schlüsselrotationsrichtlinie. | KeyRotationPolicyAttributes |
| lifetimeActions | Die lifetimeActions-Aktion für die Schlüsselrotationsaktion. | LifetimeAction[] |
KeyRotationPolicyAttributes
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| expiryTime | Die Ablaufzeit für die neue Schlüsselversion. Es sollte in ISO8601 Format vorliegen. Z. B. 'P90D', 'P1Y'. | Zeichenfolge |
LifetimeAction
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| action | Die Aktion der Lebensdauer der SchlüsselrotationsrichtlinieAction. | Aktion |
| Trigger (trigger) | Der Trigger der Lebensdauer der SchlüsselrotationsrichtlinieAction. | Trigger |
Aktion
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Aktionstyp. | "benachrichtigen" "Rotieren" |
Trigger
| 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 |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
Erstellen eines Schlüssels in Azure KeyVault |
Mit diesem Modul können Sie einen Schlüssel in einem vorhandenen KeyVault erstellen. |
| Azure Storage-Kontoverschlüsselung mit kundenseitig verwaltetem Schlüssel |
Diese Vorlage stellt ein Speicherkonto mit einem kundenseitig verwalteten Schlüssel für die Verschlüsselung bereit, der generiert und in einem Key Vault platziert wird. |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp Tresore/Schlüssel 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.
Hinweise
Anleitungen zur Verwendung von Schlüsseltresoren für sichere Werte finden Sie unter Verwalten von Geheimnissen mit Bicep.
Einen Schnellstart zum Erstellen eines Geheimnisses finden Sie unter Schnellstart: Festlegen und Abrufen eines Geheimnisses aus Azure Key Vault mithilfe einer ARM-Vorlage.
Einen Schnellstart zum Erstellen eines Schlüssels finden Sie unter Schnellstart: Erstellen eines Azure-Schlüsseltresors und eines Schlüssels mithilfe der ARM-Vorlage.
Ressourcenformat
Um eine Microsoft.KeyVault/vaults/keys-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.KeyVault/vaults/keys",
"apiVersion": "2023-07-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
vaults/keys
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.KeyVault/vaults/keys" |
| apiVersion | Die Ressourcen-API-Version | '2023-07-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. | KeyProperties (erforderlich) |
KeyProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| attributes | 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 folgendes 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 | KeyReleasePolicy |
| rotationPolicy | Schlüsselrotationsrichtlinie als Antwort. Sie wird sowohl für die Ausgabe als auch für die Eingabe verwendet. Ausgelassen, wenn leer | RotationPolicy |
KeyAttributes
| 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 |
KeyReleasePolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| contentType | Inhaltstyp und Version der Schlüsselfreigaberichtlinie | Zeichenfolge |
| data | Blobcodierung der Richtlinienregeln, unter denen der Schlüssel freigegeben werden kann. | Zeichenfolge |
RotationPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| attributes | Die Attribute der Schlüsselrotationsrichtlinie. | KeyRotationPolicyAttributes |
| lifetimeActions | Die lifetimeActions-Aktion für die Schlüsselrotationsaktion. | LifetimeAction[] |
KeyRotationPolicyAttributes
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| expiryTime | Die Ablaufzeit für die neue Schlüsselversion. Es sollte in ISO8601 Format vorliegen. Beispiel: 'P90D', 'P1Y'. | Zeichenfolge |
LifetimeAction
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| action | Die Aktion der Lebensdauer der SchlüsselrotationsrichtlinieAction. | Aktion |
| Trigger (trigger) | Der Trigger der Lebensdauer der SchlüsselrotationsrichtlinieAction. | Trigger |
Aktion
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Aktionstyp. | "benachrichtigen" "rotieren" |
Trigger
| 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 |
Schnellstartvorlagen
In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
| Erstellen eines Schlüssels in Azure KeyVault |
In diesem Modul können Sie einen Schlüssel in einem vorhandenen KeyVault erstellen. |
| Azure Storage-Kontoverschlüsselung mit kundenseitig verwaltetem Schlüssel |
Diese Vorlage stellt ein Speicherkonto mit einem kundenseitig verwalteten Schlüssel für die Verschlüsselung bereit, der generiert und in einem Key Vault platziert wird. |
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 im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.KeyVault/vaults/keys-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/vaults/keys@2023-07-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
vaults/keys
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.KeyVault/vaults/keys@2023-07-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: Tresore |
| tags | Die Tags, die dem Schlüssel zugewiesen werden. | Wörterbuch der Tagnamen und -werte. |
| properties | Die Eigenschaften des zu erstellenden Schlüssels. | KeyProperties (erforderlich) |
KeyProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| attributes | 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 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 | KeyReleasePolicy |
| rotationPolicy | Als Reaktion auf die Schlüsselrotationsrichtlinie. Sie wird sowohl für die Ausgabe als auch für die Eingabe verwendet. Ausgelassen, wenn leer | RotationPolicy |
KeyAttributes
| 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 |
KeyReleasePolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| contentType | Inhaltstyp und Version der Schlüsselfreigaberichtlinie | Zeichenfolge |
| data | Blobcodierung der Richtlinienregeln, unter denen der Schlüssel freigegeben werden kann. | Zeichenfolge |
RotationPolicy
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| attributes | Die Attribute der Schlüsselrotationsrichtlinie. | KeyRotationPolicyAttributes |
| lifetimeActions | Die aktion lifetimeActions für die Schlüsselrotation. | LifetimeAction[] |
KeyRotationPolicyAttributes
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| expiryTime | Die Ablaufzeit für die neue Schlüsselversion. Es sollte in ISO8601 Format vorliegen. Beispiel: 'P90D', 'P1Y'. | Zeichenfolge |
LifetimeAction
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| action | Die Aktion der Lebensdauer der SchlüsselrotationsrichtlinieAction. | Aktion |
| Trigger (trigger) | Der Trigger der Lebensdauer der SchlüsselrotationsrichtlinieAction. | Trigger |
Aktion
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Aktionstyp. | "benachrichtigen" "rotieren" |
Trigger
| 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 |
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für