WebSiteData Class

Definition

Namespace:

Azure.ResourceManager.AppService

Assembly:

Azure.ResourceManager.AppService.dll

Package:

Azure.ResourceManager.AppService v1.5.0

Source:

WebSiteData.cs

A class representing the WebSite data model. A web app, a mobile app backend, or an API app. Serialized Name: Site

public class WebSiteData : Azure.ResourceManager.Models.TrackedResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.AppService.WebSiteData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.AppService.WebSiteData>

type WebSiteData = class
    inherit TrackedResourceData
    interface IJsonModel<WebSiteData>
    interface IPersistableModel<WebSiteData>

Public Class WebSiteData
Inherits TrackedResourceData
Implements IJsonModel(Of WebSiteData), IPersistableModel(Of WebSiteData)

Inheritance

Object

ResourceData

TrackedResourceData

WebSiteData

Implements

IJsonModel<WebSiteData> IPersistableModel<WebSiteData> IPersistableModel<T>

Constructors

Name	Description
WebSiteData(AzureLocation)	Initializes a new instance of WebSiteData.

Properties

Name	Description
AppServicePlanId	Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". Serialized Name: Site.properties.serverFarmId
AutoGeneratedDomainNameLabelScope	Specifies the scope of uniqueness for the default hostname during resource creation Serialized Name: Site.properties.autoGeneratedDomainNameLabelScope
AvailabilityState	Management information availability state for the app. Serialized Name: Site.properties.availabilityState
ClientCertExclusionPaths	client certificate authentication comma-separated exclusion paths Serialized Name: Site.properties.clientCertExclusionPaths
ClientCertMode	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. Serialized Name: Site.properties.clientCertMode
CloningInfo	If specified during app creation, the app is cloned from a source app. Serialized Name: Site.properties.cloningInfo
ContainerSize	Size of the function container. Serialized Name: Site.properties.containerSize
CustomDomainVerificationId	Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. Serialized Name: Site.properties.customDomainVerificationId
DailyMemoryTimeQuota	Maximum allowed daily memory-time quota (applicable on dynamic apps only). Serialized Name: Site.properties.dailyMemoryTimeQuota
DaprConfig	Dapr configuration of the app. Serialized Name: Site.properties.daprConfig
DefaultHostName	Default hostname of the app. Read-only. Serialized Name: Site.properties.defaultHostName
DnsConfiguration	Property to configure various DNS related settings for a site. Serialized Name: Site.properties.dnsConfiguration
EnabledHostNames	Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. Serialized Name: Site.properties.enabledHostNames
ExtendedLocation	Extended Location. Serialized Name: Site.extendedLocation
FunctionAppConfig	Configuration specific of the Azure Function app. Serialized Name: Site.properties.functionAppConfig
HostingEnvironmentProfile	App Service Environment to use for the app. Serialized Name: Site.properties.hostingEnvironmentProfile
HostNames	Hostnames associated with the app. Serialized Name: Site.properties.hostNames
HostNameSslStates	Hostname SSL states are used to manage the SSL bindings for app's hostnames. Serialized Name: Site.properties.hostNameSslStates
Id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. (Inherited from ResourceData)
Identity	Managed service identity. Serialized Name: Site.identity
InProgressOperationId	Specifies an operation id if this site has a pending operation. Serialized Name: Site.properties.inProgressOperationId
IPMode	Specifies the IP mode of the app. Serialized Name: Site.properties.ipMode
IsClientAffinityEnabled	<code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. Serialized Name: Site.properties.clientAffinityEnabled
IsClientAffinityPartitioningEnabled	<code>true</code> to enable client affinity partitioning using CHIPS cookies, this will add the <code>partitioned</code> property to the affinity cookies; <code>false</code> to stop sending partitioned affinity cookies. Default is <code>false</code>. Serialized Name: Site.properties.clientAffinityPartitioningEnabled
IsClientAffinityProxyEnabled	<code>true</code> to override client affinity cookie domain with X-Forwarded-Host request header. <code>false</code> to use default domain. Default is <code>false</code>. Serialized Name: Site.properties.clientAffinityProxyEnabled
IsClientCertEnabled	<code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. Serialized Name: Site.properties.clientCertEnabled
IsDefaultContainer	<code>true</code> if the app is a default container; otherwise, <code>false</code>. Serialized Name: Site.properties.isDefaultContainer
IsEnabled	<code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). Serialized Name: Site.properties.enabled
IsEndToEndEncryptionEnabled	Whether to use end to end encryption between the FrontEnd and the Worker Serialized Name: Site.properties.endToEndEncryptionEnabled
IsHostNameDisabled	<code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process. Serialized Name: Site.properties.hostNamesDisabled
IsHttpsOnly	HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests Serialized Name: Site.properties.httpsOnly
IsHyperV	Hyper-V sandbox. Serialized Name: Site.properties.hyperV
IsReserved	<code>true</code> if reserved; otherwise, <code>false</code>. Serialized Name: Site.properties.reserved
IsScmSiteAlsoStopped	<code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. Serialized Name: Site.properties.scmSiteAlsoStopped
IsSshEnabled	Whether to enable ssh access. Serialized Name: Site.properties.sshEnabled
IsStorageAccountRequired	Checks if Customer provided storage account is required Serialized Name: Site.properties.storageAccountRequired
IsXenon	Obsolete: Hyper-V sandbox. Serialized Name: Site.properties.isXenon
KeyVaultReferenceIdentity	Identity to use for Key Vault Reference authentication. Serialized Name: Site.properties.keyVaultReferenceIdentity
Kind	Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind. Serialized Name: Site.kind
LastModifiedTimeUtc	Last time the app was modified, in UTC. Read-only. Serialized Name: Site.properties.lastModifiedTimeUtc
Location	The geo-location where the resource lives. (Inherited from TrackedResourceData)
ManagedEnvironmentId	Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} Serialized Name: Site.properties.managedEnvironmentId
MaxNumberOfWorkers	Maximum number of workers. This only applies to Functions container. Serialized Name: Site.properties.maxNumberOfWorkers
Name	The name of the resource. (Inherited from ResourceData)
OutboundIPAddresses	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. Serialized Name: Site.properties.outboundIpAddresses
OutboundVnetRouting	Property to configure various outbound traffic routing options over virtual network for a site Serialized Name: Site.properties.outboundVnetRouting
PossibleOutboundIPAddresses	List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. Serialized Name: Site.properties.possibleOutboundIpAddresses
PublicNetworkAccess	Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. Serialized Name: Site.properties.publicNetworkAccess
RedundancyMode	Site redundancy mode Serialized Name: Site.properties.redundancyMode
RepositorySiteName	Name of the repository site. Serialized Name: Site.properties.repositorySiteName
ResourceConfig	Function app resource requirements. Serialized Name: Site.properties.resourceConfig
ResourceGroup	Name of the resource group the app belongs to. Read-only. Serialized Name: Site.properties.resourceGroup
ResourceType	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". (Inherited from ResourceData)
SiteConfig	Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information. Serialized Name: Site.properties.siteConfig
Sku	Current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2 Serialized Name: Site.properties.sku
SlotSwapStatus	Status of the last deployment slot swap operation. Serialized Name: Site.properties.slotSwapStatus
State	Current state of the app. Serialized Name: Site.properties.state
SuspendOn	App suspended till in case memory-time quota is exceeded. Serialized Name: Site.properties.suspendedTill
SystemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. (Inherited from ResourceData)
Tags	Resource tags. (Inherited from TrackedResourceData)
TargetSwapSlot	Specifies which deployment slot this app will swap into. Read-only. Serialized Name: Site.properties.targetSwapSlot
TrafficManagerHostNames	Azure Traffic Manager hostnames associated with the app. Read-only. Serialized Name: Site.properties.trafficManagerHostNames
UsageState	State indicating whether the app has exceeded its quota usage. Read-only. Serialized Name: Site.properties.usageState
VirtualNetworkSubnetId	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} Serialized Name: Site.properties.virtualNetworkSubnetId
WorkloadProfileName	Workload profile name for function app to execute on. Serialized Name: Site.properties.workloadProfileName

Methods

Name	Description
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

Name	Description
IJsonModel<WebSiteData>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<WebSiteData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<WebSiteData>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<WebSiteData>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<WebSiteData>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.