Microsoft.Web sites/config 2018-02-01

Article
10/25/2024

Bicep resource definition

The sites/config resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.Web/sites/config@2018-02-01' = {
  name: 'string'
  // For remaining properties, see microsoft.web/sites/config objects
}

microsoft.web/sites/config objects

Set the name property to specify the type of object.

For appsettings, use:

{
  kind: 'string'
  name: 'appsettings'
  properties: {
    {customized property}: 'string'
  }
}

For authsettings, use:

{
  kind: 'string'
  name: 'authsettings'
  properties: {
    additionalLoginParams: [
      'string'
    ]
    allowedAudiences: [
      'string'
    ]
    allowedExternalRedirectUrls: [
      'string'
    ]
    clientId: 'string'
    clientSecret: 'string'
    clientSecretCertificateThumbprint: 'string'
    defaultProvider: 'string'
    enabled: bool
    facebookAppId: 'string'
    facebookAppSecret: 'string'
    facebookOAuthScopes: [
      'string'
    ]
    googleClientId: 'string'
    googleClientSecret: 'string'
    googleOAuthScopes: [
      'string'
    ]
    issuer: 'string'
    microsoftAccountClientId: 'string'
    microsoftAccountClientSecret: 'string'
    microsoftAccountOAuthScopes: [
      'string'
    ]
    runtimeVersion: 'string'
    tokenRefreshExtensionHours: int
    tokenStoreEnabled: bool
    twitterConsumerKey: 'string'
    twitterConsumerSecret: 'string'
    unauthenticatedClientAction: 'string'
    validateIssuer: bool
  }
}

For azurestorageaccounts, use:

{
  kind: 'string'
  name: 'azurestorageaccounts'
  properties: {
    {customized property}: {
      accessKey: 'string'
      accountName: 'string'
      mountPath: 'string'
      shareName: 'string'
      type: 'string'
    }
  }
}

For backup, use:

{
  kind: 'string'
  name: 'backup'
  properties: {
    backupName: 'string'
    backupSchedule: {
      frequencyInterval: int
      frequencyUnit: 'string'
      keepAtLeastOneBackup: bool
      retentionPeriodInDays: int
      startTime: 'string'
    }
    databases: [
      {
        connectionString: 'string'
        connectionStringName: 'string'
        databaseType: 'string'
        name: 'string'
      }
    ]
    enabled: bool
    storageAccountUrl: 'string'
  }
}

For connectionstrings, use:

{
  kind: 'string'
  name: 'connectionstrings'
  properties: {
    {customized property}: {
      type: 'string'
      value: 'string'
    }
  }
}

For logs, use:

{
  kind: 'string'
  name: 'logs'
  properties: {
    applicationLogs: {
      azureBlobStorage: {
        level: 'string'
        retentionInDays: int
        sasUrl: 'string'
      }
      azureTableStorage: {
        level: 'string'
        sasUrl: 'string'
      }
      fileSystem: {
        level: 'string'
      }
    }
    detailedErrorMessages: {
      enabled: bool
    }
    failedRequestsTracing: {
      enabled: bool
    }
    httpLogs: {
      azureBlobStorage: {
        enabled: bool
        retentionInDays: int
        sasUrl: 'string'
      }
      fileSystem: {
        enabled: bool
        retentionInDays: int
        retentionInMb: int
      }
    }
  }
}

For metadata, use:

{
  kind: 'string'
  name: 'metadata'
  properties: {
    {customized property}: 'string'
  }
}

For pushsettings, use:

{
  kind: 'string'
  name: 'pushsettings'
  properties: {
    dynamicTagsJson: 'string'
    isPushEnabled: bool
    tagsRequiringAuth: 'string'
    tagWhitelistJson: 'string'
  }
}

For slotConfigNames, use:

{
  kind: 'string'
  name: 'slotConfigNames'
  properties: {
    appSettingNames: [
      'string'
    ]
    azureStorageConfigNames: [
      'string'
    ]
    connectionStringNames: [
      'string'
    ]
  }
}

For web, use:

