Łączenie usługi Azure Functions z usługą Azure Cosmos DB przy użyciu programu Visual Studio Code
Usługa Azure Functions umożliwia łączenie usług platformy Azure i innych zasobów z funkcjami bez konieczności pisania własnego kodu integracji. Te powiązania, które reprezentują zarówno dane wejściowe, jak i wyjściowe, są deklarowane w definicji funkcji. Dane z powiązań są podawane do funkcji jako parametry. Wyzwalacz to specjalny typ powiązania wejściowego. Chociaż funkcja ma tylko jeden wyzwalacz, może mieć wiele powiązań wejściowych i wyjściowych. Aby dowiedzieć się więcej, zobacz Pojęcia dotyczące wyzwalaczy i powiązań usługi Azure Functions.
W tym artykule pokazano, jak używać programu Visual Studio Code do łączenia usługi Azure Cosmos DB z funkcją utworzoną w poprzednim artykule Szybki start. Powiązanie wyjściowe dodawane do tej funkcji zapisuje dane z żądania HTTP do dokumentu JSON przechowywanego w kontenerze usługi Azure Cosmos DB.
Przed rozpoczęciem należy ukończyć przewodnik Szybki start: tworzenie funkcji języka C# na platformie Azure przy użyciu programu Visual Studio Code. Jeśli zasoby zostały już wyczyszczone na końcu tego artykułu, wykonaj kroki ponownie, aby ponownie utworzyć aplikację funkcji i powiązane zasoby na platformie Azure.
Przed rozpoczęciem należy ukończyć przewodnik Szybki start: tworzenie funkcji JavaScript na platformie Azure przy użyciu programu Visual Studio Code. Jeśli zasoby zostały już wyczyszczone na końcu tego artykułu, wykonaj kroki ponownie, aby ponownie utworzyć aplikację funkcji i powiązane zasoby na platformie Azure.
Uwaga
Ten artykuł obsługuje obecnie tylko Node.js w wersji 3 dla usługi Functions.
Przed rozpoczęciem należy ukończyć przewodnik Szybki start: tworzenie funkcji języka Python na platformie Azure przy użyciu programu Visual Studio Code. Jeśli zasoby zostały już wyczyszczone na końcu tego artykułu, wykonaj kroki ponownie, aby ponownie utworzyć aplikację funkcji i powiązane zasoby na platformie Azure.
Konfigurowanie środowiska
Przed rozpoczęciem upewnij się, że zainstalowano rozszerzenie Azure Databases dla programu Visual Studio Code.
Tworzenie konta usługi Azure Cosmos DB
Teraz utworzysz konto usługi Azure Cosmos DB jako typ konta bezserwerowego. Ten tryb oparty na użyciu sprawia, że usługa Azure Cosmos DB jest silną opcją dla obciążeń bezserwerowych.
W Visual Studio Code wybierz Widok>Paletę poleceń..., a następnie w palecie poleceń wyszukaj
Azure Databases: Create Server...Podaj następujące informacje po wyświetleniu monitów:
Monit Wybór Wybieranie serwera usługi Azure Database Wybierz Core (NoSQL), aby utworzyć bazę danych dokumentacyjnych, którą można przeszukiwać za pomocą składni SQL lub Query Copilot (Preview), konwertując monity języka naturalnego na zapytania. Dowiedz się więcej o usłudze Azure Cosmos DB. Nazwa konta Wprowadź unikatową nazwę do identyfikacji konta usługi Azure Cosmos DB. Nazwa konta może używać tylko małych liter, cyfr i łączników (-) i musi mieć długość od 3 do 31 znaków. Wybieranie modelu pojemności Wybierz pozycję Bezserwerowe , aby utworzyć konto w trybie bezserwerowym . Wybierz grupę zasobów dla nowych zasobów Wybierz grupę zasobów, w której utworzono aplikację funkcji w poprzednim artykule. Wybieranie lokalizacji dla nowych zasobów Wybierz lokalizację geograficzną, w której będzie hostowane konto usługi Azure Cosmos DB. Użyj lokalizacji znajdującej się najbliżej Ciebie lub Twoich użytkowników, aby uzyskać najszybszy dostęp do danych. Po aprowizacji nowego konta w obszarze powiadomień zostanie wyświetlony komunikat.
Tworzenie bazy danych i kontenera usługi Azure Cosmos DB
Wybierz ikonę Azure na pasku aktywności, rozwiń Zasobyusługi Azure Cosmos DB, kliknij prawym przyciskiem myszy (lub Ctrl+kliknij w macOS) konto, a następnie wybierz polecenie Utwórz bazę danych....
Podaj następujące informacje po wyświetleniu monitów:
Polecenie Wybór Nazwa bazy danych Wpisz my-database.Wprowadź identyfikator kolekcji Wpisz my-container.Wprowadź klucz partycji dla kolekcji Wpisz /idjako klucz partycji.Wybierz przycisk OK , aby utworzyć kontener i bazę danych.
Zaktualizuj ustawienia aplikacji funkcji
W poprzednim artykule z cyklu "Szybki start" utworzyłeś aplikację funkcji w Azure. W tym artykule zaktualizujesz aplikację, aby zapisywała dokumenty JSON w utworzonym kontenerze usługi Azure Cosmos DB. Aby nawiązać połączenie z kontem usługi Azure Cosmos DB, musisz dodać jego parametry połączenia do ustawień aplikacji. Następnie pobierz nowe ustawienie do pliku local.settings.json, aby można było nawiązać połączenie z kontem usługi Azure Cosmos DB podczas uruchamiania lokalnego.
W programie Visual Studio Code kliknij prawym przyciskiem myszy (Ctrl+wybierz w systemie macOS) na nowym koncie usługi Azure Cosmos DB i wybierz polecenie Kopiuj parametry połączenia.
Naciśnij F1 , aby otworzyć paletę poleceń, a następnie wyszukaj i uruchom polecenie
Azure Functions: Add New Setting....Wybierz aplikację funkcji utworzoną w poprzednim artykule. Podaj następujące informacje po wyświetleniu monitów:
Podpowiedź Wybór Wprowadź nazwę nowego ustawienia aplikacji Wpisz CosmosDbConnectionSetting.Wprowadź wartość parametru "CosmosDbConnectionSetting" Wklej parametry połączenia skopiowanego konta usługi Azure Cosmos DB. Możesz również skonfigurować tożsamość Microsoft Entra jako alternatywne rozwiązanie. Spowoduje to utworzenie ustawienia aplikacji o nazwie connection
CosmosDbConnectionSettingw aplikacji funkcji na platformie Azure. Teraz możesz pobrać to ustawienie do pliku local.settings.json.Naciśnij F1 ponownie, aby otworzyć paletę poleceń, a następnie wyszukaj i uruchom polecenie
Azure Functions: Download Remote Settings....Wybierz aplikację funkcji, którą utworzyłeś w poprzednim artykule. Wybierz Tak dla wszystkich, aby zastąpić istniejące ustawienia lokalne.
To spowoduje pobranie wszystkich ustawień z platformy Azure do lokalnego projektu, w tym nowego ustawienia ciągu połączenia. Większość pobranych ustawień nie jest używana podczas uruchamiania lokalnego.
Rejestrowanie rozszerzeń wiązań
Ponieważ używasz powiązania wyjściowego usługi Azure Cosmos DB, przed uruchomieniem projektu musisz mieć zainstalowane odpowiednie rozszerzenie powiązań.
Z wyjątkiem wyzwalaczy HTTP i czasomierza powiązania są implementowane jako pakiety rozszerzeń. Uruchom następujące polecenie dotnet add package w oknie terminalu, aby dodać pakiet rozszerzenia usługi Azure Cosmos DB do projektu.
dotnet add package Microsoft.Azure.Functions.Worker.Extensions.CosmosDB
Projekt został skonfigurowany do używania pakietów rozszerzeń, które automatycznie instalują wstępnie zdefiniowany zestaw pakietów rozszerzeń.
Użycie pakietów rozszerzeń jest włączone w pliku host.json w katalogu głównym projektu, który jest wyświetlany w następujący sposób:
{
"version": "2.0",
"logging": {
"applicationInsights": {
"samplingSettings": {
"isEnabled": true,
"excludedTypes": "Request"
}
}
},
"extensionBundle": {
"id": "Microsoft.Azure.Functions.ExtensionBundle",
"version": "[4.*, 5.0.0)"
},
"concurrency": {
"dynamicConcurrencyEnabled": true,
"snapshotPersistenceEnabled": true
},
"extensions": {
"cosmosDB": {
"connectionMode": "Gateway"
}
}
}
Projekt został skonfigurowany do używania pakietów rozszerzeń, które automatycznie instalują wstępnie zdefiniowany zestaw pakietów rozszerzeń.
Użycie pakietów rozszerzeń jest włączone w pliku host.json w katalogu głównym projektu, który jest wyświetlany w następujący sposób:
{
"version": "2.0",
"extensionBundle": {
"id": "Microsoft.Azure.Functions.ExtensionBundle",
"version": "[3.*, 4.0.0)"
}
}
Teraz możesz dodać powiązanie wyjściowe usługi Azure Cosmos DB do projektu.
Dodaj powiązanie danych wyjściowych
W projekcie biblioteki klas języka C# powiązania są definiowane jako atrybuty powiązania w metodzie funkcji.
Otwórz plik projektu HttpExample.cs i dodaj następujące klasy:
public class MultiResponse
{
[CosmosDBOutput("my-database", "my-container",
Connection = "CosmosDbConnectionSetting", CreateIfNotExists = true)]
public MyDocument Document { get; set; }
public HttpResponseData HttpResponse { get; set; }
}
public class MyDocument {
public string id { get; set; }
public string message { get; set; }
}
Klasa MyDocument definiuje obiekt, który jest zapisywany w bazie danych. Parametry połączenia dla konta Storage są ustawiane przez właściwość Connection. W takim przypadku można pominąć Connection, ponieważ używasz już domyślnego konta przechowywania.
Klasa MultiResponse umożliwia zarówno zapisywanie w określonej kolekcji w usłudze Azure Cosmos DB, jak i przekazywanie komunikatu o pomyślnym zakończeniu operacji HTTP. Ponieważ musisz zwrócić obiekt, należy również zaktualizować sygnaturę MultiResponse metody.
Określone atrybuty określają nazwę kontenera i nazwę nadrzędnej bazy danych. Ciąg połączenia dla konta usługi Azure Cosmos DB jest ustawiany przez element CosmosDbConnectionSetting.
Atrybuty powiązania są definiowane bezpośrednio w kodzie funkcji. W konfiguracji wyjścia Azure Cosmos DB opisano pola wymagane dla powiązania wyjściowego usługi Azure Cosmos DB.
W tym scenariuszu MultiResponse musisz dodać do funkcji powiązanie wyjściowe extraOutputs.
app.http('HttpExample', {
methods: ['GET', 'POST'],
extraOutputs: [sendToCosmosDb],
handler: async (request, context) => {
Dodaj następujące właściwości do konfiguracji powiązania:
const sendToCosmosDb = output.cosmosDB({
databaseName: 'my-database',
containerName: 'my-container',
createIfNotExists: false,
connection: 'CosmosDBConnectionString',
});
Atrybuty powiązania są definiowane bezpośrednio w pliku function_app.py . Używasz dekoratora cosmos_db_output, aby dodać powiązanie wyjściowe usługi Azure Cosmos DB.
@app.cosmos_db_output(arg_name="outputDocument", database_name="my-database",
container_name="my-container", connection="CosmosDbConnectionSetting")
W tym kodzie arg_name identyfikuje parametr powiązania, do którego odwołuje się kod, database_name i container_name są nazwami bazy danych i kolekcji, do których zapisuje powiązanie, i connection jest nazwą ustawienia aplikacji zawierającego parametry połączenia dla konta usługi Azure Cosmos DB, które znajduje się w CosmosDbConnectionSetting ustawieniu w pliku local.settings.json.
Dodawanie kodu korzystającego z powiązania danych wyjściowych
Zastąp istniejącą metodę Run następującym kodem:
[Function("HttpExample")]
public static MultiResponse Run([HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequestData req,
FunctionContext executionContext)
{
var logger = executionContext.GetLogger("HttpExample");
logger.LogInformation("C# HTTP trigger function processed a request.");
var message = "Welcome to Azure Functions!";
var response = req.CreateResponse(HttpStatusCode.OK);
response.Headers.Add("Content-Type", "text/plain; charset=utf-8");
response.WriteString(message);
// Return a response to both HTTP trigger and Azure Cosmos DB output binding.
return new MultiResponse()
{
Document = new MyDocument
{
id = System.Guid.NewGuid().ToString(),
message = message
},
HttpResponse = response
};
}
Dodaj kod, który używa obiektu powiązania wyjściowego extraInputs na context do wysyłania dokumentu JSON do nazwanej funkcji powiązanego wyjścia, sendToCosmosDb. Dodaj ten kod przed instrukcją return .
context.extraOutputs.set(sendToCosmosDb, {
// create a random ID
id:
new Date().toISOString() + Math.random().toString().substring(2, 10),
name: name,
});
W tym momencie funkcja powinna wyglądać następująco:
const { app, output } = require('@azure/functions');
const sendToCosmosDb = output.cosmosDB({
databaseName: 'my-database',
containerName: 'my-container',
createIfNotExists: false,
connection: 'CosmosDBConnectionString',
});
app.http('HttpExampleToCosmosDB', {
methods: ['GET', 'POST'],
extraOutputs: [sendToCosmosDb],
handler: async (request, context) => {
try {
context.log(`Http function processed request for url "${request.url}"`);
const name = request.query.get('name') || (await request.text());
if (!name) {
return { status: 404, body: 'Missing required data' };
}
// Output to Database
context.extraOutputs.set(sendToCosmosDb, {
// create a random ID
id:
new Date().toISOString() + Math.random().toString().substring(2, 10),
name: name,
});
const responseMessage = name
? 'Hello, ' +
name +
'. This HTTP triggered function executed successfully.'
: 'This HTTP triggered function executed successfully. Pass a name in the query string or in the request body for a personalized response.';
// Return to HTTP client
return { body: responseMessage };
} catch (error) {
context.log(`Error: ${error}`);
return { status: 500, body: 'Internal Server Error' };
}
},
});
Teraz ten kod zwraca obiekt MultiResponse zawierający zarówno dokument, jak i odpowiedź HTTP.
Zaktualizuj plik HttpExample\function_app.py , aby był zgodny z poniższym kodem.
outputDocument Dodaj parametr do definicji funkcji i outputDocument.set() w instrukcji if name: :
import azure.functions as func
import logging
app = func.FunctionApp()
@app.function_name(name="HttpTrigger1")
@app.route(route="hello", auth_level=func.AuthLevel.ANONYMOUS)
@app.queue_output(arg_name="msg", queue_name="outqueue", connection="AzureWebJobsStorage")
@app.cosmos_db_output(arg_name="outputDocument", database_name="my-database", container_name="my-container", connection="CosmosDbConnectionSetting")
def test_function(req: func.HttpRequest, msg: func.Out[func.QueueMessage],
outputDocument: func.Out[func.Document]) -> func.HttpResponse:
logging.info('Python HTTP trigger function processed a request.')
logging.info('Python Cosmos DB trigger function processed a request.')
name = req.params.get('name')
if not name:
try:
req_body = req.get_json()
except ValueError:
pass
else:
name = req_body.get('name')
if name:
outputDocument.set(func.Document.from_dict({"id": name}))
msg.set(name)
return func.HttpResponse(f"Hello {name}!")
else:
return func.HttpResponse(
"Please pass a name on the query string or in the request body",
status_code=400
)
Dokument {"id": "name"} jest tworzony w kolekcji bazy danych określonej w powiązaniu.
Lokalne uruchamianie funkcji
Program Visual Studio Code integruje się z narzędziami Azure Functions Core, aby umożliwić uruchamianie tego projektu na lokalnym komputerze deweloperów przed opublikowaniem na platformie Azure. Jeśli nie masz jeszcze zainstalowanych lokalnie narzędzi Core Tools, zostanie wyświetlony monit o zainstalowanie go po raz pierwszy podczas uruchamiania projektu.
Aby wywołać funkcję, naciśnij F5 , aby uruchomić projekt aplikacji funkcji. Na panelu Terminal są wyświetlane dane wyjściowe z narzędzi Core Tools. Aplikacja zostanie uruchomiona na panelu Terminal . Punkt końcowy adresu URL funkcji wyzwalanej przez protokół HTTP jest widoczny lokalnie.
Jeśli nie masz jeszcze zainstalowanych narzędzi Core Tools, po wyświetleniu monitu wybierz pozycję Zainstaluj , aby zainstalować narzędzia Core Tools.
Jeśli masz problemy z działaniem w systemie Windows, upewnij się, że domyślny terminal programu Visual Studio Code nie jest ustawiony na powłokę WSL Bash.Po uruchomieniu narzędzi Core Tools przejdź do obszaru Azure: Functions . Pod Funkcje rozwiń lokalny projekt>Funkcje. Kliknij prawym przyciskiem myszy (Windows) lub Ctrl — kliknij funkcję (macOS),
HttpExamplea następnie wybierz polecenie Wykonaj funkcję teraz....
W sekcji Wprowadź treść żądania, naciśnij Enter, aby wysłać komunikat żądania do funkcji.
Gdy funkcja jest wykonywana lokalnie i zwraca odpowiedź, w programie Visual Studio Code pojawi się powiadomienie. Informacje o wykonywaniu funkcji są wyświetlane na panelu Terminal .
Naciśnij Ctrl + C , aby zatrzymać narzędzia Core Tools i odłączyć debuger.
Lokalne uruchamianie funkcji
Podobnie jak w poprzednim artykule, naciśnij F5, aby uruchomić projekt aplikacji funkcji oraz narzędzia Core Tools.
Po uruchomieniu narzędzi Core Tools przejdź do obszaru Azure: Functions . Pod Funkcje rozwiń Lokalny projekt>Funkcje. Kliknij prawym przyciskiem myszy (kliknij na komputerze Mac)
HttpExamplefunkcję, a następnie wybierz polecenie Wykonaj funkcję teraz....
W Wprowadź treść żądania widać wartość treści komunikatu
{ "name": "Azure" }. Naciśnij Enter, aby wysłać ten komunikat żądania do funkcji.Po powrocie odpowiedzi naciśnij Ctrl + C , aby zatrzymać narzędzia Core Tools.
Sprawdź, czy dokument JSON został utworzony
W witrynie Azure Portal wróć do konta usługi Azure Cosmos DB i wybierz pozycję Eksplorator danych.
Rozwiń bazę danych i kontener, a następnie wybierz pozycję Elementy , aby wyświetlić listę dokumentów utworzonych w kontenerze.
Sprawdź, czy nowy dokument JSON został utworzony przez powiązanie wyjściowe.
Ponowne wdrażanie i weryfikowanie zaktualizowanej aplikacji
W programie Visual Studio Code naciśnij F1, aby otworzyć paletę poleceń. W palecie poleceń wyszukaj i wybierz pozycję
Azure Functions: Deploy to function app....Wybierz aplikację funkcjonalną utworzoną w pierwszym artykule. Ponieważ ponownie wdrażasz projekt w tej samej aplikacji, wybierz pozycję Wdróż , aby odrzucić ostrzeżenie dotyczące zastępowania plików.
Po zakończeniu wdrażania możesz ponownie użyć funkcji Execute Function Now... w celu wyzwolenia funkcji na platformie Azure.
Ponownie sprawdź dokumenty utworzone w kontenerze usługi Azure Cosmos DB, aby sprawdzić, czy powiązanie wyjściowe ponownie generuje nowy dokument JSON.
Czyszczenie zasobów
Na platformie Azure zasoby odnoszą się do aplikacji funkcjonalnych, funkcji, kont pamięci itd. Są one grupowane w grupy zasobów i można usunąć wszystkie elementy w grupie, usuwając grupę.
Aby ukończyć te przewodniki Szybki start, zostały utworzone zasoby. Opłaty za te zasoby mogą być naliczane w zależności od stanu konta i cen usług. Jeśli nie potrzebujesz już tych zasobów, oto jak możesz je usunąć:
W programie Visual Studio Code naciśnij F1 , aby otworzyć paletę poleceń. W palecie poleceń wyszukaj i wybierz pozycję
Azure: Open in portal.Wybierz aplikację funkcji i naciśnij Enter. Strona aplikacji funkcji otwiera się w Azure Portal.
Na karcie Przegląd wybierz nazwany link obok pozycji Grupa zasobów.
Na stronie Grupa zasobów przejrzyj listę uwzględnionych zasobów i sprawdź, czy są to te, które chcesz usunąć.
Wybierz pozycję Usuń grupę zasobów, a następnie postępuj zgodnie z instrukcjami.
Usuwanie może potrwać kilka minut. Po jego zakończeniu przez kilka sekund będzie widoczne powiadomienie. Możesz również wybrać ikonę dzwonka w górnej części strony, aby wyświetlić powiadomienie.
Następne kroki
Zaktualizowano funkcję wyzwalaną przez protokół HTTP, aby zapisywać dokumenty JSON w kontenerze usługi Azure Cosmos DB. Teraz możesz dowiedzieć się więcej na temat tworzenia funkcji przy użyciu programu Visual Studio Code:
Opracowywanie usługi Azure Functions przy użyciu programu Visual Studio Code
Wyzwalacze i powiązania usługi Azure Functions.