Microsoft.Web sites/config 'web' 2015-08-01

مقالة
05/06/2022
قراءة خلال 12 دقائق

The sites/config resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Options for name property

The sites/config resource accepts different properties based on the value of the name property. This article shows the properties that are available when you set name: 'web'.

For other options, see:

Template format

To create a Microsoft.Web/sites/config resource, add the following Bicep or JSON to your template.

Bicep
JSON

resource symbolicname 'Microsoft.Web/sites/config@2015-08-01' = {
  name: 'web'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  parent: resourceSymbolicName
  properties: {
    alwaysOn: bool
    apiDefinition: {
      url: 'string'
    }
    appCommandLine: 'string'
    appSettings: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    autoHealEnabled: bool
    autoHealRules: {
      actions: {
        actionType: 'string'
        customAction: {
          exe: 'string'
          parameters: 'string'
        }
        minProcessExecutionTime: 'string'
      }
      triggers: {
        privateBytesInKB: int
        requests: {
          count: int
          timeInterval: 'string'
        }
        slowRequests: {
          count: int
          timeInterval: 'string'
          timeTaken: 'string'
        }
        statusCodes: [
          {
            count: int
            status: int
            subStatus: int
            timeInterval: 'string'
            win32Status: int
          }
        ]
      }
    }
    autoSwapSlotName: 'string'
    connectionStrings: [
      {
        connectionString: 'string'
        name: 'string'
        type: 'string'
      }
    ]
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    defaultDocuments: [
      'string'
    ]
    detailedErrorLoggingEnabled: bool
    documentRoot: 'string'
    experiments: {
      rampUpRules: [
        {
          actionHostName: 'string'
          changeDecisionCallbackUrl: 'string'
          changeIntervalInMinutes: int
          changeStep: int
          maxReroutePercentage: int
          minReroutePercentage: int
          name: 'string'
          reroutePercentage: int
        }
      ]
    }
    handlerMappings: [
      {
        arguments: 'string'
        extension: 'string'
        scriptProcessor: 'string'
      }
    ]
    httpLoggingEnabled: bool
    ipSecurityRestrictions: [
      {
        ipAddress: 'string'
        subnetMask: 'string'
      }
    ]
    javaContainer: 'string'
    javaContainerVersion: 'string'
    javaVersion: 'string'
    limits: {
      maxDiskSizeInMb: int
      maxMemoryInMb: int
      maxPercentageCpu: int
    }
    loadBalancing: 'string'
    localMySqlEnabled: bool
    logsDirectorySizeLimit: int
    managedPipelineMode: 'string'
    metadata: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    netFrameworkVersion: 'string'
    nodeVersion: 'string'
    numberOfWorkers: int
    phpVersion: 'string'
    publishingPassword: 'string'
    publishingUsername: 'string'
    pythonVersion: 'string'
    remoteDebuggingEnabled: bool
    remoteDebuggingVersion: 'string'
    requestTracingEnabled: bool
    requestTracingExpirationTime: 'string'
    scmType: 'string'
    tracingOptions: 'string'
    use32BitWorkerProcess: bool
    virtualApplications: [
      {
        physicalPath: 'string'
        preloadEnabled: bool
        virtualDirectories: [
          {
            physicalPath: 'string'
            virtualPath: 'string'
          }
        ]
        virtualPath: 'string'
      }
    ]
    vnetName: 'string'
    webSocketsEnabled: bool
  }
}

