Share via


ArmAppServiceModelFactory.WebSiteData Method

Definition

Initializes a new instance of WebSiteData.

public static Azure.ResourceManager.AppService.WebSiteData WebSiteData (Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, System.Collections.Generic.IDictionary<string,string> tags = default, Azure.Core.AzureLocation location = default, Azure.ResourceManager.Models.ManagedServiceIdentity identity = default, Azure.ResourceManager.Resources.Models.ExtendedLocation extendedLocation = default, string state = default, System.Collections.Generic.IEnumerable<string> hostNames = default, string repositorySiteName = default, Azure.ResourceManager.AppService.Models.AppServiceUsageState? usageState = default, bool? isEnabled = default, System.Collections.Generic.IEnumerable<string> enabledHostNames = default, Azure.ResourceManager.AppService.Models.WebSiteAvailabilityState? availabilityState = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.AppService.Models.HostNameSslState> hostNameSslStates = default, Azure.Core.ResourceIdentifier appServicePlanId = default, bool? isReserved = default, bool? isXenon = default, bool? isHyperV = default, DateTimeOffset? lastModifiedTimeUtc = default, Azure.ResourceManager.AppService.Models.SiteDnsConfig dnsConfiguration = default, bool? isVnetRouteAllEnabled = default, bool? isVnetImagePullEnabled = default, bool? isVnetContentShareEnabled = default, bool? isVnetBackupRestoreEnabled = default, Azure.ResourceManager.AppService.Models.SiteConfigProperties siteConfig = default, Azure.ResourceManager.AppService.Models.FunctionAppConfig functionAppConfig = default, Azure.ResourceManager.AppService.Models.AppDaprConfig daprConfig = default, string workloadProfileName = default, Azure.ResourceManager.AppService.Models.FunctionAppResourceConfig resourceConfig = default, System.Collections.Generic.IEnumerable<string> trafficManagerHostNames = default, bool? isScmSiteAlsoStopped = default, string targetSwapSlot = default, Azure.ResourceManager.AppService.Models.HostingEnvironmentProfile hostingEnvironmentProfile = default, bool? isClientAffinityEnabled = default, bool? isClientCertEnabled = default, Azure.ResourceManager.AppService.Models.ClientCertMode? clientCertMode = default, string clientCertExclusionPaths = default, bool? isHostNameDisabled = default, string customDomainVerificationId = default, string outboundIPAddresses = default, string possibleOutboundIPAddresses = default, int? containerSize = default, int? dailyMemoryTimeQuota = default, DateTimeOffset? suspendOn = default, int? maxNumberOfWorkers = default, Azure.ResourceManager.AppService.Models.CloningInfo cloningInfo = default, string resourceGroup = default, bool? isDefaultContainer = default, string defaultHostName = default, Azure.ResourceManager.AppService.Models.SlotSwapStatus slotSwapStatus = default, bool? isHttpsOnly = default, Azure.ResourceManager.AppService.Models.RedundancyMode? redundancyMode = default, Guid? inProgressOperationId = default, string publicNetworkAccess = default, bool? isStorageAccountRequired = default, string keyVaultReferenceIdentity = default, Azure.Core.ResourceIdentifier virtualNetworkSubnetId = default, string managedEnvironmentId = default, string kind = default);
static member WebSiteData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * System.Collections.Generic.IDictionary<string, string> * Azure.Core.AzureLocation * Azure.ResourceManager.Models.ManagedServiceIdentity * Azure.ResourceManager.Resources.Models.ExtendedLocation * string * seq<string> * string * Nullable<Azure.ResourceManager.AppService.Models.AppServiceUsageState> * Nullable<bool> * seq<string> * Nullable<Azure.ResourceManager.AppService.Models.WebSiteAvailabilityState> * seq<Azure.ResourceManager.AppService.Models.HostNameSslState> * Azure.Core.ResourceIdentifier * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<DateTimeOffset> * Azure.ResourceManager.AppService.Models.SiteDnsConfig * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Azure.ResourceManager.AppService.Models.SiteConfigProperties * Azure.ResourceManager.AppService.Models.FunctionAppConfig * Azure.ResourceManager.AppService.Models.AppDaprConfig * string * Azure.ResourceManager.AppService.Models.FunctionAppResourceConfig * seq<string> * Nullable<bool> * string * Azure.ResourceManager.AppService.Models.HostingEnvironmentProfile * Nullable<bool> * Nullable<bool> * Nullable<Azure.ResourceManager.AppService.Models.ClientCertMode> * string * Nullable<bool> * string * string * string * Nullable<int> * Nullable<int> * Nullable<DateTimeOffset> * Nullable<int> * Azure.ResourceManager.AppService.Models.CloningInfo * string * Nullable<bool> * string * Azure.ResourceManager.AppService.Models.SlotSwapStatus * Nullable<bool> * Nullable<Azure.ResourceManager.AppService.Models.RedundancyMode> * Nullable<Guid> * string * Nullable<bool> * string * Azure.Core.ResourceIdentifier * string * string -> Azure.ResourceManager.AppService.WebSiteData
Public Shared Function WebSiteData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional location As AzureLocation = Nothing, Optional identity As ManagedServiceIdentity = Nothing, Optional extendedLocation As ExtendedLocation = Nothing, Optional state As String = Nothing, Optional hostNames As IEnumerable(Of String) = Nothing, Optional repositorySiteName As String = Nothing, Optional usageState As Nullable(Of AppServiceUsageState) = Nothing, Optional isEnabled As Nullable(Of Boolean) = Nothing, Optional enabledHostNames As IEnumerable(Of String) = Nothing, Optional availabilityState As Nullable(Of WebSiteAvailabilityState) = Nothing, Optional hostNameSslStates As IEnumerable(Of HostNameSslState) = Nothing, Optional appServicePlanId As ResourceIdentifier = Nothing, Optional isReserved As Nullable(Of Boolean) = Nothing, Optional isXenon As Nullable(Of Boolean) = Nothing, Optional isHyperV As Nullable(Of Boolean) = Nothing, Optional lastModifiedTimeUtc As Nullable(Of DateTimeOffset) = Nothing, Optional dnsConfiguration As SiteDnsConfig = Nothing, Optional isVnetRouteAllEnabled As Nullable(Of Boolean) = Nothing, Optional isVnetImagePullEnabled As Nullable(Of Boolean) = Nothing, Optional isVnetContentShareEnabled As Nullable(Of Boolean) = Nothing, Optional isVnetBackupRestoreEnabled As Nullable(Of Boolean) = Nothing, Optional siteConfig As SiteConfigProperties = Nothing, Optional functionAppConfig As FunctionAppConfig = Nothing, Optional daprConfig As AppDaprConfig = Nothing, Optional workloadProfileName As String = Nothing, Optional resourceConfig As FunctionAppResourceConfig = Nothing, Optional trafficManagerHostNames As IEnumerable(Of String) = Nothing, Optional isScmSiteAlsoStopped As Nullable(Of Boolean) = Nothing, Optional targetSwapSlot As String = Nothing, Optional hostingEnvironmentProfile As HostingEnvironmentProfile = Nothing, Optional isClientAffinityEnabled As Nullable(Of Boolean) = Nothing, Optional isClientCertEnabled As Nullable(Of Boolean) = Nothing, Optional clientCertMode As Nullable(Of ClientCertMode) = Nothing, Optional clientCertExclusionPaths As String = Nothing, Optional isHostNameDisabled As Nullable(Of Boolean) = Nothing, Optional customDomainVerificationId As String = Nothing, Optional outboundIPAddresses As String = Nothing, Optional possibleOutboundIPAddresses As String = Nothing, Optional containerSize As Nullable(Of Integer) = Nothing, Optional dailyMemoryTimeQuota As Nullable(Of Integer) = Nothing, Optional suspendOn As Nullable(Of DateTimeOffset) = Nothing, Optional maxNumberOfWorkers As Nullable(Of Integer) = Nothing, Optional cloningInfo As CloningInfo = Nothing, Optional resourceGroup As String = Nothing, Optional isDefaultContainer As Nullable(Of Boolean) = Nothing, Optional defaultHostName As String = Nothing, Optional slotSwapStatus As SlotSwapStatus = Nothing, Optional isHttpsOnly As Nullable(Of Boolean) = Nothing, Optional redundancyMode As Nullable(Of RedundancyMode) = Nothing, Optional inProgressOperationId As Nullable(Of Guid) = Nothing, Optional publicNetworkAccess As String = Nothing, Optional isStorageAccountRequired As Nullable(Of Boolean) = Nothing, Optional keyVaultReferenceIdentity As String = Nothing, Optional virtualNetworkSubnetId As ResourceIdentifier = Nothing, Optional managedEnvironmentId As String = Nothing, Optional kind As String = Nothing) As WebSiteData

