WebSiteData Class
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.
A class representing the WebSite data model. A web app, a mobile app backend, or an API app.
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
- Implements
Constructors
WebSiteData(AzureLocation) |
Initializes a new instance of WebSiteData. |
Properties
AppServicePlanId |
Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". |
AvailabilityState |
Management information availability state for the app. |
ClientCertExclusionPaths |
client certificate authentication comma-separated exclusion paths. |
ClientCertMode |
This composes with ClientCertEnabled setting.
|
CloningInfo |
If specified during app creation, the app is cloned from a source app. |
ContainerSize |
Size of the function container. |
CustomDomainVerificationId |
Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. |
DailyMemoryTimeQuota |
Maximum allowed daily memory-time quota (applicable on dynamic apps only). |
DaprConfig |
Dapr configuration of the app. |
DefaultHostName |
Default hostname of the app. Read-only. |
DnsConfiguration |
Property to configure various DNS related settings for a site. |
EnabledHostNames |
Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. |
ExtendedLocation |
Extended Location. |
FunctionAppConfig |
Configuration specific of the Azure Function app. |
HostingEnvironmentProfile |
App Service Environment to use for the app. |
HostNames |
Hostnames associated with the app. |
HostNameSslStates |
Hostname SSL states are used to manage the SSL bindings for app's hostnames. |
Id |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. (Inherited from ResourceData) |
Identity |
Managed service identity. |
InProgressOperationId |
Specifies an operation id if this site has a pending operation. |
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>. |
IsClientCertEnabled |
<code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. |
IsDefaultContainer |
<code>true</code> if the app is a default container; otherwise, <code>false</code>. |
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). |
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. |
IsHttpsOnly |
HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests |
IsHyperV |
Hyper-V sandbox. |
IsReserved |
<code>true</code> if reserved; otherwise, <code>false</code>. |
IsScmSiteAlsoStopped |
<code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. |
IsStorageAccountRequired |
Checks if Customer provided storage account is required. |
IsVnetBackupRestoreEnabled |
To enable Backup and Restore operations over virtual network. |
IsVnetContentShareEnabled |
To enable accessing content over virtual network. |
IsVnetImagePullEnabled |
To enable pulling image over Virtual Network. |
IsVnetRouteAllEnabled |
Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. |
IsXenon |
Obsolete: Hyper-V sandbox. |
KeyVaultReferenceIdentity |
Identity to use for Key Vault Reference authentication. |
Kind |
Kind of resource. |
LastModifiedTimeUtc |
Last time the app was modified, in UTC. Read-only. |
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}. |
MaxNumberOfWorkers |
Maximum number of workers. This only applies to Functions container. |
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. |
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. |
PublicNetworkAccess |
Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. |
RedundancyMode |
Site redundancy mode. |
RepositorySiteName |
Name of the repository site. |
ResourceConfig |
Function app resource requirements. |
ResourceGroup |
Name of the resource group the app belongs to. Read-only. |
ResourceType |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". (Inherited from ResourceData) |
SiteConfig |
Configuration of the app. |
SlotSwapStatus |
Status of the last deployment slot swap operation. |
State |
Current state of the app. |
SuspendOn |
App suspended till in case memory-time quota is exceeded. |
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. |
TrafficManagerHostNames |
Azure Traffic Manager hostnames associated with the app. Read-only. |
UsageState |
State indicating whether the app has exceeded its quota usage. Read-only. |
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} |
WorkloadProfileName |
Workload profile name for function app to execute on. |
Methods
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | (Inherited from TrackedResourceData) |
Explicit Interface Implementations
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. |
Applies to
Azure SDK for .NET