Share via


IWebSiteBase Interface

Definition

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

public interface IWebSiteBase : Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasInner<Microsoft.Azure.Management.AppService.Fluent.Models.SiteInner>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasResourceGroup, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IResource
type IWebSiteBase = interface
    interface IResource
    interface IIndexable
    interface IHasId
    interface IHasName
    interface IHasResourceGroup
    interface IHasInner<SiteInner>
Public Interface IWebSiteBase
Implements IHasInner(Of SiteInner), IHasResourceGroup, IResource
Derived
Implements

Properties

AvailabilityState

Gets management information availability state for the app. Possible values include: 'Normal', 'Limited', 'DisasterRecoveryMode'

ClientAffinityEnabled

Gets &lt;code&gt;true&lt;/code&gt; to enable client affinity; &lt;code&gt;false&lt;/code&gt; to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is &lt;code&gt;true&lt;/code&gt;.

ClientCertEnabled

Gets &lt;code&gt;true&lt;/code&gt; to enable client certificate authentication (TLS mutual authentication); otherwise, &lt;code&gt;false&lt;/code&gt;. Default is &lt;code&gt;false&lt;/code&gt;.

ClientCertExclusionPaths

Gets client certificate authentication comma-separated exclusion paths

CloningInfo

Gets if specified during app creation, the app is cloned from a source app.

ContainerSize

Gets size of the function container.

DailyMemoryTimeQuota

Gets maximum allowed daily memory-time quota (applicable on dynamic apps only).

DefaultHostName

Gets default hostname of the app. Read-only.

Enabled

Gets &lt;code&gt;true&lt;/code&gt; if the app is enabled; otherwise, &lt;code&gt;false&lt;/code&gt;. Setting this value to false disables the app (takes the app offline).

EnabledHostNames

Gets enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames.

HostingEnvironmentProfile

Gets app Service Environment to use for the app.

HostNames

Gets hostnames associated with the app.

HostNamesDisabled

Gets &lt;code&gt;true&lt;/code&gt; to disable the hostnames of the app; otherwise, &lt;code&gt;false&lt;/code&gt;. If &lt;code&gt;true&lt;/code&gt;, the app is only accessible via API management process.

HostNameSslStates

Gets hostname SSL states are used to manage the SSL bindings for app's hostnames.

HttpsOnly

Gets httpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

HyperV

Gets hyper-V sandbox.

Id

Gets the resource id string

(Inherited from IHasId)
Identity
Inner (Inherited from IHasInner<T>)
IsDefaultContainer

Gets &lt;code&gt;true&lt;/code&gt; if the app is a default container; otherwise, &lt;code&gt;false&lt;/code&gt;.

Key (Inherited from IIndexable)
Kind

Gets kind of resource.

LastModifiedTimeUtc

Gets last time the app was modified, in UTC. Read-only.

MaxNumberOfWorkers

Gets maximum number of workers. This only applies to Functions container.

Name

Gets the name of the resource

(Inherited from IHasName)
OperatingSystem

Gets the operating system.

OutboundIpAddresses

Gets list of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.

PossibleOutboundIpAddresses

Gets list of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.

RedundancyMode

Gets site redundancy mode. Possible values include: 'None', 'Manual', 'Failover', 'ActiveActive', 'GeoRedundant'

Region (Inherited from IResource)
RegionName (Inherited from IResource)
RepositorySiteName

Gets name of the repository site.

Reserved

Gets &lt;code&gt;true&lt;/code&gt; if reserved; otherwise, &lt;code&gt;false&lt;/code&gt;.

ResourceGroupName (Inherited from IHasResourceGroup)
ScmSiteAlsoStopped

Gets &lt;code&gt;true&lt;/code&gt; to stop SCM (KUDU) site when the app is stopped; otherwise, &lt;code&gt;false&lt;/code&gt;. The default is &lt;code&gt;false&lt;/code&gt;.

ServerFarmId

Gets resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

SlotSwapStatus

Gets status of the last deployment slot swap operation.

SuspendedTill

Gets app suspended till in case memory-time quota is exceeded.

Tags (Inherited from IResource)
TargetSwapSlot

Gets specifies which deployment slot this app will swap into. Read-only.

TrafficManagerHostNames

Gets azure Traffic Manager hostnames associated with the app. Read-only.

Type (Inherited from IResource)
UsageState

Gets state indicating whether the app has exceeded its quota usage. Read-only. Possible values include: 'Normal', 'Exceeded'

Applies to