Microsoft.Web sites/slots/config 'web' 2016-08-01

  • مقالة
  • قراءة خلال 8 دقائق

The sites/slots/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/slots/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/slots/config resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Web/sites/slots/config@2016-08-01' = {
  name: 'web'
  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'
      }
    ]
    http20Enabled: bool
    httpLoggingEnabled: bool
    ipSecurityRestrictions: [
      {
        ipAddress: 'string'
        subnetMask: 'string'
      }
    ]
    javaContainer: 'string'
    javaContainerVersion: 'string'
    javaVersion: 'string'
    limits: {
      maxDiskSizeInMb: int
      maxMemoryInMb: int
      maxPercentageCpu: int
    }
    linuxFxVersion: 'string'
    loadBalancing: 'string'
    localMySqlEnabled: bool
    logsDirectorySizeLimit: int
    managedPipelineMode: 'string'
    minTlsVersion: 'string'
    netFrameworkVersion: 'string'
    nodeVersion: 'string'
    numberOfWorkers: int
    phpVersion: 'string'
    publishingUsername: 'string'
    push: {
      kind: 'string'
      properties: {
        dynamicTagsJson: 'string'
        isPushEnabled: bool
        tagsRequiringAuth: 'string'
        tagWhitelistJson: '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/slots/config-web

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.		 'Microsoft.Web/sites/slots/config'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.		 '2016-08-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.		 'web'
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: slots
properties Configuration of an App Service app. SiteConfig

SiteConfig

Name Description Value
alwaysOn true if Always On is enabled; otherwise, false. bool
apiDefinition Information about the formal API definition for the app. ApiDefinitionInfo
appCommandLine App command line to launch. string
appSettings Application settings. NameValuePair[]
autoHealEnabled true if Auto Heal is enabled; otherwise, false. bool
autoHealRules Rules that 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 app. CorsSettings
defaultDocuments Default documents. string[]
detailedErrorLoggingEnabled true if detailed error logging is enabled; otherwise, false. bool
documentRoot Document root. string
experiments Routing rules in production experiments. Experiments
handlerMappings Handler mappings. HandlerMapping[]
http20Enabled Http20Enabled: configures a web site to allow clients to connect over http2.0 bool
httpLoggingEnabled true if HTTP logging is enabled; otherwise, false. bool
ipSecurityRestrictions IP security restrictions. IpSecurityRestriction[]
javaContainer Java container. string
javaContainerVersion Java container version. string
javaVersion Java version. string
limits Metric limits set on an app. SiteLimits
linuxFxVersion Linux App Framework and version string
loadBalancing Site load balancing. 'LeastRequests'
'LeastResponseTime'
'RequestHash'
'WeightedRoundRobin'
'WeightedTotalTraffic'
localMySqlEnabled true to enable local MySQL; otherwise, false. bool
logsDirectorySizeLimit HTTP logs directory size limit. int
managedPipelineMode Managed pipeline mode. 'Classic'
'Integrated'
minTlsVersion MinTlsVersion: configures the minimum version of TLS required for SSL requests '1.0'
'1.1'
'1.2'
netFrameworkVersion .NET Framework version. string
nodeVersion Version of Node.js. string
numberOfWorkers Number of workers. int
phpVersion Version of PHP. string
publishingUsername Publishing user name. string
push Push settings for the App. PushSettings
pythonVersion Version of Python. string
remoteDebuggingEnabled true if remote debugging is enabled; otherwise, false. bool
remoteDebuggingVersion Remote debugging version. string
requestTracingEnabled true if request tracing is enabled; otherwise, false. bool
requestTracingExpirationTime Request tracing expiration time. string
scmType SCM type. 'BitbucketGit'
'BitbucketHg'
'CodePlexGit'
'CodePlexHg'
'Dropbox'
'ExternalGit'
'ExternalHg'
'GitHub'
'LocalGit'
'None'
'OneDrive'
'Tfs'
'VSO'
tracingOptions Tracing options. string
use32BitWorkerProcess true to use 32-bit worker process; otherwise, false. bool
virtualApplications Virtual applications. VirtualApplication[]
vnetName Virtual Network name. string
webSocketsEnabled true if WebSocket is enabled; otherwise, false. 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 Actions which to take by the auto-heal module when a rule is triggered. AutoHealActions
triggers Triggers for auto-heal. AutoHealTriggers

AutoHealActions

Name Description Value
actionType Predefined action to be taken. 'CustomAction'
'LogEvent'
'Recycle'
customAction Custom action to be executed
when an auto heal rule is triggered.		 AutoHealCustomAction
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 A rule based on private bytes. int
requests Trigger based on total requests. RequestsBasedTrigger
slowRequests Trigger based on request execution time. SlowRequestsBasedTrigger
statusCodes A rule based on status codes. StatusCodesBasedTrigger[]

RequestsBasedTrigger

Name Description Value
count Request Count. int
timeInterval Time interval. string

SlowRequestsBasedTrigger

Name Description Value
count Request Count. int
timeInterval Time interval. string
timeTaken Time taken. string

StatusCodesBasedTrigger

Name Description Value
count Request Count. int
status HTTP status code. int
subStatus Request Sub Status. int
timeInterval Time interval. 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. 'ApiHub'
'Custom'
'DocDb'
'EventHub'
'MySql'
'NotificationHub'
'PostgreSQL'
'RedisCache'
'SQLAzure'
'SQLServer'
'ServiceBus'

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 ramp-up rules. RampUpRule[]

RampUpRule

Name Description Value
actionHostName Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-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 Specifies interval in minutes to reevaluate ReroutePercentage. int
changeStep In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches
MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.
Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.		 int
maxReroutePercentage Specifies upper boundary below which ReroutePercentage will stay. int
minReroutePercentage 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 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 (required)
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

PushSettings

Name Description Value
kind Kind of resource. string
properties PushSettings resource specific properties PushSettingsProperties

PushSettingsProperties

Name Description Value
dynamicTagsJson Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. string
isPushEnabled Gets or sets a flag indicating whether the Push endpoint is enabled. bool (required)
tagsRequiringAuth Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.
Tags can consist of alphanumeric characters and the following:
'_', '@', '#', '.', ':', '-'.
Validation should be performed at the PushRequestHandler.		 string
tagWhitelistJson Gets or sets a JSON string containing a list of tags that are allowed for use by the push registration endpoint. string

VirtualApplication

Name Description Value
physicalPath Physical path. string
preloadEnabled true if preloading is enabled; otherwise, false. bool
virtualDirectories Virtual directories for virtual application. VirtualDirectory[]
virtualPath Virtual path. string

VirtualDirectory

Name Description Value
physicalPath Physical path. string
virtualPath Path to virtual application. string