Inhoudstype gebruiken om JSON-sleutelwaarden op te slaan in App Configuration

Gegevens worden in App Configuration opgeslagen als sleutelwaarden, waarbij waarden standaard worden behandeld als het tekenreekstype. U kunt echter een aangepast type opgeven met behulp van de inhoudstypeeigenschap die aan elke sleutelwaarde is gekoppeld. Dit proces behoudt het oorspronkelijke type van uw gegevens of zorgt ervoor dat uw toepassing zich anders gedraagt op basis van het inhoudstype.

Overzicht

In App Configuration kunt u het JSON-mediatype gebruiken als het inhoudstype van uw sleutelwaarden om gebruik te maken van de volgende voordelen:

• Eenvoudiger gegevensbeheer: het beheren van sleutelwaarden, zoals matrices, wordt veel eenvoudiger in Azure Portal.
• Verbeterde gegevensexport: Primitieve typen, matrices en JSON-objecten blijven behouden tijdens het exporteren van gegevens.
• Systeemeigen ondersteuning bij App Configuration-provider: sleutelwaarden met JSON-inhoudstype werken prima wanneer ze worden gebruikt door App Configuration-providerbibliotheken in uw toepassingen.

Geldig JSON-inhoudstype

Mediatypen, zoals hier gedefinieerd, kunnen worden toegewezen aan het inhoudstype dat aan elke sleutelwaarde is gekoppeld. Een mediatype bestaat uit een type en een subtype. Als het type is application en het subtype (of achtervoegsel), jsonwordt het mediatype beschouwd als een geldig JSON-inhoudstype. Enkele voorbeelden van geldige JSON-inhoudstypen zijn:

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

Geldige JSON-waarden

Wanneer een sleutelwaarde een JSON-inhoudstype heeft, moet de waarde ervan een geldige JSON-indeling hebben, zodat clients deze correct kunnen verwerken. Anders kunnen klanten mislukken of teruggrijpen en dit als tekenreeksformaat behandelen. Enkele voorbeelden van geldige JSON-waarden zijn:

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

Opmerking

Voor de rest van dit artikel wordt elke sleutelwaarde in App Configuration met een geldig JSON-inhoudstype en een geldige JSON-waarde aangeduid als JSON-sleutelwaarde.

In deze handleiding leer je hoe je:

• JSON-sleutelwaarden maken in App Configuration.
• JSON-sleutelwaarden importeren uit een JSON-bestand.
• JSON-sleutelwaarden exporteren naar een JSON-bestand.
• Gebruik JSON-sleutelwaarden in uw toepassingen.

Als u geen Azure-account hebt, maak dan een gratis account aan voordat u begint.

Vereiste voorwaarden

• Gebruik de Bash-omgeving in Azure Cloud Shell. Zie Aan de slag met Azure Cloud Shell voor meer informatie.

  

• Als je de voorkeur geeft aan het lokaal uitvoeren van CLI-referentiecommando's, installeer dan de Azure CLI. Als je op Windows of macOS werkt, overweeg dan om Azure CLI in een Docker-container te draaien. Voor meer informatie, zie Hoe u de Azure CLI in een Docker-container kunt uitvoeren.

  • Als u een lokale installatie gebruikt, meldt u zich aan bij Azure CLI met de opdracht az login. Om het authenticatieproces te voltooien, volgt u de stappen die op uw terminal worden weergegeven. Zie Verifiëren bij Azure met behulp van Azure CLI voor andere aanmeldingsopties.

  • Wanneer u daarom wordt gevraagd, installeer de Azure CLI-extensie bij het eerste gebruik. Zie Extensies gebruiken en beheren met de Azure CLIvoor meer informatie over extensies.

  • Voer az version uit om de geïnstalleerde versie en de afhankelijke bibliotheken te vinden. Voer az upgrade uit om naar de nieuwste versie te upgraden.

• Een App Configuration-winkel, zoals uiteengezet in de zelfstudie voor het maken van een winkel.
• Voor deze zelfstudie is versie 2.10.0 of hoger van de Azure CLI vereist. Als u Azure Cloud Shell gebruikt, is de nieuwste versie al geïnstalleerd.

JSON-sleutelwaarden maken in App Configuration

JSON-sleutelwaarden kunnen worden gemaakt met behulp van Azure Portal, Azure CLI of door een JSON-bestand te importeren. In deze sectie vindt u instructies voor het maken van dezelfde JSON-sleutelwaarden met behulp van alle drie de methoden.

JSON-sleutelwaarden maken met behulp van Azure Portal

Voeg de volgende sleutelwaarden toe aan de App Configuration-opslag. Laat Label met de standaardwaarde staan. Ga naar Een sleutelwaarde maken voor meer informatie over het toevoegen van sleutelwaarden aan een opslag met de Azure Portal of de CLI.

Sleutelcode	Waarde	Inhoudstype
Instellingen:BackgroundColor	"Groen"	application/json
Instellingen:Lettergrootte	24	application/json
Instellingen:UseDefaultRouting	onwaar	application/json
Instellingen:BlockedUsers	nul	application/json
Instellingen:ReleaseDate	"2020-08-04T12:34:56.789Z"	application/json
Instellingen:RolloutPercentage	[25,50,75,100]	application/json
Instellingen:Logboekregistratie	{"Test":{"Niveau":"Debuggen"},"Prod":{"Niveau":"Waarschuwing"}}	application/json

1. Selecteer de optie Toepassen.

JSON-sleutelwaarden maken met behulp van Azure CLI

