Freigeben über

Verwenden des Inhaltstyps zum Speichern von JSON-Schlüssel-Wert-Paaren in App Configuration

  • Artikel

Daten werden in App Configuration als Schlüssel-Wert-Paare gespeichert. Dabei werden Werte standardmäßig als Zeichenfolgentyp behandelt. Sie können jedoch einen benutzerdefinierten Typ mithilfe der Inhaltstypeigenschaft angeben, die jedem Schlüsse-Wert-Paar zugeordnet ist. Dadurch wird der ursprüngliche Typ Ihrer Daten beibehalten oder das Verhalten Ihrer Anwendung basierend auf dem Inhaltstyp geändert.

Übersicht

In App Configuration kann der JSON-Medientyp als Inhaltstyp Ihrer Schlüssel-Wert-Paare verwendet werden, um von den folgenden Vorteilen zu profitieren:

  • Vereinfachte Datenverwaltung: Das Verwalten von Schlüssel-Wert-Paaren (z. B. Arrays) wird im Azure-Portal deutlich vereinfacht.
  • Erweiterter Datenexport: Primitive Typen, Arrays und JSON-Objekte werden während des Datenexports beibehalten.
  • Native Unterstützung beim App Configuration-Anbieter: Schlüssel-Wert-Paare mit JSON-Inhaltstyp können problemlos von App Configuration-Anbieterbibliotheken in Ihren Anwendungen genutzt werden.

Gültiger JSON-Inhaltstyp

Medientypen, wie die hier definierten, können dem Inhaltstyp zugewiesen werden, der den einzelnen Schlüssel-Wert-Paaren zugeordnet ist. Ein Medientyp umfasst einen Typ und einen Untertyp. Wenn der Typ application ist und der Untertyp (oder das Suffix) json, wird der Medientyp als gültiger JSON-Inhaltstyp betrachtet. Nachfolgend sind Beispiele für gültige JSON-Inhaltstypen aufgeführt:

  • application/json
  • application/activity+json
  • application/vnd.foobar+json;charset=utf-8

Gültige JSON-Werte

Wenn ein Schlüssel-Wert-Paar den JSON-Inhaltstyp aufweist, muss der Wert im gültigen JSON-Format vorliegen, damit Clients ihn ordnungsgemäß verarbeiten können. Anderenfalls tritt bei der Verarbeitung durch Clients möglicherweise ein Fehler auf, oder der Wert wird als Zeichenfolge behandelt. Nachfolgend sind Beispiele für gültige JSON-Werte aufgeführt:

  • "John Doe"
  • 723
  • false
  • null
  • "2020-01-01T12:34:56.789Z"
  • [1, 2, 3, 4]
  • {"ObjectSetting":{"Targeting":{"Default":true,"Level":"Information"}}}

Hinweis

In den nachfolgenden Abschnitten dieses Artikels werden Schlüssel-Wert-Paare in App Configuration, die einen gültigen JSON-Inhaltstyp und einen gültigen JSON-Wert aufweisen, als JSON-Schlüssel-Wert-Paar bezeichnet.

In diesem Tutorial lernen Sie Folgendes:

  • Erstellen von JSON-Schlüssel-Wert-Paaren in App Configuration.
  • Importieren von JSON-Schlüssel-Wert-Paaren aus einer JSON-Datei.
  • Exportieren von JSON-Schlüssel-Wert-Paaren in eine JSON-Datei.
  • Verwenden von JSON-Schlüssel-Wert-Paaren in Ihren Anwendungen.

Wenn Sie kein Azure-Abonnement haben, erstellen Sie ein kostenloses Azure-Konto, bevor Sie beginnen.

Voraussetzungen

  • Verwenden Sie die Bash-Umgebung in Azure Cloud Shell. Weitere Informationen finden Sie unter Schnellstart für Bash in Azure Cloud Shell.

  • Wenn Sie CLI-Referenzbefehle lieber lokal ausführen, installieren Sie die Azure CLI. Wenn Sie Windows oder macOS ausführen, sollten Sie die Azure CLI in einem Docker-Container ausführen. Weitere Informationen finden Sie unter Ausführen der Azure CLI in einem Docker-Container.

    • Wenn Sie eine lokale Installation verwenden, melden Sie sich mithilfe des Befehls az login bei der Azure CLI an. Führen Sie die in Ihrem Terminal angezeigten Schritte aus, um den Authentifizierungsprozess abzuschließen. Informationen zu anderen Anmeldeoptionen finden Sie unter Anmelden mit der Azure CLI.

    • Installieren Sie die Azure CLI-Erweiterung beim ersten Einsatz, wenn Sie dazu aufgefordert werden. Weitere Informationen zu Erweiterungen finden Sie unter Verwenden von Erweiterungen mit der Azure CLI.

    • Führen Sie az version aus, um die installierte Version und die abhängigen Bibliotheken zu ermitteln. Führen Sie az upgrade aus, um das Upgrade auf die aktuelle Version durchzuführen.

  • Ein App Configuration-Speicher. Erstellen Sie einen Speicher.
  • Für dieses Tutorial ist mindestens Version 2.10.0 der Azure CLI erforderlich. Bei Verwendung von Azure Cloud Shell ist die aktuelle Version bereits installiert.

