Site Class

Definition

A web app, a mobile app backend, or an API app.

[Microsoft.Rest.Serialization.JsonTransformation]
public class Site : Microsoft.Azure.Management.WebSites.Models.Resource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type Site = class
    inherit Resource
Public Class Site
Inherits Resource
Inheritance
Attributes

Constructors

Site()

Initializes a new instance of the Site class.

Site(String, String, String, String, String, IDictionary<String,String>, String, IList<String>, String, Nullable<UsageState>, Nullable<Boolean>, IList<String>, Nullable<SiteAvailabilityState>, IList<HostNameSslState>, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<DateTime>, SiteConfig, IList<String>, Nullable<Boolean>, String, HostingEnvironmentProfile, Nullable<Boolean>, Nullable<Boolean>, Nullable<ClientCertMode>, String, Nullable<Boolean>, String, String, String, Nullable<Int32>, Nullable<Int32>, Nullable<DateTime>, Nullable<Int32>, CloningInfo, String, Nullable<Boolean>, String, SlotSwapStatus, Nullable<Boolean>, Nullable<RedundancyMode>, Nullable<Guid>, Nullable<Boolean>, String, String, ManagedServiceIdentity, ExtendedLocation)

Initializes a new instance of the Site class.

Properties

AvailabilityState

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

ClientAffinityEnabled

Gets or sets &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 or sets &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 or sets client certificate authentication comma-separated exclusion paths

ClientCertMode

Gets or sets this composes with ClientCertEnabled setting.

  • ClientCertEnabled: false means ClientCert is ignored.
  • ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.
  • ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. Possible values include: 'Required', 'Optional', 'OptionalInteractiveUser'
CloningInfo

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

ContainerSize

Gets or sets size of the function container.

CustomDomainVerificationId

Gets or sets unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.

DailyMemoryTimeQuota

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

DefaultHostName

Gets default hostname of the app. Read-only.

Enabled

Gets or sets &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.

ExtendedLocation
HostingEnvironmentProfile

Gets or sets app Service Environment to use for the app.

HostNames

Gets hostnames associated with the app.

HostNamesDisabled

Gets or sets &lt;code&gt;true&lt;/code&gt; to disable the public 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 or sets hostname SSL states are used to manage the SSL bindings for app's hostnames.

HttpsOnly

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

HyperV

Gets or sets hyper-V sandbox.

Id

Gets resource Id.

(Inherited from Resource)
Identity
InProgressOperationId

Gets specifies an operation id if this site has a pending operation.

IsDefaultContainer

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

IsXenon

Gets or sets obsolete: Hyper-V sandbox.

KeyVaultReferenceIdentity

Gets or sets identity to use for Key Vault Reference authentication.

Kind

Gets or sets kind of resource.

(Inherited from Resource)
LastModifiedTimeUtc

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

Location

Gets or sets resource Location.

(Inherited from Resource)
MaxNumberOfWorkers

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

Name

Gets resource Name.

(Inherited from Resource)
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 or sets site redundancy mode. Possible values include: 'None', 'Manual', 'Failover', 'ActiveActive', 'GeoRedundant'

RepositorySiteName

Gets name of the repository site.

Reserved

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

ResourceGroup

Gets name of the resource group the app belongs to. Read-only.

ScmSiteAlsoStopped

Gets or sets &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 or sets resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

SiteConfig

Gets or sets configuration of the app.

SlotSwapStatus

Gets status of the last deployment slot swap operation.

State

Gets current state of the app.

StorageAccountRequired

Gets or sets checks if Customer provided storage account is required

SuspendedTill

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

Tags

Gets or sets resource tags.

(Inherited from Resource)
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

Gets resource type.

(Inherited from Resource)
UsageState

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

VirtualNetworkSubnetId

Gets or sets azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}

Methods

Validate()

Validate the object.

Applies to