Microsoft.KeyVault Vaults/secrets 2016-10-01
Bemerkungen
Anleitungen zur Verwendung von Schlüsseltresorn für sichere Werte finden Sie unter Verwalten von geheimen Schlüsseln mithilfe von Bicep.
Eine Schnellstartanleitung zum Erstellen eines geheimen Schlüssels finden Sie unter Schnellstart: Festlegen und Abrufen eines geheimen Schlüssels 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 der ARM-Vorlage.
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 ihrer Vorlage die folgende Bicep hinzu.
resource symbolicname 'Microsoft.KeyVault/vaults/secrets@2016-10-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
attributes: {
enabled: bool
exp: int
nbf: int
}
contentType: 'string'
value: 'string'
}
tags: {
{customized property}: 'string'
}
}
Eigenschaftswerte
Microsoft.KeyVault/vaults/secrets
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | Schnur Zwänge: Pattern = ^[a-zA-Z0-9-]{1,127}$ (erforderlich) |
| Elternteil | 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 des Typs: Tresore |
| Eigenschaften | Eigenschaften des geheimen Schlüssels | SecretProperties- (erforderlich) |
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
SecretAttributes
| 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 |
|---|
SecretProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Attribute | Die Attribute des geheimen Schlüssels. | SecretAttributes- |
| contentType | 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 |
Schnellstartbeispiele
Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.
| Bicep-Datei | Beschreibung |
|---|---|
| Anwendungsgateway mit interner API-Verwaltung und Web App- | Das Anwendungsgateway routingt Internetdatenverkehr an eine API-Verwaltungsinstanz für virtuelle Netzwerke (interner Modus), die eine in einer Azure Web App gehostete Web-API verwendet. |
| Azure Function-App und eine http-ausgelöste Funktion | In diesem Beispiel wird eine Azure Function-App und eine HTTP-ausgelöste Funktion inline in der Vorlage bereitgestellt. Außerdem wird ein Schlüsseltresor bereitgestellt und ein Geheimschlüssel mit dem Hostschlüssel der Funktions-App aufgefüllt. |
| Erstellen eines Schlüsseltresors und einer Liste mit geheimen Schlüsseln | Diese Vorlage erstellt einen Schlüsseltresor und eine Liste der geheimen Schlüssel im Schlüsseltresor, die zusammen mit den Parametern übergeben werden. |
| Erstellen eines API-Verwaltungsdiensts 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 eines Azure Key Vault und eines geheimen | Diese Vorlage erstellt einen Azure Key Vault und einen geheimen Schlüssel. |
| Erstellen eines Azure Key Vault mit RBAC und einem geheimen | Diese Vorlage erstellt einen Azure Key Vault und einen geheimen Schlüssel. Anstatt sich auf Zugriffsrichtlinien zu verlassen, nutzt sie Azure RBAC zum Verwalten der Autorisierung für geheime Schlüssel |
| FinOps Hub- | Diese Vorlage erstellt eine neue FinOps-Hubinstanz, einschließlich Data Lake-Speicher und einer Data Factory. |
| Testumgebung für Azure Firewall Premium | Diese Vorlage erstellt eine Azure Firewall Premium- und Firewallrichtlinie mit Premium-Features wie Intrusion Inspection Detection (IDPS), TLS-Inspektion und Webkategoriefilterung |
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": "2016-10-01",
"name": "string",
"properties": {
"attributes": {
"enabled": "bool",
"exp": "int",
"nbf": "int"
},
"contentType": "string",
"value": "string"
},
"tags": {
"{customized property}": "string"
}
}
Eigenschaftswerte
Microsoft.KeyVault/vaults/secrets
| Name | Beschreibung | Wert |
|---|---|---|
| apiVersion | Die API-Version | '2016-10-01' |
| Name | Der Ressourcenname | Schnur Zwänge: Pattern = ^[a-zA-Z0-9-]{1,127}$ (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" |
SecretAttributes
| 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 |
|---|
SecretProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Attribute | Die Attribute des geheimen Schlüssels. | SecretAttributes- |
| contentType | 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 |
Schnellstartvorlagen
Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.
| Schablone | Beschreibung |
|---|---|
Anwendungsgateway mit interner API-Verwaltung und Web App-
|
Das Anwendungsgateway routingt Internetdatenverkehr an eine API-Verwaltungsinstanz für virtuelle Netzwerke (interner Modus), die eine in einer Azure Web App gehostete Web-API verwendet. |
|
Azure Function-App und eine http-ausgelöste Funktion
|
In diesem Beispiel wird eine Azure Function-App und eine HTTP-ausgelöste Funktion inline in der Vorlage bereitgestellt. Außerdem wird ein Schlüsseltresor bereitgestellt und ein Geheimschlüssel mit dem Hostschlüssel der Funktions-App aufgefüllt. |
|
Herstellen einer Verbindung mit einem Key Vault über private Endpunkte
|
In diesem Beispiel wird gezeigt, wie Sie ein virtuelles Netzwerk und eine private DNS-Zone für den Zugriff auf Key Vault über einen privaten Endpunkt verwenden. |
|
Erstellen eines Schlüsseltresors und einer Liste mit geheimen Schlüsseln
|
Diese Vorlage erstellt einen Schlüsseltresor und eine Liste der geheimen Schlüssel im Schlüsseltresor, die zusammen mit den Parametern übergeben werden. |
|
Erstellen eines API-Verwaltungsdiensts 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 eines Anwendungsgateways V2 mit Key Vault-
|
Diese Vorlage stellt ein Anwendungsgateway V2 in einem virtuellen Netzwerk, einer benutzerdefinierten Identität, einem Schlüsseltresor, einem geheimen Schlüssel (Zertifikatdaten) und einer Zugriffsrichtlinie für Key Vault und Anwendungsgateway bereit. |
|
Erstellen eines Azure Key Vault und eines geheimen
|
Diese Vorlage erstellt einen Azure Key Vault und einen geheimen Schlüssel. |
|
Erstellen eines Azure Key Vault mit RBAC und einem geheimen
|
Diese Vorlage erstellt einen Azure Key Vault und einen geheimen Schlüssel. Anstatt sich auf Zugriffsrichtlinien zu verlassen, nutzt sie Azure RBAC zum Verwalten der Autorisierung für geheime Schlüssel |
|
Erstellen eines Azure Maps SAS-Tokens, das in einem Azure Key Vault-
|
Diese Vorlage stellt das Azure Maps-Konto bereit und listet ein Sas-Token basierend auf der bereitgestellten vom Benutzer zugewiesenen Identität auf, die in einem Azure Key Vault-Geheimnis gespeichert werden soll. |
|
Erstellen von SSH-Schlüsseln und Speichern in KeyVault
|
Diese Vorlage verwendet die DeploymentScript-Ressource, um SSH-Schlüssel zu generieren und den privaten Schlüssel in keyVault zu speichern. |
|
erstellt einen Azure Stack HCI 23H2-Cluster-
|
Diese Vorlage erstellt einen Azure Stack HCI 23H2-Cluster mithilfe einer ARM-Vorlage mit benutzerdefinierter Speicher-IP |
|
erstellt einen Azure Stack HCI 23H2-Cluster-
|
Diese Vorlage erstellt einen Azure Stack HCI 23H2-Cluster mit einer ARM-Vorlage. |
|
erstellt einen Azure Stack HCI 23H2-Cluster im Switchless-Dual-Link-Netzwerkmodus
|
Diese Vorlage erstellt einen Azure Stack HCI 23H2-Cluster mit einer ARM-Vorlage. |
|
erstellt einen Azure Stack HCI 23H2-Cluster im Switchless-SingleLink Netzwerkmodus
|
Diese Vorlage erstellt einen Azure Stack HCI 23H2-Cluster mit einer ARM-Vorlage. |
|
FinOps Hub-
|
Diese Vorlage erstellt eine neue FinOps-Hubinstanz, einschließlich Data Lake-Speicher und einer Data Factory. |
|
Testumgebung für Azure Firewall Premium
|
Diese Vorlage erstellt eine Azure Firewall Premium- und Firewallrichtlinie mit Premium-Features wie Intrusion Inspection Detection (IDPS), TLS-Inspektion und Webkategoriefilterung |
|
aktualisiert einen Azure Stack HCI 22H2-Cluster auf 23H2-Cluster-
|
Diese Vorlage aktualisiert einen Azure Stack HCI 22H2-Cluster mithilfe einer ARM-Vorlage auf 23H2-Cluster. |
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@2016-10-01"
name = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
attributes = {
enabled = bool
exp = int
nbf = int
}
contentType = "string"
value = "string"
}
})
}
Eigenschaftswerte
Microsoft.KeyVault/vaults/secrets
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | Schnur Zwänge: Pattern = ^[a-zA-Z0-9-]{1,127}$ (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@2016-10-01" |
SecretAttributes
| 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 |
|---|
SecretProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Attribute | Die Attribute des geheimen Schlüssels. | SecretAttributes- |
| contentType | 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 |