Dela via

Så här skickar du begäranden till Azure Digital Twins-API:er med Hjälp av Visual Studio

  • Artikel

Visual Studio 2022 har stöd för .http filer som kan användas för att strukturera, lagra och skicka HTTP-begäranden direkt från programmet. Att använda den här funktionen i Visual Studio är ett sätt att skapa HTTP-begäranden och skicka dem till REST-API:erna för Azure Digital Twins. Den här artikeln beskriver hur du konfigurerar en .http fil i Visual Studio som kan samverka med Azure Digital Twins-API:er.

Den här artikeln innehåller information om följande steg:

  1. Konfigurera ett Visual Studio-projekt och .http en fil med variabler som representerar din Azure Digital Twins-instans.
  2. Använd Azure CLI för att hämta en ägartoken som du kan använda för att göra API-begäranden i Visual Studio.
  3. Använd Azure Digital Twins REST API-dokumentationen som en resurs för att skapa begäranden i .http filen och skicka dem till Azure Digital Twins-API:erna.

Azure Digital Twins har två uppsättningar API:er som du kan arbeta med: dataplan och kontrollplan. Mer information om skillnaden mellan dessa API-uppsättningar finns i Azure Digital Twins API:er och SDK:er. Den här artikeln innehåller instruktioner för båda API-uppsättningarna.

Mer information om .http filstöd i Visual Studio finns i Använda .http-filer i Visual Studio 2022.

Förutsättningar

Om du vill göra begäranden till Azure Digital Twins-API:er med Visual Studio måste du konfigurera en Azure Digital Twins-instans och ladda ned Visual Studio 2022. Det här avsnittet är till för de här stegen.

Konfigurera Azure Digital Twins-instans

För att arbeta med Azure Digital Twins i den här artikeln behöver du en Azure Digital Twins-instans och de behörigheter som krävs för att använda den. Om du redan har konfigurerat en Azure Digital Twins-instans kan du använda den instansen och gå vidare till nästa avsnitt. Annars följer du anvisningarna i Konfigurera en instans och autentisering. Anvisningarna innehåller information som hjälper dig att kontrollera att du har slutfört varje steg.

När du har konfigurerat instansen antecknar du instansens värdnamn. Du hittar värdnamnet i Azure-portalen.

Ladda ned Visual Studio 2022

Ladda sedan ned Visual Studio 2022. Se till att inkludera arbetsbelastningen ASP.NET och webbutveckling i installationen.

Konfigurera Visual Studio-projekt

I det här avsnittet konfigurerar du projektet i Visual Studio som ska användas för att skapa HTTP-begäranden.

Öppna Visual Studio på datorn och skapa ett nytt projekt. Använd projektmallen ASP.NET Core Empty .

Skärmbild av en ASP.NET Core Empty-projektmall i Visual Studio.

Följ anvisningarna i Skapa en .http-fil för att skapa en ny .http fil i projektet.

Lägga till variabler

Lägg sedan till några variabler överst .http i filen som ska användas för att ansluta till din Azure Digital Twins-resurs.

Vilken uppsättning variabler du behöver beror på vilken uppsättning API:er du använder, så använd flikarna nedan för att välja mellan API:er för dataplan och kontrollplan .

Lägg till följande variabler för dataplansbegäranden. Det finns en platshållare för värdnamnet för din Azure Digital Twins-instans (den slutar i digitaltwins.azure.net).

@hostName=<host-name-of-your-Azure-Digital-Twins-instance>
@DPversion=2023-10-31

Lägg till ägartoken

Nu när du har konfigurerat Azure Digital Twins-instansen och Visual Studio-projektet måste du hämta en ägartoken som HTTP-begäranden kan använda för att auktorisera mot Azure Digital Twins-API:erna.

Det finns flera sätt att hämta den här token. Den här artikeln använder Azure CLI för att logga in på ditt Azure-konto och hämta en token på det sättet.

Om du har en Azure CLI installerad lokalt kan du starta en kommandotolk på datorn för att köra följande kommandon. Annars kan du öppna ett Azure Cloud Shell-fönster i webbläsaren och köra kommandona där.

  1. Kontrollera först att du är inloggad i Azure med rätt autentiseringsuppgifter genom att köra det här kommandot:

    az login

  2. Använd sedan kommandot az account get-access-token för att hämta en ägartoken med åtkomst till Azure Digital Twins-tjänsten. I det här kommandot skickar du in resurs-ID:t för Azure Digital Twins-tjänstslutpunkten för att få en åtkomsttoken som kan komma åt Azure Digital Twins-resurser.

    Vilken kontext som krävs för token beror på vilken uppsättning API:er du använder, så använd flikarna nedan för att välja mellan API:er för dataplan och kontrollplan .

    Om du vill hämta en token som ska användas med API:erna för dataplanet använder du följande statiska värde för tokenkontexten: 0b07f429-9f4b-4714-9392-cc5e8e80c8b0. Det här värdet är resurs-ID:t för Azure Digital Twins-tjänstslutpunkten.

    az account get-access-token --resource 0b07f429-9f4b-4714-9392-cc5e8e80c8b0

    Kommentar

    Om du behöver komma åt din Azure Digital Twins-instans med hjälp av tjänstens huvudnamn eller användarkonto som tillhör en annan Microsoft Entra-klient från instansen måste du begära en token från Azure Digital Twins-instansens "hem"-klientorganisation. Mer information om den här processen finns i Skriva appautentiseringskod.

  3. Kopiera värdet accessToken för i resultatet. Det här värdet är ditt tokenvärde som du klistrar in i Visual Studio för att auktorisera dina begäranden.

    Skärmbild av konsolen som visar resultatet av kommandot az account get-access-token. Fältet accessToken med ett exempelvärde är markerat.

