Microsoft.KeyVault-kluizen/sleutels
Bicep-resourcedefinitie
Het resourcetype kluizen/sleutels kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Opmerkingen
Zie Geheimen beheren met Bicep voor hulp bij het gebruik van sleutelkluizen voor beveiligde waarden.
Zie Quickstart: Een geheim instellen en ophalen uit Azure Key Vault met behulp van een ARM-sjabloon voor een quickstart over het maken van een geheim.
Zie Quickstart: Een Azure-sleutelkluis en een sleutel maken met behulp van een ARM-sjabloon voor een quickstart over het maken van een sleutel.
Resource-indeling
Als u een resource Microsoft.KeyVault/vaults/keys wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
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'
}
}
]
}
}
}
Eigenschapswaarden
kluizen/sleutels
| Naam | Description | Waarde |
|---|---|---|
| naam | De resourcenaam Meer informatie over het instellen van namen en typen voor onderliggende resources in Bicep. |
tekenreeks (vereist) |
| tags | De tags die aan de sleutel worden toegewezen. | Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken |
| Bovenliggende | In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd. Zie Onderliggende resource buiten bovenliggende resource voor meer informatie. |
Symbolische naam voor resource van het type: kluizen |
| properties | De eigenschappen van de sleutel die moet worden gemaakt. | KeyProperties (vereist) |
KeyProperties
| Naam | Description | Waarde |
|---|---|---|
| kenmerken | De kenmerken van de sleutel. | KeyAttributes |
| curveName | De naam van de elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden. | 'P-256' 'P-256K' 'P-384' 'P-521' |
| keyOps | Tekenreeksmatrix met een van de volgende waarden: 'ontsleutelen' 'encrypt' 'importeren' 'release' 'sign' 'unwrapKey' 'verifiëren' 'wrapKey' |
|
| keySize | De sleutelgrootte in bits. Bijvoorbeeld: 2048, 3072 of 4096 voor RSA. | int |
| kty | Het type sleutel. Zie JsonWebKeyType voor geldige waarden. | "EG" EC-HSM 'RSA' 'RSA-HSM' |
| release_policy | Beleid voor sleutelrelease als antwoord. Deze wordt gebruikt voor zowel uitvoer als invoer. Weggelaten indien leeg | KeyReleasePolicy |
| rotationPolicy | Beleid voor sleutelrotatie als antwoord. Deze wordt gebruikt voor zowel uitvoer als invoer. Weggelaten indien leeg | RotationPolicy |
KeyAttributes
| Naam | Description | Waarde |
|---|---|---|
| enabled | Bepaalt of het object is ingeschakeld. | booleaans |
| exp | Vervaldatum in seconden sinds 1970-01-01T00:00:00Z. | int |
| Exporteerbaar | Geeft aan of de persoonlijke sleutel kan worden geëxporteerd. | booleaans |
| nbf | Niet voor datum in seconden sinds 1970-01-01T00:00:00Z. | int |
KeyReleasePolicy
| Naam | Description | Waarde |
|---|---|---|
| Contenttype | Inhoudstype en versie van beleid voor sleutelrelease | tekenreeks |
| gegevens | Blobcodering van de beleidsregels waaronder de sleutel kan worden vrijgegeven. | tekenreeks |
RotationPolicy
| Naam | Description | Waarde |
|---|---|---|
| kenmerken | De kenmerken van het sleutelrotatiebeleid. | KeyRotationPolicyAttributes |
| lifetimeActions | De actie lifetimeActions voor sleutelrotatie. | LifetimeAction[] |
KeyRotationPolicyAttributes
| Naam | Description | Waarde |
|---|---|---|
| expiryTime | De verlooptijd voor de nieuwe sleutelversie. De indeling moet ISO8601 hebben. Bijvoorbeeld: 'P90D', 'P1Y'. | tekenreeks |
LifetimeAction
| Naam | Description | Waarde |
|---|---|---|
| action | De actie van de levensduur van het beleid voor sleutelrotatieActie. | Actie |
| activeren | De trigger van de levensduur van sleutelrotatiebeleidAction. | Trigger |
Actie
| Naam | Description | Waarde |
|---|---|---|
| type | Het type actie. | 'aanmelden' 'roteren' |
Trigger
| Naam | Description | Waarde |
|---|---|---|
| timeAfterCreate | De tijdsduur na het maken van de sleutel om de sleutel te roteren. Dit geldt alleen voor roteren. Het heeft een ISO 8601-duurindeling. Bijvoorbeeld: 'P90D', 'P1Y'. | tekenreeks |
| timeBeforeExpiry | De tijdsduur voordat de sleutel verloopt om te draaien of te melden. Het heeft een ISO 8601-duurindeling. Bijvoorbeeld: 'P90D', 'P1Y'. | tekenreeks |
Snelstartsjablonen
Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.
| Template | Beschrijving |
|---|---|
Een sleutel maken in Azure KeyVault |
Met deze module kunt u een sleutel maken in een bestaande KeyVault. |
| Azure Storage-accountversleuteling met door de klant beheerde sleutel |
Met deze sjabloon wordt een opslagaccount geïmplementeerd met een door de klant beheerde sleutel voor versleuteling die wordt gegenereerd en in een Key Vault wordt geplaatst. |
Resourcedefinitie van ARM-sjabloon
Het resourcetype kluizen/sleutels kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Opmerkingen
Zie Geheimen beheren met bicep voor hulp bij het gebruik van sleutelkluizen voor veilige waarden.
Zie Quickstart: Een geheim instellen en ophalen uit Azure Key Vault met behulp van een ARM-sjabloon voor een quickstart over het maken van een geheim.
Zie Quickstart: Een Azure-sleutelkluis en een sleutel maken met behulp van een ARM-sjabloon voor een quickstart over het maken van een sleutel.
Resource-indeling
Als u een Resource microsoft.KeyVault/vaults/keys wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"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"
}
}
]
}
}
}
Eigenschapswaarden
kluizen/sleutels
| Naam | Description | Waarde |
|---|---|---|
| type | Het resourcetype | 'Microsoft.KeyVault/vaults/keys' |
| apiVersion | De resource-API-versie | '2023-07-01' |
| naam | De resourcenaam Meer informatie over het instellen van namen en typen voor onderliggende resources in JSON ARM-sjablonen. |
tekenreeks (vereist) |
| tags | De tags die aan de sleutel worden toegewezen. | Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken |
| properties | De eigenschappen van de sleutel die moet worden gemaakt. | KeyProperties (vereist) |
KeyProperties
| Naam | Description | Waarde |
|---|---|---|
| kenmerken | De kenmerken van de sleutel. | KeyAttributes |
| curveName | De naam van de elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden. | 'P-256' 'P-256K' 'P-384' 'P-521' |
| keyOps | Tekenreeksmatrix met een van de volgende: 'ontsleutelen' 'versleutelen' 'importeren' 'release' 'sign' 'unwrapKey' 'verifiëren' 'wrapKey' |
|
| keySize | De sleutelgrootte in bits. Bijvoorbeeld: 2048, 3072 of 4096 voor RSA. | int |
| kty | Het type sleutel. Zie JsonWebKeyType voor geldige waarden. | "EG" 'EC-HSM' 'RSA' 'RSA-HSM' |
| release_policy | Beleid voor sleutelrelease als antwoord. Deze wordt gebruikt voor zowel uitvoer als invoer. Weggelaten indien leeg | KeyReleasePolicy |
| rotationPolicy | Sleutelrotatiebeleid als antwoord. Deze wordt gebruikt voor zowel uitvoer als invoer. Weggelaten indien leeg | RotationPolicy |
KeyAttributes
| Naam | Description | Waarde |
|---|---|---|
| enabled | Bepaalt of het object is ingeschakeld. | booleaans |
| exp | Vervaldatum in seconden sinds 1970-01-01T00:00:00Z. | int |
| Exporteerbaar | Geeft aan of de persoonlijke sleutel kan worden geëxporteerd. | booleaans |
| nbf | Niet voor datum in seconden sinds 1970-01-01T00:00:00Z. | int |
KeyReleasePolicy
| Naam | Description | Waarde |
|---|---|---|
| Contenttype | Inhoudstype en versie van beleid voor sleutelrelease | tekenreeks |
| gegevens | Blobcodering van de beleidsregels waaronder de sleutel kan worden vrijgegeven. | tekenreeks |
RotationPolicy
| Naam | Description | Waarde |
|---|---|---|
| kenmerken | De kenmerken van het sleutelrotatiebeleid. | KeyRotationPolicyAttributes |
| lifetimeActions | De actie lifetimeActions voor sleutelrotatie. | LifetimeAction[] |
KeyRotationPolicyAttributes
| Naam | Description | Waarde |
|---|---|---|
| expiryTime | De verlooptijd voor de nieuwe sleutelversie. De indeling moet ISO8601 hebben. Bijvoorbeeld: 'P90D', 'P1Y'. | tekenreeks |
LifetimeAction
| Naam | Description | Waarde |
|---|---|---|
| action | De actie van het beleid voor sleutelrotatie lifetimeAction. | Actie |
| activeren | De trigger van het beleid voor sleutelrotatie lifetimeAction. | Trigger |
Actie
| Naam | Description | Waarde |
|---|---|---|
| type | Het type actie. | 'kennisgeving' 'roteren' |
Trigger
| Naam | Description | Waarde |
|---|---|---|
| timeAfterCreate | De tijdsduur na het maken van de sleutel om de sleutel te roteren. Dit geldt alleen voor roteren. Het heeft de iso 8601-duurnotatie. Bijvoorbeeld: 'P90D', 'P1Y'. | tekenreeks |
| timeBeforeExpiry | De tijdsduur voordat de sleutel verloopt om te draaien of te melden. Het heeft de iso 8601-duurnotatie. Bijvoorbeeld: 'P90D', 'P1Y'. | tekenreeks |
Snelstartsjablonen
Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.
| Template | Beschrijving |
|---|---|
| Een sleutel maken in Azure KeyVault |
Met deze module kunt u een sleutel maken in een bestaande KeyVault. |
| Azure Storage-accountversleuteling met door de klant beheerde sleutel |
Met deze sjabloon wordt een opslagaccount geïmplementeerd met een door de klant beheerde sleutel voor versleuteling die wordt gegenereerd en in een Key Vault wordt geplaatst. |
Resourcedefinitie van Terraform (AzAPI-provider)
Het resourcetype kluizen/sleutels kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource Microsoft.KeyVault/vaults/keys wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
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"
}
}
]
}
}
})
}
Eigenschapswaarden
kluizen/sleutels
| Naam | Description | Waarde |
|---|---|---|
| type | Het resourcetype | "Microsoft.KeyVault/vaults/keys@2023-07-01" |
| naam | De resourcenaam | tekenreeks (vereist) |
| parent_id | De id van de resource die het bovenliggende item voor deze resource is. | Id voor resource van het type: kluizen |
| tags | De tags die aan de sleutel worden toegewezen. | Woordenlijst met tagnamen en -waarden. |
| properties | De eigenschappen van de sleutel die moet worden gemaakt. | KeyProperties (vereist) |
KeyProperties
| Naam | Description | Waarde |
|---|---|---|
| kenmerken | De kenmerken van de sleutel. | KeyAttributes |
| curveName | De naam van de elliptische curve. Zie JsonWebKeyCurveName voor geldige waarden. | "P-256" "P-256K" "P-384" "P-521" |
| keyOps | Tekenreeksmatrix met een van de volgende waarden: "ontsleutelen" "encrypt" "importeren" "release" "sign" "unwrapKey" "verifiëren" "wrapKey" |
|
| keySize | De sleutelgrootte in bits. Bijvoorbeeld: 2048, 3072 of 4096 voor RSA. | int |
| kty | Het type sleutel. Zie JsonWebKeyType voor geldige waarden. | "EC" "EC-HSM" "RSA" "RSA-HSM" |
| release_policy | Beleid voor sleutelrelease als antwoord. Deze wordt gebruikt voor zowel uitvoer als invoer. Weggelaten indien leeg | KeyReleasePolicy |
| rotationPolicy | Sleutelrotatiebeleid als antwoord. Deze wordt gebruikt voor zowel uitvoer als invoer. Weggelaten indien leeg | RotationPolicy |
KeyAttributes
| Naam | Description | Waarde |
|---|---|---|
| enabled | Bepaalt of het object is ingeschakeld. | booleaans |
| exp | Vervaldatum in seconden sinds 1970-01-01T00:00:00Z. | int |
| Exporteerbaar | Geeft aan of de persoonlijke sleutel kan worden geëxporteerd. | booleaans |
| nbf | Niet voor datum in seconden sinds 1970-01-01T00:00:00Z. | int |
KeyReleasePolicy
| Naam | Description | Waarde |
|---|---|---|
| Contenttype | Inhoudstype en versie van beleid voor sleutelrelease | tekenreeks |
| gegevens | Blobcodering van de beleidsregels waaronder de sleutel kan worden vrijgegeven. | tekenreeks |
RotationPolicy
| Naam | Description | Waarde |
|---|---|---|
| kenmerken | De kenmerken van het sleutelrotatiebeleid. | KeyRotationPolicyAttributes |
| lifetimeActions | De actie lifetimeActions voor sleutelrotatie. | LifetimeAction[] |
KeyRotationPolicyAttributes
| Naam | Description | Waarde |
|---|---|---|
| expiryTime | De verlooptijd voor de nieuwe sleutelversie. De indeling moet ISO8601 hebben. Bijvoorbeeld: 'P90D', 'P1Y'. | tekenreeks |
LifetimeAction
| Naam | Description | Waarde |
|---|---|---|
| action | De actie van de levensduur van het beleid voor sleutelrotatieActie. | Actie |
| activeren | De trigger van de levensduur van sleutelrotatiebeleidAction. | Trigger |
Actie
| Naam | Description | Waarde |
|---|---|---|
| type | Het type actie. | "notify" "roteren" |
Trigger
| Naam | Description | Waarde |
|---|---|---|
| timeAfterCreate | De tijdsduur na het maken van de sleutel om de sleutel te roteren. Dit geldt alleen voor roteren. Het heeft een ISO 8601-duurindeling. Bijvoorbeeld: 'P90D', 'P1Y'. | tekenreeks |
| timeBeforeExpiry | De tijdsduur voordat de sleutel verloopt om te draaien of te melden. Het heeft een ISO 8601-duurindeling. Bijvoorbeeld: 'P90D', 'P1Y'. | tekenreeks |
Feedback
Binnenkort beschikbaar: In de loop van 2024 zullen we GitHub-problemen geleidelijk uitfaseren als het feedbackmechanisme voor inhoud en deze vervangen door een nieuw feedbacksysteem. Zie voor meer informatie: https://aka.ms/ContentUserFeedback.
Feedback verzenden en weergeven voor