{
  kind: 'string'
  name: 'web'
  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'
    azureStorageAccounts: {
      {customized property}: {
        accessKey: 'string'
        accountName: 'string'
        mountPath: 'string'
        shareName: 'string'
        type: 'string'
      }
    }
    connectionStrings: [
      {
        connectionString: 'string'
        name: 'string'
        type: 'string'
      }
    ]
    cors: {
      allowedOrigins: [
        'string'
      ]
      supportCredentials: bool
    }
    defaultDocuments: [
      'string'
    ]
    detailedErrorLoggingEnabled: bool
    documentRoot: 'string'
    experiments: {
      rampUpRules: [
        {
          actionHostName: 'string'
          changeDecisionCallbackUrl: 'string'
          changeIntervalInMinutes: int
          changeStep: int
          maxReroutePercentage: int
          minReroutePercentage: int
          name: 'string'
          reroutePercentage: int
        }
      ]
    }
    ftpsState: 'string'
    handlerMappings: [
      {
        arguments: 'string'
        extension: 'string'
        scriptProcessor: 'string'
      }
    ]
    http20Enabled: bool
    httpLoggingEnabled: bool
    ipSecurityRestrictions: [
      {
        action: 'string'
        description: 'string'
        ipAddress: 'string'
        name: 'string'
        priority: int
        subnetMask: 'string'
        subnetTrafficTag: int
        tag: 'string'
        vnetSubnetResourceId: 'string'
        vnetTrafficTag: int
      }
    ]
    javaContainer: 'string'
    javaContainerVersion: 'string'
    javaVersion: 'string'
    limits: {
      maxDiskSizeInMb: int
      maxMemoryInMb: int
      maxPercentageCpu: int
    }
    linuxFxVersion: 'string'
    loadBalancing: 'string'
    localMySqlEnabled: bool
    logsDirectorySizeLimit: int
    managedPipelineMode: 'string'
    managedServiceIdentityId: int
    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'
    reservedInstanceCount: int
    scmIpSecurityRestrictions: [
      {
        action: 'string'
        description: 'string'
        ipAddress: 'string'
        name: 'string'
        priority: int
        subnetMask: 'string'
        subnetTrafficTag: int
        tag: 'string'
        vnetSubnetResourceId: 'string'
        vnetTrafficTag: int
      }
    ]
    scmIpSecurityRestrictionsUseMain: bool
    scmType: 'string'
    tracingOptions: 'string'
    use32BitWorkerProcess: bool
    virtualApplications: [
      {
        physicalPath: 'string'
        preloadEnabled: bool
        virtualDirectories: [
          {
            physicalPath: 'string'
            virtualPath: 'string'
          }
        ]
        virtualPath: 'string'
      }
    ]
    vnetName: 'string'
    webSocketsEnabled: bool
    windowsFxVersion: 'string'
    xManagedServiceIdentityId: int
  }
}

Property values

ApiDefinitionInfo

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

ApplicationLogsConfig

Name	Description	Value
azureBlobStorage	Application logs to blob storage configuration.	AzureBlobStorageApplicationLogsConfig
azureTableStorage	Application logs to azure table storage configuration.	AzureTableStorageApplicationLogsConfig
fileSystem	Application logs to file system configuration.	FileSystemApplicationLogsConfig

AutoHealActions

Name	Description	Value
actionType	Predefined action to be taken.	'CustomAction' 'LogEvent' 'Recycle'
customAction	Custom action to be taken.	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

AutoHealRules

Name	Description	Value
actions	Actions to be executed when a rule is triggered.	AutoHealActions
triggers	Conditions that describe when to execute the auto-heal actions.	AutoHealTriggers

AutoHealTriggers

Name	Description	Value
privateBytesInKB	A rule based on private bytes.	int
requests	A rule based on total requests.	RequestsBasedTrigger
slowRequests	A rule based on request execution time.	SlowRequestsBasedTrigger
statusCodes	A rule based on status codes.	StatusCodesBasedTrigger[]

AzureBlobStorageApplicationLogsConfig

Name	Description	Value
level	Log level.	'Error' 'Information' 'Off' 'Verbose' 'Warning'
retentionInDays	Retention in days. Remove blobs older than X days. 0 or lower means no retention.	int
sasUrl	SAS url to a azure blob container with read/write/list/delete permissions.	string