Dricks

Den här token är giltig i minst fem minuter och högst 60 minuter. Om tiden för den aktuella token tar slut kan du upprepa stegen i det här avsnittet för att hämta en ny.

Lägga till token i .http filen

.http I filen i Visual Studio lägger du till en annan variabel som innehåller värdet för din token.

@token=<paste-data-plane-token>

Variablerna bör nu se ut ungefär så här:

Skärmbild av variablerna för dataplanet, inklusive en token.

Lägga till begäranden

Nu när .http filen har konfigurerats kan du lägga till begäranden till Azure Digital Twin-API:erna.

Börja med att öppna REST API-referensen för Azure Digital Twins. Den här dokumentationen innehåller information om alla åtgärder som omfattas av API:erna. Gå till referenssidan för den begäran som du vill köra.

Den här artikeln använder DigitalTwins Update-API :et från dataplanet som exempel.

  1. Lägg till mall för begäran: Kopiera HTTP-begäran som visas i referensdokumentationen.

    Skärmbild av HTTP-begäran i dokumentationen för Digital Twins API.

    I Visual Studio klistrar du in begäran på en ny rad under variablerna i .http filen.

  2. Lägg till parametrar: Titta på avsnittet URI-parametrar i referensdokumentationen för att se vilka parametervärden som krävs av begäran. Du kan ersätta vissa med variablerna som du skapade tidigare och fylla i andra parametervärden efter behov. Om du vill referera till en variabel placerar du variabelnamnet i dubbla klammerparenteser, till exempel {{variable}}. Mer information finns i Variabler.

    Kommentar

    För dataplansbegäranden digitaltwins-hostname är det också en parameter. Ersätt detta med {{hostName}} för att använda värdet för värdnamnsvariabeln.

    Så här ser det här steget ut i en exempelbegäran:

    Skärmbild av begäran med parametrar i Visual Studio.

  3. Lägg till auktorisering: Lägg till följande rad (exakt som skrivet) direkt under begäran för att ange autentisering med din ägartokenvariabel.

    Authorization: Bearer {{token}}

    Så här ser det här steget ut i en exempelbegäran:

    Skärmbild av begäran med auktoriseringsraden i Visual Studio.

  4. Lägg till ytterligare rubriker: Titta på avsnittet Begärandehuvud i referensdokumentationen för att se vilka rubrikvärden som kan följa med begäran. Du kanske också vill inkludera traditionella HTTP-huvuden som Content-Type. Lägg till varje rubrik på en egen rad i formatet HeaderName: Value. Mer information finns i Begärandehuvuden.

    Så här ser det här steget ut i en exempelbegäran:

    Skärmbild av begäran med en annan rubrik i Visual Studio.

  5. Lägg till brödtext: Titta på avsnittet Begärandetext i referensdokumentationen för att se vilken brödtextinformation som kan behövas av begäran. Lägg till begärandetexten efter en tom rad. Mer information finns i Begärandetext.

    Så här ser det här steget ut i en exempelbegäran: Skärmbild av begäran med en brödtext i Visual Studio.

  6. När begäran är klar väljer du Skicka begäran ovanför begäran för att skicka den.

    Skärmbild av Skicka begäran i Visual Studio.

Visual Studio visar ett fönster med information om svaret. Titta på avsnittet Svar i referensdokumentationen för att tolka statuskoden och eventuella data i svarstexten.

Skärmbild av svaret i Visual Studio.

Lägga till ytterligare begäranden

Om du vill lägga till fler begäranden i .http filen separerar du dem med ### som avgränsare.

Skärmbild av flera begäranden i en fil i Visual Studio.

Nästa steg

Mer information om hur du skickar begäranden med .http filer i Visual Studio, inklusive syntaxinformation och avancerade scenarier, finns i Använda .http-filer i Visual Studio 2022.

Om du vill veta mer om Digital Twins-API:er läser du Azure Digital Twins-API:er och SDK:er eller visar referensdokumentationen för REST-API:erna.