{
  "type": "Microsoft.Web/sites/config",
  "apiVersion": "2015-08-01",
  "name": "web",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "properties": {
    "alwaysOn": "bool",
    "apiDefinition": {
      "url": "string"
    },
    "appCommandLine": "string",
    "appSettings": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "autoHealEnabled": "bool",
    "autoHealRules": {
      "actions": {
        "actionType": "string",
        "customAction": {
          "exe": "string",
          "parameters": "string"
        },
        "minProcessExecutionTime": "string"
      },
      "triggers": {
        "privateBytesInKB": "int",
        "requests": {
          "count": "int",
          "timeInterval": "string"
        },
        "slowRequests": {
          "count": "int",
          "timeInterval": "string",
          "timeTaken": "string"
        },
        "statusCodes": [
          {
            "count": "int",
            "status": "int",
            "subStatus": "int",
            "timeInterval": "string",
            "win32Status": "int"
          }
        ]
      }
    },
    "autoSwapSlotName": "string",
    "connectionStrings": [
      {
        "connectionString": "string",
        "name": "string",
        "type": "string"
      }
    ],
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "defaultDocuments": [ "string" ],
    "detailedErrorLoggingEnabled": "bool",
    "documentRoot": "string",
    "experiments": {
      "rampUpRules": [
        {
          "actionHostName": "string",
          "changeDecisionCallbackUrl": "string",
          "changeIntervalInMinutes": "int",
          "changeStep": "int",
          "maxReroutePercentage": "int",
          "minReroutePercentage": "int",
          "name": "string",
          "reroutePercentage": "int"
        }
      ]
    },
    "handlerMappings": [
      {
        "arguments": "string",
        "extension": "string",
        "scriptProcessor": "string"
      }
    ],
    "httpLoggingEnabled": "bool",
    "ipSecurityRestrictions": [
      {
        "ipAddress": "string",
        "subnetMask": "string"
      }
    ],
    "javaContainer": "string",
    "javaContainerVersion": "string",
    "javaVersion": "string",
    "limits": {
      "maxDiskSizeInMb": "int",
      "maxMemoryInMb": "int",
      "maxPercentageCpu": "int"
    },
    "loadBalancing": "string",
    "localMySqlEnabled": "bool",
    "logsDirectorySizeLimit": "int",
    "managedPipelineMode": "string",
    "metadata": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "netFrameworkVersion": "string",
    "nodeVersion": "string",
    "numberOfWorkers": "int",
    "phpVersion": "string",
    "publishingPassword": "string",
    "publishingUsername": "string",
    "pythonVersion": "string",
    "remoteDebuggingEnabled": "bool",
    "remoteDebuggingVersion": "string",
    "requestTracingEnabled": "bool",
    "requestTracingExpirationTime": "string",
    "scmType": "string",
    "tracingOptions": "string",
    "use32BitWorkerProcess": "bool",
    "virtualApplications": [
      {
        "physicalPath": "string",
        "preloadEnabled": "bool",
        "virtualDirectories": [
          {
            "physicalPath": "string",
            "virtualPath": "string"
          }
        ],
        "virtualPath": "string"
      }
    ],
    "vnetName": "string",
    "webSocketsEnabled": "bool"
  }
}

Property values

sites/config-web

