Interface FunctionApp
- All Superinterfaces:
FunctionAppBasic
,GroupableResource<AppServiceManager,
,SiteInner> HasId
,HasInnerModel<SiteInner>
,HasManager<AppServiceManager>
,HasName
,HasResourceGroup
,Indexable
,Refreshable<FunctionApp>
,Resource
,SupportsListingPrivateEndpointConnection
,SupportsListingPrivateLinkResource
,SupportsUpdatingPrivateEndpointConnection
,Updatable<FunctionApp.Update>
,WebAppBase
,WebSiteBase
public interface FunctionApp
extends FunctionAppBasic, WebAppBase, Updatable<FunctionApp.Update>, SupportsListingPrivateLinkResource, SupportsListingPrivateEndpointConnection, SupportsUpdatingPrivateEndpointConnection
An immutable client-side representation of an Azure Function App.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
Container interface for all the definitions that need to be implemented.static interface
Grouping of all the function app definition stages.static interface
The template for a function app update operation, containing all the settings that can be modified.static interface
Grouping of all the function app update stages.Nested classes/interfaces inherited from interface com.azure.resourcemanager.resources.fluentcore.arm.models.Resource
Resource.DefinitionWithRegion<T extends Object>, Resource.DefinitionWithTags<T extends Object>, Resource.UpdateWithTags<T extends Object>
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddFunctionKey
(String functionName, String keyName, String keyValue) Adds a key to a function in this function app.addFunctionKeyAsync
(String functionName, String keyName, String keyValue) Adds a key to a function in this function app.listFunctionKeys
(String functionName) Retrieve the function key for a specific function.listFunctionKeysAsync
(String functionName) Retrieve the function key for a specific function.com.azure.core.http.rest.PagedIterable<FunctionEnvelope>
List function information elements.void
removeFunctionKey
(String functionName, String keyName) Removes a key to a function in this function app.removeFunctionKeyAsync
(String functionName, String keyName) Removes a key to a function in this function app.void
Syncs the triggers on the function app.Syncs the triggers on the function app.void
triggerFunction
(String functionName, Object payload) Triggers a function.triggerFunctionAsync
(String functionName, Object payload) Triggers a function.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.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 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 com.azure.resourcemanager.appservice.models.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, 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 com.azure.resourcemanager.appservice.models.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()- 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
- 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
Retrieve the function key for a specific function.- Parameters:
functionName
- the name of the function- Returns:
- the function key
-
listFunctionKeysAsync
Retrieve the function key for a specific function.- Parameters:
functionName
- the name of the function- Returns:
- the function key
-
addFunctionKey
Adds a key to a function in this function app.- Parameters:
functionName
- the name of the functionkeyName
- the name of the key to addkeyValue
- optional. If not provided, a value will be generated.- Returns:
- the added function key
-
addFunctionKeyAsync
Adds a key to a function in this function app.- Parameters:
functionName
- the name of the functionkeyName
- the name of the key to addkeyValue
- optional. If not provided, a value will be generated.- Returns:
- the added function key
-
removeFunctionKey
Removes a key to a function in this function app.- Parameters:
functionName
- the name of the functionkeyName
- the name of the key to remove
-
removeFunctionKeyAsync
Removes a key to a function in this function app.- Parameters:
functionName
- the name of the functionkeyName
- the name of the key to remove- Returns:
- the completable of the operation
-
triggerFunction
Triggers a function.- Parameters:
functionName
- the name of the functionpayload
- the payload to be serialized to JSON
-
triggerFunctionAsync
Triggers a function.- Parameters:
functionName
- the name of the functionpayload
- the payload to be serialized to JSON- Returns:
- the completable of the operation
-
syncTriggers
void syncTriggers()Syncs the triggers on the function app. -
syncTriggersAsync
Syncs the triggers on the function app.- Returns:
- a completable for the operation
-