Microsoft.Web (stable:2025-03-01)

2025/11/14 • 2 updated methods

WebApps_Update (updated)
Description :  Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebApps_Update",
  "$parameters": {
    "siteEnvelope": {
      "$properties": {
        "properties": [
          {
            "@added_755354fc12904724b01bf7ee774a4445": {
              "#name": "publicNetworkAccess",
              "Description": "Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string.",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter. ,
Required: True ,
}
string ,
siteEnvelope:
{
Description: A JSON representation of the app properties. See example. ,
Required: True ,
}
{
properties:
{
Description: SitePatchResource resource specific properties ,
Required: False ,
}
{
state:
{
Description: Current state of the app. ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with the app. ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of the repository site. ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether the app has exceeded its quota usage. Read-only. ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the app. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL certificate thumbprint. ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set to true to update existing hostname. ,
Required: False ,
}
boolean ,
hostType:
{
Description: Indicates whether the hostname is a standard or repository hostname. ,
Enum:
{
Standard: No description available. ,
Repository: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
reserved:
{
Description: true if reserved; otherwise, false. ,
Required: False ,
}
boolean ,
isXenon:
{
Description: Obsolete: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
dnsConfiguration:
{
Description: Property to configure various DNS related settings for a site. ,
Required: False ,
}
{
dnsServers:
{
Description: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. ,
Required: False ,
}
[
string ,
]
,
dnsAltServer:
{
Description: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. ,
Required: False ,
}
string ,
dnsRetryAttemptTimeout:
{
Description: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsRetryAttemptCount:
{
Description: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsMaxCacheTimeout:
{
Description: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsLegacySortOrder:
{
Description: Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only. ,
Required: False ,
}
boolean ,
}
,
siteConfig:
{
Description: Configuration of the app. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
powerShellVersion:
{
Description: Version of PowerShell. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
windowsFxVersion:
{
Description: Xenon App Framework and version ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: true if request tracing is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: true if remote debugging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote debugging version. ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: true if HTTP logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
acrUseManagedIdentityCreds:
{
Description: Flag to use Managed Identity Creds for ACR pull ,
Required: False ,
}
boolean ,
acrUserManagedIdentityID:
{
Description: If using user managed identity, the user managed identity ClientId ,
Required: False ,
}
string ,
logsDirectorySizeLimit:
{
Description: HTTP logs directory size limit. ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: true if detailed error logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name. ,
Required: False ,
}
string ,
appSettings:
{
Description: Application settings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Application metadata. This property cannot be retrieved, since it may contain secrets. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value. ,
Required: False ,
}
string ,
type:
{
Description: Type of database. ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
NotificationHub: No description available. ,
ServiceBus: No description available. ,
EventHub: No description available. ,
ApiHub: No description available. ,
DocDb: No description available. ,
RedisCache: No description available. ,
PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
machineKey:
{
Description: Site MachineKey. ,
Required: False ,
}
{
validation:
{
Description: MachineKey validation. ,
Required: False ,
}
string ,
validationKey:
{
Description: Validation key. ,
Required: False ,
}
string ,
decryption:
{
Description: Algorithm used for decryption. ,
Required: False ,
}
string ,
decryptionKey:
{
Description: Decryption key. ,
Required: False ,
}
string ,
}
,
handlerMappings:
{
Description: Handler mappings. ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root. ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type. ,
Enum:
{
None: No description available. ,
Dropbox: No description available. ,
Tfs: No description available. ,
LocalGit: No description available. ,
GitHub: No description available. ,
CodePlexGit: No description available. ,
CodePlexHg: No description available. ,
BitbucketGit: No description available. ,
BitbucketHg: No description available. ,
ExternalGit: No description available. ,
ExternalHg: No description available. ,
OneDrive: No description available. ,
VSO: No description available. ,
VSTSRM: No description available. ,
}
,
Required: False ,
}
enum ,
use32BitWorkerProcess:
{
Description: true to use 32-bit worker process; otherwise, false. ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: true if WebSocket is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: true if Always On is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version. ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container. ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version. ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App command line to launch. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode. ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
preloadEnabled:
{
Description: true if preloading is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
virtualDirectories:
{
Description: Virtual directories for virtual application. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Path to virtual application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing. ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
PerSiteRoundRobin: No description available. ,
LeastRequestsWithTieBreaker: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types. ,
Required: False ,
}
{
rampUpRules:
{
Description: List of ramp-up rules. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to ActionHostName. ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: Specifies interval in minutes to reevaluate ReroutePercentage. ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits. ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage. ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: true if Auto Heal is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto Heal rules. ,
Required: False ,
}
{
triggers:
{
Description: Conditions that describe when to execute the auto-heal actions. ,
Required: False ,
}
{
requests:
{
Description: A rule based on total requests. ,
Required: False ,
}
{
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: A rule based on private bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: A rule based on status codes. ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code. ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: Request Sub Status. ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code. ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
path:
{
Description: Request Path ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
slowRequestsWithPath:
{
Description: A rule based on multiple Slow Requests Rule with path ,
Required: False ,
}
[
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
statusCodesRange:
{
Description: A rule based on status codes ranges. ,
Required: False ,
}
[
{
statusCodes:
{
Description: HTTP status code. ,
Required: False ,
}
string ,
path:
{
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
}
,
actions:
{
Description: Actions to be executed when a rule is triggered. ,
Required: False ,
}
{
actionType:
{
Description: Predefined action to be taken. ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: False ,
}
enum ,
customAction:
{
Description: Custom action to be taken. ,
Required: False ,
}
{
exe:
{
Description: Executable to be run. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable. ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: Minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options. ,
Required: False ,
}
string ,
vnetName:
{
Description: Virtual Network name. ,
Required: False ,
}
string ,
vnetRouteAllEnabled:
{
Description: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. ,
Required: False ,
}
boolean ,
vnetPrivatePortsCount:
{
Description: The number of private ports assigned to this app. These will be assigned dynamically on runtime. ,
Format: int32 ,
Required: False ,
}
integer ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
supportCredentials:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
push:
{
Description: Push endpoint settings. ,
Required: False ,
}
{
properties:
{
Description: PushSettings resource specific properties ,
Required: False ,
}
{
isPushEnabled:
{
Description: Gets or sets a flag indicating whether the Push endpoint is enabled. ,
Required: True ,
}
boolean ,
tagWhitelistJson:
{
Description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. ,
Required: False ,
}
string ,
tagsRequiringAuth:
{
Description: 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. ,
Required: False ,
}
string ,
dynamicTagsJson:
{
Description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. ,
Required: False ,
}
string ,
}
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
apiManagementConfig:
{
Description: Azure API management settings linked to the app. ,
Required: False ,
}
{
id:
{
Description: APIM-Api Identifier. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
managedServiceIdentityId:
{
Description: Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
xManagedServiceIdentityId:
{
Description: Explicit Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
ipSecurityRestrictions:
{
Description: IP security restrictions for main. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
ipSecurityRestrictionsDefaultAction:
{
Description: Default action for main access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictions:
{
Description: IP security restrictions for scm. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
scmIpSecurityRestrictionsDefaultAction:
{
Description: Default action for scm access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictionsUseMain:
{
Description: IP security restrictions for scm to use main. ,
Required: False ,
}
boolean ,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
http20ProxyFlag:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
minTlsVersion:
{
Description: MinTlsVersion: configures the minimum version of TLS required for SSL requests ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
minTlsCipherSuite:
{
Description: The minimum strength TLS cipher suite allowed for an application ,
Enum:
{
TLS_AES_256_GCM_SHA384: No description available. ,
TLS_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA: No description available. ,
}
,
Required: False ,
}
enum ,
scmMinTlsVersion:
{
Description: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
ftpsState:
{
Description: State of FTP / FTPS service ,
Enum:
{
AllAllowed: No description available. ,
FtpsOnly: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
preWarmedInstanceCount:
{
Description: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
functionAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans ,
Format: int32 ,
Required: False ,
}
integer ,
elasticWebAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is true ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckPath:
{
Description: Health check path ,
Required: False ,
}
string ,
functionsRuntimeScaleMonitoringEnabled:
{
Description: 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. ,
Required: False ,
}
boolean ,
websiteTimeZone:
{
Description: 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 ,
Required: False ,
}
string ,
minimumElasticInstanceCount:
{
Description: Number of minimum instance count for a site This setting only applies to the Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
azureStorageAccounts:
{
Description: List of Azure Storage Accounts. ,
Required: False ,
}
object ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. ,
Required: False ,
}
string ,
}
,
trafficManagerHostNames:
{
Description: Azure Traffic Manager hostnames associated with the app. Read-only. ,
Required: False ,
}
[
string ,
]
,
scmSiteAlsoStopped:
{
Description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Specifies which deployment slot this app will swap into. Read-only. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: App Service Environment to use for the app. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
clientAffinityEnabled:
{
Description: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true. ,
Required: False ,
}
boolean ,
clientAffinityProxyEnabled:
{
Description: true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
clientCertMode:
{
Description: 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. ,
Enum:
{
Required: No description available. ,
Optional: No description available. ,
OptionalInteractiveUser: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertExclusionPaths:
{
Description: client certificate authentication comma-separated exclusion paths ,
Required: False ,
}
string ,
hostNamesDisabled:
{
Description: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. ,
Required: False ,
}
boolean ,
customDomainVerificationId:
{
Description: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. ,
Required: False ,
}
string ,
outboundIpAddresses:
{
Description: 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. ,
Required: False ,
}
string ,
possibleOutboundIpAddresses:
{
Description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of the function container. ,
Format: int32 ,
Required: False ,
}
integer ,
dailyMemoryTimeQuota:
{
Description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). ,
Format: int32 ,
Required: False ,
}
integer ,
suspendedTill:
{
Description: App suspended till in case memory-time quota is exceeded. ,
Format: date-time ,
Required: False ,
}
string ,
maxNumberOfWorkers:
{
Description: Maximum number of workers. This only applies to Functions container. ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: If specified during app creation, the app is cloned from a source app. ,
Required: False ,
}
{
correlationId:
{
Description: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. ,
Format: uuid ,
Required: False ,
}
string ,
overwrite:
{
Description: true to overwrite destination app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: true to clone custom hostnames from source app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: true to clone source control from source app; otherwise, false. ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. ,
Required: True ,
}
string ,
sourceWebAppLocation:
{
Description: Location of source app ex: West US or North Europe ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: App Service Environment. ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: true to configure load balancing for source and destination app. ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Name of the resource group the app belongs to. Read-only. ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: true if the app is a default container; otherwise, false. ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the app. Read-only. ,
Required: False ,
}
string ,
slotSwapStatus:
{
Description: Status of the last deployment slot swap operation. ,
Required: False ,
}
{
timestampUtc:
{
Description: The time the last successful slot swap completed. ,
Format: date-time ,
Required: False ,
}
string ,
sourceSlotName:
{
Description: The source slot of the last swap operation. ,
Required: False ,
}
string ,
destinationSlotName:
{
Description: The destination slot of the last swap operation. ,
Required: False ,
}
string ,
}
,
httpsOnly:
{
Description: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests ,
Required: False ,
}
boolean ,
redundancyMode:
{
Description: Site redundancy mode ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
Failover: No description available. ,
ActiveActive: No description available. ,
GeoRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
inProgressOperationId:
{
Description: Specifies an operation id if this site has a pending operation. ,
Format: uuid ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
storageAccountRequired:
{
Description: Checks if Customer provided storage account is required ,
Required: False ,
}
boolean ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
virtualNetworkSubnetId:
{
Description: 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} ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Site resource specific properties ,
Required: False ,
}
{
state:
{
Description: Current state of the app. ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with the app. ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of the repository site. ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether the app has exceeded its quota usage. Read-only. ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the app. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL certificate thumbprint. ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set to true to update existing hostname. ,
Required: False ,
}
boolean ,
hostType:
{
Description: Indicates whether the hostname is a standard or repository hostname. ,
Enum:
{
Standard: No description available. ,
Repository: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
reserved:
{
Description: true if reserved; otherwise, false. ,
Required: False ,
}
boolean ,
isXenon:
{
Description: Obsolete: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
dnsConfiguration:
{
Description: Property to configure various DNS related settings for a site. ,
Required: False ,
}
{
dnsServers:
{
Description: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. ,
Required: False ,
}
[
string ,
]
,
dnsAltServer:
{
Description: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. ,
Required: False ,
}
string ,
dnsRetryAttemptTimeout:
{
Description: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsRetryAttemptCount:
{
Description: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsMaxCacheTimeout:
{
Description: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsLegacySortOrder:
{
Description: Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only. ,
Required: False ,
}
boolean ,
}
,
outboundVnetRouting:
{
Description: Property to configure various outbound traffic routing options over virtual network for a site ,
Required: False ,
}
{
allTraffic:
{
Description: Enables all other routing options defined in OutboundVnetRouting if this setting is set to true. ,
Required: False ,
}
boolean ,
applicationTraffic:
{
Description: This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled. ,
Required: False ,
}
boolean ,
contentShareTraffic:
{
Description: Enables accessing content over virtual network. Previously called VnetContentShareEnabled ,
Required: False ,
}
boolean ,
imagePullTraffic:
{
Description: Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled. ,
Required: False ,
}
boolean ,
backupRestoreTraffic:
{
Description: Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled ,
Required: False ,
}
boolean ,
}
,
siteConfig:
{
Description: 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. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
powerShellVersion:
{
Description: Version of PowerShell. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
windowsFxVersion:
{
Description: Xenon App Framework and version ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: true if request tracing is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: true if remote debugging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote debugging version. ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: true if HTTP logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
acrUseManagedIdentityCreds:
{
Description: Flag to use Managed Identity Creds for ACR pull ,
Required: False ,
}
boolean ,
acrUserManagedIdentityID:
{
Description: If using user managed identity, the user managed identity ClientId ,
Required: False ,
}
string ,
logsDirectorySizeLimit:
{
Description: HTTP logs directory size limit. ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: true if detailed error logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name. ,
Required: False ,
}
string ,
appSettings:
{
Description: Application settings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Application metadata. This property cannot be retrieved, since it may contain secrets. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value. ,
Required: False ,
}
string ,
type:
{
Description: Type of database. ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
NotificationHub: No description available. ,
ServiceBus: No description available. ,
EventHub: No description available. ,
ApiHub: No description available. ,
DocDb: No description available. ,
RedisCache: No description available. ,
PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
machineKey:
{
Description: Site MachineKey. ,
Required: False ,
}
{
validation:
{
Description: MachineKey validation. ,
Required: False ,
}
string ,
validationKey:
{
Description: Validation key. ,
Required: False ,
}
string ,
decryption:
{
Description: Algorithm used for decryption. ,
Required: False ,
}
string ,
decryptionKey:
{
Description: Decryption key. ,
Required: False ,
}
string ,
}
,
handlerMappings:
{
Description: Handler mappings. ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root. ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type. ,
Enum:
{
None: No description available. ,
Dropbox: No description available. ,
Tfs: No description available. ,
LocalGit: No description available. ,
GitHub: No description available. ,
CodePlexGit: No description available. ,
CodePlexHg: No description available. ,
BitbucketGit: No description available. ,
BitbucketHg: No description available. ,
ExternalGit: No description available. ,
ExternalHg: No description available. ,
OneDrive: No description available. ,
VSO: No description available. ,
VSTSRM: No description available. ,
}
,
Required: False ,
}
enum ,
use32BitWorkerProcess:
{
Description: true to use 32-bit worker process; otherwise, false. ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: true if WebSocket is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: true if Always On is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version. ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container. ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version. ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App command line to launch. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode. ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
preloadEnabled:
{
Description: true if preloading is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
virtualDirectories:
{
Description: Virtual directories for virtual application. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Path to virtual application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing. ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
PerSiteRoundRobin: No description available. ,
LeastRequestsWithTieBreaker: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types. ,
Required: False ,
}
{
rampUpRules:
{
Description: List of ramp-up rules. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to ActionHostName. ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: Specifies interval in minutes to reevaluate ReroutePercentage. ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits. ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage. ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: true if Auto Heal is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto Heal rules. ,
Required: False ,
}
{
triggers:
{
Description: Conditions that describe when to execute the auto-heal actions. ,
Required: False ,
}
{
requests:
{
Description: A rule based on total requests. ,
Required: False ,
}
{
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: A rule based on private bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: A rule based on status codes. ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code. ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: Request Sub Status. ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code. ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
path:
{
Description: Request Path ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
slowRequestsWithPath:
{
Description: A rule based on multiple Slow Requests Rule with path ,
Required: False ,
}
[
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
statusCodesRange:
{
Description: A rule based on status codes ranges. ,
Required: False ,
}
[
{
statusCodes:
{
Description: HTTP status code. ,
Required: False ,
}
string ,
path:
{
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
}
,
actions:
{
Description: Actions to be executed when a rule is triggered. ,
Required: False ,
}
{
actionType:
{
Description: Predefined action to be taken. ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: False ,
}
enum ,
customAction:
{
Description: Custom action to be taken. ,
Required: False ,
}
{
exe:
{
Description: Executable to be run. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable. ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: Minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options. ,
Required: False ,
}
string ,
vnetName:
{
Description: Virtual Network name. ,
Required: False ,
}
string ,
vnetRouteAllEnabled:
{
Description: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. ,
Required: False ,
}
boolean ,
vnetPrivatePortsCount:
{
Description: The number of private ports assigned to this app. These will be assigned dynamically on runtime. ,
Format: int32 ,
Required: False ,
}
integer ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
supportCredentials:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
push:
{
Description: Push endpoint settings. ,
Required: False ,
}
{
properties:
{
Description: PushSettings resource specific properties ,
Required: False ,
}
{
isPushEnabled:
{
Description: Gets or sets a flag indicating whether the Push endpoint is enabled. ,
Required: True ,
}
boolean ,
tagWhitelistJson:
{
Description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. ,
Required: False ,
}
string ,
tagsRequiringAuth:
{
Description: 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. ,
Required: False ,
}
string ,
dynamicTagsJson:
{
Description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. ,
Required: False ,
}
string ,
}
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
apiManagementConfig:
{
Description: Azure API management settings linked to the app. ,
Required: False ,
}
{
id:
{
Description: APIM-Api Identifier. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
managedServiceIdentityId:
{
Description: Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
xManagedServiceIdentityId:
{
Description: Explicit Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
ipSecurityRestrictions:
{
Description: IP security restrictions for main. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
ipSecurityRestrictionsDefaultAction:
{
Description: Default action for main access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictions:
{
Description: IP security restrictions for scm. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
scmIpSecurityRestrictionsDefaultAction:
{
Description: Default action for scm access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictionsUseMain:
{
Description: IP security restrictions for scm to use main. ,
Required: False ,
}
boolean ,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
http20ProxyFlag:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
minTlsVersion:
{
Description: MinTlsVersion: configures the minimum version of TLS required for SSL requests ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
minTlsCipherSuite:
{
Description: The minimum strength TLS cipher suite allowed for an application ,
Enum:
{
TLS_AES_256_GCM_SHA384: No description available. ,
TLS_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA: No description available. ,
}
,
Required: False ,
}
enum ,
scmMinTlsVersion:
{
Description: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
ftpsState:
{
Description: State of FTP / FTPS service ,
Enum:
{
AllAllowed: No description available. ,
FtpsOnly: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
preWarmedInstanceCount:
{
Description: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
functionAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans ,
Format: int32 ,
Required: False ,
}
integer ,
elasticWebAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is true ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckPath:
{
Description: Health check path ,
Required: False ,
}
string ,
functionsRuntimeScaleMonitoringEnabled:
{
Description: 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. ,
Required: False ,
}
boolean ,
websiteTimeZone:
{
Description: 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 ,
Required: False ,
}
string ,
minimumElasticInstanceCount:
{
Description: Number of minimum instance count for a site This setting only applies to the Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
azureStorageAccounts:
{
Description: List of Azure Storage Accounts. ,
Required: False ,
}
object ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. ,
Required: False ,
}
string ,
}
,
functionAppConfig:
{
Description: Configuration specific of the Azure Function app. ,
Required: False ,
}
{
deployment:
{
Description: Function app deployment configuration. ,
Required: False ,
}
{
storage:
{
Description: Storage for deployed package used by the function app. ,
Required: False ,
}
{
type:
{
Description: Property to select Azure Storage type. Available options: blobContainer. ,
Enum:
{
blobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://.blob.core.windows.net/. ,
Format: uri ,
Required: False ,
}
string ,
authentication:
{
Description: Authentication method to access the storage account for deployment. ,
Required: False ,
}
{
type:
{
Description: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
StorageAccountConnectionString: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
storageAccountConnectionStringName:
{
Description: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
}
,
}
,
}
,
runtime:
{
Description: Function app runtime settings. ,
Required: False ,
}
{
name:
{
Description: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom ,
Enum:
{
dotnet-isolated: No description available. ,
node: No description available. ,
java: No description available. ,
powershell: No description available. ,
python: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Function app runtime version. Example: 8 (for dotnet-isolated) ,
Required: False ,
}
string ,
}
,
scaleAndConcurrency:
{
Description: Function app scale and concurrency settings. ,
Required: False ,
}
{
alwaysReady:
{
Description: 'Always Ready' configuration for the function app. ,
Required: False ,
}
[
{
name:
{
Description: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Required: False ,
}
string ,
instanceCount:
{
Description: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
maximumInstanceCount:
{
Description: The maximum number of instances for the function app. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceMemoryMB:
{
Description: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. ,
Format: int32 ,
Required: False ,
}
integer ,
triggers:
{
Description: Scale and concurrency settings for the function app triggers. ,
Required: False ,
}
{
http:
{
Description: Scale and concurrency settings for the HTTP trigger. ,
Required: False ,
}
{
perInstanceConcurrency:
{
Description: The maximum number of concurrent HTTP trigger invocations per instance. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
daprConfig:
{
Description: Dapr configuration of the app. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
}
,
workloadProfileName:
{
Description: Workload profile name for function app to execute on. ,
Required: False ,
}
string ,
resourceConfig:
{
Description: Function app resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "1Gi" ,
Required: False ,
}
string ,
}
,
trafficManagerHostNames:
{
Description: Azure Traffic Manager hostnames associated with the app. Read-only. ,
Required: False ,
}
[
string ,
]
,
scmSiteAlsoStopped:
{
Description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Specifies which deployment slot this app will swap into. Read-only. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: App Service Environment to use for the app. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
clientAffinityEnabled:
{
Description: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true. ,
Required: False ,
}
boolean ,
clientAffinityPartitioningEnabled:
{
Description: true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitioned affinity cookies. Default is false. ,
Required: False ,
}
boolean ,
clientAffinityProxyEnabled:
{
Description: true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
clientCertMode:
{
Description: 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. ,
Enum:
{
Required: No description available. ,
Optional: No description available. ,
OptionalInteractiveUser: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertExclusionPaths:
{
Description: client certificate authentication comma-separated exclusion paths ,
Required: False ,
}
string ,
ipMode:
{
Description: Specifies the IP mode of the app. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
IPv4AndIPv6: No description available. ,
}
,
Required: False ,
}
enum ,
endToEndEncryptionEnabled:
{
Description: Whether to use end to end encryption between the FrontEnd and the Worker ,
Required: False ,
}
boolean ,
sshEnabled:
{
Description: Whether to enable ssh access. ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. ,
Required: False ,
}
boolean ,
customDomainVerificationId:
{
Description: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. ,
Required: False ,
}
string ,
outboundIpAddresses:
{
Description: 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. ,
Required: False ,
}
string ,
possibleOutboundIpAddresses:
{
Description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of the function container. ,
Format: int32 ,
Required: False ,
}
integer ,
dailyMemoryTimeQuota:
{
Description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). ,
Format: int32 ,
Required: False ,
}
integer ,
suspendedTill:
{
Description: App suspended till in case memory-time quota is exceeded. ,
Format: date-time ,
Required: False ,
}
string ,
maxNumberOfWorkers:
{
Description: Maximum number of workers. This only applies to Functions container. ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: If specified during app creation, the app is cloned from a source app. ,
Required: False ,
}
{
correlationId:
{
Description: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. ,
Format: uuid ,
Required: False ,
}
string ,
overwrite:
{
Description: true to overwrite destination app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: true to clone custom hostnames from source app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: true to clone source control from source app; otherwise, false. ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. ,
Required: True ,
}
string ,
sourceWebAppLocation:
{
Description: Location of source app ex: West US or North Europe ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: App Service Environment. ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: true to configure load balancing for source and destination app. ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Name of the resource group the app belongs to. Read-only. ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: true if the app is a default container; otherwise, false. ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the app. Read-only. ,
Required: False ,
}
string ,
slotSwapStatus:
{
Description: Status of the last deployment slot swap operation. ,
Required: False ,
}
{
timestampUtc:
{
Description: The time the last successful slot swap completed. ,
Format: date-time ,
Required: False ,
}
string ,
sourceSlotName:
{
Description: The source slot of the last swap operation. ,
Required: False ,
}
string ,
destinationSlotName:
{
Description: The destination slot of the last swap operation. ,
Required: False ,
}
string ,
}
,
httpsOnly:
{
Description: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests ,
Required: False ,
}
boolean ,
redundancyMode:
{
Description: Site redundancy mode ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
Failover: No description available. ,
ActiveActive: No description available. ,
GeoRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
inProgressOperationId:
{
Description: Specifies an operation id if this site has a pending operation. ,
Format: uuid ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
storageAccountRequired:
{
Description: Checks if Customer provided storage account is required ,
Required: False ,
}
boolean ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: Specifies the scope of uniqueness for the default hostname during resource creation ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetId:
{
Description: 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} ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: 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} ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Site resource specific properties ,
Required: False ,
}
{
state:
{
Description: Current state of the app. ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with the app. ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of the repository site. ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether the app has exceeded its quota usage. Read-only. ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the app. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL certificate thumbprint. ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set to true to update existing hostname. ,
Required: False ,
}
boolean ,
hostType:
{
Description: Indicates whether the hostname is a standard or repository hostname. ,
Enum:
{
Standard: No description available. ,
Repository: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
reserved:
{
Description: true if reserved; otherwise, false. ,
Required: False ,
}
boolean ,
isXenon:
{
Description: Obsolete: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
dnsConfiguration:
{
Description: Property to configure various DNS related settings for a site. ,
Required: False ,
}
{
dnsServers:
{
Description: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. ,
Required: False ,
}
[
string ,
]
,
dnsAltServer:
{
Description: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. ,
Required: False ,
}
string ,
dnsRetryAttemptTimeout:
{
Description: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsRetryAttemptCount:
{
Description: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsMaxCacheTimeout:
{
Description: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsLegacySortOrder:
{
Description: Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only. ,
Required: False ,
}
boolean ,
}
,
outboundVnetRouting:
{
Description: Property to configure various outbound traffic routing options over virtual network for a site ,
Required: False ,
}
{
allTraffic:
{
Description: Enables all other routing options defined in OutboundVnetRouting if this setting is set to true. ,
Required: False ,
}
boolean ,
applicationTraffic:
{
Description: This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled. ,
Required: False ,
}
boolean ,
contentShareTraffic:
{
Description: Enables accessing content over virtual network. Previously called VnetContentShareEnabled ,
Required: False ,
}
boolean ,
imagePullTraffic:
{
Description: Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled. ,
Required: False ,
}
boolean ,
backupRestoreTraffic:
{
Description: Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled ,
Required: False ,
}
boolean ,
}
,
siteConfig:
{
Description: 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. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
powerShellVersion:
{
Description: Version of PowerShell. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
windowsFxVersion:
{
Description: Xenon App Framework and version ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: true if request tracing is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: true if remote debugging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote debugging version. ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: true if HTTP logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
acrUseManagedIdentityCreds:
{
Description: Flag to use Managed Identity Creds for ACR pull ,
Required: False ,
}
boolean ,
acrUserManagedIdentityID:
{
Description: If using user managed identity, the user managed identity ClientId ,
Required: False ,
}
string ,
logsDirectorySizeLimit:
{
Description: HTTP logs directory size limit. ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: true if detailed error logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name. ,
Required: False ,
}
string ,
appSettings:
{
Description: Application settings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Application metadata. This property cannot be retrieved, since it may contain secrets. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value. ,
Required: False ,
}
string ,
type:
{
Description: Type of database. ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
NotificationHub: No description available. ,
ServiceBus: No description available. ,
EventHub: No description available. ,
ApiHub: No description available. ,
DocDb: No description available. ,
RedisCache: No description available. ,
PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
machineKey:
{
Description: Site MachineKey. ,
Required: False ,
}
{
validation:
{
Description: MachineKey validation. ,
Required: False ,
}
string ,
validationKey:
{
Description: Validation key. ,
Required: False ,
}
string ,
decryption:
{
Description: Algorithm used for decryption. ,
Required: False ,
}
string ,
decryptionKey:
{
Description: Decryption key. ,
Required: False ,
}
string ,
}
,
handlerMappings:
{
Description: Handler mappings. ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root. ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type. ,
Enum:
{
None: No description available. ,
Dropbox: No description available. ,
Tfs: No description available. ,
LocalGit: No description available. ,
GitHub: No description available. ,
CodePlexGit: No description available. ,
CodePlexHg: No description available. ,
BitbucketGit: No description available. ,
BitbucketHg: No description available. ,
ExternalGit: No description available. ,
ExternalHg: No description available. ,
OneDrive: No description available. ,
VSO: No description available. ,
VSTSRM: No description available. ,
}
,
Required: False ,
}
enum ,
use32BitWorkerProcess:
{
Description: true to use 32-bit worker process; otherwise, false. ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: true if WebSocket is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: true if Always On is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version. ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container. ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version. ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App command line to launch. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode. ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
preloadEnabled:
{
Description: true if preloading is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
virtualDirectories:
{
Description: Virtual directories for virtual application. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Path to virtual application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing. ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
PerSiteRoundRobin: No description available. ,
LeastRequestsWithTieBreaker: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types. ,
Required: False ,
}
{
rampUpRules:
{
Description: List of ramp-up rules. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to ActionHostName. ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: Specifies interval in minutes to reevaluate ReroutePercentage. ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits. ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage. ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: true if Auto Heal is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto Heal rules. ,
Required: False ,
}
{
triggers:
{
Description: Conditions that describe when to execute the auto-heal actions. ,
Required: False ,
}
{
requests:
{
Description: A rule based on total requests. ,
Required: False ,
}
{
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: A rule based on private bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: A rule based on status codes. ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code. ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: Request Sub Status. ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code. ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
path:
{
Description: Request Path ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
slowRequestsWithPath:
{
Description: A rule based on multiple Slow Requests Rule with path ,
Required: False ,
}
[
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
statusCodesRange:
{
Description: A rule based on status codes ranges. ,
Required: False ,
}
[
{
statusCodes:
{
Description: HTTP status code. ,
Required: False ,
}
string ,
path:
{
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
}
,
actions:
{
Description: Actions to be executed when a rule is triggered. ,
Required: False ,
}
{
actionType:
{
Description: Predefined action to be taken. ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: False ,
}
enum ,
customAction:
{
Description: Custom action to be taken. ,
Required: False ,
}
{
exe:
{
Description: Executable to be run. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable. ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: Minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options. ,
Required: False ,
}
string ,
vnetName:
{
Description: Virtual Network name. ,
Required: False ,
}
string ,
vnetRouteAllEnabled:
{
Description: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. ,
Required: False ,
}
boolean ,
vnetPrivatePortsCount:
{
Description: The number of private ports assigned to this app. These will be assigned dynamically on runtime. ,
Format: int32 ,
Required: False ,
}
integer ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
supportCredentials:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
push:
{
Description: Push endpoint settings. ,
Required: False ,
}
{
properties:
{
Description: PushSettings resource specific properties ,
Required: False ,
}
{
isPushEnabled:
{
Description: Gets or sets a flag indicating whether the Push endpoint is enabled. ,
Required: True ,
}
boolean ,
tagWhitelistJson:
{
Description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. ,
Required: False ,
}
string ,
tagsRequiringAuth:
{
Description: 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. ,
Required: False ,
}
string ,
dynamicTagsJson:
{
Description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. ,
Required: False ,
}
string ,
}
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
apiManagementConfig:
{
Description: Azure API management settings linked to the app. ,
Required: False ,
}
{
id:
{
Description: APIM-Api Identifier. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
managedServiceIdentityId:
{
Description: Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
xManagedServiceIdentityId:
{
Description: Explicit Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
ipSecurityRestrictions:
{
Description: IP security restrictions for main. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
ipSecurityRestrictionsDefaultAction:
{
Description: Default action for main access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictions:
{
Description: IP security restrictions for scm. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
scmIpSecurityRestrictionsDefaultAction:
{
Description: Default action for scm access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictionsUseMain:
{
Description: IP security restrictions for scm to use main. ,
Required: False ,
}
boolean ,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
http20ProxyFlag:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
minTlsVersion:
{
Description: MinTlsVersion: configures the minimum version of TLS required for SSL requests ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
minTlsCipherSuite:
{
Description: The minimum strength TLS cipher suite allowed for an application ,
Enum:
{
TLS_AES_256_GCM_SHA384: No description available. ,
TLS_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA: No description available. ,
}
,
Required: False ,
}
enum ,
scmMinTlsVersion:
{
Description: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
ftpsState:
{
Description: State of FTP / FTPS service ,
Enum:
{
AllAllowed: No description available. ,
FtpsOnly: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
preWarmedInstanceCount:
{
Description: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
functionAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans ,
Format: int32 ,
Required: False ,
}
integer ,
elasticWebAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is true ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckPath:
{
Description: Health check path ,
Required: False ,
}
string ,
functionsRuntimeScaleMonitoringEnabled:
{
Description: 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. ,
Required: False ,
}
boolean ,
websiteTimeZone:
{
Description: 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 ,
Required: False ,
}
string ,
minimumElasticInstanceCount:
{
Description: Number of minimum instance count for a site This setting only applies to the Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
azureStorageAccounts:
{
Description: List of Azure Storage Accounts. ,
Required: False ,
}
object ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. ,
Required: False ,
}
string ,
}
,
functionAppConfig:
{
Description: Configuration specific of the Azure Function app. ,
Required: False ,
}
{
deployment:
{
Description: Function app deployment configuration. ,
Required: False ,
}
{
storage:
{
Description: Storage for deployed package used by the function app. ,
Required: False ,
}
{
type:
{
Description: Property to select Azure Storage type. Available options: blobContainer. ,
Enum:
{
blobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://.blob.core.windows.net/. ,
Format: uri ,
Required: False ,
}
string ,
authentication:
{
Description: Authentication method to access the storage account for deployment. ,
Required: False ,
}
{
type:
{
Description: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
StorageAccountConnectionString: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
storageAccountConnectionStringName:
{
Description: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
}
,
}
,
}
,
runtime:
{
Description: Function app runtime settings. ,
Required: False ,
}
{
name:
{
Description: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom ,
Enum:
{
dotnet-isolated: No description available. ,
node: No description available. ,
java: No description available. ,
powershell: No description available. ,
python: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Function app runtime version. Example: 8 (for dotnet-isolated) ,
Required: False ,
}
string ,
}
,
scaleAndConcurrency:
{
Description: Function app scale and concurrency settings. ,
Required: False ,
}
{
alwaysReady:
{
Description: 'Always Ready' configuration for the function app. ,
Required: False ,
}
[
{
name:
{
Description: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Required: False ,
}
string ,
instanceCount:
{
Description: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
maximumInstanceCount:
{
Description: The maximum number of instances for the function app. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceMemoryMB:
{
Description: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. ,
Format: int32 ,
Required: False ,
}
integer ,
triggers:
{
Description: Scale and concurrency settings for the function app triggers. ,
Required: False ,
}
{
http:
{
Description: Scale and concurrency settings for the HTTP trigger. ,
Required: False ,
}
{
perInstanceConcurrency:
{
Description: The maximum number of concurrent HTTP trigger invocations per instance. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
daprConfig:
{
Description: Dapr configuration of the app. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
}
,
workloadProfileName:
{
Description: Workload profile name for function app to execute on. ,
Required: False ,
}
string ,
resourceConfig:
{
Description: Function app resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "1Gi" ,
Required: False ,
}
string ,
}
,
trafficManagerHostNames:
{
Description: Azure Traffic Manager hostnames associated with the app. Read-only. ,
Required: False ,
}
[
string ,
]
,
scmSiteAlsoStopped:
{
Description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Specifies which deployment slot this app will swap into. Read-only. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: App Service Environment to use for the app. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
clientAffinityEnabled:
{
Description: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true. ,
Required: False ,
}
boolean ,
clientAffinityPartitioningEnabled:
{
Description: true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitioned affinity cookies. Default is false. ,
Required: False ,
}
boolean ,
clientAffinityProxyEnabled:
{
Description: true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
clientCertMode:
{
Description: 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. ,
Enum:
{
Required: No description available. ,
Optional: No description available. ,
OptionalInteractiveUser: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertExclusionPaths:
{
Description: client certificate authentication comma-separated exclusion paths ,
Required: False ,
}
string ,
ipMode:
{
Description: Specifies the IP mode of the app. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
IPv4AndIPv6: No description available. ,
}
,
Required: False ,
}
enum ,
endToEndEncryptionEnabled:
{
Description: Whether to use end to end encryption between the FrontEnd and the Worker ,
Required: False ,
}
boolean ,
sshEnabled:
{
Description: Whether to enable ssh access. ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. ,
Required: False ,
}
boolean ,
customDomainVerificationId:
{
Description: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. ,
Required: False ,
}
string ,
outboundIpAddresses:
{
Description: 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. ,
Required: False ,
}
string ,
possibleOutboundIpAddresses:
{
Description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of the function container. ,
Format: int32 ,
Required: False ,
}
integer ,
dailyMemoryTimeQuota:
{
Description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). ,
Format: int32 ,
Required: False ,
}
integer ,
suspendedTill:
{
Description: App suspended till in case memory-time quota is exceeded. ,
Format: date-time ,
Required: False ,
}
string ,
maxNumberOfWorkers:
{
Description: Maximum number of workers. This only applies to Functions container. ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: If specified during app creation, the app is cloned from a source app. ,
Required: False ,
}
{
correlationId:
{
Description: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. ,
Format: uuid ,
Required: False ,
}
string ,
overwrite:
{
Description: true to overwrite destination app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: true to clone custom hostnames from source app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: true to clone source control from source app; otherwise, false. ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. ,
Required: True ,
}
string ,
sourceWebAppLocation:
{
Description: Location of source app ex: West US or North Europe ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: App Service Environment. ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: true to configure load balancing for source and destination app. ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Name of the resource group the app belongs to. Read-only. ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: true if the app is a default container; otherwise, false. ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the app. Read-only. ,
Required: False ,
}
string ,
slotSwapStatus:
{
Description: Status of the last deployment slot swap operation. ,
Required: False ,
}
{
timestampUtc:
{
Description: The time the last successful slot swap completed. ,
Format: date-time ,
Required: False ,
}
string ,
sourceSlotName:
{
Description: The source slot of the last swap operation. ,
Required: False ,
}
string ,
destinationSlotName:
{
Description: The destination slot of the last swap operation. ,
Required: False ,
}
string ,
}
,
httpsOnly:
{
Description: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests ,
Required: False ,
}
boolean ,
redundancyMode:
{
Description: Site redundancy mode ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
Failover: No description available. ,
ActiveActive: No description available. ,
GeoRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
inProgressOperationId:
{
Description: Specifies an operation id if this site has a pending operation. ,
Format: uuid ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
storageAccountRequired:
{
Description: Checks if Customer provided storage account is required ,
Required: False ,
}
boolean ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: Specifies the scope of uniqueness for the default hostname during resource creation ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetId:
{
Description: 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} ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: 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} ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}
WebApps_UpdateSlot (updated)
Description :  Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
Reference :  Link ¶

⚶ Changes

{
  "#id": "WebApps_UpdateSlot",
  "$parameters": {
    "siteEnvelope": {
      "$properties": {
        "properties": [
          {
            "@added_7e015d25411e4d17bb405b545d25bcf1": {
              "#name": "publicNetworkAccess",
              "Description": "Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string.",
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName:
{
Description: Name of the resource group to which the resource belongs. ,
Required: True ,
}
string ,
name:
{
Description: Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter. ,
Required: True ,
}
string ,
siteEnvelope:
{
Description: A JSON representation of the app properties. See example. ,
Required: True ,
}
{
properties:
{
Description: SitePatchResource resource specific properties ,
Required: False ,
}
{
state:
{
Description: Current state of the app. ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with the app. ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of the repository site. ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether the app has exceeded its quota usage. Read-only. ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the app. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL certificate thumbprint. ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set to true to update existing hostname. ,
Required: False ,
}
boolean ,
hostType:
{
Description: Indicates whether the hostname is a standard or repository hostname. ,
Enum:
{
Standard: No description available. ,
Repository: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
reserved:
{
Description: true if reserved; otherwise, false. ,
Required: False ,
}
boolean ,
isXenon:
{
Description: Obsolete: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
dnsConfiguration:
{
Description: Property to configure various DNS related settings for a site. ,
Required: False ,
}
{
dnsServers:
{
Description: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. ,
Required: False ,
}
[
string ,
]
,
dnsAltServer:
{
Description: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. ,
Required: False ,
}
string ,
dnsRetryAttemptTimeout:
{
Description: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsRetryAttemptCount:
{
Description: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsMaxCacheTimeout:
{
Description: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsLegacySortOrder:
{
Description: Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only. ,
Required: False ,
}
boolean ,
}
,
siteConfig:
{
Description: Configuration of the app. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
powerShellVersion:
{
Description: Version of PowerShell. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
windowsFxVersion:
{
Description: Xenon App Framework and version ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: true if request tracing is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: true if remote debugging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote debugging version. ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: true if HTTP logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
acrUseManagedIdentityCreds:
{
Description: Flag to use Managed Identity Creds for ACR pull ,
Required: False ,
}
boolean ,
acrUserManagedIdentityID:
{
Description: If using user managed identity, the user managed identity ClientId ,
Required: False ,
}
string ,
logsDirectorySizeLimit:
{
Description: HTTP logs directory size limit. ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: true if detailed error logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name. ,
Required: False ,
}
string ,
appSettings:
{
Description: Application settings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Application metadata. This property cannot be retrieved, since it may contain secrets. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value. ,
Required: False ,
}
string ,
type:
{
Description: Type of database. ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
NotificationHub: No description available. ,
ServiceBus: No description available. ,
EventHub: No description available. ,
ApiHub: No description available. ,
DocDb: No description available. ,
RedisCache: No description available. ,
PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
machineKey:
{
Description: Site MachineKey. ,
Required: False ,
}
{
validation:
{
Description: MachineKey validation. ,
Required: False ,
}
string ,
validationKey:
{
Description: Validation key. ,
Required: False ,
}
string ,
decryption:
{
Description: Algorithm used for decryption. ,
Required: False ,
}
string ,
decryptionKey:
{
Description: Decryption key. ,
Required: False ,
}
string ,
}
,
handlerMappings:
{
Description: Handler mappings. ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root. ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type. ,
Enum:
{
None: No description available. ,
Dropbox: No description available. ,
Tfs: No description available. ,
LocalGit: No description available. ,
GitHub: No description available. ,
CodePlexGit: No description available. ,
CodePlexHg: No description available. ,
BitbucketGit: No description available. ,
BitbucketHg: No description available. ,
ExternalGit: No description available. ,
ExternalHg: No description available. ,
OneDrive: No description available. ,
VSO: No description available. ,
VSTSRM: No description available. ,
}
,
Required: False ,
}
enum ,
use32BitWorkerProcess:
{
Description: true to use 32-bit worker process; otherwise, false. ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: true if WebSocket is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: true if Always On is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version. ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container. ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version. ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App command line to launch. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode. ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
preloadEnabled:
{
Description: true if preloading is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
virtualDirectories:
{
Description: Virtual directories for virtual application. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Path to virtual application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing. ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
PerSiteRoundRobin: No description available. ,
LeastRequestsWithTieBreaker: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types. ,
Required: False ,
}
{
rampUpRules:
{
Description: List of ramp-up rules. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to ActionHostName. ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: Specifies interval in minutes to reevaluate ReroutePercentage. ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits. ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage. ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: true if Auto Heal is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto Heal rules. ,
Required: False ,
}
{
triggers:
{
Description: Conditions that describe when to execute the auto-heal actions. ,
Required: False ,
}
{
requests:
{
Description: A rule based on total requests. ,
Required: False ,
}
{
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: A rule based on private bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: A rule based on status codes. ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code. ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: Request Sub Status. ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code. ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
path:
{
Description: Request Path ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
slowRequestsWithPath:
{
Description: A rule based on multiple Slow Requests Rule with path ,
Required: False ,
}
[
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
statusCodesRange:
{
Description: A rule based on status codes ranges. ,
Required: False ,
}
[
{
statusCodes:
{
Description: HTTP status code. ,
Required: False ,
}
string ,
path:
{
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
}
,
actions:
{
Description: Actions to be executed when a rule is triggered. ,
Required: False ,
}
{
actionType:
{
Description: Predefined action to be taken. ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: False ,
}
enum ,
customAction:
{
Description: Custom action to be taken. ,
Required: False ,
}
{
exe:
{
Description: Executable to be run. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable. ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: Minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options. ,
Required: False ,
}
string ,
vnetName:
{
Description: Virtual Network name. ,
Required: False ,
}
string ,
vnetRouteAllEnabled:
{
Description: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. ,
Required: False ,
}
boolean ,
vnetPrivatePortsCount:
{
Description: The number of private ports assigned to this app. These will be assigned dynamically on runtime. ,
Format: int32 ,
Required: False ,
}
integer ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
supportCredentials:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
push:
{
Description: Push endpoint settings. ,
Required: False ,
}
{
properties:
{
Description: PushSettings resource specific properties ,
Required: False ,
}
{
isPushEnabled:
{
Description: Gets or sets a flag indicating whether the Push endpoint is enabled. ,
Required: True ,
}
boolean ,
tagWhitelistJson:
{
Description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. ,
Required: False ,
}
string ,
tagsRequiringAuth:
{
Description: 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. ,
Required: False ,
}
string ,
dynamicTagsJson:
{
Description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. ,
Required: False ,
}
string ,
}
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
apiManagementConfig:
{
Description: Azure API management settings linked to the app. ,
Required: False ,
}
{
id:
{
Description: APIM-Api Identifier. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
managedServiceIdentityId:
{
Description: Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
xManagedServiceIdentityId:
{
Description: Explicit Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
ipSecurityRestrictions:
{
Description: IP security restrictions for main. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
ipSecurityRestrictionsDefaultAction:
{
Description: Default action for main access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictions:
{
Description: IP security restrictions for scm. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
scmIpSecurityRestrictionsDefaultAction:
{
Description: Default action for scm access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictionsUseMain:
{
Description: IP security restrictions for scm to use main. ,
Required: False ,
}
boolean ,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
http20ProxyFlag:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
minTlsVersion:
{
Description: MinTlsVersion: configures the minimum version of TLS required for SSL requests ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
minTlsCipherSuite:
{
Description: The minimum strength TLS cipher suite allowed for an application ,
Enum:
{
TLS_AES_256_GCM_SHA384: No description available. ,
TLS_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA: No description available. ,
}
,
Required: False ,
}
enum ,
scmMinTlsVersion:
{
Description: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
ftpsState:
{
Description: State of FTP / FTPS service ,
Enum:
{
AllAllowed: No description available. ,
FtpsOnly: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
preWarmedInstanceCount:
{
Description: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
functionAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans ,
Format: int32 ,
Required: False ,
}
integer ,
elasticWebAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is true ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckPath:
{
Description: Health check path ,
Required: False ,
}
string ,
functionsRuntimeScaleMonitoringEnabled:
{
Description: 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. ,
Required: False ,
}
boolean ,
websiteTimeZone:
{
Description: 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 ,
Required: False ,
}
string ,
minimumElasticInstanceCount:
{
Description: Number of minimum instance count for a site This setting only applies to the Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
azureStorageAccounts:
{
Description: List of Azure Storage Accounts. ,
Required: False ,
}
object ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. ,
Required: False ,
}
string ,
}
,
trafficManagerHostNames:
{
Description: Azure Traffic Manager hostnames associated with the app. Read-only. ,
Required: False ,
}
[
string ,
]
,
scmSiteAlsoStopped:
{
Description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Specifies which deployment slot this app will swap into. Read-only. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: App Service Environment to use for the app. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
clientAffinityEnabled:
{
Description: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true. ,
Required: False ,
}
boolean ,
clientAffinityProxyEnabled:
{
Description: true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
clientCertMode:
{
Description: 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. ,
Enum:
{
Required: No description available. ,
Optional: No description available. ,
OptionalInteractiveUser: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertExclusionPaths:
{
Description: client certificate authentication comma-separated exclusion paths ,
Required: False ,
}
string ,
hostNamesDisabled:
{
Description: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. ,
Required: False ,
}
boolean ,
customDomainVerificationId:
{
Description: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. ,
Required: False ,
}
string ,
outboundIpAddresses:
{
Description: 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. ,
Required: False ,
}
string ,
possibleOutboundIpAddresses:
{
Description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of the function container. ,
Format: int32 ,
Required: False ,
}
integer ,
dailyMemoryTimeQuota:
{
Description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). ,
Format: int32 ,
Required: False ,
}
integer ,
suspendedTill:
{
Description: App suspended till in case memory-time quota is exceeded. ,
Format: date-time ,
Required: False ,
}
string ,
maxNumberOfWorkers:
{
Description: Maximum number of workers. This only applies to Functions container. ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: If specified during app creation, the app is cloned from a source app. ,
Required: False ,
}
{
correlationId:
{
Description: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. ,
Format: uuid ,
Required: False ,
}
string ,
overwrite:
{
Description: true to overwrite destination app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: true to clone custom hostnames from source app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: true to clone source control from source app; otherwise, false. ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. ,
Required: True ,
}
string ,
sourceWebAppLocation:
{
Description: Location of source app ex: West US or North Europe ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: App Service Environment. ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: true to configure load balancing for source and destination app. ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Name of the resource group the app belongs to. Read-only. ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: true if the app is a default container; otherwise, false. ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the app. Read-only. ,
Required: False ,
}
string ,
slotSwapStatus:
{
Description: Status of the last deployment slot swap operation. ,
Required: False ,
}
{
timestampUtc:
{
Description: The time the last successful slot swap completed. ,
Format: date-time ,
Required: False ,
}
string ,
sourceSlotName:
{
Description: The source slot of the last swap operation. ,
Required: False ,
}
string ,
destinationSlotName:
{
Description: The destination slot of the last swap operation. ,
Required: False ,
}
string ,
}
,
httpsOnly:
{
Description: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests ,
Required: False ,
}
boolean ,
redundancyMode:
{
Description: Site redundancy mode ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
Failover: No description available. ,
ActiveActive: No description available. ,
GeoRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
inProgressOperationId:
{
Description: Specifies an operation id if this site has a pending operation. ,
Format: uuid ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
storageAccountRequired:
{
Description: Checks if Customer provided storage account is required ,
Required: False ,
}
boolean ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
virtualNetworkSubnetId:
{
Description: 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} ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
slot:
{
Description: Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ,
Required: True ,
}
string ,
api-version:
{
Description: API Version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Site resource specific properties ,
Required: False ,
}
{
state:
{
Description: Current state of the app. ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with the app. ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of the repository site. ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether the app has exceeded its quota usage. Read-only. ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the app. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL certificate thumbprint. ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set to true to update existing hostname. ,
Required: False ,
}
boolean ,
hostType:
{
Description: Indicates whether the hostname is a standard or repository hostname. ,
Enum:
{
Standard: No description available. ,
Repository: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
reserved:
{
Description: true if reserved; otherwise, false. ,
Required: False ,
}
boolean ,
isXenon:
{
Description: Obsolete: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
dnsConfiguration:
{
Description: Property to configure various DNS related settings for a site. ,
Required: False ,
}
{
dnsServers:
{
Description: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. ,
Required: False ,
}
[
string ,
]
,
dnsAltServer:
{
Description: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. ,
Required: False ,
}
string ,
dnsRetryAttemptTimeout:
{
Description: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsRetryAttemptCount:
{
Description: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsMaxCacheTimeout:
{
Description: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsLegacySortOrder:
{
Description: Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only. ,
Required: False ,
}
boolean ,
}
,
outboundVnetRouting:
{
Description: Property to configure various outbound traffic routing options over virtual network for a site ,
Required: False ,
}
{
allTraffic:
{
Description: Enables all other routing options defined in OutboundVnetRouting if this setting is set to true. ,
Required: False ,
}
boolean ,
applicationTraffic:
{
Description: This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled. ,
Required: False ,
}
boolean ,
contentShareTraffic:
{
Description: Enables accessing content over virtual network. Previously called VnetContentShareEnabled ,
Required: False ,
}
boolean ,
imagePullTraffic:
{
Description: Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled. ,
Required: False ,
}
boolean ,
backupRestoreTraffic:
{
Description: Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled ,
Required: False ,
}
boolean ,
}
,
siteConfig:
{
Description: 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. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
powerShellVersion:
{
Description: Version of PowerShell. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
windowsFxVersion:
{
Description: Xenon App Framework and version ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: true if request tracing is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: true if remote debugging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote debugging version. ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: true if HTTP logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
acrUseManagedIdentityCreds:
{
Description: Flag to use Managed Identity Creds for ACR pull ,
Required: False ,
}
boolean ,
acrUserManagedIdentityID:
{
Description: If using user managed identity, the user managed identity ClientId ,
Required: False ,
}
string ,
logsDirectorySizeLimit:
{
Description: HTTP logs directory size limit. ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: true if detailed error logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name. ,
Required: False ,
}
string ,
appSettings:
{
Description: Application settings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Application metadata. This property cannot be retrieved, since it may contain secrets. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value. ,
Required: False ,
}
string ,
type:
{
Description: Type of database. ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
NotificationHub: No description available. ,
ServiceBus: No description available. ,
EventHub: No description available. ,
ApiHub: No description available. ,
DocDb: No description available. ,
RedisCache: No description available. ,
PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
machineKey:
{
Description: Site MachineKey. ,
Required: False ,
}
{
validation:
{
Description: MachineKey validation. ,
Required: False ,
}
string ,
validationKey:
{
Description: Validation key. ,
Required: False ,
}
string ,
decryption:
{
Description: Algorithm used for decryption. ,
Required: False ,
}
string ,
decryptionKey:
{
Description: Decryption key. ,
Required: False ,
}
string ,
}
,
handlerMappings:
{
Description: Handler mappings. ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root. ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type. ,
Enum:
{
None: No description available. ,
Dropbox: No description available. ,
Tfs: No description available. ,
LocalGit: No description available. ,
GitHub: No description available. ,
CodePlexGit: No description available. ,
CodePlexHg: No description available. ,
BitbucketGit: No description available. ,
BitbucketHg: No description available. ,
ExternalGit: No description available. ,
ExternalHg: No description available. ,
OneDrive: No description available. ,
VSO: No description available. ,
VSTSRM: No description available. ,
}
,
Required: False ,
}
enum ,
use32BitWorkerProcess:
{
Description: true to use 32-bit worker process; otherwise, false. ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: true if WebSocket is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: true if Always On is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version. ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container. ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version. ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App command line to launch. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode. ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
preloadEnabled:
{
Description: true if preloading is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
virtualDirectories:
{
Description: Virtual directories for virtual application. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Path to virtual application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing. ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
PerSiteRoundRobin: No description available. ,
LeastRequestsWithTieBreaker: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types. ,
Required: False ,
}
{
rampUpRules:
{
Description: List of ramp-up rules. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to ActionHostName. ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: Specifies interval in minutes to reevaluate ReroutePercentage. ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits. ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage. ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: true if Auto Heal is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto Heal rules. ,
Required: False ,
}
{
triggers:
{
Description: Conditions that describe when to execute the auto-heal actions. ,
Required: False ,
}
{
requests:
{
Description: A rule based on total requests. ,
Required: False ,
}
{
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: A rule based on private bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: A rule based on status codes. ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code. ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: Request Sub Status. ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code. ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
path:
{
Description: Request Path ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
slowRequestsWithPath:
{
Description: A rule based on multiple Slow Requests Rule with path ,
Required: False ,
}
[
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
statusCodesRange:
{
Description: A rule based on status codes ranges. ,
Required: False ,
}
[
{
statusCodes:
{
Description: HTTP status code. ,
Required: False ,
}
string ,
path:
{
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
}
,
actions:
{
Description: Actions to be executed when a rule is triggered. ,
Required: False ,
}
{
actionType:
{
Description: Predefined action to be taken. ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: False ,
}
enum ,
customAction:
{
Description: Custom action to be taken. ,
Required: False ,
}
{
exe:
{
Description: Executable to be run. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable. ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: Minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options. ,
Required: False ,
}
string ,
vnetName:
{
Description: Virtual Network name. ,
Required: False ,
}
string ,
vnetRouteAllEnabled:
{
Description: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. ,
Required: False ,
}
boolean ,
vnetPrivatePortsCount:
{
Description: The number of private ports assigned to this app. These will be assigned dynamically on runtime. ,
Format: int32 ,
Required: False ,
}
integer ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
supportCredentials:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
push:
{
Description: Push endpoint settings. ,
Required: False ,
}
{
properties:
{
Description: PushSettings resource specific properties ,
Required: False ,
}
{
isPushEnabled:
{
Description: Gets or sets a flag indicating whether the Push endpoint is enabled. ,
Required: True ,
}
boolean ,
tagWhitelistJson:
{
Description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. ,
Required: False ,
}
string ,
tagsRequiringAuth:
{
Description: 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. ,
Required: False ,
}
string ,
dynamicTagsJson:
{
Description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. ,
Required: False ,
}
string ,
}
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
apiManagementConfig:
{
Description: Azure API management settings linked to the app. ,
Required: False ,
}
{
id:
{
Description: APIM-Api Identifier. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
managedServiceIdentityId:
{
Description: Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
xManagedServiceIdentityId:
{
Description: Explicit Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
ipSecurityRestrictions:
{
Description: IP security restrictions for main. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
ipSecurityRestrictionsDefaultAction:
{
Description: Default action for main access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictions:
{
Description: IP security restrictions for scm. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
scmIpSecurityRestrictionsDefaultAction:
{
Description: Default action for scm access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictionsUseMain:
{
Description: IP security restrictions for scm to use main. ,
Required: False ,
}
boolean ,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
http20ProxyFlag:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
minTlsVersion:
{
Description: MinTlsVersion: configures the minimum version of TLS required for SSL requests ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
minTlsCipherSuite:
{
Description: The minimum strength TLS cipher suite allowed for an application ,
Enum:
{
TLS_AES_256_GCM_SHA384: No description available. ,
TLS_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA: No description available. ,
}
,
Required: False ,
}
enum ,
scmMinTlsVersion:
{
Description: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
ftpsState:
{
Description: State of FTP / FTPS service ,
Enum:
{
AllAllowed: No description available. ,
FtpsOnly: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
preWarmedInstanceCount:
{
Description: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
functionAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans ,
Format: int32 ,
Required: False ,
}
integer ,
elasticWebAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is true ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckPath:
{
Description: Health check path ,
Required: False ,
}
string ,
functionsRuntimeScaleMonitoringEnabled:
{
Description: 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. ,
Required: False ,
}
boolean ,
websiteTimeZone:
{
Description: 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 ,
Required: False ,
}
string ,
minimumElasticInstanceCount:
{
Description: Number of minimum instance count for a site This setting only applies to the Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
azureStorageAccounts:
{
Description: List of Azure Storage Accounts. ,
Required: False ,
}
object ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. ,
Required: False ,
}
string ,
}
,
functionAppConfig:
{
Description: Configuration specific of the Azure Function app. ,
Required: False ,
}
{
deployment:
{
Description: Function app deployment configuration. ,
Required: False ,
}
{
storage:
{
Description: Storage for deployed package used by the function app. ,
Required: False ,
}
{
type:
{
Description: Property to select Azure Storage type. Available options: blobContainer. ,
Enum:
{
blobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://.blob.core.windows.net/. ,
Format: uri ,
Required: False ,
}
string ,
authentication:
{
Description: Authentication method to access the storage account for deployment. ,
Required: False ,
}
{
type:
{
Description: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
StorageAccountConnectionString: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
storageAccountConnectionStringName:
{
Description: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
}
,
}
,
}
,
runtime:
{
Description: Function app runtime settings. ,
Required: False ,
}
{
name:
{
Description: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom ,
Enum:
{
dotnet-isolated: No description available. ,
node: No description available. ,
java: No description available. ,
powershell: No description available. ,
python: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Function app runtime version. Example: 8 (for dotnet-isolated) ,
Required: False ,
}
string ,
}
,
scaleAndConcurrency:
{
Description: Function app scale and concurrency settings. ,
Required: False ,
}
{
alwaysReady:
{
Description: 'Always Ready' configuration for the function app. ,
Required: False ,
}
[
{
name:
{
Description: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Required: False ,
}
string ,
instanceCount:
{
Description: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
maximumInstanceCount:
{
Description: The maximum number of instances for the function app. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceMemoryMB:
{
Description: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. ,
Format: int32 ,
Required: False ,
}
integer ,
triggers:
{
Description: Scale and concurrency settings for the function app triggers. ,
Required: False ,
}
{
http:
{
Description: Scale and concurrency settings for the HTTP trigger. ,
Required: False ,
}
{
perInstanceConcurrency:
{
Description: The maximum number of concurrent HTTP trigger invocations per instance. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
daprConfig:
{
Description: Dapr configuration of the app. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
}
,
workloadProfileName:
{
Description: Workload profile name for function app to execute on. ,
Required: False ,
}
string ,
resourceConfig:
{
Description: Function app resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "1Gi" ,
Required: False ,
}
string ,
}
,
trafficManagerHostNames:
{
Description: Azure Traffic Manager hostnames associated with the app. Read-only. ,
Required: False ,
}
[
string ,
]
,
scmSiteAlsoStopped:
{
Description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Specifies which deployment slot this app will swap into. Read-only. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: App Service Environment to use for the app. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
clientAffinityEnabled:
{
Description: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true. ,
Required: False ,
}
boolean ,
clientAffinityPartitioningEnabled:
{
Description: true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitioned affinity cookies. Default is false. ,
Required: False ,
}
boolean ,
clientAffinityProxyEnabled:
{
Description: true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
clientCertMode:
{
Description: 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. ,
Enum:
{
Required: No description available. ,
Optional: No description available. ,
OptionalInteractiveUser: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertExclusionPaths:
{
Description: client certificate authentication comma-separated exclusion paths ,
Required: False ,
}
string ,
ipMode:
{
Description: Specifies the IP mode of the app. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
IPv4AndIPv6: No description available. ,
}
,
Required: False ,
}
enum ,
endToEndEncryptionEnabled:
{
Description: Whether to use end to end encryption between the FrontEnd and the Worker ,
Required: False ,
}
boolean ,
sshEnabled:
{
Description: Whether to enable ssh access. ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. ,
Required: False ,
}
boolean ,
customDomainVerificationId:
{
Description: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. ,
Required: False ,
}
string ,
outboundIpAddresses:
{
Description: 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. ,
Required: False ,
}
string ,
possibleOutboundIpAddresses:
{
Description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of the function container. ,
Format: int32 ,
Required: False ,
}
integer ,
dailyMemoryTimeQuota:
{
Description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). ,
Format: int32 ,
Required: False ,
}
integer ,
suspendedTill:
{
Description: App suspended till in case memory-time quota is exceeded. ,
Format: date-time ,
Required: False ,
}
string ,
maxNumberOfWorkers:
{
Description: Maximum number of workers. This only applies to Functions container. ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: If specified during app creation, the app is cloned from a source app. ,
Required: False ,
}
{
correlationId:
{
Description: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. ,
Format: uuid ,
Required: False ,
}
string ,
overwrite:
{
Description: true to overwrite destination app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: true to clone custom hostnames from source app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: true to clone source control from source app; otherwise, false. ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. ,
Required: True ,
}
string ,
sourceWebAppLocation:
{
Description: Location of source app ex: West US or North Europe ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: App Service Environment. ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: true to configure load balancing for source and destination app. ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Name of the resource group the app belongs to. Read-only. ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: true if the app is a default container; otherwise, false. ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the app. Read-only. ,
Required: False ,
}
string ,
slotSwapStatus:
{
Description: Status of the last deployment slot swap operation. ,
Required: False ,
}
{
timestampUtc:
{
Description: The time the last successful slot swap completed. ,
Format: date-time ,
Required: False ,
}
string ,
sourceSlotName:
{
Description: The source slot of the last swap operation. ,
Required: False ,
}
string ,
destinationSlotName:
{
Description: The destination slot of the last swap operation. ,
Required: False ,
}
string ,
}
,
httpsOnly:
{
Description: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests ,
Required: False ,
}
boolean ,
redundancyMode:
{
Description: Site redundancy mode ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
Failover: No description available. ,
ActiveActive: No description available. ,
GeoRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
inProgressOperationId:
{
Description: Specifies an operation id if this site has a pending operation. ,
Format: uuid ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
storageAccountRequired:
{
Description: Checks if Customer provided storage account is required ,
Required: False ,
}
boolean ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: Specifies the scope of uniqueness for the default hostname during resource creation ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetId:
{
Description: 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} ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: 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} ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Site resource specific properties ,
Required: False ,
}
{
state:
{
Description: Current state of the app. ,
Required: False ,
}
string ,
hostNames:
{
Description: Hostnames associated with the app. ,
Required: False ,
}
[
string ,
]
,
repositorySiteName:
{
Description: Name of the repository site. ,
Required: False ,
}
string ,
usageState:
{
Description: State indicating whether the app has exceeded its quota usage. Read-only. ,
Enum:
{
Normal: No description available. ,
Exceeded: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). ,
Required: False ,
}
boolean ,
enabledHostNames:
{
Description: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. ,
Required: False ,
}
[
string ,
]
,
availabilityState:
{
Description: Management information availability state for the app. ,
Enum:
{
Normal: No description available. ,
Limited: No description available. ,
DisasterRecoveryMode: No description available. ,
}
,
Required: False ,
}
enum ,
hostNameSslStates:
{
Description: Hostname SSL states are used to manage the SSL bindings for app's hostnames. ,
Required: False ,
}
[
{
name:
{
Description: Hostname. ,
Required: False ,
}
string ,
sslState:
{
Description: SSL type. ,
Enum:
{
Disabled: No description available. ,
SniEnabled: No description available. ,
IpBasedEnabled: No description available. ,
}
,
Required: False ,
}
enum ,
virtualIP:
{
Description: Virtual IP address assigned to the hostname if IP based SSL is enabled. ,
Required: False ,
}
string ,
thumbprint:
{
Description: SSL certificate thumbprint. ,
Required: False ,
}
string ,
toUpdate:
{
Description: Set to true to update existing hostname. ,
Required: False ,
}
boolean ,
hostType:
{
Description: Indicates whether the hostname is a standard or repository hostname. ,
Enum:
{
Standard: No description available. ,
Repository: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serverFarmId:
{
Description: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". ,
Required: False ,
}
string ,
reserved:
{
Description: true if reserved; otherwise, false. ,
Required: False ,
}
boolean ,
isXenon:
{
Description: Obsolete: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
hyperV:
{
Description: Hyper-V sandbox. ,
Required: False ,
}
boolean ,
lastModifiedTimeUtc:
{
Description: Last time the app was modified, in UTC. Read-only. ,
Format: date-time ,
Required: False ,
}
string ,
dnsConfiguration:
{
Description: Property to configure various DNS related settings for a site. ,
Required: False ,
}
{
dnsServers:
{
Description: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. ,
Required: False ,
}
[
string ,
]
,
dnsAltServer:
{
Description: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. ,
Required: False ,
}
string ,
dnsRetryAttemptTimeout:
{
Description: Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsRetryAttemptCount:
{
Description: Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsMaxCacheTimeout:
{
Description: Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. ,
Format: int32 ,
Required: False ,
}
integer ,
dnsLegacySortOrder:
{
Description: Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only. ,
Required: False ,
}
boolean ,
}
,
outboundVnetRouting:
{
Description: Property to configure various outbound traffic routing options over virtual network for a site ,
Required: False ,
}
{
allTraffic:
{
Description: Enables all other routing options defined in OutboundVnetRouting if this setting is set to true. ,
Required: False ,
}
boolean ,
applicationTraffic:
{
Description: This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled. ,
Required: False ,
}
boolean ,
contentShareTraffic:
{
Description: Enables accessing content over virtual network. Previously called VnetContentShareEnabled ,
Required: False ,
}
boolean ,
imagePullTraffic:
{
Description: Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled. ,
Required: False ,
}
boolean ,
backupRestoreTraffic:
{
Description: Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled ,
Required: False ,
}
boolean ,
}
,
siteConfig:
{
Description: 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. ,
Required: False ,
}
{
numberOfWorkers:
{
Description: Number of workers. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultDocuments:
{
Description: Default documents. ,
Required: False ,
}
[
string ,
]
,
netFrameworkVersion:
{
Description: .NET Framework version. ,
Required: False ,
}
string ,
phpVersion:
{
Description: Version of PHP. ,
Required: False ,
}
string ,
pythonVersion:
{
Description: Version of Python. ,
Required: False ,
}
string ,
nodeVersion:
{
Description: Version of Node.js. ,
Required: False ,
}
string ,
powerShellVersion:
{
Description: Version of PowerShell. ,
Required: False ,
}
string ,
linuxFxVersion:
{
Description: Linux App Framework and version ,
Required: False ,
}
string ,
windowsFxVersion:
{
Description: Xenon App Framework and version ,
Required: False ,
}
string ,
requestTracingEnabled:
{
Description: true if request tracing is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
requestTracingExpirationTime:
{
Description: Request tracing expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDebuggingEnabled:
{
Description: true if remote debugging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
remoteDebuggingVersion:
{
Description: Remote debugging version. ,
Required: False ,
}
string ,
httpLoggingEnabled:
{
Description: true if HTTP logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
acrUseManagedIdentityCreds:
{
Description: Flag to use Managed Identity Creds for ACR pull ,
Required: False ,
}
boolean ,
acrUserManagedIdentityID:
{
Description: If using user managed identity, the user managed identity ClientId ,
Required: False ,
}
string ,
logsDirectorySizeLimit:
{
Description: HTTP logs directory size limit. ,
Format: int32 ,
Required: False ,
}
integer ,
detailedErrorLoggingEnabled:
{
Description: true if detailed error logging is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
publishingUsername:
{
Description: Publishing user name. ,
Required: False ,
}
string ,
appSettings:
{
Description: Application settings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
metadata:
{
Description: Application metadata. This property cannot be retrieved, since it may contain secrets. ,
Required: False ,
}
[
{
name:
{
Description: Pair name. ,
Required: False ,
}
string ,
value:
{
Description: Pair value. ,
Required: False ,
}
string ,
}
,
]
,
connectionStrings:
{
Description: Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. ,
Required: False ,
}
[
{
name:
{
Description: Name of connection string. ,
Required: False ,
}
string ,
connectionString:
{
Description: Connection string value. ,
Required: False ,
}
string ,
type:
{
Description: Type of database. ,
Enum:
{
MySql: No description available. ,
SQLServer: No description available. ,
SQLAzure: No description available. ,
Custom: No description available. ,
NotificationHub: No description available. ,
ServiceBus: No description available. ,
EventHub: No description available. ,
ApiHub: No description available. ,
DocDb: No description available. ,
RedisCache: No description available. ,
PostgreSQL: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
machineKey:
{
Description: Site MachineKey. ,
Required: False ,
}
{
validation:
{
Description: MachineKey validation. ,
Required: False ,
}
string ,
validationKey:
{
Description: Validation key. ,
Required: False ,
}
string ,
decryption:
{
Description: Algorithm used for decryption. ,
Required: False ,
}
string ,
decryptionKey:
{
Description: Decryption key. ,
Required: False ,
}
string ,
}
,
handlerMappings:
{
Description: Handler mappings. ,
Required: False ,
}
[
{
extension:
{
Description: Requests with this extension will be handled using the specified FastCGI application. ,
Required: False ,
}
string ,
scriptProcessor:
{
Description: The absolute path to the FastCGI application. ,
Required: False ,
}
string ,
arguments:
{
Description: Command-line arguments to be passed to the script processor. ,
Required: False ,
}
string ,
}
,
]
,
documentRoot:
{
Description: Document root. ,
Required: False ,
}
string ,
scmType:
{
Description: SCM type. ,
Enum:
{
None: No description available. ,
Dropbox: No description available. ,
Tfs: No description available. ,
LocalGit: No description available. ,
GitHub: No description available. ,
CodePlexGit: No description available. ,
CodePlexHg: No description available. ,
BitbucketGit: No description available. ,
BitbucketHg: No description available. ,
ExternalGit: No description available. ,
ExternalHg: No description available. ,
OneDrive: No description available. ,
VSO: No description available. ,
VSTSRM: No description available. ,
}
,
Required: False ,
}
enum ,
use32BitWorkerProcess:
{
Description: true to use 32-bit worker process; otherwise, false. ,
Required: False ,
}
boolean ,
webSocketsEnabled:
{
Description: true if WebSocket is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
alwaysOn:
{
Description: true if Always On is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
javaVersion:
{
Description: Java version. ,
Required: False ,
}
string ,
javaContainer:
{
Description: Java container. ,
Required: False ,
}
string ,
javaContainerVersion:
{
Description: Java container version. ,
Required: False ,
}
string ,
appCommandLine:
{
Description: App command line to launch. ,
Required: False ,
}
string ,
managedPipelineMode:
{
Description: Managed pipeline mode. ,
Enum:
{
Integrated: No description available. ,
Classic: No description available. ,
}
,
Required: False ,
}
enum ,
virtualApplications:
{
Description: Virtual applications. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Virtual path. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
preloadEnabled:
{
Description: true if preloading is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
virtualDirectories:
{
Description: Virtual directories for virtual application. ,
Required: False ,
}
[
{
virtualPath:
{
Description: Path to virtual application. ,
Required: False ,
}
string ,
physicalPath:
{
Description: Physical path. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
loadBalancing:
{
Description: Site load balancing. ,
Enum:
{
WeightedRoundRobin: No description available. ,
LeastRequests: No description available. ,
LeastResponseTime: No description available. ,
WeightedTotalTraffic: No description available. ,
RequestHash: No description available. ,
PerSiteRoundRobin: No description available. ,
LeastRequestsWithTieBreaker: No description available. ,
}
,
Required: False ,
}
enum ,
experiments:
{
Description: This is work around for polymorphic types. ,
Required: False ,
}
{
rampUpRules:
{
Description: List of ramp-up rules. ,
Required: False ,
}
[
{
actionHostName:
{
Description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. ,
Required: False ,
}
string ,
reroutePercentage:
{
Description: Percentage of the traffic which will be redirected to ActionHostName. ,
Format: double ,
Required: False ,
}
number ,
changeStep:
{
Description: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. ,
Format: double ,
Required: False ,
}
number ,
changeIntervalInMinutes:
{
Description: Specifies interval in minutes to reevaluate ReroutePercentage. ,
Format: int32 ,
Required: False ,
}
integer ,
minReroutePercentage:
{
Description: Specifies lower boundary above which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
maxReroutePercentage:
{
Description: Specifies upper boundary below which ReroutePercentage will stay. ,
Format: double ,
Required: False ,
}
number ,
changeDecisionCallbackUrl:
{
Description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. ,
Required: False ,
}
string ,
name:
{
Description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. ,
Required: False ,
}
string ,
}
,
]
,
}
,
limits:
{
Description: Site limits. ,
Required: False ,
}
{
maxPercentageCpu:
{
Description: Maximum allowed CPU usage percentage. ,
Format: double ,
Required: False ,
}
number ,
maxMemoryInMb:
{
Description: Maximum allowed memory usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
maxDiskSizeInMb:
{
Description: Maximum allowed disk size usage in MB. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
autoHealEnabled:
{
Description: true if Auto Heal is enabled; otherwise, false. ,
Required: False ,
}
boolean ,
autoHealRules:
{
Description: Auto Heal rules. ,
Required: False ,
}
{
triggers:
{
Description: Conditions that describe when to execute the auto-heal actions. ,
Required: False ,
}
{
requests:
{
Description: A rule based on total requests. ,
Required: False ,
}
{
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
privateBytesInKB:
{
Description: A rule based on private bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
statusCodes:
{
Description: A rule based on status codes. ,
Required: False ,
}
[
{
status:
{
Description: HTTP status code. ,
Format: int32 ,
Required: False ,
}
integer ,
subStatus:
{
Description: Request Sub Status. ,
Format: int32 ,
Required: False ,
}
integer ,
win32Status:
{
Description: Win32 error code. ,
Format: int32 ,
Required: False ,
}
integer ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
path:
{
Description: Request Path ,
Required: False ,
}
string ,
}
,
]
,
slowRequests:
{
Description: A rule based on request execution time. ,
Required: False ,
}
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
slowRequestsWithPath:
{
Description: A rule based on multiple Slow Requests Rule with path ,
Required: False ,
}
[
{
timeTaken:
{
Description: Time taken. ,
Required: False ,
}
string ,
path:
{
Description: Request Path. ,
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
statusCodesRange:
{
Description: A rule based on status codes ranges. ,
Required: False ,
}
[
{
statusCodes:
{
Description: HTTP status code. ,
Required: False ,
}
string ,
path:
{
Required: False ,
}
string ,
count:
{
Description: Request Count. ,
Format: int32 ,
Required: False ,
}
integer ,
timeInterval:
{
Description: Time interval. ,
Required: False ,
}
string ,
}
,
]
,
}
,
actions:
{
Description: Actions to be executed when a rule is triggered. ,
Required: False ,
}
{
actionType:
{
Description: Predefined action to be taken. ,
Enum:
{
Recycle: No description available. ,
LogEvent: No description available. ,
CustomAction: No description available. ,
}
,
Required: False ,
}
enum ,
customAction:
{
Description: Custom action to be taken. ,
Required: False ,
}
{
exe:
{
Description: Executable to be run. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters for the executable. ,
Required: False ,
}
string ,
}
,
minProcessExecutionTime:
{
Description: Minimum time the process must execute before taking the action ,
Required: False ,
}
string ,
}
,
}
,
tracingOptions:
{
Description: Tracing options. ,
Required: False ,
}
string ,
vnetName:
{
Description: Virtual Network name. ,
Required: False ,
}
string ,
vnetRouteAllEnabled:
{
Description: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. ,
Required: False ,
}
boolean ,
vnetPrivatePortsCount:
{
Description: The number of private ports assigned to this app. These will be assigned dynamically on runtime. ,
Format: int32 ,
Required: False ,
}
integer ,
cors:
{
Description: Cross-Origin Resource Sharing (CORS) settings. ,
Required: False ,
}
{
allowedOrigins:
{
Description: 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. ,
Required: False ,
}
[
string ,
]
,
supportCredentials:
{
Description: 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. ,
Required: False ,
}
boolean ,
}
,
push:
{
Description: Push endpoint settings. ,
Required: False ,
}
{
properties:
{
Description: PushSettings resource specific properties ,
Required: False ,
}
{
isPushEnabled:
{
Description: Gets or sets a flag indicating whether the Push endpoint is enabled. ,
Required: True ,
}
boolean ,
tagWhitelistJson:
{
Description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. ,
Required: False ,
}
string ,
tagsRequiringAuth:
{
Description: 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. ,
Required: False ,
}
string ,
dynamicTagsJson:
{
Description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. ,
Required: False ,
}
string ,
}
,
}
,
apiDefinition:
{
Description: Information about the formal API definition for the app. ,
Required: False ,
}
{
url:
{
Description: The URL of the API definition. ,
Required: False ,
}
string ,
}
,
apiManagementConfig:
{
Description: Azure API management settings linked to the app. ,
Required: False ,
}
{
id:
{
Description: APIM-Api Identifier. ,
Required: False ,
}
string ,
}
,
autoSwapSlotName:
{
Description: Auto-swap slot name. ,
Required: False ,
}
string ,
localMySqlEnabled:
{
Description: true to enable local MySQL; otherwise, false. ,
Required: False ,
}
boolean ,
managedServiceIdentityId:
{
Description: Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
xManagedServiceIdentityId:
{
Description: Explicit Managed Service Identity Id ,
Format: int32 ,
Required: False ,
}
integer ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
ipSecurityRestrictions:
{
Description: IP security restrictions for main. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
ipSecurityRestrictionsDefaultAction:
{
Description: Default action for main access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictions:
{
Description: IP security restrictions for scm. ,
Required: False ,
}
[
{
ipAddress:
{
Description: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified. ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet mask for the range of IP addresses the restriction is valid for. ,
Required: False ,
}
string ,
vnetSubnetResourceId:
{
Description: Virtual network resource id ,
Required: False ,
}
string ,
vnetTrafficTag:
{
Description: (internal) Vnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
subnetTrafficTag:
{
Description: (internal) Subnet traffic tag ,
Format: int32 ,
Required: False ,
}
integer ,
action:
{
Description: Allow or Deny access for this IP range. ,
Required: False ,
}
string ,
tag:
{
Description: Defines what this IP filter will be used for. This is to support IP filtering on proxies. ,
Enum:
{
Default: No description available. ,
XffProxy: No description available. ,
ServiceTag: No description available. ,
}
,
Required: False ,
}
enum ,
priority:
{
Description: Priority of IP restriction rule. ,
Format: int32 ,
Required: False ,
}
integer ,
name:
{
Description: IP restriction rule name. ,
Required: False ,
}
string ,
description:
{
Description: IP restriction rule description. ,
Required: False ,
}
string ,
headers:
{
Description: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match. ,
Required: False ,
}
object ,
}
,
]
,
scmIpSecurityRestrictionsDefaultAction:
{
Description: Default action for scm access restriction if no rules are matched. ,
Enum:
{
Allow: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
scmIpSecurityRestrictionsUseMain:
{
Description: IP security restrictions for scm to use main. ,
Required: False ,
}
boolean ,
http20Enabled:
{
Description: Http20Enabled: configures a web site to allow clients to connect over http2.0 ,
Required: False ,
}
boolean ,
http20ProxyFlag:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
minTlsVersion:
{
Description: MinTlsVersion: configures the minimum version of TLS required for SSL requests ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
minTlsCipherSuite:
{
Description: The minimum strength TLS cipher suite allowed for an application ,
Enum:
{
TLS_AES_256_GCM_SHA384: No description available. ,
TLS_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_256_GCM_SHA384: No description available. ,
TLS_RSA_WITH_AES_128_GCM_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA256: No description available. ,
TLS_RSA_WITH_AES_256_CBC_SHA: No description available. ,
TLS_RSA_WITH_AES_128_CBC_SHA: No description available. ,
}
,
Required: False ,
}
enum ,
scmMinTlsVersion:
{
Description: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site ,
Enum:
{
1.0: No description available. ,
1.1: No description available. ,
1.2: No description available. ,
1.3: No description available. ,
}
,
Required: False ,
}
enum ,
ftpsState:
{
Description: State of FTP / FTPS service ,
Enum:
{
AllAllowed: No description available. ,
FtpsOnly: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
preWarmedInstanceCount:
{
Description: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
functionAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans ,
Format: int32 ,
Required: False ,
}
integer ,
elasticWebAppScaleLimit:
{
Description: Maximum number of workers that a site can scale out to. This setting only applies to apps in plans where ElasticScaleEnabled is true ,
Format: int32 ,
Required: False ,
}
integer ,
healthCheckPath:
{
Description: Health check path ,
Required: False ,
}
string ,
functionsRuntimeScaleMonitoringEnabled:
{
Description: 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. ,
Required: False ,
}
boolean ,
websiteTimeZone:
{
Description: 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 ,
Required: False ,
}
string ,
minimumElasticInstanceCount:
{
Description: Number of minimum instance count for a site This setting only applies to the Elastic Plans ,
Format: int32 ,
Required: False ,
}
integer ,
azureStorageAccounts:
{
Description: List of Azure Storage Accounts. ,
Required: False ,
}
object ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. ,
Required: False ,
}
string ,
}
,
functionAppConfig:
{
Description: Configuration specific of the Azure Function app. ,
Required: False ,
}
{
deployment:
{
Description: Function app deployment configuration. ,
Required: False ,
}
{
storage:
{
Description: Storage for deployed package used by the function app. ,
Required: False ,
}
{
type:
{
Description: Property to select Azure Storage type. Available options: blobContainer. ,
Enum:
{
blobContainer: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://.blob.core.windows.net/. ,
Format: uri ,
Required: False ,
}
string ,
authentication:
{
Description: Authentication method to access the storage account for deployment. ,
Required: False ,
}
{
type:
{
Description: Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. ,
Enum:
{
SystemAssignedIdentity: No description available. ,
UserAssignedIdentity: No description available. ,
StorageAccountConnectionString: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentityResourceId:
{
Description: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
storageAccountConnectionStringName:
{
Description: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. ,
Required: False ,
}
string ,
}
,
}
,
}
,
runtime:
{
Description: Function app runtime settings. ,
Required: False ,
}
{
name:
{
Description: Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom ,
Enum:
{
dotnet-isolated: No description available. ,
node: No description available. ,
java: No description available. ,
powershell: No description available. ,
python: No description available. ,
custom: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Function app runtime version. Example: 8 (for dotnet-isolated) ,
Required: False ,
}
string ,
}
,
scaleAndConcurrency:
{
Description: Function app scale and concurrency settings. ,
Required: False ,
}
{
alwaysReady:
{
Description: 'Always Ready' configuration for the function app. ,
Required: False ,
}
[
{
name:
{
Description: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Required: False ,
}
string ,
instanceCount:
{
Description: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
maximumInstanceCount:
{
Description: The maximum number of instances for the function app. ,
Format: int32 ,
Required: False ,
}
integer ,
instanceMemoryMB:
{
Description: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. ,
Format: int32 ,
Required: False ,
}
integer ,
triggers:
{
Description: Scale and concurrency settings for the function app triggers. ,
Required: False ,
}
{
http:
{
Description: Scale and concurrency settings for the HTTP trigger. ,
Required: False ,
}
{
perInstanceConcurrency:
{
Description: The maximum number of concurrent HTTP trigger invocations per instance. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
}
,
daprConfig:
{
Description: Dapr configuration of the app. ,
Required: False ,
}
{
enabled:
{
Description: Boolean indicating if the Dapr side car is enabled ,
Required: False ,
}
boolean ,
appId:
{
Description: Dapr application identifier ,
Required: False ,
}
string ,
appPort:
{
Description: Tells Dapr which port your application is listening on ,
Format: int32 ,
Required: False ,
}
integer ,
httpReadBufferSize:
{
Description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. ,
Format: int32 ,
Required: False ,
}
integer ,
httpMaxRequestSize:
{
Description: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. ,
Format: int32 ,
Required: False ,
}
integer ,
logLevel:
{
Description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. ,
Enum:
{
info: No description available. ,
debug: No description available. ,
warn: No description available. ,
error: No description available. ,
}
,
Required: False ,
}
enum ,
enableApiLogging:
{
Description: Enables API logging for the Dapr sidecar ,
Required: False ,
}
boolean ,
}
,
workloadProfileName:
{
Description: Workload profile name for function app to execute on. ,
Required: False ,
}
string ,
resourceConfig:
{
Description: Function app resource requirements. ,
Required: False ,
}
{
cpu:
{
Description: Required CPU in cores, e.g. 0.5 ,
Format: double ,
Required: False ,
}
number ,
memory:
{
Description: Required memory, e.g. "1Gi" ,
Required: False ,
}
string ,
}
,
trafficManagerHostNames:
{
Description: Azure Traffic Manager hostnames associated with the app. Read-only. ,
Required: False ,
}
[
string ,
]
,
scmSiteAlsoStopped:
{
Description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. ,
Required: False ,
}
boolean ,
targetSwapSlot:
{
Description: Specifies which deployment slot this app will swap into. Read-only. ,
Required: False ,
}
string ,
hostingEnvironmentProfile:
{
Description: App Service Environment to use for the app. ,
Required: False ,
}
{
id:
{
Description: Resource ID of the App Service Environment. ,
Required: False ,
}
string ,
name:
{
Description: Name of the App Service Environment. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the App Service Environment. ,
Required: False ,
}
string ,
}
,
clientAffinityEnabled:
{
Description: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true. ,
Required: False ,
}
boolean ,
clientAffinityPartitioningEnabled:
{
Description: true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitioned affinity cookies. Default is false. ,
Required: False ,
}
boolean ,
clientAffinityProxyEnabled:
{
Description: true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false. ,
Required: False ,
}
boolean ,
clientCertEnabled:
{
Description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. ,
Required: False ,
}
boolean ,
clientCertMode:
{
Description: 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. ,
Enum:
{
Required: No description available. ,
Optional: No description available. ,
OptionalInteractiveUser: No description available. ,
}
,
Required: False ,
}
enum ,
clientCertExclusionPaths:
{
Description: client certificate authentication comma-separated exclusion paths ,
Required: False ,
}
string ,
ipMode:
{
Description: Specifies the IP mode of the app. ,
Enum:
{
IPv4: No description available. ,
IPv6: No description available. ,
IPv4AndIPv6: No description available. ,
}
,
Required: False ,
}
enum ,
endToEndEncryptionEnabled:
{
Description: Whether to use end to end encryption between the FrontEnd and the Worker ,
Required: False ,
}
boolean ,
sshEnabled:
{
Description: Whether to enable ssh access. ,
Required: False ,
}
boolean ,
hostNamesDisabled:
{
Description: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. ,
Required: False ,
}
boolean ,
customDomainVerificationId:
{
Description: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. ,
Required: False ,
}
string ,
outboundIpAddresses:
{
Description: 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. ,
Required: False ,
}
string ,
possibleOutboundIpAddresses:
{
Description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. ,
Required: False ,
}
string ,
containerSize:
{
Description: Size of the function container. ,
Format: int32 ,
Required: False ,
}
integer ,
dailyMemoryTimeQuota:
{
Description: Maximum allowed daily memory-time quota (applicable on dynamic apps only). ,
Format: int32 ,
Required: False ,
}
integer ,
suspendedTill:
{
Description: App suspended till in case memory-time quota is exceeded. ,
Format: date-time ,
Required: False ,
}
string ,
maxNumberOfWorkers:
{
Description: Maximum number of workers. This only applies to Functions container. ,
Format: int32 ,
Required: False ,
}
integer ,
cloningInfo:
{
Description: If specified during app creation, the app is cloned from a source app. ,
Required: False ,
}
{
correlationId:
{
Description: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot. ,
Format: uuid ,
Required: False ,
}
string ,
overwrite:
{
Description: true to overwrite destination app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneCustomHostNames:
{
Description: true to clone custom hostnames from source app; otherwise, false. ,
Required: False ,
}
boolean ,
cloneSourceControl:
{
Description: true to clone source control from source app; otherwise, false. ,
Required: False ,
}
boolean ,
sourceWebAppId:
{
Description: ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots. ,
Required: True ,
}
string ,
sourceWebAppLocation:
{
Description: Location of source app ex: West US or North Europe ,
Required: False ,
}
string ,
hostingEnvironment:
{
Description: App Service Environment. ,
Required: False ,
}
string ,
appSettingsOverrides:
{
Description: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained. ,
Required: False ,
}
object ,
configureLoadBalancing:
{
Description: true to configure load balancing for source and destination app. ,
Required: False ,
}
boolean ,
trafficManagerProfileId:
{
Description: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}. ,
Required: False ,
}
string ,
trafficManagerProfileName:
{
Description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. ,
Required: False ,
}
string ,
}
,
resourceGroup:
{
Description: Name of the resource group the app belongs to. Read-only. ,
Required: False ,
}
string ,
isDefaultContainer:
{
Description: true if the app is a default container; otherwise, false. ,
Required: False ,
}
boolean ,
defaultHostName:
{
Description: Default hostname of the app. Read-only. ,
Required: False ,
}
string ,
slotSwapStatus:
{
Description: Status of the last deployment slot swap operation. ,
Required: False ,
}
{
timestampUtc:
{
Description: The time the last successful slot swap completed. ,
Format: date-time ,
Required: False ,
}
string ,
sourceSlotName:
{
Description: The source slot of the last swap operation. ,
Required: False ,
}
string ,
destinationSlotName:
{
Description: The destination slot of the last swap operation. ,
Required: False ,
}
string ,
}
,
httpsOnly:
{
Description: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests ,
Required: False ,
}
boolean ,
redundancyMode:
{
Description: Site redundancy mode ,
Enum:
{
None: No description available. ,
Manual: No description available. ,
Failover: No description available. ,
ActiveActive: No description available. ,
GeoRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
inProgressOperationId:
{
Description: Specifies an operation id if this site has a pending operation. ,
Format: uuid ,
Required: False ,
}
string ,
publicNetworkAccess:
{
Description: Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. ,
Required: False ,
}
string ,
storageAccountRequired:
{
Description: Checks if Customer provided storage account is required ,
Required: False ,
}
boolean ,
keyVaultReferenceIdentity:
{
Description: Identity to use for Key Vault Reference authentication. ,
Required: False ,
}
string ,
autoGeneratedDomainNameLabelScope:
{
Description: Specifies the scope of uniqueness for the default hostname during resource creation ,
Enum:
{
TenantReuse: No description available. ,
SubscriptionReuse: No description available. ,
ResourceGroupReuse: No description available. ,
NoReuse: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetId:
{
Description: 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} ,
Required: False ,
}
string ,
managedEnvironmentId:
{
Description: 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} ,
Required: False ,
}
string ,
sku:
{
Description: 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 ,
Required: False ,
}
string ,
}
,
identity:
{
Description: Managed service identity. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Extended Location. ,
Required: False ,
}
{
name:
{
Description: Name of extended location. ,
Required: False ,
}
string ,
type:
{
Description: Type of extended location. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Error model. ,
Required: False ,
}
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
{
code:
{
Description: Standardized string to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
target:
{
Description: Detailed error description and debugging information. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: More information to debug error. ,
Required: False ,
}
string ,
}
,
}