AzureBlobStorageHttpLogsConfig

Name	Description	Value
enabled	True if configuration is enabled, false if it is disabled and null if configuration is not set.	bool
retentionInDays	Retention in days. Remove blobs older than X days. 0 or lower means no retention.	int
sasUrl	SAS url to a azure blob container with read/write/list/delete permissions.	string

AzureStorageInfoValue

Name	Description	Value
accessKey	Access key for the storage account.	string
accountName	Name of the storage account.	string
mountPath	Path to mount the storage within the site's runtime environment.	string
shareName	Name of the file share (container name, for Blob storage).	string
type	Type of storage.	'AzureBlob' 'AzureFiles'

AzureStoragePropertyDictionaryResourceProperties

Name	Description	Value

AzureTableStorageApplicationLogsConfig

Name	Description	Value
level	Log level.	'Error' 'Information' 'Off' 'Verbose' 'Warning'
sasUrl	SAS URL to an Azure table with add/query/delete permissions.	string (required)

BackupRequestProperties

Name	Description	Value
backupName	Name of the backup.	string
backupSchedule	Schedule for the backup if it is executed periodically.	BackupSchedule
databases	Databases included in the backup.	DatabaseBackupSetting[]
enabled	True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.	bool
storageAccountUrl	SAS URL to the container.	string (required)

BackupSchedule

Name	Description	Value
frequencyInterval	How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)	int (required)
frequencyUnit	The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)	'Day' 'Hour' (required)
keepAtLeastOneBackup	True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.	bool (required)
retentionPeriodInDays	After how many days backups should be deleted.	int (required)
startTime	When the schedule should start working.	string

ConnectionStringDictionaryProperties

Name	Description	Value

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' 'ServiceBus' 'SQLAzure' 'SQLServer'

ConnStringValueTypePair

Name	Description	Value
type	Type of database.	'ApiHub' 'Custom' 'DocDb' 'EventHub' 'MySql' 'NotificationHub' 'PostgreSQL' 'RedisCache' 'ServiceBus' 'SQLAzure' 'SQLServer' (required)
value	Value of pair.	string (required)

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[]
supportCredentials	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.	bool

DatabaseBackupSetting

Name	Description	Value
connectionString	Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.	string
connectionStringName	Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.	string
databaseType	Database type (e.g. SqlAzure / MySql).	'LocalMySql' 'MySql' 'PostgreSql' 'SqlAzure' (required)
name		string

EnabledConfig

Name	Description	Value
enabled	True if configuration is enabled, false if it is disabled and null if configuration is not set.	bool

Experiments

Name	Description	Value
rampUpRules	List of ramp-up rules.	RampUpRule[]

FileSystemApplicationLogsConfig

Name	Description	Value
level	Log level.	'Error' 'Information' 'Off' 'Verbose' 'Warning'

FileSystemHttpLogsConfig

Name	Description	Value
enabled	True if configuration is enabled, false if it is disabled and null if configuration is not set.	bool
retentionInDays	Retention in days. Remove files older than X days. 0 or lower means no retention.	int
retentionInMb	Maximum size in megabytes that http log files can use. When reached old log files will be removed to make space for new ones. Value can range between 25 and 100.	int Constraints: Min value = 25 Max value = 100

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

HttpLogsConfig

Name	Description	Value
azureBlobStorage	Http logs to azure blob storage configuration.	AzureBlobStorageHttpLogsConfig
fileSystem	Http logs to file system configuration.	FileSystemHttpLogsConfig

IpSecurityRestriction

Name	Description	Value
action	Allow or Deny access for this IP range.	string
description	IP restriction rule description.	string
ipAddress	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.	string
name	IP restriction rule name.	string
priority	Priority of IP restriction rule.	int
subnetMask	Subnet mask for the range of IP addresses the restriction is valid for.	string
subnetTrafficTag	(internal) Subnet traffic tag	int
tag	Defines what this IP filter will be used for. This is to support IP filtering on proxies.	'Default' 'XffProxy'
vnetSubnetResourceId	Virtual network resource id	string
vnetTrafficTag	(internal) Vnet traffic tag	int