Package com.microsoft.azure.management.appservice

Interface FunctionApp

All Superinterfaces:

GroupableResource<com.microsoft.azure.management.appservice.implementation.AppServiceManager,com.microsoft.azure.management.appservice.implementation.SiteInner>, HasId, HasInner<com.microsoft.azure.management.appservice.implementation.SiteInner>, HasManager<com.microsoft.azure.management.appservice.implementation.AppServiceManager>, HasName, HasResourceGroup, Indexable, Refreshable<FunctionApp>, Resource, Updatable<FunctionApp.Update>, WebAppBase

@Beta
public interface FunctionApp
extends WebAppBase, Refreshable<FunctionApp>, Updatable<FunctionApp.Update>

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FunctionApp.Definition	Container interface for all the definitions that need to be implemented.
static interface	FunctionApp.DefinitionStages	Grouping of all the function app definition stages.
static interface	FunctionApp.Update	The template for a function app update operation, containing all the settings that can be modified.
static interface	FunctionApp.UpdateStages	Grouping of all the function app update stages.

Nested classes/interfaces inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource

Resource.DefinitionWithRegion<T>, Resource.DefinitionWithTags<T>, Resource.UpdateWithTags<T>

Method Summary

Modifier and Type	Method	Description
NameValuePair	addFunctionKey(String functionName, String keyName, String keyValue)	Adds a key to a function in this function app.
rx.Observable<NameValuePair>	addFunctionKeyAsync(String functionName, String keyName, String keyValue)	Adds a key to a function in this function app.
FunctionDeploymentSlots	deploymentSlots()
String	getMasterKey()
rx.Observable<String>	getMasterKeyAsync()
Map<String,String>	listFunctionKeys(String functionName)	Retrieve the function key for a specific function.
rx.Observable<Map<String,String>>	listFunctionKeysAsync(String functionName)	Retrieve the function key for a specific function.
void	removeFunctionKey(String functionName, String keyName)	Removes a key to a function in this function app.
rx.Completable	removeFunctionKeyAsync(String functionName, String keyName)	Removes a key to a function in this function app.
StorageAccount	storageAccount()
void	syncTriggers()	Syncs the triggers on the function app.
rx.Completable	syncTriggersAsync()	Syncs the triggers on the function app.
void	triggerFunction(String functionName, Object payload)	Triggers a function.
rx.Completable	triggerFunctionAsync(String functionName, Object payload)	Triggers a function.

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasId

id

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.HasInner

inner

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager

manager

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasName

name

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup

resourceGroupName

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Indexable

key

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Refreshable

refresh, refreshAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.Resource

region, regionName, tags, type

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Updatable

update

Methods inherited from interface com.microsoft.azure.management.appservice.WebAppBase

alwaysOn, applySlotConfigurations, applySlotConfigurationsAsync, appServicePlanId, autoSwapSlotName, availabilityState, clientAffinityEnabled, clientCertEnabled, cloningInfo, containerSize, defaultDocuments, defaultHostName, deploy, diagnosticLogsConfig, documentRoot, enabled, enabledHostNames, ftpsState, getAppSettings, getAppSettingsAsync, getAuthenticationConfig, getAuthenticationConfigAsync, getConnectionStrings, getConnectionStringsAsync, getContainerLogs, getContainerLogsAsync, getContainerLogsZip, getContainerLogsZipAsync, getHostNameBindings, getHostNameBindingsAsync, getPublishingProfile, getPublishingProfileAsync, getSiteAppSettings, getSiteAppSettingsAsync, getSourceControl, getSourceControlAsync, hostNames, hostNamesDisabled, hostNameSslStates, http20Enabled, httpsOnly, isDefaultContainer, javaContainer, javaContainerVersion, javaVersion, lastModifiedTime, linuxFxVersion, localMySqlEnabled, managedPipelineMode, minTlsVersion, netFrameworkVersion, nodeVersion, operatingSystem, outboundIPAddresses, phpVersion, platformArchitecture, pythonVersion, remoteDebuggingEnabled, remoteDebuggingVersion, repositorySiteName, resetSlotConfigurations, resetSlotConfigurationsAsync, restart, restartAsync, scmSiteAlsoStopped, scmType, start, startAsync, state, stop, stopAsync, streamAllLogs, streamAllLogsAsync, streamApplicationLogs, streamApplicationLogsAsync, streamDeploymentLogs, streamDeploymentLogsAsync, streamHttpLogs, streamHttpLogsAsync, streamTraceLogs, streamTraceLogsAsync, swap, swapAsync, systemAssignedManagedServiceIdentityPrincipalId, systemAssignedManagedServiceIdentityTenantId, targetSwapSlot, trafficManagerHostNames, usageState, userAssignedManagedServiceIdentityIds, verifyDomainOwnership, verifyDomainOwnershipAsync, virtualApplications, webSocketsEnabled, zipDeploy, zipDeploy, zipDeployAsync, zipDeployAsync

Method Details

deploymentSlots

@Beta(V1_3_0)
FunctionDeploymentSlots deploymentSlots()

Returns:

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

storageAccount

StorageAccount storageAccount()

Returns:

the storage account associated with the function app

getMasterKey

String getMasterKey()

Returns:

the master key for the function app

getMasterKeyAsync

rx.Observable<String> getMasterKeyAsync()

Returns:

the master key for the function app

listFunctionKeys

Map<String,String> listFunctionKeys(String functionName)

Retrieve the function key for a specific function.

Parameters:

functionName - the name of the function

Returns:

the function key

listFunctionKeysAsync

rx.Observable<Map<String,String>> listFunctionKeysAsync(String functionName)

Retrieve the function key for a specific function.

Parameters:

functionName - the name of the function

Returns:

the function key

addFunctionKey

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

rx.Observable<NameValuePair> 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

removeFunctionKey

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

rx.Completable 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

triggerFunction

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

rx.Completable 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

syncTriggers

void syncTriggers()

Syncs the triggers on the function app.

syncTriggersAsync

rx.Completable syncTriggersAsync()

Syncs the triggers on the function app.

Returns:

a completable for the operation