Vazby Mobile Apps pro Azure Functions

Článek
04/07/2024

Poznámka:

Vazby Azure Mobile Apps jsou dostupné jenom pro Azure Functions 1.x. Nejsou podporované ve službě Azure Functions 2.x a vyšší.

Důležité

Podpora pro modul runtime Azure Functions verze 1.x skončí 14. září 2026. Důrazně doporučujeme migrovat aplikace na verzi 4.x , abyste měli plnou podporu.

Tento článek vysvětluje, jak pracovat s vazbami Azure Mobile Apps ve službě Azure Functions. Azure Functions podporuje vstupní a výstupní vazby pro Mobile Apps.

Vazby Mobile Apps umožňují číst a aktualizovat tabulky dat v mobilních aplikacích.

Balíčky – Funkce 1.x

Vazby Mobile Apps jsou k dispozici v balíčku NuGet Microsoft.Azure.WebJobs.Extensions.MobileApps verze 1.x. Zdrojový kód balíčku je v úložišti GitHubu pro azure-webjobs-sdk-extensions .

Následující tabulka uvádí, jak přidat podporu této vazby v každém vývojovém prostředí.

Vývojové prostředí	Přidání podpory do Functions 1.x
Místní vývoj – knihovna tříd jazyka C#	Instalace balíčku
Místní vývoj – skript jazyka C#, JavaScript, F#	Automatic (Automaticky)
Vývoj portálu	Automatic (Automaticky)

Vstup

Vstupní vazba Mobile Apps načte záznam z koncového bodu mobilní tabulky a předá ho do vaší funkce. Ve funkcích jazyka C# a F# se všechny změny provedené v záznamu automaticky odešlou zpět do tabulky, jakmile se funkce úspěšně ukončí.

Vstup – příklad

Podívejte se na příklad specifický pro jazyk:

Skript jazyka C#
JavaScript

Následující příklad ukazuje vstupní vazbu Mobile Apps v souboru function.json a funkci skriptu jazyka C#, která používá vazbu. Funkce se aktivuje zprávou fronty, která má identifikátor záznamu. Funkce přečte zadaný záznam a upraví jeho Text vlastnost.

Tady jsou data vazby v souboru function.json :

{
"bindings": [
    {
        "name": "myQueueItem",
        "queueName": "myqueue-items",
        "connection": "",
        "type": "queueTrigger",
        "direction": "in"
    },
    {
        "name": "record",
        "type": "mobileTable",
        "tableName": "MyTable",
        "id": "{queueTrigger}",
        "connection": "My_MobileApp_Url",
        "apiKey": "My_MobileApp_Key",
        "direction": "in"
    }
]
}

Oddíl konfigurace vysvětluje tyto vlastnosti.

Tady je kód skriptu jazyka C#:

#r "Newtonsoft.Json"    
using Newtonsoft.Json.Linq;

public static void Run(string myQueueItem, JObject record)
{
    if (record != null)
    {
        record["Text"] = "This has changed.";
    }    
}

Následující příklad ukazuje vstupní vazbu Mobile Apps v souboru function.json a funkci JavaScriptu, která používá vazbu. Funkce se aktivuje zprávou fronty, která má identifikátor záznamu. Funkce přečte zadaný záznam a upraví jeho Text vlastnost.

Tady jsou data vazby v souboru function.json :

{
"bindings": [
    {
        "name": "myQueueItem",
        "queueName": "myqueue-items",
        "connection": "",
        "type": "queueTrigger",
        "direction": "in"
    },
    {
        "name": "record",
        "type": "mobileTable",
        "tableName": "MyTable",
        "id": "{queueTrigger}",
        "connection": "My_MobileApp_Url",
        "apiKey": "My_MobileApp_Key",
        "direction": "in"
    }
]
}

Oddíl konfigurace vysvětluje tyto vlastnosti.

Tady je javascriptový kód:

module.exports = async function (context, myQueueItem) {    
    context.log(context.bindings.record);
};

Vstup – atributy

V knihovnách tříd jazyka C# použijte atribut MobileTable .

Informace o vlastnostech atributů, které můžete konfigurovat, najdete v následující části konfigurace.

Vstup – konfigurace

Následující tabulka vysvětluje vlastnosti konfigurace vazby, které jste nastavili v souboru function.json a atributu MobileTable .

