Kérések küldése az Azure Digital Twins API-knak a Visual Studióval

A Visual Studio 2022 támogatja a .http fájlokat, amelyek http-kérések strukturálására, tárolására és közvetlen küldésére használhatók az alkalmazásból. A Visual Studio ezen funkciójának használatával http-kéréseket hozhat létre, és elküldheti őket az Azure Digital Twins REST API-knak. Ez a cikk azt ismerteti, hogyan állíthat be olyan .http fájlokat a Visual Studióban, amelyek képesek csatlakozni az Azure Digital Twins API-khoz.

Ez a cikk a következő lépésekről tartalmaz információkat:

1. Állítson be egy Visual Studio-projektet és .http -fájlt az Azure Digital Twins-példányt képviselő változókkal.
2. Az Azure CLI használatával beszerezhet egy tulajdonosi jogkivonatot , amellyel API-kéréseket végezhet a Visual Studióban.
3. Az Azure Digital Twins REST API dokumentációját erőforrásként használhatja a .http fájlban lévő kérések létrehozásához, és elküldheti őket az Azure Digital Twins API-knak.

Az Azure Digital Twins két api-készlettel rendelkezik, amelyekkel dolgozhat: adatsíkkal és vezérlősíkkal. A két API-készlet közötti különbségről további információt az Azure Digital Twins API-k és az SDK-k című témakörben talál. Ez a cikk mindkét API-készletre vonatkozó utasításokat tartalmaz.

További információ a Visual Studio fájltámogatásáról .http : .http-fájlok használata a Visual Studio 2022-ben.

Előfeltételek

Az Azure Digital Twins API-knak a Visual Studio használatával történő kéréséhez be kell állítania egy Azure Digital Twins-példányt, és le kell töltenie a Visual Studio 2022-t. Ez a szakasz ezeket a lépéseket ismerteti.

Az Azure Digital Twins-példány beállítása

Az Azure Digital Twins ebben a cikkben való használatához szüksége lesz egy Azure Digital Twins-példányra és a használatához szükséges engedélyekre. Ha már beállított egy Azure Digital Twins-példányt, használhatja ezt a példányt, és ugorjon a következő szakaszra. Ellenkező esetben kövesse a példány és a hitelesítés beállítása című témakör utasításait. Az utasítások olyan információkat tartalmaznak, amelyek segítenek ellenőrizni, hogy sikeresen végrehajtotta-e az egyes lépéseket.

A példány beállítása után jegyezze fel a példány állomásnevét. A gazdagép nevét az Azure Portalon találja.

A Visual Studio 2022 letöltése

Ezután töltse le a Visual Studio 2022-t. Ügyeljen arra, hogy a telepítésbe belefoglalja a ASP.NET és a webfejlesztési számítási feladatot.

Visual Studio-projekt beállítása

Ebben a szakaszban beállítja azt a projektet a Visual Studióban, amely HTTP-kérések készítésére lesz használva.

Nyissa meg a Visual Studiót a számítógépén, és hozzon létre egy új projektet. Használja a ASP.NET Core Empty projektsablont.

A .http-fájl létrehozása című témakör utasításait követve hozzon létre egy új .http fájlt a projektben.

Változók hozzáadása

Ezután adjon hozzá néhány változót a .http fájl tetején, amelyek az Azure Digital Twins-erőforráshoz való csatlakozáshoz lesznek használva.

A szükséges változók halmaza attól függ, hogy milyen API-kat használ, ezért az alábbi fülek segítségével válasszon az adatsík és a vezérlősík API-k között.

Adatsík

Adja hozzá a következő változókat az adatsík-kérelmekhez. Az Azure Digital Twins-példány állomásneve egy helyőrzővel rendelkezik (digitaltwins.azure.net végződik).

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

Vezérlősík

Adja hozzá a következő változókat a vezérlősík-kérelmekhez. Helyőrzőket tartalmaznak az erőforrásértékekhez.

@instance=<name-of-your-Azure-Digital-Twins-instance>
@subscription=<ID-of-your-Azure-subscription>
@resourceGroup=<resource-group>
@CPversion=2023-01-31

Tulajdonosi jogkivonat hozzáadása

Most, hogy beállította az Azure Digital Twins-példányt és a Visual Studio-projektet, le kell szereznie egy tulajdonosi jogkivonatot, amelyet a HTTP-kérések az Azure Digital Twins API-kon való engedélyezéshez használhatnak.

Ennek a jogkivonatnak több módja is van. Ez a cikk az Azure CLI használatával jelentkezik be az Azure-fiókjába, és így szerez be egy jogkivonatot.

Ha helyileg telepítette az Azure CLI-t, a következő parancsok futtatásához parancssort indíthat el a számítógépen. Ellenkező esetben megnyithat egy Azure Cloud Shell-ablakot a böngészőben, és ott futtathatja a parancsokat.

1. Először győződjön meg arról, hogy a megfelelő hitelesítő adatokkal van bejelentkezve az Azure-ba a következő parancs futtatásával:

   az login
   

