SiteConfigResource 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.
Web app configuration ARM resource.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.SiteConfigResourceTypeConverter))]
public class SiteConfigResource : Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISiteConfigResource, Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.SiteConfigResourceTypeConverter))>]
type SiteConfigResource = class
interface ISiteConfigResource
interface IJsonSerializable
interface IProxyOnlyResource
interface IValidates
Public Class SiteConfigResource
Implements ISiteConfigResource, IValidates
- Inheritance
-
SiteConfigResource
- Attributes
- Implements
Constructors
SiteConfigResource() |
Creates an new SiteConfigResource instance. |
Properties
AcrUseManagedIdentityCred |
Flag to use Managed Identity Creds for ACR pull |
AcrUserManagedIdentityId |
If using user managed identity, the user managed identity ClientId |
ActionMinProcessExecutionTime |
Minimum time the process must execute before taking the action |
ActionType |
Predefined action to be taken. |
AlwaysOn |
|
ApiDefinitionUrl |
The URL of the API definition. |
ApiManagementConfigId |
APIM-Api Identifier. |
AppCommandLine |
App command line to launch. |
AppSetting |
Application settings. |
AutoHealEnabled |
|
AutoSwapSlotName |
Auto-swap slot name. |
AzureStorageAccount |
List of Azure Storage Accounts. |
ConnectionString |
Connection strings. |
CorAllowedOrigin |
Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. |
CorSupportCredentials |
Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details. |
CustomActionExe |
Executable to be run. |
CustomActionParameter |
Parameters for the executable. |
DefaultDocument |
Default documents. |
DetailedErrorLoggingEnabled |
|
DocumentRoot |
Document root. |
DynamicTagsJson |
Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. |
ElasticWebAppScaleLimit |
Maximum number of workers that a site can scale out to.
This setting only applies to apps in plans where ElasticScaleEnabled is |
ExperimentRampUpRule |
List of ramp-up rules. |
FtpsState |
State of FTP / FTPS service |
FunctionAppScaleLimit |
Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans |
FunctionsRuntimeScaleMonitoringEnabled |
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. |
HandlerMapping |
Handler mappings. |
HealthCheckPath |
Health check path |
Http20Enabled |
Http20Enabled: configures a web site to allow clients to connect over http2.0 |
HttpLoggingEnabled |
|
Id |
Resource Id. |
IPSecurityRestriction |
IP security restrictions for main. |
IPSecurityRestrictionsDefaultAction |
Default action for main access restriction if no rules are matched. |
IsPushEnabled |
Gets or sets a flag indicating whether the Push endpoint is enabled. |
JavaContainer |
Java container. |
JavaContainerVersion |
Java container version. |
JavaVersion |
Java version. |
KeyVaultReferenceIdentity |
Identity to use for Key Vault Reference authentication. |
Kind |
Kind of resource. |
LimitMaxDiskSizeInMb |
Maximum allowed disk size usage in MB. |
LimitMaxMemoryInMb |
Maximum allowed memory usage in MB. |
LimitMaxPercentageCpu |
Maximum allowed CPU usage percentage. |
LinuxFxVersion |
Linux App Framework and version |
LoadBalancing |
Site load balancing. |
LocalMySqlEnabled |
|
LogsDirectorySizeLimit |
HTTP logs directory size limit. |
MachineKeyDecryption |
Algorithm used for decryption. |
MachineKeyDecryptionKey |
Decryption key. |
MachineKeyValidation |
MachineKey validation. |
MachineKeyValidationKey |
Validation key. |
ManagedPipelineMode |
Managed pipeline mode. |
ManagedServiceIdentityId |
Managed Service Identity Id |
Metadata |
Application metadata. This property cannot be retrieved, since it may contain secrets. |
MinimumElasticInstanceCount |
Number of minimum instance count for a site This setting only applies to the Elastic Plans |
MinTlsCipherSuite |
The minimum strength TLS cipher suite allowed for an application |
MinTlsVersion |
MinTlsVersion: configures the minimum version of TLS required for SSL requests |
Name |
Resource Name. |
NetFrameworkVersion |
.NET Framework version. |
NodeVersion |
Version of Node.js. |
NumberOfWorker |
Number of workers. |
PhpVersion |
Version of PHP. |
PowerShellVersion |
Version of PowerShell. |
PreWarmedInstanceCount |
Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans |
PublicNetworkAccess |
Property to allow or block all public traffic. |
PublishingUsername |
Publishing user name. |
PushId |
Resource Id. |
PushKind |
Kind of resource. |
PushName |
Resource Name. |
PushType |
Resource type. |
PythonVersion |
Version of Python. |
RemoteDebuggingEnabled |
|
RemoteDebuggingVersion |
Remote debugging version. |
RequestCount |
Request Count. |
RequestTimeInterval |
Time interval. |
RequestTracingEnabled |
|
RequestTracingExpirationTime |
Request tracing expiration time. |
ScmIPSecurityRestriction |
IP security restrictions for scm. |
ScmIPSecurityRestrictionsDefaultAction |
Default action for scm access restriction if no rules are matched. |
ScmIPSecurityRestrictionsUseMain |
IP security restrictions for scm to use main. |
ScmMinTlsVersion |
ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site |
ScmType |
SCM type. |
SlowRequestCount |
Request Count. |
SlowRequestPath |
Request Path. |
SlowRequestTimeInterval |
Time interval. |
SlowRequestTimeTaken |
Time taken. |
TagsRequiringAuth |
Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. |
TagWhitelistJson |
Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. |
TracingOption |
Tracing options. |
TriggerPrivateBytesInKb |
A rule based on private bytes. |
TriggerSlowRequestsWithPath |
A rule based on multiple Slow Requests Rule with path |
TriggerStatusCode |
A rule based on status codes. |
TriggerStatusCodesRange |
A rule based on status codes ranges. |
Type |
Resource type. |
Use32BitWorkerProcess |
|
VirtualApplication |
Virtual applications. |
VnetName |
Virtual Network name. |
VnetPrivatePortsCount |
The number of private ports assigned to this app. These will be assigned dynamically on runtime. |
VnetRouteAllEnabled |
Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. |
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 |
WebSocketsEnabled |
|
WindowsFxVersion |
Xenon App Framework and version |
XManagedServiceIdentityId |
Explicit Managed Service Identity Id |
Methods
DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of SiteConfigResource. |
DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of SiteConfigResource. |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISiteConfigResource. |
FromJsonString(String) |
Creates a new instance of SiteConfigResource, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) |
Serializes this instance of SiteConfigResource into a JsonNode. |
ToJsonString() |
Serializes this instance to a json string. |
Validate(IEventListener) |
Validates that this object meets the validation criteria. |