Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
- neueste
- 2026-03-01-Vorschau
- 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
Bemerkungen
Für Hinweise zur Verwendung von Schlüsseltresoren für sichere Werte siehe Verwalten Sie Geheimnisse mit Bicep.
Für einen Quickstart zur Erstellung eines Geheimnisses siehe Quickstart: Set and retrieve a secret from Azure Key Vault using a ARM template.
Für einen Quickstart zur Erstellung eines Schlüssels siehe Quickstart: Create an Azure Key Vault and a Key mit ARM template.
Bicep-Ressourcendefinition
Der Ressourcentyp Vaults/Secrets kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.KeyVault/vaults/secrets-Ressource zu erstellen, fügen Sie den folgenden Bicep Ihrer Vorlage hinzu.
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'
}
}
Eigenschaftswerte
Microsoft.KeyVault/Tresore/Geheimnisse
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| Elternteil | In Bicep kann man die Elternressource für eine Kindressource 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 des Typs: Tresore |
| Eigenschaften | Eigenschaften des geheimen Schlüssels | SecretProperties- (erforderlich) |
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
Geheime Attribute
| Name | Beschreibung | Wert |
|---|---|---|
| ermöglichte | Bestimmt, ob das Objekt aktiviert ist. | Bool |
| Exp | Ablaufdatum in Sekunden seit 1970-01-01T00:00:00Z. | Int |
| nbf | Nicht vor dem Datum in Sekunden seit 1970-01-01T00:00:00Z. | Int |
SecretCreateOrUpdateParametersTags
| Name | Beschreibung | Wert |
|---|
Geheime Eigenschaften
| Name | Beschreibung | Wert |
|---|---|---|
| Attribute | Die Attribute des geheimen Schlüssels. | SecretAttributes- |
| Inhaltstyp | Der Inhaltstyp des geheimen Schlüssels. | Schnur |
| Wert | Der Wert des geheimen Schlüssels. HINWEIS: "value" wird nie vom Dienst zurückgegeben, da APIs, die dieses Modell verwenden, für die interne Verwendung in ARM-Bereitstellungen vorgesehen sind. Benutzer sollten den REST-Dienst der Datenebene für die Interaktion mit geheimen Tresorschlüsseln verwenden. | Schnur |
Verwendungsbeispiele
Bicep-Proben
Ein grundlegendes Beispiel für die Bereitstellung von Key Vault Secrets.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource vault 'Microsoft.KeyVault/vaults@2023-02-01' = {
name: resourceName
location: location
properties: {
accessPolicies: []
enableSoftDelete: true
sku: {
family: 'A'
name: 'standard'
}
tenantId: deployer().tenantId
}
}
resource putSecret 'Microsoft.KeyVault/vaults/secrets@2023-02-01' = {
parent: vault
name: resourceName
properties: {
value: 'szechuan'
}
}
Azure Verified Modules
Die folgenden Azure Verifizierte Module können verwendet werden, um diesen Ressourcentyp bereitzustellen.
| Modul | Beschreibung |
|---|---|
| Key Vault - Geheimnis | AVM Child Module für Key Vault – Geheim |
Azure Quickstart Samples
Die folgenden Azure Quickstart-Vorlagen enthalten Bicep Beispiele für die Bereitstellung dieses Ressourcentyps.
| Bicep-Datei | Beschreibung |
|---|---|
| Application Gateway mit internem API-Management und Web App | Application Gateway leitet den Internetverkehr an eine virtuelle Netzwerk-API-Management-Instanz (im internen Modus), die eine Web-API in einer Azure-Webanwendung bedient. |
| Azure Funktions-App und eine HTTP-ausgelöste Funktion | Dieses Beispiel stellt eine Azure Function-App und eine HTTP-ausgelöste Funktion direkt in der Vorlage bereit. Es installiert außerdem einen Key Vault und füllt ein Geheimnis mit dem Host-Schlüssel der Funktions-App. |
| Erstellen Sie einen Key Vault und eine Liste von Geheimnissen | Diese Vorlage erstellt einen Key Vault und eine Liste der Geheimnisse innerhalb des key vault, wie sie zusammen mit den Parametern weitergegeben wurden. |
| Erstellen Sie einen API-Management-Dienst mit SSL von KeyVault | Diese Vorlage stellt einen API-Verwaltungsdienst bereit, der mit der vom Benutzer zugewiesenen Identität konfiguriert ist. Sie verwendet diese Identität, um SSL-Zertifikat von KeyVault abzurufen und es alle 4 Stunden zu aktualisieren. |
| Erstelle ein Azure Key Vault und ein Geheimnis | Diese Vorlage erstellt einen Azure Key Vault und ein Geheimnis. |
| Erstellen Sie ein Azure Key Vault mit RBAC und einem Secret | Diese Vorlage erstellt einen Azure Key Vault und ein Geheimnis. Anstatt sich auf Zugriffsrichtlinien zu verlassen, nutzt es Azure RBAC, um die Autorisierung von Geheimnissen zu verwalten |
| FinOps hub | Diese Vorlage erstellt eine neue FinOps-Hub-Instanz, einschließlich Data Explorer, Data Lake-Speicher und Data Factory. |
| Testumgebung für Azure Firewall Premium | Diese Vorlage erstellt eine Azure Firewall Premium- und Firewall-Richtlinie mit Premium-Funktionen wie Intrusion Inspection Detection (IDPS), TLS-Inspektion und Web-Kategorie-Filterung |
ARM-Vorlagenressourcendefinition
Der Ressourcentyp Vaults/Secrets kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.KeyVault/vaults/secrets-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden JSON-Code hinzu.
{
"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"
}
}
Eigenschaftswerte
Microsoft.KeyVault/Tresore/Geheimnisse
| Name | Beschreibung | Wert |
|---|---|---|
| apiVersion (Englisch) | Die API-Version | '2026-03-01-Vorschau' |
| Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| Eigenschaften | Eigenschaften des geheimen Schlüssels | SecretProperties- (erforderlich) |
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
| Art | Der Ressourcentyp | "Microsoft.KeyVault/vaults/secrets" |
Geheime Attribute
| Name | Beschreibung | Wert |
|---|---|---|
| ermöglichte | Bestimmt, ob das Objekt aktiviert ist. | Bool |
| Exp | Ablaufdatum in Sekunden seit 1970-01-01T00:00:00Z. | Int |
| nbf | Nicht vor dem Datum in Sekunden seit 1970-01-01T00:00:00Z. | Int |
SecretCreateOrUpdateParametersTags
| Name | Beschreibung | Wert |
|---|
Geheime Eigenschaften
| Name | Beschreibung | Wert |
|---|---|---|
| Attribute | Die Attribute des geheimen Schlüssels. | SecretAttributes- |
| Inhaltstyp | Der Inhaltstyp des geheimen Schlüssels. | Schnur |
| Wert | Der Wert des geheimen Schlüssels. HINWEIS: "value" wird nie vom Dienst zurückgegeben, da APIs, die dieses Modell verwenden, für die interne Verwendung in ARM-Bereitstellungen vorgesehen sind. Benutzer sollten den REST-Dienst der Datenebene für die Interaktion mit geheimen Tresorschlüsseln verwenden. | Schnur |
Verwendungsbeispiele
Azure Quickstart Templates
Die folgenden Azure Quickstart-Vorlagen bereitstellen diesen Ressourcentyp aus.
| Schablone | Beschreibung |
|---|---|
|
Application Gateway mit internem API-Management und Web App |
Application Gateway leitet den Internetverkehr an eine virtuelle Netzwerk-API-Management-Instanz (im internen Modus), die eine Web-API in einer Azure-Webanwendung bedient. |
|
Azure Funktions-App und eine HTTP-ausgelöste Funktion |
Dieses Beispiel stellt eine Azure Function-App und eine HTTP-ausgelöste Funktion direkt in der Vorlage bereit. Es installiert außerdem einen Key Vault und füllt ein Geheimnis mit dem Host-Schlüssel der Funktions-App. |
|
Verbinden Sie sich mit einem Key Vault über privaten Endpunkt |
Dieses Beispiel zeigt, wie man ein virtuelles Netzwerk und eine private DNS-Zone konfiguriert, um über einen privaten Endpunkt auf Key Vault zuzugreifen. |
|
Erstellen Sie einen Key Vault und eine Liste von Geheimnissen |
Diese Vorlage erstellt einen Key Vault und eine Liste der Geheimnisse innerhalb des key vault, wie sie zusammen mit den Parametern weitergegeben wurden. |
|
Erstellen Sie einen API-Management-Dienst mit SSL von KeyVault |
Diese Vorlage stellt einen API-Verwaltungsdienst bereit, der mit der vom Benutzer zugewiesenen Identität konfiguriert ist. Sie verwendet diese Identität, um SSL-Zertifikat von KeyVault abzurufen und es alle 4 Stunden zu aktualisieren. |
|
Erstellen Sie ein Anwendungsgateway V2 mit Key Vault |
Diese Vorlage stellt ein Application Gateway V2 in einem Virtual Network, eine benutzerdefinierte Identität, einen Key Vault, ein Secret (Zertifikatsdaten) und eine Zugriffsrichtlinie auf Key Vault und Application Gateway bereit. |
|
Erstelle ein Azure Key Vault und ein Geheimnis |
Diese Vorlage erstellt einen Azure Key Vault und ein Geheimnis. |
|
Erstellen Sie ein Azure Key Vault mit RBAC und einem Secret |
Diese Vorlage erstellt einen Azure Key Vault und ein Geheimnis. Anstatt sich auf Zugriffsrichtlinien zu verlassen, nutzt es Azure RBAC, um die Autorisierung von Geheimnissen zu verwalten |
| Diese Vorlage stellt ein Azure Maps-Konto bereit und listet ein SAS-Token basierend auf der angegebenen benutzerzugewiesenen Identität auf, die in einem Azure Key Vault-Geheimnis gespeichert werden soll. | |
|
Erstellen Sie ssh-Schlüssel und speichern Sie sie in KeyVault |
Diese Vorlage verwendet die DeploymentScript-Ressource, um SSH-Schlüssel zu generieren und den privaten Schlüssel in keyVault zu speichern. |
|
FinOps hub |
Diese Vorlage erstellt eine neue FinOps-Hub-Instanz, einschließlich Data Explorer, Data Lake-Speicher und Data Factory. |
|
Testumgebung für Azure Firewall Premium |
Diese Vorlage erstellt eine Azure Firewall Premium- und Firewall-Richtlinie mit Premium-Funktionen wie Intrusion Inspection Detection (IDPS), TLS-Inspektion und Web-Kategorie-Filterung |
Terraform -Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp Vaults/Secrets 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/Vaults/secrets-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
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"
}
}
}
Eigenschaftswerte
Microsoft.KeyVault/Tresore/Geheimnisse
| Name | Beschreibung | Wert |
|---|---|---|
| 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: Vaults |
| Eigenschaften | Eigenschaften des geheimen Schlüssels | SecretProperties- (erforderlich) |
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. |
| Art | Der Ressourcentyp | "Microsoft.KeyVault/vaults/secrets@2026-03-01-preview" |
Geheime Attribute
| Name | Beschreibung | Wert |
|---|---|---|
| ermöglichte | Bestimmt, ob das Objekt aktiviert ist. | Bool |
| Exp | Ablaufdatum in Sekunden seit 1970-01-01T00:00:00Z. | Int |
| nbf | Nicht vor dem Datum in Sekunden seit 1970-01-01T00:00:00Z. | Int |
SecretCreateOrUpdateParametersTags
| Name | Beschreibung | Wert |
|---|
Geheime Eigenschaften
| Name | Beschreibung | Wert |
|---|---|---|
| Attribute | Die Attribute des geheimen Schlüssels. | SecretAttributes- |
| Inhaltstyp | Der Inhaltstyp des geheimen Schlüssels. | Schnur |
| Wert | Der Wert des geheimen Schlüssels. HINWEIS: "value" wird nie vom Dienst zurückgegeben, da APIs, die dieses Modell verwenden, für die interne Verwendung in ARM-Bereitstellungen vorgesehen sind. Benutzer sollten den REST-Dienst der Datenebene für die Interaktion mit geheimen Tresorschlüsseln verwenden. | Schnur |
Verwendungsbeispiele
Terraform-Beispiele
Ein grundlegendes Beispiel für die Bereitstellung von 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 = ["*"]
}