vlastnost function.json	Vlastnost atributu	Popis
type	Není k dispozici	Musí být nastavená na "mobileTable".
direction	Není k dispozici	Musí být nastavená na "in".
Jméno	Není k dispozici	Název vstupního parametru v podpisu funkce
Tablename	TableName	Název tabulky dat mobilní aplikace
id	Id	Identifikátor záznamu, který se má načíst. Může být statická nebo založená na triggeru, který funkci vyvolá. Pokud například pro funkci použijete trigger fronty, použije `"id": "{queueTrigger}"` se jako ID záznamu řetězcová hodnota zprávy fronty.
Připojení	Připojení	Název nastavení aplikace, které má adresu URL mobilní aplikace. Tato funkce používá tuto adresu URL k vytvoření požadovaných operací REST pro vaši mobilní aplikaci. Vytvořte v aplikaci funkcí nastavení aplikace, které obsahuje adresu URL mobilní aplikace, a pak zadejte název nastavení aplikace ve `connection` vlastnosti ve vstupní vazbě. Adresa URL vypadá takto `https://<appname>.azurewebsites.net`.
apiKey	Klíč rozhraní API	Název nastavení aplikace, které má klíč rozhraní API vaší mobilní aplikace. Zadejte klíč rozhraní API, pokud implementujete klíč rozhraní API ve Node.js mobilní aplikaci nebo implementujete klíč rozhraní API v mobilní aplikaci .NET. Pokud chcete klíč zadat, vytvořte ve své aplikaci funkcí nastavení aplikace, které obsahuje klíč rozhraní API, a pak do vstupní vazby přidejte `apiKey` vlastnost s názvem nastavení aplikace.

Při místním vývoji přidejte nastavení aplikace do souboru local.settings.json v kolekci Values .

Důležité

Nesdílejte klíč rozhraní API s klienty mobilních aplikací. Měla by být distribuována bezpečně pouze klientům na straně služby, jako je Azure Functions. Azure Functions ukládá informace o připojení a klíče rozhraní API jako nastavení aplikace, aby se neověřily do úložiště správy zdrojového kódu. Tím se chrání vaše citlivé informace.

Vstup – využití

Ve funkcích jazyka C# se při nalezení záznamu se zadaným ID předá do pojmenovaného parametru JObject . Pokud záznam nebyl nalezen, hodnota parametru je null.

Ve funkcích JavaScriptu se záznam předá do objektu context.bindings.<name> . Pokud záznam nebyl nalezen, hodnota parametru je null.

Ve funkcích jazyka C# a F# se všechny změny vstupního záznamu (vstupního parametru) automaticky odešlou zpět do tabulky, když se funkce úspěšně ukončí. Záznam ve funkcích JavaScriptu nejde upravit.

Výstup

Výstupní vazba Mobile Apps slouží k zápisu nového záznamu do tabulky Mobile Apps.

Výstup – příklad

Následující příklad ukazuje funkci jazyka C#, která se aktivuje zprávou fronty a vytvoří záznam v tabulce mobilní aplikace.

[FunctionName("MobileAppsOutput")]        
[return: MobileTable(ApiKeySetting = "MyMobileAppKey", TableName = "MyTable", MobileAppUriSetting = "MyMobileAppUri")]
public static object Run(
    [QueueTrigger("myqueue-items", Connection = "AzureWebJobsStorage")] string myQueueItem,
    TraceWriter log)
{
    return new { Text = $"I'm running in a C# function! {myQueueItem}" };
}

Následující příklad ukazuje výstupní vazbu Mobile Apps v souboru function.json a funkci skriptu jazyka C#, která používá vazbu. Funkce se aktivuje zprávou fronty a vytvoří nový záznam s pevně zakódovanou hodnotou vlastnosti Text .

Tady jsou data vazby v souboru function.json :

{
"bindings": [
    {
        "name": "myQueueItem",
        "queueName": "myqueue-items",
        "connection": "",
        "type": "queueTrigger",
        "direction": "in"
    },
    {
        "name": "record",
        "type": "mobileTable",
        "tableName": "MyTable",
        "connection": "My_MobileApp_Url",
        "apiKey": "My_MobileApp_Key",
        "direction": "out"
    }
]
}

Oddíl konfigurace vysvětluje tyto vlastnosti.

Tady je kód skriptu jazyka C#:

public static void Run(string myQueueItem, out object record)
{
    record = new {
        Text = $"I'm running in a C# function! {myQueueItem}"
    };
}

