SiteConfigData Class

Definition

A class representing the SiteConfig data model. Web app configuration ARM resource. Serialized Name: SiteConfig

public class SiteConfigData : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.AppService.SiteConfigData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.AppService.SiteConfigData>
type SiteConfigData = class
    inherit ResourceData
    interface IJsonModel<SiteConfigData>
    interface IPersistableModel<SiteConfigData>
Public Class SiteConfigData
Inherits ResourceData
Implements IJsonModel(Of SiteConfigData), IPersistableModel(Of SiteConfigData)
Inheritance
SiteConfigData
Implements

Constructors

Name Description
SiteConfigData()

Initializes a new instance of SiteConfigData.

Properties

Name Description
AcrUserManagedIdentityId

If using user managed identity, the user managed identity ClientId Serialized Name: SiteConfig.properties.acrUserManagedIdentityID

AllowIPSecurityRestrictionsForScmToUseMain

IP security restrictions for scm to use main. Serialized Name: SiteConfig.properties.scmIpSecurityRestrictionsUseMain

ApiDefinitionUriStringValue

The URL of the API definition. Serialized Name: ApiDefinitionInfo.url

ApiManagementConfigId

APIM-Api Identifier. Serialized Name: ApiManagementConfig.id

AppCommandLine

App command line to launch. Serialized Name: SiteConfig.properties.appCommandLine

AppSettings

Application settings. This property is not returned in response to normal create and read requests since it may contain sensitive information. Serialized Name: SiteConfig.properties.appSettings

AutoHealRules

Auto Heal rules. Serialized Name: SiteConfig.properties.autoHealRules

AutoSwapSlotName

Auto-swap slot name. Serialized Name: SiteConfig.properties.autoSwapSlotName

AzureStorageAccounts

List of Azure Storage Accounts. Serialized Name: SiteConfig.properties.azureStorageAccounts

ConnectionStrings

Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. Serialized Name: SiteConfig.properties.connectionStrings

Cors

Cross-Origin Resource Sharing (CORS) settings. Serialized Name: SiteConfig.properties.cors

DefaultDocuments

Default documents. Serialized Name: SiteConfig.properties.defaultDocuments

DocumentRoot

Document root. Serialized Name: SiteConfig.properties.documentRoot

ElasticWebAppScaleLimit

Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is <code>true</code> Serialized Name: SiteConfig.properties.elasticWebAppScaleLimit

ExperimentsRampUpRules

List of ramp-up rules. Serialized Name: Experiments.rampUpRules

FtpsState

State of FTP / FTPS service Serialized Name: SiteConfig.properties.ftpsState

FunctionAppScaleLimit

Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans Serialized Name: SiteConfig.properties.functionAppScaleLimit

HandlerMappings

Handler mappings. Serialized Name: SiteConfig.properties.handlerMappings

HealthCheckPath

Health check path Serialized Name: SiteConfig.properties.healthCheckPath

Http20ProxyFlag

Http20ProxyFlag: Configures a website to allow http2.0 to pass be proxied all the way to the app. 0 = disabled, 1 = pass through all http2 traffic, 2 = pass through gRPC only. Serialized Name: SiteConfig.properties.http20ProxyFlag

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
IPSecurityRestrictions

IP security restrictions for main. Serialized Name: SiteConfig.properties.ipSecurityRestrictions

IPSecurityRestrictionsDefaultAction

Default action for main access restriction if no rules are matched. Serialized Name: SiteConfig.properties.ipSecurityRestrictionsDefaultAction

IsAlwaysOn

<code>true</code> if Always On is enabled; otherwise, <code>false</code>. Serialized Name: SiteConfig.properties.alwaysOn

IsAutoHealEnabled

<code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. Serialized Name: SiteConfig.properties.autoHealEnabled

IsDetailedErrorLoggingEnabled

<code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. Serialized Name: SiteConfig.properties.detailedErrorLoggingEnabled

IsFunctionsRuntimeScaleMonitoringEnabled

Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status. Serialized Name: SiteConfig.properties.functionsRuntimeScaleMonitoringEnabled

IsHttp20Enabled

Http20Enabled: configures a web site to allow clients to connect over http2.0 Serialized Name: SiteConfig.properties.http20Enabled

IsHttpLoggingEnabled

<code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. Serialized Name: SiteConfig.properties.httpLoggingEnabled

IsLocalMySqlEnabled

<code>true</code> to enable local MySQL; otherwise, <code>false</code>. Serialized Name: SiteConfig.properties.localMySqlEnabled

IsRemoteDebuggingEnabled

<code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. Serialized Name: SiteConfig.properties.remoteDebuggingEnabled

IsRequestTracingEnabled

<code>true</code> if request tracing is enabled; otherwise, <code>false</code>. Serialized Name: SiteConfig.properties.requestTracingEnabled

IsVnetRouteAllEnabled

Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Serialized Name: SiteConfig.properties.vnetRouteAllEnabled

IsWebSocketsEnabled

