IFunctionApp Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
An immutable client-side representation of an Azure Function App.
public interface IFunctionApp : Microsoft.Azure.Management.AppService.Fluent.IWebAppBase, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IBeta, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IGroupableResource<Microsoft.Azure.Management.AppService.Fluent.IAppServiceManager,Microsoft.Azure.Management.AppService.Fluent.Models.SiteInner>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasInner<Microsoft.Azure.Management.AppService.Fluent.Models.SiteInner>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasManager<Microsoft.Azure.Management.AppService.Fluent.IAppServiceManager>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.ResourceActions.IRefreshable<Microsoft.Azure.Management.AppService.Fluent.IFunctionApp>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.ResourceActions.IUpdatable<Microsoft.Azure.Management.AppService.Fluent.FunctionApp.Update.IUpdate>type IFunctionApp = interface
interface IBeta
interface IWebAppBase
interface IHasName
interface IGroupableResource<IAppServiceManager, SiteInner>
interface IResource
interface IIndexable
interface IHasId
interface IHasResourceGroup
interface IHasManager<IAppServiceManager>
interface IHasInner<SiteInner>
interface IRefreshable<IFunctionApp>
interface IUpdatable<IUpdate>Public Interface IFunctionApp
Implements IBeta, IGroupableResource(Of IAppServiceManager, SiteInner), IHasInner(Of SiteInner), IHasManager(Of IAppServiceManager), IRefreshable(Of IFunctionApp), IUpdatable(Of IUpdate), IWebAppBase- Implements
Properties
| AlwaysOn |
Gets if the web app is always on. (Inherited from IWebAppBase) |
| AppServicePlanId |
Gets The resource ID of the app service plan. (Inherited from IWebAppBase) |
| AutoSwapSlotName |
Gets the auto swap slot name. (Inherited from IWebAppBase) |
| AvailabilityState |
Gets management information availability state for the web app. (Inherited from IWebAppBase) |
| ClientAffinityEnabled |
Gets if the client affinity is enabled when load balancing http request for multiple instances of the web app. (Inherited from IWebAppBase) |
| ClientCertEnabled |
Gets if the client certificate is enabled for the web app. (Inherited from IWebAppBase) |
| CloningInfo |
Gets information about whether the web app is cloned from another. (Inherited from IWebAppBase) |
| ContainerSize |
Gets size of a function container. (Inherited from IWebAppBase) |
| DefaultDocuments |
Gets the default documents. (Inherited from IWebAppBase) |
| DefaultHostName |
Gets default hostname of the web app. (Inherited from IWebAppBase) |
| DeploymentSlots |
Gets the entry point to deployment slot management API under the function app. |
| DiagnosticLogsConfig |
Gets the diagnostic logs configuration. (Inherited from IWebAppBase) |
| DocumentRoot |
Gets the root directory for the web app. (Inherited from IWebAppBase) |
| Enabled |
Gets true if the site is enabled; otherwise, false. (Inherited from IWebAppBase) |
| EnabledHostNames |
Gets host names for the web app that are enabled. (Inherited from IWebAppBase) |
| FtpsState |
Gets the state of FTP / FTPS service. (Inherited from IWebAppBase) |
| HostNames |
Gets hostnames associated with web app. (Inherited from IWebAppBase) |
| HostNamesDisabled |
Gets if the public hostnames are disabled the web app. If set to true the app is only accessible via API Management process. (Inherited from IWebAppBase) |
| HostNameSslStates |
Gets list of SSL states used to manage the SSL bindings for site's hostnames. (Inherited from IWebAppBase) |
| Http20Enabled |
Gets whether to allow clients to connect over http2.0. (Inherited from IWebAppBase) |
| HttpsOnly |
True if the web app is configured to accept only HTTPS requests. HTTP requests will be redirected. (Inherited from IWebAppBase) |
| Id |
Gets the resource id string (Inherited from IHasId) |
| Inner | (Inherited from IHasInner<T>) |
| IsDefaultContainer |
Gets site is a default container. (Inherited from IWebAppBase) |
| JavaContainer |
Gets Java container. (Inherited from IWebAppBase) |
| JavaContainerVersion |
Gets Java container version. (Inherited from IWebAppBase) |
| JavaVersion |
Gets Java version. (Inherited from IWebAppBase) |
| Key | (Inherited from IIndexable) |
| LastModifiedTime |
Gets Last time web app was modified in UTC. (Inherited from IWebAppBase) |
| LinuxFxVersion |
Gets the Linux app framework and version if this is a Linux web app. (Inherited from IWebAppBase) |
| LocalMySqlEnabled |
Gets whether local MySQL is enabled. (Inherited from IWebAppBase) |
| ManagedPipelineMode |
Gets managed pipeline mode. (Inherited from IWebAppBase) |
| Manager |
Gets the manager client type of this resource type. (Inherited from IHasManager<ManagerT>) |
| MinTlsVersion |
Gets the minimum version of TLS required for SSL requests for the web app (Inherited from IWebAppBase) |
| Name |
Gets the name of the resource (Inherited from IHasName) |
| NetFrameworkVersion |
Gets the .NET Framework version. (Inherited from IWebAppBase) |
| NodeVersion |
Gets the version of Node.JS. (Inherited from IWebAppBase) |
| OperatingSystem |
Gets the operating system the web app is running on. (Inherited from IWebAppBase) |
| OutboundIPAddresses |
Gets list of IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. (Inherited from IWebAppBase) |
| PhpVersion |
Gets the version of PHP. (Inherited from IWebAppBase) |
| PlatformArchitecture |
Gets the architecture of the platform, either 32 bit (x86) or 64 bit (x64). (Inherited from IWebAppBase) |
| PythonVersion |
Gets the version of Python. (Inherited from IWebAppBase) |
| Region | (Inherited from IResource) |
| RegionName | (Inherited from IResource) |
| RemoteDebuggingEnabled |
Gets if the remote eebugging is enabled. (Inherited from IWebAppBase) |
| RemoteDebuggingVersion |
Gets the remote debugging version. (Inherited from IWebAppBase) |
| RepositorySiteName |
Gets name of repository site. (Inherited from IWebAppBase) |
| ResourceGroupName | (Inherited from IHasResourceGroup) |
| ScmSiteAlsoStopped |
Gets whether to stop SCM (KUDU) site when the web app is stopped. Default is false. (Inherited from IWebAppBase) |
| ScmType |
Gets the SCM configuration for the web app. (Inherited from IWebAppBase) |
| State |
Gets state of the web app. (Inherited from IWebAppBase) |
| StorageAccount |
Gets the storage account associated with the function app. |
| SystemAssignedManagedServiceIdentityPrincipalId |
Gets the System Assigned (Local) Managed Service Identity specific Active Directory service principal ID assigned to the web app. (Inherited from IWebAppBase) |
| SystemAssignedManagedServiceIdentityTenantId |
Gets the System Assigned (Local) Managed Service Identity specific Active Directory tenant ID assigned to the web app. (Inherited from IWebAppBase) |
| Tags | (Inherited from IResource) |
| TargetSwapSlot |
Gets which slot this app will swap into. (Inherited from IWebAppBase) |
| TrafficManagerHostNames |
Gets list of Azure Traffic manager host names associated with web app. (Inherited from IWebAppBase) |
| Type | (Inherited from IResource) |
| UsageState |
Gets state indicating whether web app has exceeded its quota usage. (Inherited from IWebAppBase) |
| UserAssignedManagedServiceIdentityIds |
Gets The ids of the user assigned identities. (Inherited from IWebAppBase) |
| VirtualApplications |
Gets the virtual applications and their virtual directories in this web app. (Inherited from IWebAppBase) |
| WebSocketsEnabled |
Gets if web socket is enabled. (Inherited from IWebAppBase) |
Methods
| AddFunctionKey(String, String, String) |
Adds a key to a function in this function app. |
| AddFunctionKeyAsync(String, String, String, CancellationToken) |
Adds a key to a function in this function app. |
| ApplySlotConfigurations(String) |
Apply the slot (or sticky) configurations from the specified slot to the current one. This is useful for "Swap with Preview". (Inherited from IWebAppBase) |
| ApplySlotConfigurationsAsync(String, CancellationToken) |
Apply the slot (or sticky) configurations from the specified slot to the current one. This is useful for "Swap with Preview". (Inherited from IWebAppBase) |
| Deploy() |
First step specifying the parameters to make a web deployment (MS Deploy) to the web app. (Inherited from IWebAppBase) |
| GetAppSettings() | (Inherited from IWebAppBase) |
| GetAppSettingsAsync(CancellationToken) | (Inherited from IWebAppBase) |
| GetAuthenticationConfig() | (Inherited from IWebAppBase) |
| GetAuthenticationConfigAsync(CancellationToken) | (Inherited from IWebAppBase) |
| GetConnectionStrings() | (Inherited from IWebAppBase) |
| GetConnectionStringsAsync(CancellationToken) | (Inherited from IWebAppBase) |
| GetContainerLogs() | (Inherited from IWebAppBase) |
| GetContainerLogsAsync(CancellationToken) | (Inherited from IWebAppBase) |
| GetContainerLogsZip() | (Inherited from IWebAppBase) |
| GetContainerLogsZipAsync(CancellationToken) | (Inherited from IWebAppBase) |
| GetHostNameBindings() | (Inherited from IWebAppBase) |
| GetHostNameBindingsAsync(CancellationToken) | (Inherited from IWebAppBase) |
| GetMasterKey() | |
| GetMasterKeyAsync(CancellationToken) | |
| GetPublishingProfile() | (Inherited from IWebAppBase) |
| GetPublishingProfileAsync(CancellationToken) | (Inherited from IWebAppBase) |
| GetSourceControl() | (Inherited from IWebAppBase) |
| GetSourceControlAsync(CancellationToken) | (Inherited from IWebAppBase) |
| ListFunctionKeys(String) |
Retrieve the function key for a specific function. |
| ListFunctionKeysAsync(String, CancellationToken) |
Retrieve the function key for a specific function. |
| ListFunctions() |
List the functions |
| ListFunctionsAsync(Boolean, CancellationToken) |
List the functions |
| Refresh() |
Refreshes the resource to sync with Azure. (Inherited from IRefreshable<T>) |
| RefreshAsync(CancellationToken) |
Refreshes the resource to sync with Azure. (Inherited from IRefreshable<T>) |
| RemoveFunctionKey(String, String) |
Removes a key to a function in this function app. |
| RemoveFunctionKeyAsync(String, String, CancellationToken) |
Removes a key to a function in this function app. |
| ResetSlotConfigurations() |
Reset the slot to its original configurations. (Inherited from IWebAppBase) |
| ResetSlotConfigurationsAsync(CancellationToken) |
Reset the slot to its original configurations. (Inherited from IWebAppBase) |
| Restart() |
Restarts the web app or deployment slot. (Inherited from IWebAppBase) |
| RestartAsync(CancellationToken) |
Restarts the web app or deployment slot. (Inherited from IWebAppBase) |
| Start() |
Starts the web app or deployment slot. (Inherited from IWebAppBase) |
| StartAsync(CancellationToken) |
Starts the web app or deployment slot. (Inherited from IWebAppBase) |
| Stop() |
Stops the web app or deployment slot. (Inherited from IWebAppBase) |
| StopAsync(CancellationToken) |
Stops the web app or deployment slot. (Inherited from IWebAppBase) |
| StreamAllLogs() |
Gets a open stream to all logs. (Inherited from IWebAppBase) |
| StreamAllLogsAsync(CancellationToken) |
Gets a open stream to all logs. (Inherited from IWebAppBase) |
| StreamApplicationLogs() |
Gets a open stream to the application logs. (Inherited from IWebAppBase) |
| StreamApplicationLogsAsync(CancellationToken) |
Gets a open stream to the application logs. (Inherited from IWebAppBase) |
| StreamDeploymentLogs() |
Gets a open stream to the deployment logs. (Inherited from IWebAppBase) |
| StreamDeploymentLogsAsync(CancellationToken) |
Gets a open stream to the deployment logs. (Inherited from IWebAppBase) |
| StreamHttpLogs() |
Gets a open stream to the HTTP logs. (Inherited from IWebAppBase) |
| StreamHttpLogsAsync(CancellationToken) |
Gets a open stream to the HTTP logs. (Inherited from IWebAppBase) |
| StreamTraceLogs() |
Gets a open stream to the trace logs. (Inherited from IWebAppBase) |
| StreamTraceLogsAsync(CancellationToken) |
Gets a open stream to the trace logs. (Inherited from IWebAppBase) |
| Swap(String) |
Swaps the app running in the current web app / slot with the app running in the specified slot. (Inherited from IWebAppBase) |
| SwapAsync(String, CancellationToken) |
Swaps the app running in the current web app / slot with the app running in the specified slot. (Inherited from IWebAppBase) |
| SyncTriggers() |
Syncs the triggers on the function app. |
| SyncTriggersAsync(CancellationToken) |
Gets Syncs the triggers on the function app. |
| Update() | (Inherited from IUpdatable<T>) |
| VerifyDomainOwnership(String, String) |
Verifies the ownership of the domain for a certificate order by verifying a hostname of the domain is bound to this web app. (Inherited from IWebAppBase) |
| VerifyDomainOwnershipAsync(String, String, CancellationToken) |
Verifies the ownership of the domain for a certificate order by verifying a hostname of the domain is bound to this web app. (Inherited from IWebAppBase) |
Applies to
Azure SDK for .NET