Následující příklad ukazuje výstupní vazbu Mobile Apps v souboru function.json a funkci JavaScriptu, která používá vazbu. Funkce se aktivuje zprávou fronty a vytvoří nový záznam s pevně zakódovanou hodnotou vlastnosti Text .

Tady jsou data vazby v souboru function.json :

{
"bindings": [
    {
        "name": "myQueueItem",
        "queueName": "myqueue-items",
        "connection": "",
        "type": "queueTrigger",
        "direction": "in"
    },
    {
        "name": "record",
        "type": "mobileTable",
        "tableName": "MyTable",
        "connection": "My_MobileApp_Url",
        "apiKey": "My_MobileApp_Key",
        "direction": "out"
    }
],
"disabled": false
}

Oddíl konfigurace vysvětluje tyto vlastnosti.

Tady je javascriptový kód:

module.exports = async function (context, myQueueItem) {

    context.bindings.record = {
        text : "I'm running in a Node function! Data: '" + myQueueItem + "'"
    }   
};

Výstup – atributy

V knihovnách tříd jazyka C# použijte atribut MobileTable .

Informace o vlastnostech atributů, které můžete konfigurovat, naleznete v tématu Výstup – konfigurace. Tady je MobileTable příklad atributu v podpisu metody:

[FunctionName("MobileAppsOutput")]        
[return: MobileTable(ApiKeySetting = "MyMobileAppKey", TableName = "MyTable", MobileAppUriSetting = "MyMobileAppUri")]
public static object Run(
    [QueueTrigger("myqueue-items", Connection = "AzureWebJobsStorage")] string myQueueItem,
    TraceWriter log)
{
    ...
}

Výstup – konfigurace

Následující tabulka vysvětluje vlastnosti konfigurace vazby, které jste nastavili v souboru function.json a atributu MobileTable .

vlastnost function.json	Vlastnost atributu	Popis
type	Není k dispozici	Musí být nastavená na "mobileTable".
direction	Není k dispozici	Musí být nastavená na "out" (out).
Jméno	Není k dispozici	Název výstupního parametru v podpisu funkce
Tablename	TableName	Název tabulky dat mobilní aplikace
Připojení	MobileAppUriSetting	Název nastavení aplikace, které má adresu URL mobilní aplikace. Tato funkce používá tuto adresu URL k vytvoření požadovaných operací REST pro vaši mobilní aplikaci. Vytvořte v aplikaci funkcí nastavení aplikace, které obsahuje adresu URL mobilní aplikace, a pak zadejte název nastavení aplikace ve `connection` vlastnosti ve vstupní vazbě. Adresa URL vypadá takto `https://<appname>.azurewebsites.net`.
apiKey	ApiKeySetting	Název nastavení aplikace, které má klíč rozhraní API vaší mobilní aplikace. Zadejte klíč rozhraní API, pokud implementujete klíč rozhraní API v back-endu Node.js mobilní aplikace nebo implementujete klíč rozhraní API v back-endu mobilní aplikace .NET. Pokud chcete klíč zadat, vytvořte ve své aplikaci funkcí nastavení aplikace, které obsahuje klíč rozhraní API, a pak do vstupní vazby přidejte `apiKey` vlastnost s názvem nastavení aplikace.

Při místním vývoji přidejte nastavení aplikace do souboru local.settings.json v kolekci Values .

Důležité

Výstup – využití

Ve funkcích skriptu jazyka C# použijte pojmenovaný výstupní parametr typu out object pro přístup k výstupnímu záznamu. V knihovnách tříd jazyka MobileTable C# lze atribut použít s některým z následujících typů:

ICollector<T> nebo IAsyncCollector<T>, kde T je buď JObject nebo jakýkoli typ s public string Id vlastností.
out JObject
out T nebo out T[], kde T je jakýkoli typ s public string Id vlastností.

V Node.js funkcích se používá context.bindings.<name> pro přístup k výstupnímu záznamu.

Další kroky

Další informace o triggerech a vazbách Azure Functions

Vazby Mobile Apps pro Azure Functions

Balíčky – Funkce 1.x

Vstup

Vstup – příklad

Vstup – atributy

Vstup – konfigurace

Vstup – využití

Výstup

Výstup – příklad

Výstup – atributy

Výstup – konfigurace

Výstup – využití

Další kroky

Další materiály