Share via

FunctionApp Interface

  • Reference
Package:
com.azure.resourcemanager.appservice.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-appservice:2.44.0

Implements

FunctionAppBasic SupportsOneDeploy WebAppBase SupportsListingPrivateEndpointConnection SupportsListingPrivateLinkResource SupportsUpdatingPrivateEndpointConnection Updatable<Update>

public interface FunctionApp
extends FunctionAppBasic, WebAppBase, Updatable<Update>, SupportsListingPrivateLinkResource, SupportsListingPrivateEndpointConnection, SupportsUpdatingPrivateEndpointConnection, SupportsOneDeploy

An immutable client-side representation of an Azure Function App.

Method Summary

Modifier and Type Method and Description
abstract NameValuePair addFunctionKey(String functionName, String keyName, String keyValue)

Adds a key to a function in this function app.
abstract Mono<NameValuePair> addFunctionKeyAsync(String functionName, String keyName, String keyValue)

Adds a key to a function in this function app.
abstract FunctionDeploymentSlots deploymentSlots()
abstract String getMasterKey()
abstract Mono<String> getMasterKeyAsync()
abstract Map<String,String> listFunctionKeys(String functionName)

Retrieve the function key for a specific function.
abstract Mono<Map<String,String>> listFunctionKeysAsync(String functionName)

Retrieve the function key for a specific function.
abstract PagedIterable<FunctionEnvelope> listFunctions()

List function information elements.
abstract String managedEnvironmentId()

Retrieve the ID of the Azure Container Apps environment that the Function App runs on.
abstract Integer maxReplicas()

Retrieves the maximum replica count.
abstract Integer minReplicas()

Retrieves the minimum replica count.
abstract void removeFunctionKey(String functionName, String keyName)

Removes a key to a function in this function app.
abstract Mono<Void> removeFunctionKeyAsync(String functionName, String keyName)

Removes a key to a function in this function app.
abstract StorageAccount storageAccount()
abstract void syncTriggers()

Syncs the triggers on the function app.
abstract Mono<Void> syncTriggersAsync()

Syncs the triggers on the function app.
abstract void triggerFunction(String functionName, Object payload)

Triggers a function.
abstract Mono<Void> triggerFunctionAsync(String functionName, Object payload)

Triggers a function.

Method Details

addFunctionKey

public abstract NameValuePair addFunctionKey(String functionName, String keyName, String keyValue)

Adds a key to a function in this function app.

Parameters:

functionName - the name of the function
keyName - the name of the key to add
keyValue - optional. If not provided, a value will be generated.

Returns:

the added function key

addFunctionKeyAsync

public abstract Mono addFunctionKeyAsync(String functionName, String keyName, String keyValue)

Adds a key to a function in this function app.

Parameters:

functionName - the name of the function
keyName - the name of the key to add
keyValue - optional. If not provided, a value will be generated.

Returns:

the added function key

deploymentSlots

public abstract FunctionDeploymentSlots deploymentSlots()

Returns:

the entry point to deployment slot management API under the function app

getMasterKey

public abstract String getMasterKey()

Returns:

the master key for the function app

getMasterKeyAsync

public abstract Mono getMasterKeyAsync()

Returns:

the master key for the function app

listFunctionKeys

public abstract Map listFunctionKeys(String functionName)

Retrieve the function key for a specific function.

Parameters:

functionName - the name of the function

Returns:

the function key

listFunctionKeysAsync

public abstract Mono> listFunctionKeysAsync(String functionName)

Retrieve the function key for a specific function.

Parameters:

functionName - the name of the function

Returns:

the function key

listFunctions

public abstract PagedIterable listFunctions()

List function information elements.

Returns:

list of function information elements

managedEnvironmentId

public abstract String managedEnvironmentId()

Retrieve the ID of the Azure Container Apps environment that the Function App runs on.

Returns:

the ID of the Azure Container Apps environment

maxReplicas

public abstract Integer maxReplicas()

Retrieves the maximum replica count.

Returns:

the maximum replica count

minReplicas

public abstract Integer minReplicas()

Retrieves the minimum replica count.

Returns:

the minimum replica count

removeFunctionKey

public abstract void removeFunctionKey(String functionName, String keyName)

Removes a key to a function in this function app.

Parameters:

functionName - the name of the function
keyName - the name of the key to remove

removeFunctionKeyAsync

public abstract Mono removeFunctionKeyAsync(String functionName, String keyName)

Removes a key to a function in this function app.

Parameters:

functionName - the name of the function
keyName - the name of the key to remove

Returns:

the completable of the operation

storageAccount

public abstract StorageAccount storageAccount()

Returns:

the storage account associated with the function app

syncTriggers

public abstract void syncTriggers()

Syncs the triggers on the function app.

syncTriggersAsync

public abstract Mono syncTriggersAsync()

Syncs the triggers on the function app.

Returns:

a completable for the operation

triggerFunction

public abstract void triggerFunction(String functionName, Object payload)

Triggers a function.

Parameters:

functionName - the name of the function
payload - the payload to be serialized to JSON

triggerFunctionAsync

public abstract Mono triggerFunctionAsync(String functionName, Object payload)

Triggers a function.

Parameters:

functionName - the name of the function
payload - the payload to be serialized to JSON

Returns:

the completable of the operation

Applies to