Name	Description	Value
type	The resource type For Bicep, set this value in the resource declaration.	'Microsoft.Web/sites/config'
apiVersion	The resource api version For Bicep, set this value in the resource declaration.	'2015-08-01'
name	The resource name See how to set names and types for child resources in Bicep or JSON ARM templates.	'web'
location	Resource Location	string (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
kind	Kind of resource	string
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: sites
properties		SiteConfigProperties

SiteConfigProperties

Name	Description	Value
alwaysOn	Always On	bool
apiDefinition	Information about the formal API definition for the web app.	ApiDefinitionInfo
appCommandLine	App Command Line to launch	string
appSettings	Application Settings	NameValuePair[]
autoHealEnabled	Auto heal enabled	bool
autoHealRules	AutoHealRules - describes the rules which can be defined for auto-heal	AutoHealRules
autoSwapSlotName	Auto swap slot name	string
connectionStrings	Connection strings	ConnStringInfo[]
cors	Cross-Origin Resource Sharing (CORS) settings for the web app.	CorsSettings
defaultDocuments	Default documents	string[]
detailedErrorLoggingEnabled	Detailed error logging enabled	bool
documentRoot	Document root	string
experiments	Class containing Routing in production experiments	Experiments
handlerMappings	Handler mappings	HandlerMapping[]
httpLoggingEnabled	HTTP logging Enabled	bool
ipSecurityRestrictions	Ip Security restrictions	IpSecurityRestriction[]
javaContainer	Java container	string
javaContainerVersion	Java container version	string
javaVersion	Java version	string
limits	Represents metric limits set on a web app.	SiteLimits
loadBalancing	Site load balancing	'LeastRequests' 'LeastResponseTime' 'RequestHash' 'WeightedRoundRobin' 'WeightedTotalTraffic'
localMySqlEnabled	Local mysql enabled	bool
logsDirectorySizeLimit	HTTP Logs Directory size limit	int
managedPipelineMode	Managed pipeline mode	'Classic' 'Integrated'
metadata	Site Metadata	NameValuePair[]
netFrameworkVersion	Net Framework Version	string
nodeVersion	Version of Node	string
numberOfWorkers	Number of workers	int
phpVersion	Version of PHP	string
publishingPassword	Publishing password	string
publishingUsername	Publishing user name	string
pythonVersion	Version of Python	string
remoteDebuggingEnabled	Remote Debugging Enabled	bool
remoteDebuggingVersion	Remote Debugging Version	string
requestTracingEnabled	Enable request tracing	bool
requestTracingExpirationTime	Request tracing expiration time	string
scmType	SCM type	string
tracingOptions	Tracing options	string
use32BitWorkerProcess	Use 32 bit worker process	bool
virtualApplications	Virtual applications	VirtualApplication[]
vnetName	Vnet name	string
webSocketsEnabled	Web socket enabled.	bool

ApiDefinitionInfo

Name	Description	Value
url	The URL of the API definition.	string

NameValuePair

Name	Description	Value
name	Pair name	string
value	Pair value	string

AutoHealRules

Name	Description	Value
actions	AutoHealActions - Describes the actions which can be taken by the auto-heal module when a rule is triggered.	AutoHealActions
triggers	AutoHealTriggers - describes the triggers for auto-heal.	AutoHealTriggers

AutoHealActions

Name	Description	Value
actionType	ActionType - predefined action to be taken	'CustomAction' 'LogEvent' 'Recycle'
customAction	AutoHealCustomAction - Describes the custom action to be executed when an auto heal rule is triggered.	AutoHealCustomAction
minProcessExecutionTime	MinProcessExecutionTime - minimum time the process must execute before taking the action	string

AutoHealCustomAction

Name	Description	Value
exe	Executable to be run	string
parameters	Parameters for the executable	string

AutoHealTriggers

Name	Description	Value
privateBytesInKB	PrivateBytesInKB - Defines a rule based on private bytes	int
requests	RequestsBasedTrigger	RequestsBasedTrigger
slowRequests	SlowRequestsBasedTrigger	SlowRequestsBasedTrigger
statusCodes	StatusCodes - Defines a rule based on status codes	StatusCodesBasedTrigger[]

RequestsBasedTrigger

Name	Description	Value
count	Count	int
timeInterval	TimeInterval	string

SlowRequestsBasedTrigger

Name	Description	Value
count	Count	int
timeInterval	TimeInterval	string
timeTaken	TimeTaken	string

StatusCodesBasedTrigger

Name	Description	Value
count	Count	int
status	HTTP status code	int
subStatus	SubStatus	int
timeInterval	TimeInterval	string
win32Status	Win32 error code	int

ConnStringInfo

Name	Description	Value
connectionString	Connection string value	string
name	Name of connection string	string
type	Type of database	'Custom' 'MySql' 'SQLAzure' 'SQLServer'

CorsSettings

Name	Description	Value
allowedOrigins	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.	string[]

Experiments

Name	Description	Value
rampUpRules	List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects.	RampUpRule[]

RampUpRule

Name	Description	Value
actionHostName	Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net	string
changeDecisionCallbackUrl	Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/	string
changeIntervalInMinutes	[Optional] Specifies interval in minutes to reevaluate ReroutePercentage	int
changeStep	[Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}. Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl}	int
maxReroutePercentage	[Optional] Specifies upper boundary below which ReroutePercentage will stay.	int
minReroutePercentage	[Optional] Specifies lower boundary above which ReroutePercentage will stay.	int
name	Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.	string
reroutePercentage	Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName}	int

HandlerMapping

Name	Description	Value
arguments	Command-line arguments to be passed to the script processor.	string
extension	Requests with this extension will be handled using the specified FastCGI application.	string
scriptProcessor	The absolute path to the FastCGI application.	string

IpSecurityRestriction

Name	Description	Value
ipAddress	IP address the security restriction is valid for	string
subnetMask	Subnet mask for the range of IP addresses the restriction is valid for	string

SiteLimits

Name	Description	Value
maxDiskSizeInMb	Maximum allowed disk size usage in MB	int
maxMemoryInMb	Maximum allowed memory usage in MB	int
maxPercentageCpu	Maximum allowed CPU usage percentage	int

VirtualApplication

Name	Description	Value
physicalPath		string
preloadEnabled		bool
virtualDirectories	Array of VirtualDirectory	VirtualDirectory[]
virtualPath		string

VirtualDirectory

