Notitie
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen u aan te melden of de directory te wijzigen.
Voor toegang tot deze pagina is autorisatie vereist. U kunt proberen de mappen te wijzigen.
- meest recente
- 2026-03-01-vooruitblik
- 2026-02-01
- 2025-05-01
- 2024-12-01-preview-
- 2024-11-01
- 2024-04-01-preview-
- 2023-07-01
- 2023-02-01
- 2022-11-01
- 2022-07-01
- 2022-02-01-preview-
- 2021-11-01-preview-
- 2021-10-01
- 2021-06-01-preview-
- 2021-04-01-preview-
- 2020-04-01-preview-
- 2019-09-01
- 2018-02-14
- 2018-02-14-preview-
- 2016-10-01
Opmerkingen
Voor richtlijnen over het gebruik van key vaults voor veilige waarden, zie Beheer geheimen door Bicep te gebruiken.
Voor een quickstart voor het aanmaken van een geheim, zie Quickstart: Set en haal een geheim op van Azure Key Vault met een ARM-template.
Voor een snelstart bij het aanmaken van een sleutel, zie Quickstart: Create an Azure key vault en een sleutel door ARM template te gebruiken.
Bicep-resourcedefinitie
Het resourcetype kluizen/geheimen kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Gebruiksvoorbeelden
Bicep Monsters
Een basisvoorbeeld van het inzetten van Key Vault Secrets.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource vault 'Microsoft.KeyVault/vaults@2023-02-01' = {
name: resourceName
location: location
properties: {
sku: {
family: 'A'
name: 'standard'
}
accessPolicies: []
enableSoftDelete: true
tenantId: tenant().tenantId
}
}
resource putSecret 'Microsoft.KeyVault/vaults/secrets@2023-02-01' = {
name: resourceName
parent: vault
properties: {
value: 'szechuan'
}
}
Geverifieerde Azure-modules
De volgende Azure Geverifieerde modules kunnen worden gebruikt om dit resourcetype uit te voeren.
| Module | Beschrijving |
|---|---|
| Key Vault - Geheim | AVM Child Module voor Key Vault - Secret |
Azure-snelstartvoorbeelden
De volgende Azure Quickstart-sjablonen bevatten Bicep voorbeelden voor het uitrollen van dit resourcetype.
| Bicep-bestand | Beschrijving |
|---|---|
| Application Gateway met intern API-beheer en Web App | Application Gateway leidt internetverkeer naar een virtueel netwerk (interne modus) API Management-instantie die een web-API bedient die wordt gehost in een Azure Web App. |
| Azure Functie-app en een HTTP-getriggerde functie | Dit voorbeeld deployeert een Azure Function-app en een HTTP-getriggerde functie inline in het sjabloon. Het implementeert ook een Key Vault en vult een geheim in met de hostsleutel van de functie-app. |
| Maak een Key Vault en een lijst met geheimen | Dit sjabloon maakt een Key Vault aan en een lijst van geheimen binnen de key vault zoals doorgegeven, samen met de parameters |
| Maak een API-beheerdienst aan met SSL vanuit KeyVault | Met deze sjabloon wordt een API Management-service geïmplementeerd die is geconfigureerd met door de gebruiker toegewezen identiteit. Deze identiteit gebruikt om een SSL-certificaat op te halen uit KeyVault en wordt bijgewerkt door elke 4 uur te controleren. |
| Dit sjabloon maakt een Azure Key Vault en een secret aan. | |
| Maak een Azure Key Vault met RBAC en een secret | Dit sjabloon maakt een Azure Key Vault en een secret aan. In plaats van te vertrouwen op toegangsbeleid, maakt het gebruik van Azure RBAC om autorisatie van geheimen te beheren |
| FinOps-hub | Deze template maakt een nieuwe FinOps-hub-instantie aan, inclusief Data Explorer, Data Lake-opslag en Data Factory. |
| Testomgeving voor Azure Firewall Premium | Deze template maakt een Azure Firewall Premium en Firewall Policy aan met premiumfuncties zoals Intrusion Inspection Detection (IDPS), TLS-inspectie en Web Category Filtering |
Resource-indeling
Om een Microsoft.KeyVault/vaults/secrets-bron te maken, voeg je de volgende Bicep toe aan je sjabloon.
resource symbolicname 'Microsoft.KeyVault/vaults/secrets@2026-03-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
attributes: {
enabled: bool
exp: int
nbf: int
}
contentType: 'string'
value: 'string'
}
tags: {
{customized property}: 'string'
}
}
Eigenschapswaarden
Microsoft.KeyVault/kluizen/geheimen
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De resourcenaam | Touwtje (verplicht) |
| ouder | In Bicep kun je de ouderresource voor een kindresource specificeren. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd. Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie. |
Symbolische naam voor resource van het type: kluizen |
| Eigenschappen | Eigenschappen van het geheim | SecretProperties (vereist) |
| Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen |
SecretAttributes
| Naam | Beschrijving | Waarde |
|---|---|---|
| Ingeschakeld | Bepaalt of het object is ingeschakeld. | Bool |
| Exp | Vervaldatum in seconden sinds 1970-01-01T00:00:00Z. | Int |
| NBF | Niet vóór datum in seconden sinds 1970-01-01T00:00:00Z. | Int |
SecretCreateOrUpdateParametersTags
| Naam | Beschrijving | Waarde |
|---|
SecretEigenschappen
| Naam | Beschrijving | Waarde |
|---|---|---|
| Kenmerken | De kenmerken van het geheim. | SecretAttributes- |
| inhoudstype | Het inhoudstype van het geheim. | snaar |
| waarde | De waarde van het geheim. OPMERKING: 'waarde' wordt nooit geretourneerd door de service, omdat API's die dit model gebruiken, bedoeld zijn voor intern gebruik in ARM-implementaties. Gebruikers moeten de rest-service van het gegevensvlak gebruiken voor interactie met kluisgeheimen. | snaar |
Resourcedefinitie van ARM-sjabloon
Het resourcetype kluizen/geheimen kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie resource group deployment-commando's Voor een lijst van gewijzigde eigenschappen in elke API-versie, zie wijzigingslogboek.
Gebruiksvoorbeelden
Snelstartsjablonen voor Azure
De volgende Azure Quickstart-sjablonen deployen dit resourcetype.
| Sjabloon | Beschrijving |
|---|---|
|
Application Gateway met intern API-beheer en Web App |
Application Gateway leidt internetverkeer naar een virtueel netwerk (interne modus) API Management-instantie die een web-API bedient die wordt gehost in een Azure Web App. |
|
Azure Functie-app en een HTTP-getriggerde functie |
Dit voorbeeld deployeert een Azure Function-app en een HTTP-getriggerde functie inline in het sjabloon. Het implementeert ook een Key Vault en vult een geheim in met de hostsleutel van de functie-app. |
|
Verbind met een Key Vault via privé-endpoint |
Dit voorbeeld laat zien hoe je een virtueel netwerk en een privé DNS-zone kunt configureren om via een privé-endpoint toegang te krijgen tot Key Vault. |
|
Maak een Key Vault en een lijst met geheimen |
Dit sjabloon maakt een Key Vault aan en een lijst van geheimen binnen de key vault zoals doorgegeven, samen met de parameters |
|
Maak een API-beheerdienst aan met SSL vanuit KeyVault |
Met deze sjabloon wordt een API Management-service geïmplementeerd die is geconfigureerd met door de gebruiker toegewezen identiteit. Deze identiteit gebruikt om een SSL-certificaat op te halen uit KeyVault en wordt bijgewerkt door elke 4 uur te controleren. |
|
Maak een Application Gateway V2 aan met Key Vault |
Deze template deployt een Application Gateway V2 in een Virtual Network, een door de gebruiker gedefinieerde identiteit, Key Vault, een secret (certificaatgegevens) en toegangsbeleid op Key Vault en Application Gateway. |
| Dit sjabloon maakt een Azure Key Vault en een secret aan. | |
|
Maak een Azure Key Vault met RBAC en een secret |
Dit sjabloon maakt een Azure Key Vault en een secret aan. In plaats van te vertrouwen op toegangsbeleid, maakt het gebruik van Azure RBAC om autorisatie van geheimen te beheren |
|
Maak Azure Maps SAS-token opgeslagen in een Azure Key Vault |
Deze template deployt een Azure Maps-account en vermeldt een SAS-token gebaseerd op de opgegeven User Assigned identiteit, die wordt opgeslagen in een Azure Key Vault-geheim. |
|
Maak ssh-keys aan en sla op in KeyVault |
Deze sjabloon maakt gebruik van de deploymentScript-resource voor het genereren van ssh-sleutels en het opslaan van de persoonlijke sleutel in KeyVault. |
|
FinOps-hub |
Deze template maakt een nieuwe FinOps-hub-instantie aan, inclusief Data Explorer, Data Lake-opslag en Data Factory. |
|
Testomgeving voor Azure Firewall Premium |
Deze template maakt een Azure Firewall Premium en Firewall Policy aan met premiumfuncties zoals Intrusion Inspection Detection (IDPS), TLS-inspectie en Web Category Filtering |
Resource-indeling
Als u een Resource microsoft.KeyVault/vaults/secrets wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.KeyVault/vaults/secrets",
"apiVersion": "2026-03-01-preview",
"name": "string",
"properties": {
"attributes": {
"enabled": "bool",
"exp": "int",
"nbf": "int"
},
"contentType": "string",
"value": "string"
},
"tags": {
"{customized property}": "string"
}
}
Eigenschapswaarden
Microsoft.KeyVault/kluizen/geheimen
| Naam | Beschrijving | Waarde |
|---|---|---|
| apiVersion | De API-versie | '2026-03-01-preview' |
| naam | De resourcenaam | Touwtje (verplicht) |
| Eigenschappen | Eigenschappen van het geheim | SecretProperties (vereist) |
| Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen |
| soort | Het resourcetype | 'Microsoft.KeyVault/kluizen/geheimen' |
SecretAttributes
| Naam | Beschrijving | Waarde |
|---|---|---|
| Ingeschakeld | Bepaalt of het object is ingeschakeld. | Bool |
| Exp | Vervaldatum in seconden sinds 1970-01-01T00:00:00Z. | Int |
| NBF | Niet vóór datum in seconden sinds 1970-01-01T00:00:00Z. | Int |
SecretCreateOrUpdateParametersTags
| Naam | Beschrijving | Waarde |
|---|
SecretEigenschappen
| Naam | Beschrijving | Waarde |
|---|---|---|
| Kenmerken | De kenmerken van het geheim. | SecretAttributes- |
| inhoudstype | Het inhoudstype van het geheim. | snaar |
| waarde | De waarde van het geheim. OPMERKING: 'waarde' wordt nooit geretourneerd door de service, omdat API's die dit model gebruiken, bedoeld zijn voor intern gebruik in ARM-implementaties. Gebruikers moeten de rest-service van het gegevensvlak gebruiken voor interactie met kluisgeheimen. | snaar |
Resourcedefinitie van Terraform (AzAPI-provider)
Het resourcetype kluizen/geheimen kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen Voor een lijst van gewijzigde eigenschappen in elke API-versie, zie wijzigingslogboek.
Gebruiksvoorbeelden
Terraform-monsters
Een basisvoorbeeld van het inzetten van Key Vault Secrets.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
azurerm = {
source = "hashicorp/azurerm"
}
}
}
provider "azurerm" {
features {
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
data "azurerm_client_config" "current" {
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "vault" {
type = "Microsoft.KeyVault/vaults@2023-02-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
sku = {
family = "A"
name = "standard"
}
accessPolicies = []
enableSoftDelete = true
tenantId = data.azurerm_client_config.current.tenant_id
}
}
schema_validation_enabled = false
response_export_values = ["*"]
lifecycle {
ignore_changes = [body.properties.accessPolicies]
}
}
data "azapi_resource_id" "secret" {
type = "Microsoft.KeyVault/vaults/secrets@2023-02-01"
parent_id = azapi_resource.vault.id
name = var.resource_name
}
resource "azapi_resource_action" "put_secret" {
type = "Microsoft.KeyVault/vaults/secrets@2023-02-01"
resource_id = data.azapi_resource_id.secret.id
method = "PUT"
body = {
properties = {
value = "szechuan"
}
}
response_export_values = ["*"]
}
Resource-indeling
Als u een Resource microsoft.KeyVault/kluizen/geheimen wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.KeyVault/vaults/secrets@2026-03-01-preview"
name = "string"
parent_id = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
attributes = {
enabled = bool
exp = int
nbf = int
}
contentType = "string"
value = "string"
}
}
}
Eigenschapswaarden
Microsoft.KeyVault/kluizen/geheimen
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De resourcenaam | Touwtje (verplicht) |
| parent_id | De id van de resource die het bovenliggende item voor deze resource is. | Id voor resource van het type: kluizen |
| Eigenschappen | Eigenschappen van het geheim | SecretProperties (vereist) |
| Tags | Resourcetags | Woordenlijst met tagnamen en -waarden. |
| soort | Het resourcetype | "Microsoft.KeyVault/vaults/secrets@2026-03-01-preview" |
SecretAttributes
| Naam | Beschrijving | Waarde |
|---|---|---|
| Ingeschakeld | Bepaalt of het object is ingeschakeld. | Bool |
| Exp | Vervaldatum in seconden sinds 1970-01-01T00:00:00Z. | Int |
| NBF | Niet vóór datum in seconden sinds 1970-01-01T00:00:00Z. | Int |
SecretCreateOrUpdateParametersTags
| Naam | Beschrijving | Waarde |
|---|
SecretEigenschappen
| Naam | Beschrijving | Waarde |
|---|---|---|
| Kenmerken | De kenmerken van het geheim. | SecretAttributes- |
| inhoudstype | Het inhoudstype van het geheim. | snaar |
| waarde | De waarde van het geheim. OPMERKING: 'waarde' wordt nooit geretourneerd door de service, omdat API's die dit model gebruiken, bedoeld zijn voor intern gebruik in ARM-implementaties. Gebruikers moeten de rest-service van het gegevensvlak gebruiken voor interactie met kluisgeheimen. | snaar |