WebSite Class

Definition

Describes a web site.

public class WebSite
type WebSite = class
Public Class WebSite
Inheritance
WebSite

Constructors

WebSite()

Initializes a new instance of the WebSite class.

Properties

AdminEnabled

Optional. Read-only. This value is always true.

AvailabilityState

Optional. The state of the availability of management information for the web site. Possible values are Normal or Limited. Normal means that the web site is running correctly and that management information for the web site is available. Limited means that only partial management information for the web site is available and that detailed web site information is unavailable.

Enabled

Optional. The current state of the web site. This is true if the site is enabled and false otherwise. Setting this value to false disables the site (takes the site offline).

EnabledHostNames

Optional. An array of strings that contains enabled host names for the web site. By default, these are [SiteName].azurewebsites.net and [SiteName].scm.azurewebsites.net.

HostNames

Optional. An array of strings that contains the public host names for the web site, including custom domains. Important: When you add a custom domain in a PUT operation, be sure to include every host name that you want for the web site. To delete a custom domain name in a PUT operation, include all of the host names for the web site that you want to keep, but leave out the one that you want to delete.

HostNameSslStates

Optional. SSL states bound to the web site.

LastModifiedTimeUtc

Optional. A dateTime value that contains, in Coordinated Universal Time, the last time the web site was modified.

Name

Optional. The name of the web site.

RepositorySiteName

Optional. The name of the web site repository.

RuntimeAvailabilityState

Optional. The current availability state for the web site. Possible values are Normal, Degraded, or NotAvailable: Normal: the web site is running correctly; Degraded: the web site is running temporarily in a degraded mode (typically with less memory and a shared instance); Not Available: due to an unexpected issue, the site has been excluded from provisioning. This typically occurs only for free sites.

ServerFarm

Optional. Name of a Server Farm (Web Hosting Plan) that this site belongs to.

SiteProperties

Optional. The web site properties of the web site. Contains AppSettings, Metadata, and Properties.

Sku

Optional. The SKU of a Server Farm (Web Hosting Plan) where site belongs to.

State

Optional. A string that describes the state of the web site. Possible values are Stopped or Running.

Uri

Optional. Direct URL to the web site endpoint on Azure Web Sites, including the subscription ID, web space name, and web site name.

UsageState

Optional. The usage state of the web site. Possible values are Normal or Exceeded. If any quota is exceeded, the UsageState value changes to Exceeded and the site goes offline.

WebSpace

Optional. The name of the web space in which the web site is located. This property is read-only.

Applies to