Met de volgende opdrachten worden JSON-sleutelwaarden gemaakt in uw App Configuration-archief. Vervang <appconfig_name> door de naam van uw App Configuration-archief.

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\"}}

Belangrijk

Als u Azure CLI of Azure Cloud Shell gebruikt om JSON-sleutelwaarden te maken, moet de opgegeven waarde een escape-JSON-tekenreeks zijn.

JSON-sleutelwaarden importeren uit een bestand

Maak een JSON-bestand Import.json met de volgende inhoud en importeer het als sleutelwaarden 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

Opmerking

Het --depth argument wordt gebruikt voor het platmaken van hiërarchische gegevens uit een bestand in sleutelwaarden. In deze zelfstudie wordt diepte opgegeven om aan te tonen dat u JSON-objecten ook kunt opslaan als waarden in App Configuration. Als de diepte niet is opgegeven, worden JSON-objecten standaard afgevlakt tot het laagste niveau.

De JSON-sleutelwaarden die u hebt gemaakt, moeten er als volgt uitzien in App Configuration:

Als u dit wilt controleren, opent u uw App Configuration-resource in Azure Portal en gaat u naar Configuration Explorer.

JSON-sleutelwaarden exporteren naar een bestand

Een van de belangrijkste voordelen van het gebruik van JSON-sleutelwaarden is de mogelijkheid om het oorspronkelijke gegevenstype van uw waarden te behouden tijdens het exporteren. Als een sleutelwaarde in App Configuration geen JSON-inhoudstype heeft, wordt de waarde als een tekenreeks behandeld.

Houd rekening met deze sleutelwaarden zonder JSON-inhoudstype:

Sleutelcode	Waarde	Inhoudstype
Instellingen:Lettergrootte	24
Instellingen:Standaardroutering gebruiken	onwaar

Wanneer u deze sleutelwaarden naar een JSON-bestand exporteert, worden de waarden geëxporteerd als tekenreeksen:

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

Wanneer u echter JSON-sleutelwaarden naar een bestand exporteert, behouden alle waarden het oorspronkelijke gegevenstype. Als u dit proces wilt controleren, exporteert u sleutelwaarden uit uw App Configuration naar een JSON-bestand. U ziet dat het geëxporteerde bestand dezelfde inhoud heeft als het Import.json bestand dat u eerder hebt geïmporteerd.

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

Opmerking

Als uw App Configuration-archief een aantal sleutelwaarden zonder JSON-inhoudstype heeft, worden ze ook geëxporteerd naar hetzelfde bestand in tekenreeksindeling.

JSON-sleutelwaarden gebruiken in toepassingen

De eenvoudigste manier om JSON-sleutelwaarden in uw toepassing te gebruiken, is via App Configuration-providerbibliotheken. Met de providerbibliotheken hoeft u geen speciale verwerking van JSON-sleutelwaarden in uw toepassing te implementeren. Ze worden geparseerd en geconverteerd zodat deze overeenkomen met de systeemeigen configuratie van uw toepassing.

Als u bijvoorbeeld de volgende sleutelwaarde in App Configuration hebt:

Sleutelcode	Waarde	Inhoudstype
Instellingen	{"FontSize":24,"UseDefaultRouting":false}	application/json

De configuratie van uw .NET-toepassing heeft de volgende sleutelwaarden:

Sleutelcode	Waarde
Instellingen:Lettergrootte	24
Instellingen:Standaardroutering gebruiken	onwaar

U hebt rechtstreeks toegang tot de nieuwe sleutels of u kunt ervoor kiezen om configuratiewaarden te binden aan exemplaren van .NET-objecten.

Belangrijk

Systeemeigen ondersteuning voor JSON-sleutelwaarden is beschikbaar in .NET-configuratieprovider versie 4.0.0 (of hoger). Ga voor meer informatie naar de sectie Volgende stappen .

Als u de SDK of REST API gebruikt om sleutelwaarden te lezen uit App Configuration, op basis van het inhoudstype, is uw toepassing verantwoordelijk voor het parseren van de waarde van een JSON-sleutelwaarde.

De hulpbronnen opschonen

Als u de resources die in dit artikel zijn gemaakt niet wilt blijven gebruiken, verwijdert u de resourcegroep die u hier hebt gemaakt om kosten te voorkomen.

Belangrijk

Het verwijderen van een resourcegroep kan niet ongedaan worden gemaakt. De resourcegroep en alle resources daarin worden permanent verwijderd. Zorg ervoor dat u niet per ongeluk de verkeerde groep of bronnen verwijdert. Als u de resources voor dit artikel in een resourcegroep hebt gemaakt die andere resources bevat die u wilt behouden, moet u elke resource afzonderlijk verwijderen uit het deelvenster in plaats van dat u de resourcegroep verwijdert.

1. Meld u aan bij de Azure-portal en selecteer Resourcegroepen.
2. Voer in het vak Filteren op naam de naam van uw resourcegroep in.
3. Selecteer in de resultatenlijst de resourcegroepnaam om een overzicht te bekijken.
4. Selecteer Resourcegroep verwijderen.
5. U wordt gevraagd om het verwijderen van de resourcegroep te bevestigen. Voer de naam van de resourcegroep in die u wilt bevestigen en selecteer Verwijderen.

Na enkele ogenblikken worden de resourcegroep en alle bijbehorende resources verwijderd.

Volgende stappen

Nu u weet hoe u met JSON-sleutelwaarden in uw App Configuration-archief kunt werken, maakt u een toepassing voor het gebruik van deze sleutelwaarden:

Quickstart voor ASP.NET Core

Quickstart voor .NET Core