Erstellen von JSON-Schlüssel-Wert-Paaren in App Configuration

JSON-Schlüssel-Wert-Paare können im Azure-Portal, über die Azure CLI oder durch den Import aus einer JSON-Datei erstellt werden. In diesem Abschnitt finden Sie eine Anleitung zum Erstellen eines JSON-Schlüssel-Wert-Paars mithilfe jeder dieser drei Methoden.

Erstellen von JSON-Schlüssel-Wert-Paaren über das Azure-Portal

Fügen Sie dem App Configuration-Speicher die folgenden Schlüsselwerte hinzu. Behalten Sie für Bezeichnung den Standardwert bei. Weitere Informationen zum Hinzufügen von Schlüsselwerten zu einem Speicher mithilfe des Azure-Portals oder der CLI finden Sie unter Erstellen eines Schlüsselwerts.

Schlüssel Wert Inhaltstyp
Settings:BackgroundColor „Green“ Anwendung/json
Settings:FontSize 24 Anwendung/json
Settings:UseDefaultRouting false Anwendung/json
Settings:BlockedUsers null Anwendung/json
Settings:ReleaseDate "2020-08-04T12:34:56.789Z" Anwendung/json
Settings:RolloutPercentage [25,50,75,100] Anwendung/json
Settings:Logging {"Test":{"Level":"Debug"},"Prod":{"Level":"Warning"}} Anwendung/json
  1. Wählen Sie Übernehmen.

Erstellen von JSON-Schlüssel-Wert-Paaren über die Azure CLI

Mit den folgenden Befehlen werden JSON-Schlüssel-Wert-Paare in Ihrem App Configuration-Store erstellt. Ersetzen Sie <appconfig_name> durch den Namen Ihres App Configuration-Stores.