<code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. Serialized Name: SiteConfig.properties.webSocketsEnabled

JavaContainer

Java container. Serialized Name: SiteConfig.properties.javaContainer

JavaContainerVersion

Java container version. Serialized Name: SiteConfig.properties.javaContainerVersion

JavaVersion

Java version. Serialized Name: SiteConfig.properties.javaVersion

KeyVaultReferenceIdentity

Identity to use for Key Vault Reference authentication. Serialized Name: SiteConfig.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: SiteConfig.kind

Limits

Site limits. Serialized Name: SiteConfig.properties.limits

LinuxFxVersion

Linux App Framework and version Serialized Name: SiteConfig.properties.linuxFxVersion

LoadBalancing

Site load balancing. Serialized Name: SiteConfig.properties.loadBalancing

LogsDirectorySizeLimit

HTTP logs directory size limit. Serialized Name: SiteConfig.properties.logsDirectorySizeLimit

MachineKey

Site MachineKey. Serialized Name: SiteConfig.properties.machineKey

ManagedPipelineMode

Managed pipeline mode. Serialized Name: SiteConfig.properties.managedPipelineMode

ManagedServiceIdentityId

Managed Service Identity Id Serialized Name: SiteConfig.properties.managedServiceIdentityId

Metadata

Application metadata. This property cannot be retrieved, since it may contain secrets. Serialized Name: SiteConfig.properties.metadata

MinimumElasticInstanceCount

Number of minimum instance count for a site This setting only applies to the Elastic Plans Serialized Name: SiteConfig.properties.minimumElasticInstanceCount

MinTlsCipherSuite

The minimum strength TLS cipher suite allowed for an application Serialized Name: SiteConfig.properties.minTlsCipherSuite

MinTlsVersion

MinTlsVersion: configures the minimum version of TLS required for SSL requests Serialized Name: SiteConfig.properties.minTlsVersion

Name

The name of the resource.

(Inherited from ResourceData)
NetFrameworkVersion

.NET Framework version. Serialized Name: SiteConfig.properties.netFrameworkVersion

NodeVersion

Version of Node.js. Serialized Name: SiteConfig.properties.nodeVersion

NumberOfWorkers

Number of workers. Serialized Name: SiteConfig.properties.numberOfWorkers

PhpVersion

Version of PHP. Serialized Name: SiteConfig.properties.phpVersion

PowerShellVersion

Version of PowerShell. Serialized Name: SiteConfig.properties.powerShellVersion

PreWarmedInstanceCount

Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans Serialized Name: SiteConfig.properties.preWarmedInstanceCount

PublicNetworkAccess

Property to allow or block all public traffic. Serialized Name: SiteConfig.properties.publicNetworkAccess

PublishingUsername

Publishing user name. Serialized Name: SiteConfig.properties.publishingUsername

Push

Push endpoint settings. Serialized Name: SiteConfig.properties.push

PythonVersion

Version of Python. Serialized Name: SiteConfig.properties.pythonVersion

RemoteDebuggingVersion

Remote debugging version. Serialized Name: SiteConfig.properties.remoteDebuggingVersion

RequestTracingExpirationOn

Request tracing expiration time. Serialized Name: SiteConfig.properties.requestTracingExpirationTime

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
ScmIPSecurityRestrictions

IP security restrictions for scm. Serialized Name: SiteConfig.properties.scmIpSecurityRestrictions

ScmIPSecurityRestrictionsDefaultAction

Default action for scm access restriction if no rules are matched. Serialized Name: SiteConfig.properties.scmIpSecurityRestrictionsDefaultAction

ScmMinTlsVersion

ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site Serialized Name: SiteConfig.properties.scmMinTlsVersion

ScmType

SCM type. Serialized Name: SiteConfig.properties.scmType

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
TracingOptions

Tracing options. Serialized Name: SiteConfig.properties.tracingOptions

Use32BitWorkerProcess

<code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. Serialized Name: SiteConfig.properties.use32BitWorkerProcess

UseManagedIdentityCreds

Flag to use Managed Identity Creds for ACR pull Serialized Name: SiteConfig.properties.acrUseManagedIdentityCreds

VirtualApplications

Virtual applications. Serialized Name: SiteConfig.properties.virtualApplications

VnetName

Virtual Network name. Serialized Name: SiteConfig.properties.vnetName

VnetPrivatePortsCount

The number of private ports assigned to this app. These will be assigned dynamically on runtime. Serialized Name: SiteConfig.properties.vnetPrivatePortsCount

WebsiteTimeZone

Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones Serialized Name: SiteConfig.properties.websiteTimeZone

WindowsFxVersion

Xenon App Framework and version Serialized Name: SiteConfig.properties.windowsFxVersion

XManagedServiceIdentityId

Explicit Managed Service Identity Id Serialized Name: SiteConfig.properties.xManagedServiceIdentityId

Methods

Name Description
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<SiteConfigData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<SiteConfigData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<SiteConfigData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SiteConfigData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<SiteConfigData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to