Name	Description	Value
physicalPath		string
virtualPath		string

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Airflow Web App with PostgreSQL database on App Services	A template for deploying Airflow Web App with PostgreSQL database on App Services
EPiserverCMS in Azure	This template allows you to create resources required for EpiServerCMS deployment in Azure
Java CI/CD using Jenkins and Azure Web Apps	This is a sample for Java CI/CD using Jenkins and Azure Web Apps.
Orchard CMS Video Portal Web App	This template provides a easy way to deploy Orchard CMS on Azure App Service Web Apps with the Azure Media Services module enabled and configured.
PubNub Realtime Gateway for Azure Event Hubs	The PubNub Realtime Gateway for Azure provides a realtime data stream bridge between the PubNub Data Stream Network and Azure Event Hubs. -- consider it a bi-directional bridge between PubNub and Azure!
Scalable Umbraco CMS Web App	This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.
Simple Umbraco CMS Web App	This template provides a easy way to deploy umbraco CMS web app on Azure App Service Web Apps.
WordPress on App Service with MySQL In App	This template deploys a WordPress Web App on a Windows App Service with MySQL in app
Enterprise Governance-AppService, SQL DB, AD, OMS, Runbooks	Cloud adoption for an Enterprise, small or large, require responsible and efficient governance models to derive value from their cloud deployments. CloudWise (a code-name for the solution), is a composite solution available from Azure Partner QuickStarts, is an adoption enabler for Customers, System Integrators and Partners alike, that delivers a self-serviceable, automated governance and operations solution, focused on Optimizing Your Costs, Improve Your Application(s) Reliability, Reducing Business Risk. The solution highlights the core governance pillars of Visibility and Control.
WebApp consuming a Azure SQL Private Endpoint	This template shows how to create a Web app that consumes a private endpoint pointing to Azure SQL Server
Call custom APIs from Azure Logic Apps	Although Logic Apps provides hundreds of connectors for various services, you might want to call APIs that run your own code. One of the easiest and most scalable ways to host your own web APIs is by using Azure App Service. This template deploys a Web app for your custom API and secures that API by using Azure Active Directory authentication.
Application Gateway for a Web App with IP Restriction	This template creates an application gateway in front of an Azure Web App with IP restriction enabled on the Web App.
App Service Environment with Azure SQL backend	This template creates an App Service Environment with an Azure SQL backend along with private endpoints along with associated resources typically used in an private/isolated environment.
Provision a function app on a dedicated hosting plan	This template provisions a function app on a dedicated hosting plan, meaning it will be run and billed just like any App Service site. There are other templates available for provisioning on a dynamic hosting plan.
Provision a Mobile App with a SQL Database	This template provisions a Mobile App, SQL Database, and Notification Hub. It configures a connection string in the mobile app for the database and notification hub.
Web App with Private Endpoint	This template allows you to create a Web App and expose it through Private Endpoint
Application Gateway with internal API Management and Web App	Application Gateway routing Internet traffic to a virtual network (internal mode) API Management instance which services a web API hosted in an Azure Web App.
Create Azure Web app with Blob Storage connection string	Creates an Azure Web app with Blob Storage connection string, Template originally authored by Jeff Bowles of Microsoft
Web App with diagnostics logging to Blob Container	Deploy a Web App with diagnostics logging to Storage Account Blob Container enabled.
Create a web app on Azure with Java 13 and Tomcat 9 enabled	This template creates a web app on azure with Java 13 and Tomcat 9 enabled allowing you to run Java applications in Azure. Template was authored by Donovan Brown of Microsoft.
Web App w/ Application Insights sending to Log Analytics	This template will is to help support the new API versions of microsoft.insights/components. Starting with 2020-02-02-preview WorkspaceID will be required when creating Application Inisghts.This template will deploy the App Service Plan, App Service, Application Insights, Log Analytics Workspace and hook it all together.
Web App with Managed Identity, SQL Server and ΑΙ	Simple example to deploy Azure infrastructure for app + data + managed identity + monitoring
Create a Web App + Redis Cache + SQL DB with a template	This template creates an Azure Web App with Redis cache and a SQL Database.
Provision a Web App with a SQL Database	This template provisions a Web App, a SQL Database, AutoScale settings, Alert rules, and App Insights. It configures a connection string in the web app for the database.
Create a Web App plus Redis Cache using a template	This template creates an Azure Web App with Redis cache.
Web App with custom Deployment slots	This template provides an easy way to deploy a web app with custom deployment slots on Azure Web Apps.
Airflow Docker Web App on Linux with PostgreSQL	This template provides a easy way to deploy a puckel/docker-airflow image (latest tag) on a Linux Web App with Azure database for PostgreSQL
Sonarqube Docker Web App on Linux with Azure SQL	This template deploys Sonarqube in an Azure App Service web app Linux container using the official Sonarqube image and backed by an Azure SQL Server.
Sonarqube Docker Web App on Linux with MySQL	This template provides a easy way to deploy a Sonarqube docker image (alpine tag) on a Linux Web App with Azure database for MySQL
Sonarqube Docker Web App on Linux with PostgreSQL	This template provides a easy way to deploy a Sonarqube docker image (alpine tag) on a Linux Web App with Azure database for PostgreSQL(Preview)
Web App with Azure database for MySQL	This template provides a easy way to deploy web app on Azure App Service Web Apps with Azure database for MySQL.
Web App on Linux with PostgreSQL	This template provides a easy way to deploy Web App on Linux with Azure database for PostgreSQL.
Web App with VNet Injection and Private Endpoint.	This template allows you to create a secure end to end solution with two web apps, front end and back end, front end will consume securely the back through VNet injection and Private Endpoint