appConfigName=<appconfig_name>
az appconfig kv set -n $appConfigName --content-type application/json --key Settings:BackgroundColor --value \"Green\"
az appconfig kv set -n $appConfigName --content-type application/json --key Settings:FontSize --value 24
az appconfig kv set -n $appConfigName --content-type application/json --key Settings:UseDefaultRouting --value false
az appconfig kv set -n $appConfigName --content-type application/json --key Settings:BlockedUsers --value null
az appconfig kv set -n $appConfigName --content-type application/json --key Settings:ReleaseDate --value \"2020-08-04T12:34:56.789Z\"
az appconfig kv set -n $appConfigName --content-type application/json --key Settings:RolloutPercentage --value [25,50,75,100]
az appconfig kv set -n $appConfigName --content-type application/json --key Settings:Logging --value {\"Test\":{\"Level\":\"Debug\"},\"Prod\":{\"Level\":\"Warning\"}}

Wichtig

Wenn Sie die Azure CLI oder Azure Cloud Shell zum Erstellen von JSON-Schlüssel-Wert-Paaren verwenden, muss der angegebene Wert eine JSON-Zeichenfolge mit Escapezeichen sein.

Importieren von JSON-Schlüssel-Wert-Paaren aus einer Datei

Erstellen Sie eine JSON-Datei namens Import.json mit folgendem Inhalt, und importieren Sie sie als Schlüssel-Wert-Paare in App Configuration:

{
  "Settings": {
    "BackgroundColor": "Green",
    "BlockedUsers": null,
    "FontSize": 24,
    "Logging": {"Test":{"Level":"Debug"},"Prod":{"Level":"Warning"}},
    "ReleaseDate": "2020-08-04T12:34:56.789Z",
    "RolloutPercentage": [25,50,75,100],
    "UseDefaultRouting": false
  }
}

az appconfig kv import -s file --format json --path "~/Import.json" --content-type "application/json" --separator : --depth 2

Hinweis

Das Argument --depth wird zum Vereinfachen hierarchischer Daten aus einer Datei in Schlüssel-Werte verwendet. In diesem Tutorial wird „depth“ angegeben, um zu veranschaulichen, dass sich JSON-Objekte auch als Werte in App Configuration speichern lassen. Wenn „depth“ nicht angegeben wird, werden JSON-Objekte standardmäßig auf die niedrigste Ebene vereinfacht.

Die JSON-Schlüssel-Wert-Paare, die Sie erstellt haben, sollten in App Configuration wie folgt dargestellt werden:

Screenshot that shows the Config store containing JSON key-values.

Um dies zu überprüfen, öffnen Sie Ihre App-Konfigurationsressource im Azure-Portal, und wechseln Sie zum Konfigurations-Explorer.

Exportieren von JSON-Schlüssel-Wert-Paaren in eine JSON-Datei

Einer der größten Vorteile bei der Verwendung von JSON-Schlüssel-Wert-Paaren ist die Möglichkeit, den ursprünglichen Datentyp Ihrer Werte beim Export beizubehalten. Wenn ein Schlüssel-Wert-Paar in App Configuration nicht den JSON-Inhaltstyp aufweist, wird der Wert als Zeichenfolge behandelt.

Nachfolgend sind Schlüssel-Wert-Paare ohne JSON-Inhaltstyp aufgeführt:

Key Wert Inhaltstyp
Settings:FontSize 24
Settings:UseDefaultRouting false

Beim Export dieser Schlüssel-Wert-Paare in eine JSON-Datei werden die Werte als Zeichenfolge exportiert:

{
  "Settings": {
    "FontSize": "24",
    "UseDefaultRouting": "false"
  }
}

Wenn Sie JSON-Schlüssel-Wert-Paare jedoch in eine Datei exportieren, wird für alle Werte der ursprüngliche Datentyp beibehalten. Um dies zu überprüfen, exportieren Sie Schlüssel-Wert-Paare aus App Configuration in eine JSON-Datei. Sie werden feststellen, dass die exportierte Datei dieselben Inhalte aufweist wie die Import.json-Datei, die Sie zuvor importiert haben.

az appconfig kv export -d file --format json --path "~/Export.json" --separator :

Hinweis

Wenn Ihr App Configuration-Speicher Schlüssel-Wert-Paare ohne JSON-Inhaltstyp aufweist, werden diese ebenfalls im Zeichenfolgenformat in dieselbe Datei exportiert.

Verwenden von JSON-Schlüssel-Wert-Paaren in Anwendungen

Die einfachste Möglichkeit zum Verwenden von JSON-Schlüssel-Wert-Paaren in Ihrer Anwendung ist der Einsatz von App Configuration-Anbieterbibliotheken. Bei Verwendung von Anbieterbibliotheken muss keine spezielle Behandlung von JSON-Schlüssel-Wert-Paaren in Ihrer Anwendung implementiert werden. Sie werden analysiert und konvertiert, damit sie der nativen Konfiguration Ihrer Anwendung entsprechen.

Wenn Sie z. B. den folgenden Schlüsselwert in der App-Konfiguration haben:

Schlüssel Wert Inhaltstyp
Einstellungen {"FontSize":24,"UseDefaultRouting":false} Anwendung/json

Ihre .NET-Anwendungskonfiguration weist die folgenden Schlüsselwerte auf:

Schlüssel Wert
Settings:FontSize 24
Settings:UseDefaultRouting false

Sie können direkt auf die neuen Schlüssel zugreifen, oder Sie können das Binden von Konfigurationswerten an Instanzen von .NET-Objekten auswählen.

Wichtig

Native Unterstützung für JSON-Schlüssel-Wert-Paare ist in der .NET-Konfigurationsanbieterversion 4.0.0 oder höher verfügbar. Weitere Informationen finden Sie im Abschnitt Nächste Schritte.

Wenn Sie das SDK oder die REST-API zum Lesen von Schlüssel-Wert-Paaren aus App Configuration verwenden, muss Ihre Anwendung (basierend auf dem Inhaltstyp) die Analyse des Werts eines JSON-Schlüssel-Wert-Paars durchführen.

Bereinigen von Ressourcen

Wenn Sie die in diesem Artikel erstellten Ressourcen nicht mehr verwenden möchten, löschen Sie die erstellte Ressourcengruppe, um Kosten zu vermeiden.

Wichtig

Das Löschen einer Ressourcengruppe kann nicht rückgängig gemacht werden. Die Ressourcengruppe und alle darin enthaltenen Ressourcen werden unwiderruflich gelöscht. Achten Sie daher darauf, dass Sie nicht versehentlich die falsche Ressourcengruppe oder die falschen Ressourcen löschen. Falls Sie die Ressourcen für diesen Artikel in einer Ressourcengruppe erstellt haben, die andere beizubehaltende Ressourcen enthält, löschen Sie die Ressourcen einzeln über den entsprechenden Bereich, statt die Ressourcengruppe zu löschen.

  1. Melden Sie sich beim Azure-Portal an, und klicken Sie auf Ressourcengruppen.
  2. Geben Sie im Feld Nach Name filtern den Namen Ihrer Ressourcengruppe ein.
  3. Wählen Sie in der Ergebnisliste den Ressourcengruppennamen aus, um eine Übersicht anzuzeigen.
  4. Wählen Sie die Option Ressourcengruppe löschen.
  5. Sie werden aufgefordert, das Löschen der Ressourcengruppe zu bestätigen. Geben Sie zur Bestätigung den Namen Ihrer Ressourcengruppe ein, und klicken Sie auf Löschen.

Daraufhin werden die Ressourcengruppe und alle darin enthaltenen Ressourcen gelöscht.

Nächste Schritte

Nachdem Sie erfahren haben, wie Sie mit JSON-Schlüssel-Wert-Paaren in Ihrem App Configuration-Store arbeiten, erstellen Sie nun eine Anwendung zum Verwenden dieser Schlüssel-Wert-Paare:

Schnellstartanleitung zu ASP.NET Core

Schnellstartanleitung zu .NET Core