Parameters

id
ResourceIdentifier

The id.

name
String

The name.

resourceType
ResourceType

The resourceType.

systemData
SystemData

The systemData.

tags
IDictionary<String,String>

The tags.

location
AzureLocation

The location.

identity
ManagedServiceIdentity

Managed service identity.

extendedLocation
ExtendedLocation

Extended Location.

state
String

Current state of the app.

hostNames
IEnumerable<String>

Hostnames associated with the app.

repositorySiteName
String

Name of the repository site.

usageState
Nullable<AppServiceUsageState>

State indicating whether the app has exceeded its quota usage. Read-only.

isEnabled
Nullable<Boolean>

<code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline).

enabledHostNames
IEnumerable<String>

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

availabilityState
Nullable<WebSiteAvailabilityState>

Management information availability state for the app.

hostNameSslStates
IEnumerable<HostNameSslState>

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

appServicePlanId
ResourceIdentifier

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

isReserved
Nullable<Boolean>

<code>true</code> if reserved; otherwise, <code>false</code>.

isXenon
Nullable<Boolean>

Obsolete: Hyper-V sandbox.

isHyperV
Nullable<Boolean>

Hyper-V sandbox.

lastModifiedTimeUtc
Nullable<DateTimeOffset>

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

dnsConfiguration
SiteDnsConfig

