Interface FunctionApp

All Superinterfaces:

FunctionAppBasic, com.azure.resourcemanager.resources.fluentcore.arm.models.GroupableResource<AppServiceManager, SiteInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasId, com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel<SiteInner>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasManager<AppServiceManager>, com.azure.resourcemanager.resources.fluentcore.arm.models.HasName, com.azure.resourcemanager.resources.fluentcore.arm.models.HasResourceGroup, com.azure.resourcemanager.resources.fluentcore.model.Indexable, com.azure.resourcemanager.resources.fluentcore.model.Refreshable<FunctionApp>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateEndpointConnection, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource, SupportsOneDeploy, com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection, com.azure.resourcemanager.resources.fluentcore.model.Updatable<FunctionApp.Update>, WebAppBase, WebSiteBase

public interface FunctionApp
extends FunctionAppBasic, WebAppBase, com.azure.resourcemanager.resources.fluentcore.model.Updatable<FunctionApp.Update>, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource, com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateEndpointConnection, com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection, SupportsOneDeploy

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.azure.resourcemanager.resources.fluentcore.arm.models.Resource

com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithRegion<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.DefinitionWithTags<T>, com.azure.resourcemanager.resources.fluentcore.arm.models.Resource.UpdateWithTags<T>

Field Summary

Fields inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource

DUMMY

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.
Mono<NameValuePair>	addFunctionKeyAsync(String functionName, String keyName, String keyValue)	Adds a key to a function in this function app.
FunctionDeploymentSlots	deploymentSlots()	Gets the entry point to deployment slot management API under the function app.
String	getMasterKey()	Gets the master key for the function app.
Mono<String>	getMasterKeyAsync()	Gets the master key for the function app.
Map<String,String>	listFunctionKeys(String functionName)	Retrieve the function key for a specific function.
Mono<Map<String,String>>	listFunctionKeysAsync(String functionName)	Retrieve the function key for a specific function.
com.azure.core.http.rest.PagedIterable<FunctionEnvelope>	listFunctions()	List function information elements.
String	managedEnvironmentId()	Retrieve the ID of the Azure Container Apps environment that the Function App runs on.
Integer	maxReplicas()	Retrieves the maximum replica count.
Integer	minReplicas()	Retrieves the minimum replica count.
void	removeFunctionKey(String functionName, String keyName)	Removes a key to a function in this function app.
Mono<Void>	removeFunctionKeyAsync(String functionName, String keyName)	Removes a key to a function in this function app.
StorageAccount	storageAccount()	Gets the storage account associated with the function app.
void	syncTriggers()	Syncs the triggers on the function app.
Mono<Void>	syncTriggersAsync()	Syncs the triggers on the function app.
void	triggerFunction(String functionName, Object payload)	Triggers a function.
Mono<Void>	triggerFunctionAsync(String functionName, Object payload)	Triggers a function.

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

id

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.HasInnerModel

innerModel

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

manager

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

name

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

resourceGroupName

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Indexable

key

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Refreshable

refresh, refreshAsync

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

region, regionName, tags, type

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateEndpointConnection

listPrivateEndpointConnections, listPrivateEndpointConnectionsAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsListingPrivateLinkResource

listPrivateLinkResources, listPrivateLinkResourcesAsync

Methods inherited from interface SupportsOneDeploy

deploy, deploy, deploy, deploy, deployAsync, deployAsync, deployAsync, deployAsync, getDeploymentStatus, getDeploymentStatusAsync, pushDeploy, pushDeployAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.collection.SupportsUpdatingPrivateEndpointConnection

approvePrivateEndpointConnection, approvePrivateEndpointConnectionAsync, rejectPrivateEndpointConnection, rejectPrivateEndpointConnectionAsync

Methods inherited from interface com.azure.resourcemanager.resources.fluentcore.model.Updatable

update

Methods inherited from interface WebAppBase

alwaysOn, applySlotConfigurations, applySlotConfigurationsAsync, autoSwapSlotName, defaultDocuments, deploy, diagnosticLogsConfig, documentRoot, ftpsState, getAppSettings, getAppSettingsAsync, getAuthenticationConfig, getAuthenticationConfigAsync, getConnectionStrings, getConnectionStringsAsync, getContainerLogs, getContainerLogsAsync, getContainerLogsZip, getContainerLogsZipAsync, getHostnameBindings, getHostnameBindingsAsync, getPublishingProfile, getPublishingProfileAsync, getSiteAppSettings, getSiteAppSettingsAsync, getSourceControl, getSourceControlAsync, http20Enabled, ipSecurityRules, javaContainer, javaContainerVersion, javaVersion, linuxFxVersion, localMySqlEnabled, managedPipelineMode, minTlsVersion, netFrameworkVersion, nodeVersion, phpVersion, platformArchitecture, publicNetworkAccess, pythonVersion, remoteDebuggingEnabled, remoteDebuggingVersion, resetSlotConfigurations, resetSlotConfigurationsAsync, restart, restartAsync, scmType, start, startAsync, stop, stopAsync, streamAllLogs, streamAllLogsAsync, streamApplicationLogs, streamApplicationLogsAsync, streamDeploymentLogs, streamDeploymentLogsAsync, streamHttpLogs, streamHttpLogsAsync, streamTraceLogs, streamTraceLogsAsync, swap, swapAsync, systemAssignedManagedServiceIdentityPrincipalId, systemAssignedManagedServiceIdentityTenantId, userAssignedManagedServiceIdentityIds, verifyDomainOwnership, verifyDomainOwnershipAsync, virtualApplications, webSocketsEnabled, windowsFxVersion, zipDeploy, zipDeploy, zipDeployAsync, zipDeployAsync

Methods inherited from interface WebSiteBase

appServicePlanId, availabilityState, clientAffinityEnabled, clientCertEnabled, clientCertExclusionPaths, cloningInfo, containerSize, dailyMemoryTimeQuota, defaultHostname, enabled, enabledHostNames, hostingEnvironmentProfile, hostnames, hostnamesDisabled, hostnameSslStates, httpsOnly, hyperV, identity, isDefaultContainer, lastModifiedTime, maxNumberOfWorkers, operatingSystem, outboundIPAddresses, possibleOutboundIpAddresses, redundancyMode, repositorySiteName, scmSiteAlsoStopped, slotSwapStatus, state, suspendedTill, targetSwapSlot, trafficManagerHostNames, usageState

Method Details

deploymentSlots

FunctionDeploymentSlots deploymentSlots()

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

Returns:

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

storageAccount

StorageAccount storageAccount()

Gets the storage account associated with the function app.

Returns:

the storage account associated with the function app

getMasterKey

String getMasterKey()

Gets the master key for the function app.

Returns:

the master key for the function app

getMasterKeyAsync

Mono<String> getMasterKeyAsync()

Gets the master key for the function app.

Returns:

the master key for the function app

listFunctions

com.azure.core.http.rest.PagedIterable<FunctionEnvelope> listFunctions()

List function information elements.

Returns:

list of function information elements

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

Mono<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

Mono<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

Mono<Void> 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

Mono<Void> 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

Mono<Void> syncTriggersAsync()

Syncs the triggers on the function app.

Returns:

a completable for the operation

managedEnvironmentId

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

See Also:

• FunctionApp.DefinitionStages.WithManagedEnvironment.withManagedEnvironmentId(String)

maxReplicas

Integer maxReplicas()

Retrieves the maximum replica count.

Returns:

the maximum replica count

minReplicas

Integer minReplicas()

Retrieves the minimum replica count.

Returns:

the minimum replica count