Hinzufügen von Key Vault zu Ihrer Webanwendung mithilfe von Visual Studio Connected Services
In diesem Lernprogramm erfahren Sie, wie Sie alles hinzufügen können, was Sie benötigen, um mit der Verwendung von Azure Key Vault zu beginnen, um Ihre geheimen Schlüssel für Webprojekte in Visual Studio zu verwalten, unabhängig davon, ob Sie ASP.NET Core oder einen beliebigen Typ von ASP.NET Projekt verwenden. Mit dem Feature "Verbundene Dienste" in Visual Studio können Sie visual Studio alle NuGet-Pakete und Konfigurationseinstellungen automatisch hinzufügen, die Sie zum Herstellen einer Verbindung mit Key Vault in Azure benötigen.
Voraussetzungen
- Ein Azure-Konto. Wenn Sie nicht über ein Azure-Konto verfügen, aktivieren Sie Ihre Azure-Nutzen für Visual Studio-Abonnenten oder registrieren Sie sich für eine kostenlose Testversion.
- Visual Studio 2019, Version 16.3, oder höher Laden Sie es jetztherunter.
Hinzufügen von Key Vault-Unterstützung zu Ihrem Projekt
Bevor Sie beginnen, stellen Sie sicher, dass Sie bei Visual Studio angemeldet sind. Melden Sie sich mit demselben Konto an, das Sie für Ihr Azure-Abonnement verwenden. Öffnen Sie dann ein ASP.NET 4.7.1 oder höher oder ASP.NET Core-Webprojekt, und führen Sie die folgenden Schritte aus. Die gezeigten Schritte gelten für Visual Studio 2022, Version 17.4. Der Fluss kann sich für andere Versionen von Visual Studio geringfügig unterscheiden.
Klicken Sie im Projektmappen-Explorermit der rechten Maustaste auf das Projekt, dem Sie die Key Vault-Unterstützung hinzufügen möchten, und wählen Sie >verbundenen Dienst hinzufügenaus, oder klicken Sie mit der rechten Maustaste auf den Knoten Verbundene Dienste, und wählen Sie Hinzufügenaus.
Wenn der Knoten Verbundene Dienste nicht angezeigt wird, wählen Sie Projekt>Verbundene Dienste>Hinzufügen aus.
Wählen Sie unter Dienstabhängigkeitendas Symbol + aus. Die Seite "Verbundener Dienst" wird mit Diensten angezeigt, die Sie Ihrem Projekt hinzufügen können.
Wählen Sie im Menü der verfügbaren Dienste Azure Key Vault- aus, und klicken Sie auf Weiter.
Wählen Sie das Abonnement aus, das Sie verwenden möchten, und falls Sie bereits über einen Schlüsseltresor verfügen, den Sie verwenden möchten, wählen Sie diesen aus, und klicken Sie auf Weiter.
Wenn Sie nicht über einen vorhandenen Key Vault verfügen oder einen Schlüsseltresor benötigen, den Sie mit anderen Berechtigungen als einer vorhandenen festlegen können, klicken Sie auf Neuen Key Vault erstellen. Sie werden aufgefordert, die Ressourcengruppe, den Standort und die SKU bereitzustellen.
Im Bildschirm Konfigurieren von Key Vault können Sie den Namen der Umgebungsvariable ändern, die auf den Key Vault-URI verweist. Die Verbindungszeichenfolge wird hier nicht gespeichert; sie wird im Schlüsseltresor gespeichert.
Anmerkung
Um die Sicherheit zu verbessern, erstellt dieser Schritt in Visual Studio 17.12 und höher einen Verbindungseinstellungsnamen. In früheren Versionen wird eine Verbindungszeichenfolge erstellt. Lokal gespeicherte Verbindungszeichenfolgen können zu einem Sicherheitsrisiko führen, wenn sie versehentlich verfügbar gemacht werden.
Klicken Sie auf Weiter, bis eine Zusammenfassung der Änderungen angezeigt wird, und dann auf Fertig stellen.
Bevor Sie beginnen, stellen Sie sicher, dass Sie bei Visual Studio angemeldet sind. Melden Sie sich mit demselben Konto an, das Sie für Ihr Azure-Abonnement verwenden. Öffnen Sie dann ein ASP.NET 4.7.1 oder höher oder ASP.NET Core-Webprojekt, und führen Sie die folgenden Schritte aus.
Klicken Sie im Projektmappen-Explorermit der rechten Maustaste auf das Projekt, dem Sie die Key Vault-Unterstützung hinzufügen möchten, und wählen Sie >verbundenen Dienst hinzufügenaus, oder klicken Sie mit der rechten Maustaste auf den Knoten Verbundene Dienste, und wählen Sie Hinzufügenaus.
Wenn der Knoten Verbundene Dienste nicht angezeigt wird, wählen Sie Projekt>Verbundene Dienste>Hinzufügen aus.
Wählen Sie unter Dienstabhängigkeitendas Symbol + aus. Die Seite "Verbundener Dienst" wird mit Diensten angezeigt, die Sie Ihrem Projekt hinzufügen können.
Wählen Sie im Menü der verfügbaren Dienste Azure Key Vault- aus, und klicken Sie auf Weiter.
Wählen Sie das Abonnement aus, das Sie verwenden möchten. Wenn Sie bereits über einen Key Vault verfügen, den Sie verwenden möchten, wählen Sie diesen aus und klicken Sie auf Weiter.
Wenn Sie nicht über einen vorhandenen Key Vault verfügen, klicken Sie auf Neuen Key Vault erstellen. Sie werden aufgefordert, die Ressourcengruppe, den Standort und die SKU bereitzustellen.
Im Bildschirm Konfigurieren von Key Vault können Sie den Namen der Umgebungsvariable ändern, die auf den Key Vault-URI verweist. Die Verbindungszeichenfolge wird hier nicht gespeichert; sie wird im Key Vault gespeichert.
Klicken Sie auf Weiter, um eine Zusammenfassung der Änderungen zu überprüfen, und dann auf Fertig stellen.
Jetzt wird eine Verbindung mit Key Vault hergestellt, und Sie können im Code auf Ihre geheimen Schlüssel zugreifen. Wenn Sie gerade einen neuen Schlüsseltresor erstellt haben, testen Sie ihn, indem Sie einen geheimen Schlüssel erstellen, auf den Sie im Code verweisen können. Sie können einen geheimen Schlüssel mithilfe des Azure-Portals, PowerShell-oder der Azure CLI-erstellen.
Siehe Codebeispiele für die Arbeit mit Geheimnissen in Azure Key Vault Secrets-Clientbibliothek für .NET – Codebeispiele.
Konfigurieren des Zugriffs auf den Key Vault
Wenn Sie dieses Lernprogramm mit Visual Studio 2022, Version 17.11 oder einer früheren Version, befolgt haben, sind Ihre Key Vault-Berechtigungen für die Ausführung mit Ihrem eigenen Azure-Abonnement eingerichtet, dies ist jedoch für ein Produktionsszenario möglicherweise nicht wünschenswert. Sie können eine verwaltete Identität erstellen, um den Key Vault-Zugriff für Ihre App zu verwalten. Weitere Informationen finden Sie unter Authentifizierung beim Schlüsseltresor und Zuweisen einer Schlüsseltresor-Zugriffsrichtlinie.
Wenn Ihr Schlüsseltresor auf einem anderen Microsoft-Konto als dem konto ausgeführt wird, das Sie bei Visual Studio angemeldet sind (z. B. wird der Schlüsseltresor auf Ihrem Geschäftskonto ausgeführt, visual Studio verwendet jedoch Ihr privates Konto), erhalten Sie eine Fehlermeldung in Ihrer Program.cs Datei, dass Visual Studio keinen Zugriff auf den Schlüsseltresor erhalten kann. Um dieses Problem zu beheben, wechseln Sie zum Azure-Portal, öffnen Sie Ihren Schlüsseltresor, und wählen Sie Zugriffssteuerung (IAM) aus, um Berechtigungen festzulegen. Weitere Informationen finden Sie unter Bereitstellen des Zugriffs auf Schlüsseltresorschlüssel, Zertifikate und Geheimnisse mithilfe der rollenbasierten Zugriffssteuerung in Azure.
Anmerkung
Ältere Schlüsseltresore verwenden möglicherweise ein veraltetes Zugriffsrichtlinienmodell. Es wird empfohlen, ältere Schlüsseltresore zu migrieren, um Azure RBAC zu nutzen. Siehe Azure role-based access control (rollenbasierte Zugriffssteuerung, RBAC) im Vergleich mit Zugriffsrichtlinien.
Nächste Schritte
Erfahren Sie mehr über die Key Vault-Entwicklung, indem Sie das Key Vault-Entwicklerhandbuchlesen.
Wenn Sie die Konfiguration für eine ASP.NET Core-App in einem Azure Key Vault speichern möchten, lesen Sie Azure Key Vault-Konfigurationsanbieter in ASP.NET Core.