2. Ezután az az account get-access-token paranccsal szerezze be a tulajdonosi jogkivonatot az Azure Digital Twins szolgáltatáshoz való hozzáféréssel. Ebben a parancsban adja meg az Azure Digital Twins szolgáltatásvégpont erőforrás-azonosítóját, hogy lekérjen egy hozzáférési jogkivonatot, amely hozzáfér az Azure Digital Twins-erőforrásokhoz.

   A jogkivonat szükséges környezete attól függ, hogy milyen API-kat használ, ezért az alábbi fülek segítségével válasszon az adatsík és a vezérlősík API-k között.

   Adatsík

   Az adatsík API-ival használható jogkivonat lekéréséhez használja a következő statikus értéket a jogkivonat-környezethez: 0b07f429-9f4b-4714-9392-cc5e8e80c8b0. Ez az érték az Azure Digital Twins szolgáltatásvégpont erőforrás-azonosítója.

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

   Vezérlősík

   A vezérlősík API-ival használható jogkivonat lekéréséhez használja a következő értéket a jogkivonat-környezethez: https://management.azure.com/.

   az account get-access-token --resource https://management.azure.com/
   

   Feljegyzés

   Ha az Azure Digital Twins-példányt egy olyan szolgáltatásnévvel vagy felhasználói fiókkal kell elérnie, amely a példánytól egy másik Microsoft Entra-bérlőhöz tartozik, jogkivonatot kell kérnie az Azure Digital Twins-példány "otthoni" bérlőjétől. A folyamatról további információt az alkalmazáshitelesítési kód írása című témakörben talál.

3. Másolja ki az eredmény értékét accessToken . Ez az érték a jogkivonat értéke , amelyet be fog illeszteni a Visual Studióba a kérések engedélyezéséhez.

   

Tipp.

Ez a jogkivonat legalább öt percig és legfeljebb 60 percig érvényes. Ha elfogy az aktuális jogkivonatra vonatkozó idő, megismételheti az ebben a szakaszban ismertetett lépéseket egy új jogkivonat beszerzéséhez.

Jogkivonat hozzáadása fájlhoz .http

.http A Visual Studióban lévő fájlban adjon hozzá egy másik változót, amely tartalmazza a jogkivonat értékét.

Adatsík

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

A változóknak így kell kinéznie:

Vezérlősík

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

A változóknak így kell kinéznie:

Kérelmek hozzáadása

A fájl beállítása után .http kéréseket adhat hozzá az Azure Digital Twin API-khoz.

Először nyissa meg az Azure Digital Twins REST API-referenciát. Ez a dokumentáció az API-k által lefedett összes művelet részleteit tartalmazza. Lépjen a futtatni kívánt kérelem referenciaoldalára.

Ez a cikk példaként az adatsíkBól származó DigitalTwins Update API-t fogja használni.

1. Kérelemsablon hozzáadása: Másolja ki a referenciadokumentációban látható HTTP-kérést.

   

   A Visual Studióban illessze be a kérést egy új sorba a fájl változói .http alatt.

2. Paraméterek hozzáadása: Tekintse meg a referenciadokumentáció URI-paraméterek szakaszát annak megtekintéséhez, hogy mely paraméterértékekre van szükség a kérelemhez. Néhányat lecserélhet a korábban létrehozott változókra , és szükség szerint más paraméterértékeket is kitölthet. Egy változóra való hivatkozáshoz tegye a változó nevét dupla kapcsos zárójelekbe, például {{variable}}. További részletekért lásd: Változók.

   Feljegyzés

   Adatsík-kérelmek digitaltwins-hostname esetén is paraméter. Cserélje le ezt a {{hostName}} gazdanévváltozó értékének használatára.

   A lépés a következő módon jelenik meg egy példakérésben:

   

3. Engedélyezés hozzáadása: Adja hozzá a következő sort (pontosan az írott módon) közvetlenül a kérés alá, hogy megadhatja a hitelesítést a tulajdonosi jogkivonat változójával.

   Authorization: Bearer {{token}}
   

   A lépés a következő módon jelenik meg egy példakérésben:

   

4. További fejlécek hozzáadása: Tekintse meg a referenciadokumentáció Kérelemfejléc szakaszát, és nézze meg, hogy mely fejlécértékek kísérhetik a kérést. Érdemes lehet hagyományos HTTP-fejléceket is használni, például Content-Type. Adja hozzá az egyes fejléceket a saját sorához a formátumban HeaderName: Value. További részletekért lásd a Kérelem fejléceit.

   A lépés a következő módon jelenik meg egy példakérésben:

   

5. Törzs hozzáadása: Tekintse meg a referenciadokumentáció Kérelem törzs szakaszát, és nézze meg, hogy milyen törzsinformációkra lehet szükség a kérelemhez. Adja hozzá a kérelem törzsét egy üres sor után. További részletekért lásd : Kérelem törzse.

   A lépés a következő módon jelenik meg egy példakérésben:

6. Ha a kérés készen áll, a kérés felett válassza a Kérés küldése lehetőséget a küldéshez.

   

A Visual Studio egy panelt jelenít meg a válasz részleteivel. Tekintse meg a referenciadokumentáció Válaszok szakaszát az állapotkód és a válasz törzsében található adatok értelmezéséhez.

További kérések hozzáadása

Ha további kéréseket szeretne hozzáadni a .http fájlhoz, elkülönítse őket ### elválasztóként.

Következő lépések

A Visual Studio fájlokkal való .http elküldésével kapcsolatos további részletekért, beleértve a szintaxis részleteit és a speciális forgatókönyveket, olvassa el a .http-fájlok használata a Visual Studio 2022-ben című témakört.

A Digital Twins API-kkal kapcsolatos további információkért olvassa el az Azure Digital Twins API-kat és az SDK-kat, vagy tekintse meg a REST API-k referenciadokumentációját.