Property to configure various DNS related settings for a site.

isVnetRouteAllEnabled
Nullable<Boolean>

Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

isVnetImagePullEnabled
Nullable<Boolean>

To enable pulling image over Virtual Network.

isVnetContentShareEnabled
Nullable<Boolean>

To enable accessing content over virtual network.

isVnetBackupRestoreEnabled
Nullable<Boolean>

To enable Backup and Restore operations over virtual network.

siteConfig
SiteConfigProperties

Configuration of the app.

functionAppConfig
FunctionAppConfig

Configuration specific of the Azure Function app.

daprConfig
AppDaprConfig

Dapr configuration of the app.

workloadProfileName
String

Workload profile name for function app to execute on.

resourceConfig
FunctionAppResourceConfig

Function app resource requirements.

trafficManagerHostNames
IEnumerable<String>

Azure Traffic Manager hostnames associated with the app. Read-only.

isScmSiteAlsoStopped
Nullable<Boolean>

<code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>.

targetSwapSlot
String

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

hostingEnvironmentProfile
HostingEnvironmentProfile

App Service Environment to use for the app.

isClientAffinityEnabled
Nullable<Boolean>

<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
Nullable<Boolean>

<code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.

clientCertMode
Nullable<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.
clientCertExclusionPaths
String

client certificate authentication comma-separated exclusion paths.

isHostNameDisabled
Nullable<Boolean>

<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.

customDomainVerificationId
String

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

outboundIPAddresses
String

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
String

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

containerSize
Nullable<Int32>

Size of the function container.

dailyMemoryTimeQuota
Nullable<Int32>

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

suspendOn
Nullable<DateTimeOffset>

App suspended till in case memory-time quota is exceeded.

maxNumberOfWorkers
Nullable<Int32>

Maximum number of workers. This only applies to Functions container.

cloningInfo
CloningInfo

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

resourceGroup
String

Name of the resource group the app belongs to. Read-only.

isDefaultContainer
Nullable<Boolean>

<code>true</code> if the app is a default container; otherwise, <code>false</code>.

defaultHostName
String

Default hostname of the app. Read-only.

slotSwapStatus
SlotSwapStatus

Status of the last deployment slot swap operation.

isHttpsOnly
Nullable<Boolean>

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

redundancyMode
Nullable<RedundancyMode>

Site redundancy mode.

inProgressOperationId
Nullable<Guid>

Specifies an operation id if this site has a pending operation.

publicNetworkAccess
String

Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string.

isStorageAccountRequired
Nullable<Boolean>

Checks if Customer provided storage account is required.

keyVaultReferenceIdentity
String

Identity to use for Key Vault Reference authentication.

virtualNetworkSubnetId
ResourceIdentifier

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}

managedEnvironmentId
String

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}.

kind
String

Kind of resource.

Returns

A new WebSiteData instance for mocking.

Applies to