Microsoft.KeyVault-Tresore/Schlüssel 2021-10-01
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@2021-10-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'
}
}
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" "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" |
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 |
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. |
Ressourcendefinition mit einer ARM-Vorlage
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 JSON-Code hinzu.
{
"type": "Microsoft.KeyVault/vaults/keys",
"apiVersion": "2021-10-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"
}
}
Eigenschaftswerte
vaults/keys
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Der Ressourcentyp | "Microsoft.KeyVault/vaults/keys" |
apiVersion | Die Version der Ressourcen-API | '2021-10-01' |
name | Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen. |
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. |
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" "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" |
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 |
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@2021-10-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"
}
})
}
Eigenschaftswerte
vaults/keys
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Der Ressourcentyp | "Microsoft.KeyVault/vaults/keys@2021-10-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" "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" |
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 |