Share via

Microsoft.Web sites/slots/config 2020-10-01

  • Article

Bicep resource definition

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

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

Resource format

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

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

microsoft.web/sites/slots/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: {
    aadClaimsAuthorization: 'string'
    additionalLoginParams: [
      'string'
    ]
    allowedAudiences: [
      'string'
    ]
    allowedExternalRedirectUrls: [
      'string'
    ]
    authFilePath: 'string'
    clientId: 'string'
    clientSecret: 'string'
    clientSecretCertificateThumbprint: 'string'
    clientSecretSettingName: 'string'
    defaultProvider: 'string'
    enabled: bool
    facebookAppId: 'string'
    facebookAppSecret: 'string'
    facebookAppSecretSettingName: 'string'
    facebookOAuthScopes: [
      'string'
    ]
    gitHubClientId: 'string'
    gitHubClientSecret: 'string'
    gitHubClientSecretSettingName: 'string'
    gitHubOAuthScopes: [
      'string'
    ]
    googleClientId: 'string'
    googleClientSecret: 'string'
    googleClientSecretSettingName: 'string'
    googleOAuthScopes: [
      'string'
    ]
    isAuthFromFile: 'string'
    issuer: 'string'
    microsoftAccountClientId: 'string'
    microsoftAccountClientSecret: 'string'
    microsoftAccountClientSecretSettingName: 'string'
    microsoftAccountOAuthScopes: [
      'string'
    ]
    runtimeVersion: 'string'
    tokenRefreshExtensionHours: int
    tokenStoreEnabled: bool
    twitterConsumerKey: 'string'
    twitterConsumerSecret: 'string'
    twitterConsumerSecretSettingName: 'string'
    unauthenticatedClientAction: 'string'
    validateIssuer: bool
  }
}

For authsettingsV2, use:

{
  kind: 'string'
  name: 'authsettingsV2'
  properties: {
    globalValidation: {
      kind: 'string'
      properties: {
        excludedPaths: [
          'string'
        ]
        redirectToProvider: 'string'
        requireAuthentication: bool
        unauthenticatedClientAction: 'string'
      }
    }
    httpSettings: {
      kind: 'string'
      properties: {
        forwardProxy: {
          kind: 'string'
          properties: {
            convention: 'string'
            customHostHeaderName: 'string'
            customProtoHeaderName: 'string'
          }
        }
        requireHttps: bool
        routes: {
          kind: 'string'
          properties: {
            apiPrefix: 'string'
          }
        }
      }
    }
    identityProviders: {
      kind: 'string'
      properties: {
        azureActiveDirectory: {
          kind: 'string'
          properties: {
            enabled: bool
            isAutoProvisioned: bool
            login: {
              kind: 'string'
              properties: {
                disableWWWAuthenticate: bool
                loginParameters: [
                  'string'
                ]
              }
            }
            registration: {
              kind: 'string'
              properties: {
                clientId: 'string'
                clientSecretCertificateThumbprint: 'string'
                clientSecretSettingName: 'string'
                openIdIssuer: 'string'
              }
            }
            validation: {
              kind: 'string'
              properties: {
                allowedAudiences: [
                  'string'
                ]
                jwtClaimChecks: {
                  kind: 'string'
                  properties: {
                    allowedClientApplications: [
                      'string'
                    ]
                    allowedGroups: [
                      'string'
                    ]
                  }
                }
              }
            }
          }
        }
        customOpenIdConnectProviders: {
          {customized property}: {
            kind: 'string'
            properties: {
              enabled: bool
              login: {
                kind: 'string'
                properties: {
                  nameClaimType: 'string'
                  scopes: [
                    'string'
                  ]
                }
              }
              registration: {
                kind: 'string'
                properties: {
                  clientCredential: {
                    kind: 'string'
                    properties: {
                      clientSecretSettingName: 'string'
                      method: 'ClientSecretPost'
                    }
                  }
                  clientId: 'string'
                  openIdConnectConfiguration: {
                    kind: 'string'
                    properties: {
                      authorizationEndpoint: 'string'
                      certificationUri: 'string'
                      issuer: 'string'
                      tokenEndpoint: 'string'
                      wellKnownOpenIdConfiguration: 'string'
                    }
                  }
                }
              }
            }
          }
        }
        facebook: {
          kind: 'string'
          properties: {
            enabled: bool
            graphApiVersion: 'string'
            login: {
              kind: 'string'
              properties: {
                scopes: [
                  'string'
                ]
              }
            }
            registration: {
              kind: 'string'
              properties: {
                appId: 'string'
                appSecretSettingName: 'string'
              }
            }
          }
        }
        gitHub: {
          kind: 'string'
          properties: {
            enabled: bool
            login: {
              kind: 'string'
              properties: {
                scopes: [
                  'string'
                ]
              }
            }
            registration: {
              kind: 'string'
              properties: {
                clientId: 'string'
                clientSecretSettingName: 'string'
              }
            }
          }
        }
        google: {
          kind: 'string'
          properties: {
            enabled: bool
            login: {
              kind: 'string'
              properties: {
                scopes: [
                  'string'
                ]
              }
            }
            registration: {
              kind: 'string'
              properties: {
                clientId: 'string'
                clientSecretSettingName: 'string'
              }
            }
            validation: {
              kind: 'string'
              properties: {
                allowedAudiences: [
                  'string'
                ]
              }
            }
          }
        }
        twitter: {
          kind: 'string'
          properties: {
            enabled: bool
            registration: {
              kind: 'string'
              properties: {
                consumerKey: 'string'
                consumerSecretSettingName: 'string'
              }
            }
          }
        }
      }
    }
    login: {
      kind: 'string'
      properties: {
        allowedExternalRedirectUrls: [
          'string'
        ]
        cookieExpiration: {
          kind: 'string'
          properties: {
            convention: 'string'
            timeToExpiration: 'string'
          }
        }
        nonce: {
          kind: 'string'
          properties: {
            nonceExpirationInterval: 'string'
            validateNonce: bool
          }
        }
        preserveUrlFragmentsForLogins: bool
        routes: {
          kind: 'string'
          properties: {
            logoutEndpoint: 'string'
          }
        }
        tokenStore: {
          kind: 'string'
          properties: {
            azureBlobStorage: {
              kind: 'string'
              properties: {
                sasUrlSettingName: 'string'
              }
            }
            enabled: bool
            fileSystem: {
              kind: 'string'
              properties: {
                directory: 'string'
              }
            }
            tokenRefreshExtensionHours: int
          }
        }
      }
    }
    platform: {
      kind: 'string'
      properties: {
        configFilePath: 'string'
        enabled: bool
        runtimeVersion: 'string'
      }
    }
  }
}

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 web, use:

{
  kind: 'string'
  name: 'web'
  properties: {
    acrUseManagedIdentityCreds: bool
    acrUserManagedIdentityID: 'string'
    alwaysOn: bool
    apiDefinition: {
      url: 'string'
    }
    apiManagementConfig: {
      id: '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'
      ]
      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'
      }
    ]
    healthCheckPath: 'string'
    http20Enabled: bool
    httpLoggingEnabled: bool
    ipSecurityRestrictions: [
      {
        action: 'string'
        description: 'string'
        headers: {
          {customized property}: [
            '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'
    powerShellVersion: 'string'
    preWarmedInstanceCount: int
    publishingUsername: 'string'
    push: {
      kind: 'string'
      properties: {
        dynamicTagsJson: 'string'
        isPushEnabled: bool
        tagsRequiringAuth: 'string'
        tagWhitelistJson: 'string'
      }
    }
    pythonVersion: 'string'
    remoteDebuggingEnabled: bool
    remoteDebuggingVersion: 'string'
    requestTracingEnabled: bool
    requestTracingExpirationTime: 'string'
    scmIpSecurityRestrictions: [
      {
        action: 'string'
        description: 'string'
        headers: {
          {customized property}: [
            'string'
          ]
        }
        ipAddress: 'string'
        name: 'string'
        priority: int
        subnetMask: 'string'
        subnetTrafficTag: int
        tag: 'string'
        vnetSubnetResourceId: 'string'
        vnetTrafficTag: int
      }
    ]
    scmIpSecurityRestrictionsUseMain: bool
    scmMinTlsVersion: 'string'
    scmType: 'string'
    tracingOptions: 'string'
    use32BitWorkerProcess: bool
    virtualApplications: [
      {
        physicalPath: 'string'
        preloadEnabled: bool
        virtualDirectories: [
          {
            physicalPath: 'string'
            virtualPath: 'string'
          }
        ]
        virtualPath: 'string'
      }
    ]
    vnetName: 'string'
    vnetPrivatePortsCount: int
    vnetRouteAllEnabled: bool
    webSocketsEnabled: bool
    windowsFxVersion: 'string'
    xManagedServiceIdentityId: int
  }
}

Property values

AllowedAudiencesValidation

Name Description Value
kind Kind of resource. string
properties AllowedAudiencesValidation resource specific properties AllowedAudiencesValidationProperties

AllowedAudiencesValidationProperties

Name Description Value
allowedAudiences string[]

ApiDefinitionInfo

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

ApiManagementConfig

Name Description Value
id APIM-Api Identifier. 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

AppRegistration

Name Description Value
kind Kind of resource. string
properties AppRegistration resource specific properties AppRegistrationProperties

AppRegistrationProperties

Name Description Value
appId string
appSecretSettingName string

AuthPlatform

Name Description Value
kind Kind of resource. string
properties AuthPlatform resource specific properties AuthPlatformProperties

AuthPlatformProperties

Name Description Value
configFilePath string
enabled bool
runtimeVersion string

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[]

AzureActiveDirectory

Name Description Value
kind Kind of resource. string
properties AzureActiveDirectory resource specific properties AzureActiveDirectoryProperties

AzureActiveDirectoryLogin

Name Description Value
kind Kind of resource. string
properties AzureActiveDirectoryLogin resource specific properties AzureActiveDirectoryLoginProperties

AzureActiveDirectoryLoginProperties

Name Description Value
disableWWWAuthenticate bool
loginParameters string[]

AzureActiveDirectoryProperties

Name Description Value
enabled bool
isAutoProvisioned bool
login AzureActiveDirectoryLogin
registration AzureActiveDirectoryRegistration
validation AzureActiveDirectoryValidation

AzureActiveDirectoryRegistration

Name Description Value
kind Kind of resource. string
properties AzureActiveDirectoryRegistration resource specific properties AzureActiveDirectoryRegistrationProperties

AzureActiveDirectoryRegistrationProperties

Name Description Value
clientId string
clientSecretCertificateThumbprint string
clientSecretSettingName string
openIdIssuer string

AzureActiveDirectoryValidation

Name Description Value
kind Kind of resource. string
properties AzureActiveDirectoryValidation resource specific properties AzureActiveDirectoryValidationProperties

AzureActiveDirectoryValidationProperties

Name Description Value
allowedAudiences string[]
jwtClaimChecks JwtClaimChecks

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

BlobStorageTokenStore

Name Description Value
kind Kind of resource. string
properties BlobStorageTokenStore resource specific properties BlobStorageTokenStoreProperties

BlobStorageTokenStoreProperties

Name Description Value
sasUrlSettingName string

ClientRegistration

Name Description Value
kind Kind of resource. string
properties ClientRegistration resource specific properties ClientRegistrationProperties

ClientRegistrationProperties

Name Description Value
clientId string
clientSecretSettingName 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)

CookieExpiration

Name Description Value
kind Kind of resource. string
properties CookieExpiration resource specific properties CookieExpirationProperties

CookieExpirationProperties

Name Description Value
convention 'FixedTime'
'IdentityProviderDerived'
timeToExpiration string

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

CustomOpenIdConnectProvider

Name Description Value
kind Kind of resource. string
properties CustomOpenIdConnectProvider resource specific properties CustomOpenIdConnectProviderProperties

CustomOpenIdConnectProviderProperties

Name Description Value
enabled bool
login OpenIdConnectLogin
registration OpenIdConnectRegistration

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[]

Facebook

Name Description Value
kind Kind of resource. string
properties Facebook resource specific properties FacebookProperties

FacebookProperties

Name Description Value
enabled bool
graphApiVersion string
login LoginScopes
registration AppRegistration

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

FileSystemTokenStore

Name Description Value
kind Kind of resource. string
properties FileSystemTokenStore resource specific properties FileSystemTokenStoreProperties

FileSystemTokenStoreProperties

Name Description Value
directory string

ForwardProxy

Name Description Value
kind Kind of resource. string
properties ForwardProxy resource specific properties ForwardProxyProperties

ForwardProxyProperties

Name Description Value
convention 'Custom'
'NoProxy'
'Standard'
customHostHeaderName string
customProtoHeaderName string

GitHub

Name Description Value
kind Kind of resource. string
properties GitHub resource specific properties GitHubProperties

GitHubProperties

Name Description Value
enabled bool
login LoginScopes
registration ClientRegistration

GlobalValidation

Name Description Value
kind Kind of resource. string
properties GlobalValidation resource specific properties GlobalValidationProperties

GlobalValidationProperties

Name Description Value
excludedPaths string[]
redirectToProvider string
requireAuthentication bool
unauthenticatedClientAction 'AllowAnonymous'
'RedirectToLoginPage'
'Return401'
'Return403'

Google

Name Description Value
kind Kind of resource. string
properties Google resource specific properties GoogleProperties

GoogleProperties

Name Description Value
enabled bool
login LoginScopes
registration ClientRegistration
validation AllowedAudiencesValidation

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

HttpSettings

Name Description Value
kind Kind of resource. string
properties HttpSettings resource specific properties HttpSettingsProperties

HttpSettingsProperties

Name Description Value
forwardProxy ForwardProxy
requireHttps bool
routes HttpSettingsRoutes

HttpSettingsRoutes

Name Description Value
kind Kind of resource. string
properties HttpSettingsRoutes resource specific properties HttpSettingsRoutesProperties

HttpSettingsRoutesProperties

Name Description Value
apiPrefix string

IdentityProviders

Name Description Value
kind Kind of resource. string
properties IdentityProviders resource specific properties IdentityProvidersProperties

IdentityProvidersProperties

Name Description Value
azureActiveDirectory AzureActiveDirectory
customOpenIdConnectProviders Dictionary of <CustomOpenIdConnectProvider> IdentityProvidersPropertiesCustomOpenIdConnectProviders
facebook Facebook
gitHub GitHub
google Google
twitter Twitter

IdentityProvidersPropertiesCustomOpenIdConnectProviders

Name Description Value

IpSecurityRestriction

Name Description Value
action Allow or Deny access for this IP range. string
description IP restriction rule description. string
headers 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.		 IpSecurityRestrictionHeaders
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'
'ServiceTag'
'XffProxy'
vnetSubnetResourceId Virtual network resource id string
vnetTrafficTag (internal) Vnet traffic tag int

IpSecurityRestrictionHeaders

Name Description Value

JwtClaimChecks

Name Description Value
kind Kind of resource. string
properties JwtClaimChecks resource specific properties JwtClaimChecksProperties

JwtClaimChecksProperties

Name Description Value
allowedClientApplications string[]
allowedGroups string[]

Login

Name Description Value
kind Kind of resource. string
properties Login resource specific properties LoginProperties

LoginProperties

Name Description Value
allowedExternalRedirectUrls string[]
cookieExpiration CookieExpiration
nonce Nonce
preserveUrlFragmentsForLogins bool
routes LoginRoutes
tokenStore TokenStore

LoginRoutes

Name Description Value
kind Kind of resource. string
properties LoginRoutes resource specific properties LoginRoutesProperties

LoginRoutesProperties

Name Description Value
logoutEndpoint string

LoginScopes

Name Description Value
kind Kind of resource. string
properties LoginScopes resource specific properties LoginScopesProperties

LoginScopesProperties

Name Description Value
scopes string[]

microsoft.web/sites/slots/config

Name Description Value
name Set to 'appsettings' for type Microsoft.Web/sites/slots/config. Set to 'authsettings' for type Microsoft.Web/sites/slots/config. Set to 'authsettingsV2' for type Microsoft.Web/sites/slots/config. Set to 'azurestorageaccounts' for type Microsoft.Web/sites/slots/config. Set to 'backup' for type Microsoft.Web/sites/slots/config. Set to 'connectionstrings' for type Microsoft.Web/sites/slots/config. Set to 'logs' for type Microsoft.Web/sites/slots/config. Set to 'metadata' for type Microsoft.Web/sites/slots/config. Set to 'pushsettings' for type Microsoft.Web/sites/slots/config. Set to 'web' for type Microsoft.Web/sites/slots/config. 'appsettings'
'authsettings'
'authsettingsV2'
'azurestorageaccounts'
'backup'
'connectionstrings'
'logs'
'metadata'
'pushsettings'
'web' (required)

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'appsettings' (required)
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/slots
properties Settings. StringDictionaryProperties

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'authsettings' (required)
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/slots
properties SiteAuthSettings resource specific properties SiteAuthSettingsProperties

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'authsettingsV2' (required)
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/slots
properties SiteAuthSettingsV2 resource specific properties SiteAuthSettingsV2Properties

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'azurestorageaccounts' (required)
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/slots
properties Azure storage accounts. AzureStoragePropertyDictionaryResourceProperties

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'backup' (required)
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/slots
properties BackupRequest resource specific properties BackupRequestProperties

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'connectionstrings' (required)
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/slots
properties Connection strings. ConnectionStringDictionaryProperties

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'logs' (required)
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/slots
properties SiteLogsConfig resource specific properties SiteLogsConfigProperties

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'metadata' (required)
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/slots
properties Settings. StringDictionaryProperties

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'pushsettings' (required)
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/slots
properties PushSettings resource specific properties PushSettingsProperties

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'web' (required)
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/slots
properties Core resource properties SiteConfig

NameValuePair

Name Description Value
name Pair name. string
value Pair value. string

Nonce

Name Description Value
kind Kind of resource. string
properties Nonce resource specific properties NonceProperties

NonceProperties

Name Description Value
nonceExpirationInterval string
validateNonce bool

OpenIdConnectClientCredential

Name Description Value
kind Kind of resource. string
properties OpenIdConnectClientCredential resource specific properties OpenIdConnectClientCredentialProperties

OpenIdConnectClientCredentialProperties

Name Description Value
clientSecretSettingName string
method 'ClientSecretPost'

OpenIdConnectConfig

Name Description Value
kind Kind of resource. string
properties OpenIdConnectConfig resource specific properties OpenIdConnectConfigProperties

OpenIdConnectConfigProperties

Name Description Value
authorizationEndpoint string
certificationUri string
issuer string
tokenEndpoint string
wellKnownOpenIdConfiguration string

OpenIdConnectLogin

Name Description Value
kind Kind of resource. string
properties OpenIdConnectLogin resource specific properties OpenIdConnectLoginProperties

OpenIdConnectLoginProperties

Name Description Value
nameClaimType string
scopes string[]

OpenIdConnectRegistration

Name Description Value
kind Kind of resource. string
properties OpenIdConnectRegistration resource specific properties OpenIdConnectRegistrationProperties

OpenIdConnectRegistrationProperties

Name Description Value
clientCredential OpenIdConnectClientCredential
clientId string
openIdConnectConfiguration OpenIdConnectConfig

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 in the allowed list for use by the push registration endpoint. string

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 <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or
<code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm
can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.		 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 <code>ActionHostName</code>. int

RequestsBasedTrigger

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

SiteAuthSettingsProperties

Name Description Value
aadClaimsAuthorization Gets a JSON string containing the Azure AD Acl settings. string
additionalLoginParams Login parameters to send to the OpenID Connect authorization endpoint when
a user logs in. Each parameter must be in the form "key=value".		 string[]
allowedAudiences Allowed audience values to consider when validating JWTs issued by
Azure Active Directory. Note that the <code>ClientID</code> value is always considered an
allowed audience, regardless of this setting.		 string[]
allowedExternalRedirectUrls External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.
This is an advanced setting typically only needed by Windows Store application backends.
Note that URLs within the current domain are always implicitly allowed.		 string[]
authFilePath The path of the config file containing auth settings.
If the path is relative, base will the site's root directory.		 string
clientId The Client ID of this relying party application, known as the client_id.
This setting is required for enabling OpenID Connection authentication with Azure Active Directory or
other 3rd party OpenID Connect providers.
More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html		 string
clientSecret The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).
This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.
Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.
More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html		 string
clientSecretCertificateThumbprint An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as
a replacement for the Client Secret. It is also optional.		 string
clientSecretSettingName The app setting name that contains the client secret of the relying party application. string
defaultProvider The default authentication provider to use when multiple providers are configured.
This setting is only needed if multiple providers are configured and the unauthenticated client
action is set to "RedirectToLoginPage".		 'AzureActiveDirectory'
'Facebook'
'Github'
'Google'
'MicrosoftAccount'
'Twitter'
enabled <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>. bool
facebookAppId The App ID of the Facebook app used for login.
This setting is required for enabling Facebook Login.
Facebook Login documentation: https://developers.facebook.com/docs/facebook-login		 string
facebookAppSecret The App Secret of the Facebook app used for Facebook Login.
This setting is required for enabling Facebook Login.
Facebook Login documentation: https://developers.facebook.com/docs/facebook-login		 string
facebookAppSecretSettingName The app setting name that contains the app secret used for Facebook Login. string
facebookOAuthScopes The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.
This setting is optional.
Facebook Login documentation: https://developers.facebook.com/docs/facebook-login		 string[]
gitHubClientId The Client Id of the GitHub app used for login.
This setting is required for enabling Github login		 string
gitHubClientSecret The Client Secret of the GitHub app used for Github Login.
This setting is required for enabling Github login.		 string
gitHubClientSecretSettingName The app setting name that contains the client secret of the Github
app used for GitHub Login.		 string
gitHubOAuthScopes The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.
This setting is optional		 string[]
googleClientId The OpenID Connect Client ID for the Google web application.
This setting is required for enabling Google Sign-In.
Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/		 string
googleClientSecret The client secret associated with the Google web application.
This setting is required for enabling Google Sign-In.
Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/		 string
googleClientSecretSettingName The app setting name that contains the client secret associated with
the Google web application.		 string
googleOAuthScopes The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.
This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes.
Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/		 string[]
isAuthFromFile "true" if the auth config settings should be read from a file,
"false" otherwise		 string
issuer The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.
When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
This URI is a case-sensitive identifier for the token issuer.
More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html		 string
microsoftAccountClientId The OAuth 2.0 client ID that was created for the app used for authentication.
This setting is required for enabling Microsoft Account authentication.
Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm		 string
microsoftAccountClientSecret The OAuth 2.0 client secret that was created for the app used for authentication.
This setting is required for enabling Microsoft Account authentication.
Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm		 string
microsoftAccountClientSecretSettingName The app setting name containing the OAuth 2.0 client secret that was created for the
app used for authentication.		 string
microsoftAccountOAuthScopes The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.
This setting is optional. If not specified, "wl.basic" is used as the default scope.
Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx		 string[]
runtimeVersion The RuntimeVersion of the Authentication / Authorization feature in use for the current app.
The setting in this value can control the behavior of certain features in the Authentication / Authorization module.		 string
tokenRefreshExtensionHours The number of hours after session token expiration that a session token can be used to
call the token refresh API. The default is 72 hours.		 int
tokenStoreEnabled <code>true</code> to durably store platform-specific security tokens that are obtained during login flows; otherwise, <code>false</code>.
The default is <code>false</code>.		 bool
twitterConsumerKey The OAuth 1.0a consumer key of the Twitter application used for sign-in.
This setting is required for enabling Twitter Sign-In.
Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in		 string
twitterConsumerSecret The OAuth 1.0a consumer secret of the Twitter application used for sign-in.
This setting is required for enabling Twitter Sign-In.
Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in		 string
twitterConsumerSecretSettingName The app setting name that contains the OAuth 1.0a consumer secret of the Twitter
application used for sign-in.		 string
unauthenticatedClientAction The action to take when an unauthenticated client attempts to access the app. 'AllowAnonymous'
'RedirectToLoginPage'
validateIssuer Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. bool

SiteAuthSettingsV2Properties

Name Description Value
globalValidation GlobalValidation
httpSettings HttpSettings
identityProviders IdentityProviders
login Login
platform AuthPlatform

SiteConfig

Name Description Value
acrUseManagedIdentityCreds Flag to use Managed Identity Creds for ACR pull bool
acrUserManagedIdentityID If using user managed identity, the user managed identity ClientId string
alwaysOn <code>true</code> if Always On is enabled; otherwise, <code>false</code>. bool
apiDefinition Information about the formal API definition for the app. ApiDefinitionInfo
apiManagementConfig Azure API management settings linked to the app. ApiManagementConfig
appCommandLine App command line to launch. string
appSettings Application settings. NameValuePair[]
autoHealEnabled <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. bool
autoHealRules Auto Heal rules. AutoHealRules
autoSwapSlotName Auto-swap slot name. string
connectionStrings Connection strings. ConnStringInfo[]
cors Cross-Origin Resource Sharing (CORS) settings. CorsSettings
defaultDocuments Default documents. string[]
detailedErrorLoggingEnabled <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. bool
documentRoot Document root. string
experiments This is work around for polymorphic types. Experiments
ftpsState State of FTP / FTPS service 'AllAllowed'
'Disabled'
'FtpsOnly'
handlerMappings Handler mappings. HandlerMapping[]
healthCheckPath Health check path string
http20Enabled Http20Enabled: configures a web site to allow clients to connect over http2.0 bool
httpLoggingEnabled <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. bool
ipSecurityRestrictions IP security restrictions for main. IpSecurityRestriction[]
javaContainer Java container. string
javaContainerVersion Java container version. string
javaVersion Java version. string
limits Site limits. SiteLimits
linuxFxVersion Linux App Framework and version string
loadBalancing Site load balancing. 'LeastRequests'
'LeastResponseTime'
'RequestHash'
'WeightedRoundRobin'
'WeightedTotalTraffic'
localMySqlEnabled <code>true</code> to enable local MySQL; otherwise, <code>false</code>. bool
logsDirectorySizeLimit HTTP logs directory size limit. int
managedPipelineMode Managed pipeline mode. 'Classic'
'Integrated'
managedServiceIdentityId Managed Service Identity Id int
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
powerShellVersion Version of PowerShell. string
preWarmedInstanceCount Number of preWarmed instances.
This setting only applies to the Consumption and Elastic Plans		 int

Constraints:
Min value = 0
Max value = 10
publishingUsername Publishing user name. string
push Push endpoint settings. PushSettings
pythonVersion Version of Python. string
remoteDebuggingEnabled <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. bool
remoteDebuggingVersion Remote debugging version. string
requestTracingEnabled <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. bool
requestTracingExpirationTime Request tracing expiration time. string
scmIpSecurityRestrictions IP security restrictions for scm. IpSecurityRestriction[]
scmIpSecurityRestrictionsUseMain IP security restrictions for scm to use main. bool
scmMinTlsVersion ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site '1.0'
'1.1'
'1.2'
scmType SCM type. 'BitbucketGit'
'BitbucketHg'
'CodePlexGit'
'CodePlexHg'
'Dropbox'
'ExternalGit'
'ExternalHg'
'GitHub'
'LocalGit'
'None'
'OneDrive'
'Tfs'
'VSO'
'VSTSRM'
tracingOptions Tracing options. string
use32BitWorkerProcess <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. bool
virtualApplications Virtual applications. VirtualApplication[]
vnetName Virtual Network name. string
vnetPrivatePortsCount The number of private ports assigned to this app. These will be assigned dynamically on runtime. int
vnetRouteAllEnabled Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. bool
webSocketsEnabled <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. bool
windowsFxVersion Xenon App Framework and version string
xManagedServiceIdentityId Explicit Managed Service Identity Id int

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

SiteLogsConfigProperties

Name Description Value
applicationLogs Application logs configuration. ApplicationLogsConfig
detailedErrorMessages Detailed error messages configuration. EnabledConfig
failedRequestsTracing Failed requests tracing configuration. EnabledConfig
httpLogs HTTP logs configuration. HttpLogsConfig

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

StringDictionaryProperties

Name Description Value

StringDictionaryProperties

Name Description Value

TokenStore

Name Description Value
kind Kind of resource. string
properties TokenStore resource specific properties TokenStoreProperties

TokenStoreProperties

Name Description Value
azureBlobStorage BlobStorageTokenStore
enabled bool
fileSystem FileSystemTokenStore
tokenRefreshExtensionHours int

Twitter

Name Description Value
kind Kind of resource. string
properties Twitter resource specific properties TwitterProperties

TwitterProperties

Name Description Value
enabled bool
registration TwitterRegistration

TwitterRegistration

Name Description Value
kind Kind of resource. string
properties TwitterRegistration resource specific properties TwitterRegistrationProperties

TwitterRegistrationProperties

Name Description Value
consumerKey string
consumerSecretSettingName string

VirtualApplication

Name Description Value
physicalPath Physical path. string
preloadEnabled <code>true</code> if preloading is enabled; otherwise, <code>false</code>. 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

ARM template resource definition

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

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

Resource format

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

{
  "name": "string"
  // For remaining properties, see microsoft.web/sites/slots/config objects
}

microsoft.web/sites/slots/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": {
    "aadClaimsAuthorization": "string",
    "additionalLoginParams": [ "string" ],
    "allowedAudiences": [ "string" ],
    "allowedExternalRedirectUrls": [ "string" ],
    "authFilePath": "string",
    "clientId": "string",
    "clientSecret": "string",
    "clientSecretCertificateThumbprint": "string",
    "clientSecretSettingName": "string",
    "defaultProvider": "string",
    "enabled": "bool",
    "facebookAppId": "string",
    "facebookAppSecret": "string",
    "facebookAppSecretSettingName": "string",
    "facebookOAuthScopes": [ "string" ],
    "gitHubClientId": "string",
    "gitHubClientSecret": "string",
    "gitHubClientSecretSettingName": "string",
    "gitHubOAuthScopes": [ "string" ],
    "googleClientId": "string",
    "googleClientSecret": "string",
    "googleClientSecretSettingName": "string",
    "googleOAuthScopes": [ "string" ],
    "isAuthFromFile": "string",
    "issuer": "string",
    "microsoftAccountClientId": "string",
    "microsoftAccountClientSecret": "string",
    "microsoftAccountClientSecretSettingName": "string",
    "microsoftAccountOAuthScopes": [ "string" ],
    "runtimeVersion": "string",
    "tokenRefreshExtensionHours": "int",
    "tokenStoreEnabled": "bool",
    "twitterConsumerKey": "string",
    "twitterConsumerSecret": "string",
    "twitterConsumerSecretSettingName": "string",
    "unauthenticatedClientAction": "string",
    "validateIssuer": "bool"
  }
}

For authsettingsV2, use:

{
  "kind": "string",
  "name": "authsettingsV2",
  "properties": {
    "globalValidation": {
      "kind": "string",
      "properties": {
        "excludedPaths": [ "string" ],
        "redirectToProvider": "string",
        "requireAuthentication": "bool",
        "unauthenticatedClientAction": "string"
      }
    },
    "httpSettings": {
      "kind": "string",
      "properties": {
        "forwardProxy": {
          "kind": "string",
          "properties": {
            "convention": "string",
            "customHostHeaderName": "string",
            "customProtoHeaderName": "string"
          }
        },
        "requireHttps": "bool",
        "routes": {
          "kind": "string",
          "properties": {
            "apiPrefix": "string"
          }
        }
      }
    },
    "identityProviders": {
      "kind": "string",
      "properties": {
        "azureActiveDirectory": {
          "kind": "string",
          "properties": {
            "enabled": "bool",
            "isAutoProvisioned": "bool",
            "login": {
              "kind": "string",
              "properties": {
                "disableWWWAuthenticate": "bool",
                "loginParameters": [ "string" ]
              }
            },
            "registration": {
              "kind": "string",
              "properties": {
                "clientId": "string",
                "clientSecretCertificateThumbprint": "string",
                "clientSecretSettingName": "string",
                "openIdIssuer": "string"
              }
            },
            "validation": {
              "kind": "string",
              "properties": {
                "allowedAudiences": [ "string" ],
                "jwtClaimChecks": {
                  "kind": "string",
                  "properties": {
                    "allowedClientApplications": [ "string" ],
                    "allowedGroups": [ "string" ]
                  }
                }
              }
            }
          }
        },
        "customOpenIdConnectProviders": {
          "{customized property}": {
            "kind": "string",
            "properties": {
              "enabled": "bool",
              "login": {
                "kind": "string",
                "properties": {
                  "nameClaimType": "string",
                  "scopes": [ "string" ]
                }
              },
              "registration": {
                "kind": "string",
                "properties": {
                  "clientCredential": {
                    "kind": "string",
                    "properties": {
                      "clientSecretSettingName": "string",
                      "method": "ClientSecretPost"
                    }
                  },
                  "clientId": "string",
                  "openIdConnectConfiguration": {
                    "kind": "string",
                    "properties": {
                      "authorizationEndpoint": "string",
                      "certificationUri": "string",
                      "issuer": "string",
                      "tokenEndpoint": "string",
                      "wellKnownOpenIdConfiguration": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "facebook": {
          "kind": "string",
          "properties": {
            "enabled": "bool",
            "graphApiVersion": "string",
            "login": {
              "kind": "string",
              "properties": {
                "scopes": [ "string" ]
              }
            },
            "registration": {
              "kind": "string",
              "properties": {
                "appId": "string",
                "appSecretSettingName": "string"
              }
            }
          }
        },
        "gitHub": {
          "kind": "string",
          "properties": {
            "enabled": "bool",
            "login": {
              "kind": "string",
              "properties": {
                "scopes": [ "string" ]
              }
            },
            "registration": {
              "kind": "string",
              "properties": {
                "clientId": "string",
                "clientSecretSettingName": "string"
              }
            }
          }
        },
        "google": {
          "kind": "string",
          "properties": {
            "enabled": "bool",
            "login": {
              "kind": "string",
              "properties": {
                "scopes": [ "string" ]
              }
            },
            "registration": {
              "kind": "string",
              "properties": {
                "clientId": "string",
                "clientSecretSettingName": "string"
              }
            },
            "validation": {
              "kind": "string",
              "properties": {
                "allowedAudiences": [ "string" ]
              }
            }
          }
        },
        "twitter": {
          "kind": "string",
          "properties": {
            "enabled": "bool",
            "registration": {
              "kind": "string",
              "properties": {
                "consumerKey": "string",
                "consumerSecretSettingName": "string"
              }
            }
          }
        }
      }
    },
    "login": {
      "kind": "string",
      "properties": {
        "allowedExternalRedirectUrls": [ "string" ],
        "cookieExpiration": {
          "kind": "string",
          "properties": {
            "convention": "string",
            "timeToExpiration": "string"
          }
        },
        "nonce": {
          "kind": "string",
          "properties": {
            "nonceExpirationInterval": "string",
            "validateNonce": "bool"
          }
        },
        "preserveUrlFragmentsForLogins": "bool",
        "routes": {
          "kind": "string",
          "properties": {
            "logoutEndpoint": "string"
          }
        },
        "tokenStore": {
          "kind": "string",
          "properties": {
            "azureBlobStorage": {
              "kind": "string",
              "properties": {
                "sasUrlSettingName": "string"
              }
            },
            "enabled": "bool",
            "fileSystem": {
              "kind": "string",
              "properties": {
                "directory": "string"
              }
            },
            "tokenRefreshExtensionHours": "int"
          }
        }
      }
    },
    "platform": {
      "kind": "string",
      "properties": {
        "configFilePath": "string",
        "enabled": "bool",
        "runtimeVersion": "string"
      }
    }
  }
}

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 web, use:

{
  "kind": "string",
  "name": "web",
  "properties": {
    "acrUseManagedIdentityCreds": "bool",
    "acrUserManagedIdentityID": "string",
    "alwaysOn": "bool",
    "apiDefinition": {
      "url": "string"
    },
    "apiManagementConfig": {
      "id": "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" ],
      "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"
      }
    ],
    "healthCheckPath": "string",
    "http20Enabled": "bool",
    "httpLoggingEnabled": "bool",
    "ipSecurityRestrictions": [
      {
        "action": "string",
        "description": "string",
        "headers": {
          "{customized property}": [ "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",
    "powerShellVersion": "string",
    "preWarmedInstanceCount": "int",
    "publishingUsername": "string",
    "push": {
      "kind": "string",
      "properties": {
        "dynamicTagsJson": "string",
        "isPushEnabled": "bool",
        "tagsRequiringAuth": "string",
        "tagWhitelistJson": "string"
      }
    },
    "pythonVersion": "string",
    "remoteDebuggingEnabled": "bool",
    "remoteDebuggingVersion": "string",
    "requestTracingEnabled": "bool",
    "requestTracingExpirationTime": "string",
    "scmIpSecurityRestrictions": [
      {
        "action": "string",
        "description": "string",
        "headers": {
          "{customized property}": [ "string" ]
        },
        "ipAddress": "string",
        "name": "string",
        "priority": "int",
        "subnetMask": "string",
        "subnetTrafficTag": "int",
        "tag": "string",
        "vnetSubnetResourceId": "string",
        "vnetTrafficTag": "int"
      }
    ],
    "scmIpSecurityRestrictionsUseMain": "bool",
    "scmMinTlsVersion": "string",
    "scmType": "string",
    "tracingOptions": "string",
    "use32BitWorkerProcess": "bool",
    "virtualApplications": [
      {
        "physicalPath": "string",
        "preloadEnabled": "bool",
        "virtualDirectories": [
          {
            "physicalPath": "string",
            "virtualPath": "string"
          }
        ],
        "virtualPath": "string"
      }
    ],
    "vnetName": "string",
    "vnetPrivatePortsCount": "int",
    "vnetRouteAllEnabled": "bool",
    "webSocketsEnabled": "bool",
    "windowsFxVersion": "string",
    "xManagedServiceIdentityId": "int"
  }
}

Property values

AllowedAudiencesValidation

Name Description Value
kind Kind of resource. string
properties AllowedAudiencesValidation resource specific properties AllowedAudiencesValidationProperties

AllowedAudiencesValidationProperties

Name Description Value
allowedAudiences string[]

ApiDefinitionInfo

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

ApiManagementConfig

Name Description Value
id APIM-Api Identifier. 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

AppRegistration

Name Description Value
kind Kind of resource. string
properties AppRegistration resource specific properties AppRegistrationProperties

AppRegistrationProperties

Name Description Value
appId string
appSecretSettingName string

AuthPlatform

Name Description Value
kind Kind of resource. string
properties AuthPlatform resource specific properties AuthPlatformProperties

AuthPlatformProperties

Name Description Value
configFilePath string
enabled bool
runtimeVersion string

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[]

AzureActiveDirectory

Name Description Value
kind Kind of resource. string
properties AzureActiveDirectory resource specific properties AzureActiveDirectoryProperties

AzureActiveDirectoryLogin

Name Description Value
kind Kind of resource. string
properties AzureActiveDirectoryLogin resource specific properties AzureActiveDirectoryLoginProperties

AzureActiveDirectoryLoginProperties

Name Description Value
disableWWWAuthenticate bool
loginParameters string[]

AzureActiveDirectoryProperties

Name Description Value
enabled bool
isAutoProvisioned bool
login AzureActiveDirectoryLogin
registration AzureActiveDirectoryRegistration
validation AzureActiveDirectoryValidation

AzureActiveDirectoryRegistration

Name Description Value
kind Kind of resource. string
properties AzureActiveDirectoryRegistration resource specific properties AzureActiveDirectoryRegistrationProperties

AzureActiveDirectoryRegistrationProperties

Name Description Value
clientId string
clientSecretCertificateThumbprint string
clientSecretSettingName string
openIdIssuer string

AzureActiveDirectoryValidation

Name Description Value
kind Kind of resource. string
properties AzureActiveDirectoryValidation resource specific properties AzureActiveDirectoryValidationProperties

AzureActiveDirectoryValidationProperties

Name Description Value
allowedAudiences string[]
jwtClaimChecks JwtClaimChecks

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

BlobStorageTokenStore

Name Description Value
kind Kind of resource. string
properties BlobStorageTokenStore resource specific properties BlobStorageTokenStoreProperties

BlobStorageTokenStoreProperties

Name Description Value
sasUrlSettingName string

ClientRegistration

Name Description Value
kind Kind of resource. string
properties ClientRegistration resource specific properties ClientRegistrationProperties

ClientRegistrationProperties

Name Description Value
clientId string
clientSecretSettingName 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)

CookieExpiration

Name Description Value
kind Kind of resource. string
properties CookieExpiration resource specific properties CookieExpirationProperties

CookieExpirationProperties

Name Description Value
convention 'FixedTime'
'IdentityProviderDerived'
timeToExpiration string

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

CustomOpenIdConnectProvider

Name Description Value
kind Kind of resource. string
properties CustomOpenIdConnectProvider resource specific properties CustomOpenIdConnectProviderProperties

CustomOpenIdConnectProviderProperties

Name Description Value
enabled bool
login OpenIdConnectLogin
registration OpenIdConnectRegistration

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[]

Facebook

Name Description Value
kind Kind of resource. string
properties Facebook resource specific properties FacebookProperties

FacebookProperties

Name Description Value
enabled bool
graphApiVersion string
login LoginScopes
registration AppRegistration

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

FileSystemTokenStore

Name Description Value
kind Kind of resource. string
properties FileSystemTokenStore resource specific properties FileSystemTokenStoreProperties

FileSystemTokenStoreProperties

Name Description Value
directory string

ForwardProxy

Name Description Value
kind Kind of resource. string
properties ForwardProxy resource specific properties ForwardProxyProperties

ForwardProxyProperties

Name Description Value
convention 'Custom'
'NoProxy'
'Standard'
customHostHeaderName string
customProtoHeaderName string

GitHub

Name Description Value
kind Kind of resource. string
properties GitHub resource specific properties GitHubProperties

GitHubProperties

Name Description Value
enabled bool
login LoginScopes
registration ClientRegistration

GlobalValidation

Name Description Value
kind Kind of resource. string
properties GlobalValidation resource specific properties GlobalValidationProperties

GlobalValidationProperties

Name Description Value
excludedPaths string[]
redirectToProvider string
requireAuthentication bool
unauthenticatedClientAction 'AllowAnonymous'
'RedirectToLoginPage'
'Return401'
'Return403'

Google

Name Description Value
kind Kind of resource. string
properties Google resource specific properties GoogleProperties

GoogleProperties

Name Description Value
enabled bool
login LoginScopes
registration ClientRegistration
validation AllowedAudiencesValidation

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

HttpSettings

Name Description Value
kind Kind of resource. string
properties HttpSettings resource specific properties HttpSettingsProperties

HttpSettingsProperties

Name Description Value
forwardProxy ForwardProxy
requireHttps bool
routes HttpSettingsRoutes

HttpSettingsRoutes

Name Description Value
kind Kind of resource. string
properties HttpSettingsRoutes resource specific properties HttpSettingsRoutesProperties

HttpSettingsRoutesProperties

Name Description Value
apiPrefix string

IdentityProviders

Name Description Value
kind Kind of resource. string
properties IdentityProviders resource specific properties IdentityProvidersProperties

IdentityProvidersProperties

Name Description Value
azureActiveDirectory AzureActiveDirectory
customOpenIdConnectProviders Dictionary of <CustomOpenIdConnectProvider> IdentityProvidersPropertiesCustomOpenIdConnectProviders
facebook Facebook
gitHub GitHub
google Google
twitter Twitter

IdentityProvidersPropertiesCustomOpenIdConnectProviders

Name Description Value

IpSecurityRestriction

Name Description Value
action Allow or Deny access for this IP range. string
description IP restriction rule description. string
headers 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.		 IpSecurityRestrictionHeaders
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'
'ServiceTag'
'XffProxy'
vnetSubnetResourceId Virtual network resource id string
vnetTrafficTag (internal) Vnet traffic tag int

IpSecurityRestrictionHeaders

Name Description Value

JwtClaimChecks

Name Description Value
kind Kind of resource. string
properties JwtClaimChecks resource specific properties JwtClaimChecksProperties

JwtClaimChecksProperties

Name Description Value
allowedClientApplications string[]
allowedGroups string[]

Login

Name Description Value
kind Kind of resource. string
properties Login resource specific properties LoginProperties

LoginProperties

Name Description Value
allowedExternalRedirectUrls string[]
cookieExpiration CookieExpiration
nonce Nonce
preserveUrlFragmentsForLogins bool
routes LoginRoutes
tokenStore TokenStore

LoginRoutes

Name Description Value
kind Kind of resource. string
properties LoginRoutes resource specific properties LoginRoutesProperties

LoginRoutesProperties

Name Description Value
logoutEndpoint string

LoginScopes

Name Description Value
kind Kind of resource. string
properties LoginScopes resource specific properties LoginScopesProperties

LoginScopesProperties

Name Description Value
scopes string[]

microsoft.web/sites/slots/config

Name Description Value
name Set to 'appsettings' for type Microsoft.Web/sites/slots/config. Set to 'authsettings' for type Microsoft.Web/sites/slots/config. Set to 'authsettingsV2' for type Microsoft.Web/sites/slots/config. Set to 'azurestorageaccounts' for type Microsoft.Web/sites/slots/config. Set to 'backup' for type Microsoft.Web/sites/slots/config. Set to 'connectionstrings' for type Microsoft.Web/sites/slots/config. Set to 'logs' for type Microsoft.Web/sites/slots/config. Set to 'metadata' for type Microsoft.Web/sites/slots/config. Set to 'pushsettings' for type Microsoft.Web/sites/slots/config. Set to 'web' for type Microsoft.Web/sites/slots/config. 'appsettings'
'authsettings'
'authsettingsV2'
'azurestorageaccounts'
'backup'
'connectionstrings'
'logs'
'metadata'
'pushsettings'
'web' (required)

Microsoft.Web/sites/slots/config

Name Description Value
apiVersion The api version '2020-10-01'
kind Kind of resource. string
name The resource name 'appsettings' (required)
properties Settings. StringDictionaryProperties
type The resource type 'Microsoft.Web/sites/slots/config'

Microsoft.Web/sites/slots/config

Name Description Value
apiVersion The api version '2020-10-01'
kind Kind of resource. string
name The resource name 'authsettings' (required)
properties SiteAuthSettings resource specific properties SiteAuthSettingsProperties
type The resource type 'Microsoft.Web/sites/slots/config'

Microsoft.Web/sites/slots/config

Name Description Value
apiVersion The api version '2020-10-01'
kind Kind of resource. string
name The resource name 'authsettingsV2' (required)
properties SiteAuthSettingsV2 resource specific properties SiteAuthSettingsV2Properties
type The resource type 'Microsoft.Web/sites/slots/config'

Microsoft.Web/sites/slots/config

Name Description Value
apiVersion The api version '2020-10-01'
kind Kind of resource. string
name The resource name 'azurestorageaccounts' (required)
properties Azure storage accounts. AzureStoragePropertyDictionaryResourceProperties
type The resource type 'Microsoft.Web/sites/slots/config'

Microsoft.Web/sites/slots/config

Name Description Value
apiVersion The api version '2020-10-01'
kind Kind of resource. string
name The resource name 'backup' (required)
properties BackupRequest resource specific properties BackupRequestProperties
type The resource type 'Microsoft.Web/sites/slots/config'

Microsoft.Web/sites/slots/config

Name Description Value
apiVersion The api version '2020-10-01'
kind Kind of resource. string
name The resource name 'connectionstrings' (required)
properties Connection strings. ConnectionStringDictionaryProperties
type The resource type 'Microsoft.Web/sites/slots/config'

Microsoft.Web/sites/slots/config

Name Description Value
apiVersion The api version '2020-10-01'
kind Kind of resource. string
name The resource name 'logs' (required)
properties SiteLogsConfig resource specific properties SiteLogsConfigProperties
type The resource type 'Microsoft.Web/sites/slots/config'

Microsoft.Web/sites/slots/config

Name Description Value
apiVersion The api version '2020-10-01'
kind Kind of resource. string
name The resource name 'metadata' (required)
properties Settings. StringDictionaryProperties
type The resource type 'Microsoft.Web/sites/slots/config'

Microsoft.Web/sites/slots/config

Name Description Value
apiVersion The api version '2020-10-01'
kind Kind of resource. string
name The resource name 'pushsettings' (required)
properties PushSettings resource specific properties PushSettingsProperties
type The resource type 'Microsoft.Web/sites/slots/config'

Microsoft.Web/sites/slots/config

Name Description Value
apiVersion The api version '2020-10-01'
kind Kind of resource. string
name The resource name 'web' (required)
properties Core resource properties SiteConfig
type The resource type 'Microsoft.Web/sites/slots/config'

NameValuePair

Name Description Value
name Pair name. string
value Pair value. string

Nonce

Name Description Value
kind Kind of resource. string
properties Nonce resource specific properties NonceProperties

NonceProperties

Name Description Value
nonceExpirationInterval string
validateNonce bool

OpenIdConnectClientCredential

Name Description Value
kind Kind of resource. string
properties OpenIdConnectClientCredential resource specific properties OpenIdConnectClientCredentialProperties

OpenIdConnectClientCredentialProperties

Name Description Value
clientSecretSettingName string
method 'ClientSecretPost'

OpenIdConnectConfig

Name Description Value
kind Kind of resource. string
properties OpenIdConnectConfig resource specific properties OpenIdConnectConfigProperties

OpenIdConnectConfigProperties

Name Description Value
authorizationEndpoint string
certificationUri string
issuer string
tokenEndpoint string
wellKnownOpenIdConfiguration string

OpenIdConnectLogin

Name Description Value
kind Kind of resource. string
properties OpenIdConnectLogin resource specific properties OpenIdConnectLoginProperties

OpenIdConnectLoginProperties

Name Description Value
nameClaimType string
scopes string[]

OpenIdConnectRegistration

Name Description Value
kind Kind of resource. string
properties OpenIdConnectRegistration resource specific properties OpenIdConnectRegistrationProperties

OpenIdConnectRegistrationProperties

Name Description Value
clientCredential OpenIdConnectClientCredential
clientId string
openIdConnectConfiguration OpenIdConnectConfig

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 in the allowed list for use by the push registration endpoint. string

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 <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or
<code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm
can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.		 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 <code>ActionHostName</code>. int

RequestsBasedTrigger

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

SiteAuthSettingsProperties

Name Description Value
aadClaimsAuthorization Gets a JSON string containing the Azure AD Acl settings. string
additionalLoginParams Login parameters to send to the OpenID Connect authorization endpoint when
a user logs in. Each parameter must be in the form "key=value".		 string[]
allowedAudiences Allowed audience values to consider when validating JWTs issued by
Azure Active Directory. Note that the <code>ClientID</code> value is always considered an
allowed audience, regardless of this setting.		 string[]
allowedExternalRedirectUrls External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.
This is an advanced setting typically only needed by Windows Store application backends.
Note that URLs within the current domain are always implicitly allowed.		 string[]
authFilePath The path of the config file containing auth settings.
If the path is relative, base will the site's root directory.		 string
clientId The Client ID of this relying party application, known as the client_id.
This setting is required for enabling OpenID Connection authentication with Azure Active Directory or
other 3rd party OpenID Connect providers.
More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html		 string
clientSecret The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).
This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.
Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.
More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html		 string
clientSecretCertificateThumbprint An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as
a replacement for the Client Secret. It is also optional.		 string
clientSecretSettingName The app setting name that contains the client secret of the relying party application. string
defaultProvider The default authentication provider to use when multiple providers are configured.
This setting is only needed if multiple providers are configured and the unauthenticated client
action is set to "RedirectToLoginPage".		 'AzureActiveDirectory'
'Facebook'
'Github'
'Google'
'MicrosoftAccount'
'Twitter'
enabled <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>. bool
facebookAppId The App ID of the Facebook app used for login.
This setting is required for enabling Facebook Login.
Facebook Login documentation: https://developers.facebook.com/docs/facebook-login		 string
facebookAppSecret The App Secret of the Facebook app used for Facebook Login.
This setting is required for enabling Facebook Login.
Facebook Login documentation: https://developers.facebook.com/docs/facebook-login		 string
facebookAppSecretSettingName The app setting name that contains the app secret used for Facebook Login. string
facebookOAuthScopes The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.
This setting is optional.
Facebook Login documentation: https://developers.facebook.com/docs/facebook-login		 string[]
gitHubClientId The Client Id of the GitHub app used for login.
This setting is required for enabling Github login		 string
gitHubClientSecret The Client Secret of the GitHub app used for Github Login.
This setting is required for enabling Github login.		 string
gitHubClientSecretSettingName The app setting name that contains the client secret of the Github
app used for GitHub Login.		 string
gitHubOAuthScopes The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.
This setting is optional		 string[]
googleClientId The OpenID Connect Client ID for the Google web application.
This setting is required for enabling Google Sign-In.
Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/		 string
googleClientSecret The client secret associated with the Google web application.
This setting is required for enabling Google Sign-In.
Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/		 string
googleClientSecretSettingName The app setting name that contains the client secret associated with
the Google web application.		 string
googleOAuthScopes The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.
This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes.
Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/		 string[]
isAuthFromFile "true" if the auth config settings should be read from a file,
"false" otherwise		 string
issuer The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.
When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
This URI is a case-sensitive identifier for the token issuer.
More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html		 string
microsoftAccountClientId The OAuth 2.0 client ID that was created for the app used for authentication.
This setting is required for enabling Microsoft Account authentication.
Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm		 string
microsoftAccountClientSecret The OAuth 2.0 client secret that was created for the app used for authentication.
This setting is required for enabling Microsoft Account authentication.
Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm		 string
microsoftAccountClientSecretSettingName The app setting name containing the OAuth 2.0 client secret that was created for the
app used for authentication.		 string
microsoftAccountOAuthScopes The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.
This setting is optional. If not specified, "wl.basic" is used as the default scope.
Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx		 string[]
runtimeVersion The RuntimeVersion of the Authentication / Authorization feature in use for the current app.
The setting in this value can control the behavior of certain features in the Authentication / Authorization module.		 string
tokenRefreshExtensionHours The number of hours after session token expiration that a session token can be used to
call the token refresh API. The default is 72 hours.		 int
tokenStoreEnabled <code>true</code> to durably store platform-specific security tokens that are obtained during login flows; otherwise, <code>false</code>.
The default is <code>false</code>.		 bool
twitterConsumerKey The OAuth 1.0a consumer key of the Twitter application used for sign-in.
This setting is required for enabling Twitter Sign-In.
Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in		 string
twitterConsumerSecret The OAuth 1.0a consumer secret of the Twitter application used for sign-in.
This setting is required for enabling Twitter Sign-In.
Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in		 string
twitterConsumerSecretSettingName The app setting name that contains the OAuth 1.0a consumer secret of the Twitter
application used for sign-in.		 string
unauthenticatedClientAction The action to take when an unauthenticated client attempts to access the app. 'AllowAnonymous'
'RedirectToLoginPage'
validateIssuer Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. bool

SiteAuthSettingsV2Properties

Name Description Value
globalValidation GlobalValidation
httpSettings HttpSettings
identityProviders IdentityProviders
login Login
platform AuthPlatform

SiteConfig

Name Description Value
acrUseManagedIdentityCreds Flag to use Managed Identity Creds for ACR pull bool
acrUserManagedIdentityID If using user managed identity, the user managed identity ClientId string
alwaysOn <code>true</code> if Always On is enabled; otherwise, <code>false</code>. bool
apiDefinition Information about the formal API definition for the app. ApiDefinitionInfo
apiManagementConfig Azure API management settings linked to the app. ApiManagementConfig
appCommandLine App command line to launch. string
appSettings Application settings. NameValuePair[]
autoHealEnabled <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. bool
autoHealRules Auto Heal rules. AutoHealRules
autoSwapSlotName Auto-swap slot name. string
connectionStrings Connection strings. ConnStringInfo[]
cors Cross-Origin Resource Sharing (CORS) settings. CorsSettings
defaultDocuments Default documents. string[]
detailedErrorLoggingEnabled <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. bool
documentRoot Document root. string
experiments This is work around for polymorphic types. Experiments
ftpsState State of FTP / FTPS service 'AllAllowed'
'Disabled'
'FtpsOnly'
handlerMappings Handler mappings. HandlerMapping[]
healthCheckPath Health check path string
http20Enabled Http20Enabled: configures a web site to allow clients to connect over http2.0 bool
httpLoggingEnabled <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. bool
ipSecurityRestrictions IP security restrictions for main. IpSecurityRestriction[]
javaContainer Java container. string
javaContainerVersion Java container version. string
javaVersion Java version. string
limits Site limits. SiteLimits
linuxFxVersion Linux App Framework and version string
loadBalancing Site load balancing. 'LeastRequests'
'LeastResponseTime'
'RequestHash'
'WeightedRoundRobin'
'WeightedTotalTraffic'
localMySqlEnabled <code>true</code> to enable local MySQL; otherwise, <code>false</code>. bool
logsDirectorySizeLimit HTTP logs directory size limit. int
managedPipelineMode Managed pipeline mode. 'Classic'
'Integrated'
managedServiceIdentityId Managed Service Identity Id int
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
powerShellVersion Version of PowerShell. string
preWarmedInstanceCount Number of preWarmed instances.
This setting only applies to the Consumption and Elastic Plans		 int

Constraints:
Min value = 0
Max value = 10
publishingUsername Publishing user name. string
push Push endpoint settings. PushSettings
pythonVersion Version of Python. string
remoteDebuggingEnabled <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. bool
remoteDebuggingVersion Remote debugging version. string
requestTracingEnabled <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. bool
requestTracingExpirationTime Request tracing expiration time. string
scmIpSecurityRestrictions IP security restrictions for scm. IpSecurityRestriction[]
scmIpSecurityRestrictionsUseMain IP security restrictions for scm to use main. bool
scmMinTlsVersion ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site '1.0'
'1.1'
'1.2'
scmType SCM type. 'BitbucketGit'
'BitbucketHg'
'CodePlexGit'
'CodePlexHg'
'Dropbox'
'ExternalGit'
'ExternalHg'
'GitHub'
'LocalGit'
'None'
'OneDrive'
'Tfs'
'VSO'
'VSTSRM'
tracingOptions Tracing options. string
use32BitWorkerProcess <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. bool
virtualApplications Virtual applications. VirtualApplication[]
vnetName Virtual Network name. string
vnetPrivatePortsCount The number of private ports assigned to this app. These will be assigned dynamically on runtime. int
vnetRouteAllEnabled Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. bool
webSocketsEnabled <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. bool
windowsFxVersion Xenon App Framework and version string
xManagedServiceIdentityId Explicit Managed Service Identity Id int

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

SiteLogsConfigProperties

Name Description Value
applicationLogs Application logs configuration. ApplicationLogsConfig
detailedErrorMessages Detailed error messages configuration. EnabledConfig
failedRequestsTracing Failed requests tracing configuration. EnabledConfig
httpLogs HTTP logs configuration. HttpLogsConfig

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

StringDictionaryProperties

Name Description Value

StringDictionaryProperties

Name Description Value

TokenStore

Name Description Value
kind Kind of resource. string
properties TokenStore resource specific properties TokenStoreProperties

TokenStoreProperties

Name Description Value
azureBlobStorage BlobStorageTokenStore
enabled bool
fileSystem FileSystemTokenStore
tokenRefreshExtensionHours int

Twitter

Name Description Value
kind Kind of resource. string
properties Twitter resource specific properties TwitterProperties

TwitterProperties

Name Description Value
enabled bool
registration TwitterRegistration

TwitterRegistration

Name Description Value
kind Kind of resource. string
properties TwitterRegistration resource specific properties TwitterRegistrationProperties

TwitterRegistrationProperties

Name Description Value
consumerKey string
consumerSecretSettingName string

VirtualApplication

Name Description Value
physicalPath Physical path. string
preloadEnabled <code>true</code> if preloading is enabled; otherwise, <code>false</code>. 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

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  name = "string"
  // For remaining properties, see microsoft.web/sites/slots/config objects
}

microsoft.web/sites/slots/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 = {
    aadClaimsAuthorization = "string"
    additionalLoginParams = [
      "string"
    ]
    allowedAudiences = [
      "string"
    ]
    allowedExternalRedirectUrls = [
      "string"
    ]
    authFilePath = "string"
    clientId = "string"
    clientSecret = "string"
    clientSecretCertificateThumbprint = "string"
    clientSecretSettingName = "string"
    defaultProvider = "string"
    enabled = bool
    facebookAppId = "string"
    facebookAppSecret = "string"
    facebookAppSecretSettingName = "string"
    facebookOAuthScopes = [
      "string"
    ]
    gitHubClientId = "string"
    gitHubClientSecret = "string"
    gitHubClientSecretSettingName = "string"
    gitHubOAuthScopes = [
      "string"
    ]
    googleClientId = "string"
    googleClientSecret = "string"
    googleClientSecretSettingName = "string"
    googleOAuthScopes = [
      "string"
    ]
    isAuthFromFile = "string"
    issuer = "string"
    microsoftAccountClientId = "string"
    microsoftAccountClientSecret = "string"
    microsoftAccountClientSecretSettingName = "string"
    microsoftAccountOAuthScopes = [
      "string"
    ]
    runtimeVersion = "string"
    tokenRefreshExtensionHours = int
    tokenStoreEnabled = bool
    twitterConsumerKey = "string"
    twitterConsumerSecret = "string"
    twitterConsumerSecretSettingName = "string"
    unauthenticatedClientAction = "string"
    validateIssuer = bool
  }
}

For authsettingsV2, use:

{
  kind = "string"
  name = "authsettingsV2"
  properties = {
    globalValidation = {
      kind = "string"
      properties = {
        excludedPaths = [
          "string"
        ]
        redirectToProvider = "string"
        requireAuthentication = bool
        unauthenticatedClientAction = "string"
      }
    }
    httpSettings = {
      kind = "string"
      properties = {
        forwardProxy = {
          kind = "string"
          properties = {
            convention = "string"
            customHostHeaderName = "string"
            customProtoHeaderName = "string"
          }
        }
        requireHttps = bool
        routes = {
          kind = "string"
          properties = {
            apiPrefix = "string"
          }
        }
      }
    }
    identityProviders = {
      kind = "string"
      properties = {
        azureActiveDirectory = {
          kind = "string"
          properties = {
            enabled = bool
            isAutoProvisioned = bool
            login = {
              kind = "string"
              properties = {
                disableWWWAuthenticate = bool
                loginParameters = [
                  "string"
                ]
              }
            }
            registration = {
              kind = "string"
              properties = {
                clientId = "string"
                clientSecretCertificateThumbprint = "string"
                clientSecretSettingName = "string"
                openIdIssuer = "string"
              }
            }
            validation = {
              kind = "string"
              properties = {
                allowedAudiences = [
                  "string"
                ]
                jwtClaimChecks = {
                  kind = "string"
                  properties = {
                    allowedClientApplications = [
                      "string"
                    ]
                    allowedGroups = [
                      "string"
                    ]
                  }
                }
              }
            }
          }
        }
        customOpenIdConnectProviders = {
          {customized property} = {
            kind = "string"
            properties = {
              enabled = bool
              login = {
                kind = "string"
                properties = {
                  nameClaimType = "string"
                  scopes = [
                    "string"
                  ]
                }
              }
              registration = {
                kind = "string"
                properties = {
                  clientCredential = {
                    kind = "string"
                    properties = {
                      clientSecretSettingName = "string"
                      method = "ClientSecretPost"
                    }
                  }
                  clientId = "string"
                  openIdConnectConfiguration = {
                    kind = "string"
                    properties = {
                      authorizationEndpoint = "string"
                      certificationUri = "string"
                      issuer = "string"
                      tokenEndpoint = "string"
                      wellKnownOpenIdConfiguration = "string"
                    }
                  }
                }
              }
            }
          }
        }
        facebook = {
          kind = "string"
          properties = {
            enabled = bool
            graphApiVersion = "string"
            login = {
              kind = "string"
              properties = {
                scopes = [
                  "string"
                ]
              }
            }
            registration = {
              kind = "string"
              properties = {
                appId = "string"
                appSecretSettingName = "string"
              }
            }
          }
        }
        gitHub = {
          kind = "string"
          properties = {
            enabled = bool
            login = {
              kind = "string"
              properties = {
                scopes = [
                  "string"
                ]
              }
            }
            registration = {
              kind = "string"
              properties = {
                clientId = "string"
                clientSecretSettingName = "string"
              }
            }
          }
        }
        google = {
          kind = "string"
          properties = {
            enabled = bool
            login = {
              kind = "string"
              properties = {
                scopes = [
                  "string"
                ]
              }
            }
            registration = {
              kind = "string"
              properties = {
                clientId = "string"
                clientSecretSettingName = "string"
              }
            }
            validation = {
              kind = "string"
              properties = {
                allowedAudiences = [
                  "string"
                ]
              }
            }
          }
        }
        twitter = {
          kind = "string"
          properties = {
            enabled = bool
            registration = {
              kind = "string"
              properties = {
                consumerKey = "string"
                consumerSecretSettingName = "string"
              }
            }
          }
        }
      }
    }
    login = {
      kind = "string"
      properties = {
        allowedExternalRedirectUrls = [
          "string"
        ]
        cookieExpiration = {
          kind = "string"
          properties = {
            convention = "string"
            timeToExpiration = "string"
          }
        }
        nonce = {
          kind = "string"
          properties = {
            nonceExpirationInterval = "string"
            validateNonce = bool
          }
        }
        preserveUrlFragmentsForLogins = bool
        routes = {
          kind = "string"
          properties = {
            logoutEndpoint = "string"
          }
        }
        tokenStore = {
          kind = "string"
          properties = {
            azureBlobStorage = {
              kind = "string"
              properties = {
                sasUrlSettingName = "string"
              }
            }
            enabled = bool
            fileSystem = {
              kind = "string"
              properties = {
                directory = "string"
              }
            }
            tokenRefreshExtensionHours = int
          }
        }
      }
    }
    platform = {
      kind = "string"
      properties = {
        configFilePath = "string"
        enabled = bool
        runtimeVersion = "string"
      }
    }
  }
}

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 web, use:

{
  kind = "string"
  name = "web"
  properties = {
    acrUseManagedIdentityCreds = bool
    acrUserManagedIdentityID = "string"
    alwaysOn = bool
    apiDefinition = {
      url = "string"
    }
    apiManagementConfig = {
      id = "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"
      ]
      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"
      }
    ]
    healthCheckPath = "string"
    http20Enabled = bool
    httpLoggingEnabled = bool
    ipSecurityRestrictions = [
      {
        action = "string"
        description = "string"
        headers = {
          {customized property} = [
            "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"
    powerShellVersion = "string"
    preWarmedInstanceCount = int
    publishingUsername = "string"
    push = {
      kind = "string"
      properties = {
        dynamicTagsJson = "string"
        isPushEnabled = bool
        tagsRequiringAuth = "string"
        tagWhitelistJson = "string"
      }
    }
    pythonVersion = "string"
    remoteDebuggingEnabled = bool
    remoteDebuggingVersion = "string"
    requestTracingEnabled = bool
    requestTracingExpirationTime = "string"
    scmIpSecurityRestrictions = [
      {
        action = "string"
        description = "string"
        headers = {
          {customized property} = [
            "string"
          ]
        }
        ipAddress = "string"
        name = "string"
        priority = int
        subnetMask = "string"
        subnetTrafficTag = int
        tag = "string"
        vnetSubnetResourceId = "string"
        vnetTrafficTag = int
      }
    ]
    scmIpSecurityRestrictionsUseMain = bool
    scmMinTlsVersion = "string"
    scmType = "string"
    tracingOptions = "string"
    use32BitWorkerProcess = bool
    virtualApplications = [
      {
        physicalPath = "string"
        preloadEnabled = bool
        virtualDirectories = [
          {
            physicalPath = "string"
            virtualPath = "string"
          }
        ]
        virtualPath = "string"
      }
    ]
    vnetName = "string"
    vnetPrivatePortsCount = int
    vnetRouteAllEnabled = bool
    webSocketsEnabled = bool
    windowsFxVersion = "string"
    xManagedServiceIdentityId = int
  }
}

Property values

AllowedAudiencesValidation

Name Description Value
kind Kind of resource. string
properties AllowedAudiencesValidation resource specific properties AllowedAudiencesValidationProperties

AllowedAudiencesValidationProperties

Name Description Value
allowedAudiences string[]

ApiDefinitionInfo

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

ApiManagementConfig

Name Description Value
id APIM-Api Identifier. 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

AppRegistration

Name Description Value
kind Kind of resource. string
properties AppRegistration resource specific properties AppRegistrationProperties

AppRegistrationProperties

Name Description Value
appId string
appSecretSettingName string

AuthPlatform

Name Description Value
kind Kind of resource. string
properties AuthPlatform resource specific properties AuthPlatformProperties

AuthPlatformProperties

Name Description Value
configFilePath string
enabled bool
runtimeVersion string

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[]

AzureActiveDirectory

Name Description Value
kind Kind of resource. string
properties AzureActiveDirectory resource specific properties AzureActiveDirectoryProperties

AzureActiveDirectoryLogin

Name Description Value
kind Kind of resource. string
properties AzureActiveDirectoryLogin resource specific properties AzureActiveDirectoryLoginProperties

AzureActiveDirectoryLoginProperties

Name Description Value
disableWWWAuthenticate bool
loginParameters string[]

AzureActiveDirectoryProperties

Name Description Value
enabled bool
isAutoProvisioned bool
login AzureActiveDirectoryLogin
registration AzureActiveDirectoryRegistration
validation AzureActiveDirectoryValidation

AzureActiveDirectoryRegistration

Name Description Value
kind Kind of resource. string
properties AzureActiveDirectoryRegistration resource specific properties AzureActiveDirectoryRegistrationProperties

AzureActiveDirectoryRegistrationProperties

Name Description Value
clientId string
clientSecretCertificateThumbprint string
clientSecretSettingName string
openIdIssuer string

AzureActiveDirectoryValidation

Name Description Value
kind Kind of resource. string
properties AzureActiveDirectoryValidation resource specific properties AzureActiveDirectoryValidationProperties

AzureActiveDirectoryValidationProperties

Name Description Value
allowedAudiences string[]
jwtClaimChecks JwtClaimChecks

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

BlobStorageTokenStore

Name Description Value
kind Kind of resource. string
properties BlobStorageTokenStore resource specific properties BlobStorageTokenStoreProperties

BlobStorageTokenStoreProperties

Name Description Value
sasUrlSettingName string

ClientRegistration

Name Description Value
kind Kind of resource. string
properties ClientRegistration resource specific properties ClientRegistrationProperties

ClientRegistrationProperties

Name Description Value
clientId string
clientSecretSettingName 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)

CookieExpiration

Name Description Value
kind Kind of resource. string
properties CookieExpiration resource specific properties CookieExpirationProperties

CookieExpirationProperties

Name Description Value
convention 'FixedTime'
'IdentityProviderDerived'
timeToExpiration string

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

CustomOpenIdConnectProvider

Name Description Value
kind Kind of resource. string
properties CustomOpenIdConnectProvider resource specific properties CustomOpenIdConnectProviderProperties

CustomOpenIdConnectProviderProperties

Name Description Value
enabled bool
login OpenIdConnectLogin
registration OpenIdConnectRegistration

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[]

Facebook

Name Description Value
kind Kind of resource. string
properties Facebook resource specific properties FacebookProperties

FacebookProperties

Name Description Value
enabled bool
graphApiVersion string
login LoginScopes
registration AppRegistration

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

FileSystemTokenStore

Name Description Value
kind Kind of resource. string
properties FileSystemTokenStore resource specific properties FileSystemTokenStoreProperties

FileSystemTokenStoreProperties

Name Description Value
directory string

ForwardProxy

Name Description Value
kind Kind of resource. string
properties ForwardProxy resource specific properties ForwardProxyProperties

ForwardProxyProperties

Name Description Value
convention 'Custom'
'NoProxy'
'Standard'
customHostHeaderName string
customProtoHeaderName string

GitHub

Name Description Value
kind Kind of resource. string
properties GitHub resource specific properties GitHubProperties

GitHubProperties

Name Description Value
enabled bool
login LoginScopes
registration ClientRegistration

GlobalValidation

Name Description Value
kind Kind of resource. string
properties GlobalValidation resource specific properties GlobalValidationProperties

GlobalValidationProperties

Name Description Value
excludedPaths string[]
redirectToProvider string
requireAuthentication bool
unauthenticatedClientAction 'AllowAnonymous'
'RedirectToLoginPage'
'Return401'
'Return403'

Google

Name Description Value
kind Kind of resource. string
properties Google resource specific properties GoogleProperties

GoogleProperties

Name Description Value
enabled bool
login LoginScopes
registration ClientRegistration
validation AllowedAudiencesValidation

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

HttpSettings

Name Description Value
kind Kind of resource. string
properties HttpSettings resource specific properties HttpSettingsProperties

HttpSettingsProperties

Name Description Value
forwardProxy ForwardProxy
requireHttps bool
routes HttpSettingsRoutes

HttpSettingsRoutes

Name Description Value
kind Kind of resource. string
properties HttpSettingsRoutes resource specific properties HttpSettingsRoutesProperties

HttpSettingsRoutesProperties

Name Description Value
apiPrefix string

IdentityProviders

Name Description Value
kind Kind of resource. string
properties IdentityProviders resource specific properties IdentityProvidersProperties

IdentityProvidersProperties

Name Description Value
azureActiveDirectory AzureActiveDirectory
customOpenIdConnectProviders Dictionary of <CustomOpenIdConnectProvider> IdentityProvidersPropertiesCustomOpenIdConnectProviders
facebook Facebook
gitHub GitHub
google Google
twitter Twitter

IdentityProvidersPropertiesCustomOpenIdConnectProviders

Name Description Value

IpSecurityRestriction

Name Description Value
action Allow or Deny access for this IP range. string
description IP restriction rule description. string
headers 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.		 IpSecurityRestrictionHeaders
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'
'ServiceTag'
'XffProxy'
vnetSubnetResourceId Virtual network resource id string
vnetTrafficTag (internal) Vnet traffic tag int

IpSecurityRestrictionHeaders

Name Description Value

JwtClaimChecks

Name Description Value
kind Kind of resource. string
properties JwtClaimChecks resource specific properties JwtClaimChecksProperties

JwtClaimChecksProperties

Name Description Value
allowedClientApplications string[]
allowedGroups string[]

Login

Name Description Value
kind Kind of resource. string
properties Login resource specific properties LoginProperties

LoginProperties

Name Description Value
allowedExternalRedirectUrls string[]
cookieExpiration CookieExpiration
nonce Nonce
preserveUrlFragmentsForLogins bool
routes LoginRoutes
tokenStore TokenStore

LoginRoutes

Name Description Value
kind Kind of resource. string
properties LoginRoutes resource specific properties LoginRoutesProperties

LoginRoutesProperties

Name Description Value
logoutEndpoint string

LoginScopes

Name Description Value
kind Kind of resource. string
properties LoginScopes resource specific properties LoginScopesProperties

LoginScopesProperties

Name Description Value
scopes string[]

microsoft.web/sites/slots/config

Name Description Value
name Set to 'appsettings' for type Microsoft.Web/sites/slots/config. Set to 'authsettings' for type Microsoft.Web/sites/slots/config. Set to 'authsettingsV2' for type Microsoft.Web/sites/slots/config. Set to 'azurestorageaccounts' for type Microsoft.Web/sites/slots/config. Set to 'backup' for type Microsoft.Web/sites/slots/config. Set to 'connectionstrings' for type Microsoft.Web/sites/slots/config. Set to 'logs' for type Microsoft.Web/sites/slots/config. Set to 'metadata' for type Microsoft.Web/sites/slots/config. Set to 'pushsettings' for type Microsoft.Web/sites/slots/config. Set to 'web' for type Microsoft.Web/sites/slots/config. 'appsettings'
'authsettings'
'authsettingsV2'
'azurestorageaccounts'
'backup'
'connectionstrings'
'logs'
'metadata'
'pushsettings'
'web' (required)

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'appsettings' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites/slots
properties Settings. StringDictionaryProperties
type The resource type "Microsoft.Web/sites/slots/config@2020-10-01"

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'authsettings' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites/slots
properties SiteAuthSettings resource specific properties SiteAuthSettingsProperties
type The resource type "Microsoft.Web/sites/slots/config@2020-10-01"

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'authsettingsV2' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites/slots
properties SiteAuthSettingsV2 resource specific properties SiteAuthSettingsV2Properties
type The resource type "Microsoft.Web/sites/slots/config@2020-10-01"

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'azurestorageaccounts' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites/slots
properties Azure storage accounts. AzureStoragePropertyDictionaryResourceProperties
type The resource type "Microsoft.Web/sites/slots/config@2020-10-01"

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'backup' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites/slots
properties BackupRequest resource specific properties BackupRequestProperties
type The resource type "Microsoft.Web/sites/slots/config@2020-10-01"

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'connectionstrings' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites/slots
properties Connection strings. ConnectionStringDictionaryProperties
type The resource type "Microsoft.Web/sites/slots/config@2020-10-01"

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'logs' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites/slots
properties SiteLogsConfig resource specific properties SiteLogsConfigProperties
type The resource type "Microsoft.Web/sites/slots/config@2020-10-01"

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'metadata' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites/slots
properties Settings. StringDictionaryProperties
type The resource type "Microsoft.Web/sites/slots/config@2020-10-01"

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'pushsettings' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites/slots
properties PushSettings resource specific properties PushSettingsProperties
type The resource type "Microsoft.Web/sites/slots/config@2020-10-01"

Microsoft.Web/sites/slots/config

Name Description Value
kind Kind of resource. string
name The resource name 'web' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites/slots
properties Core resource properties SiteConfig
type The resource type "Microsoft.Web/sites/slots/config@2020-10-01"

NameValuePair

Name Description Value
name Pair name. string
value Pair value. string

Nonce

Name Description Value
kind Kind of resource. string
properties Nonce resource specific properties NonceProperties

NonceProperties

Name Description Value
nonceExpirationInterval string
validateNonce bool

OpenIdConnectClientCredential

Name Description Value
kind Kind of resource. string
properties OpenIdConnectClientCredential resource specific properties OpenIdConnectClientCredentialProperties

OpenIdConnectClientCredentialProperties

Name Description Value
clientSecretSettingName string
method 'ClientSecretPost'

OpenIdConnectConfig

Name Description Value
kind Kind of resource. string
properties OpenIdConnectConfig resource specific properties OpenIdConnectConfigProperties

OpenIdConnectConfigProperties

Name Description Value
authorizationEndpoint string
certificationUri string
issuer string
tokenEndpoint string
wellKnownOpenIdConfiguration string

OpenIdConnectLogin

Name Description Value
kind Kind of resource. string
properties OpenIdConnectLogin resource specific properties OpenIdConnectLoginProperties

OpenIdConnectLoginProperties

Name Description Value
nameClaimType string
scopes string[]

OpenIdConnectRegistration

Name Description Value
kind Kind of resource. string
properties OpenIdConnectRegistration resource specific properties OpenIdConnectRegistrationProperties

OpenIdConnectRegistrationProperties

Name Description Value
clientCredential OpenIdConnectClientCredential
clientId string
openIdConnectConfiguration OpenIdConnectConfig

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 in the allowed list for use by the push registration endpoint. string

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 <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or
<code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm
can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.		 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 <code>ActionHostName</code>. int

RequestsBasedTrigger

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

SiteAuthSettingsProperties

Name Description Value
aadClaimsAuthorization Gets a JSON string containing the Azure AD Acl settings. string
additionalLoginParams Login parameters to send to the OpenID Connect authorization endpoint when
a user logs in. Each parameter must be in the form "key=value".		 string[]
allowedAudiences Allowed audience values to consider when validating JWTs issued by
Azure Active Directory. Note that the <code>ClientID</code> value is always considered an
allowed audience, regardless of this setting.		 string[]
allowedExternalRedirectUrls External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.
This is an advanced setting typically only needed by Windows Store application backends.
Note that URLs within the current domain are always implicitly allowed.		 string[]
authFilePath The path of the config file containing auth settings.
If the path is relative, base will the site's root directory.		 string
clientId The Client ID of this relying party application, known as the client_id.
This setting is required for enabling OpenID Connection authentication with Azure Active Directory or
other 3rd party OpenID Connect providers.
More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html		 string
clientSecret The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).
This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.
Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.
More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html		 string
clientSecretCertificateThumbprint An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as
a replacement for the Client Secret. It is also optional.		 string
clientSecretSettingName The app setting name that contains the client secret of the relying party application. string
defaultProvider The default authentication provider to use when multiple providers are configured.
This setting is only needed if multiple providers are configured and the unauthenticated client
action is set to "RedirectToLoginPage".		 'AzureActiveDirectory'
'Facebook'
'Github'
'Google'
'MicrosoftAccount'
'Twitter'
enabled <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>. bool
facebookAppId The App ID of the Facebook app used for login.
This setting is required for enabling Facebook Login.
Facebook Login documentation: https://developers.facebook.com/docs/facebook-login		 string
facebookAppSecret The App Secret of the Facebook app used for Facebook Login.
This setting is required for enabling Facebook Login.
Facebook Login documentation: https://developers.facebook.com/docs/facebook-login		 string
facebookAppSecretSettingName The app setting name that contains the app secret used for Facebook Login. string
facebookOAuthScopes The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.
This setting is optional.
Facebook Login documentation: https://developers.facebook.com/docs/facebook-login		 string[]
gitHubClientId The Client Id of the GitHub app used for login.
This setting is required for enabling Github login		 string
gitHubClientSecret The Client Secret of the GitHub app used for Github Login.
This setting is required for enabling Github login.		 string
gitHubClientSecretSettingName The app setting name that contains the client secret of the Github
app used for GitHub Login.		 string
gitHubOAuthScopes The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.
This setting is optional		 string[]
googleClientId The OpenID Connect Client ID for the Google web application.
This setting is required for enabling Google Sign-In.
Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/		 string
googleClientSecret The client secret associated with the Google web application.
This setting is required for enabling Google Sign-In.
Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/		 string
googleClientSecretSettingName The app setting name that contains the client secret associated with
the Google web application.		 string
googleOAuthScopes The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.
This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes.
Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/		 string[]
isAuthFromFile "true" if the auth config settings should be read from a file,
"false" otherwise		 string
issuer The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.
When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.
This URI is a case-sensitive identifier for the token issuer.
More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html		 string
microsoftAccountClientId The OAuth 2.0 client ID that was created for the app used for authentication.
This setting is required for enabling Microsoft Account authentication.
Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm		 string
microsoftAccountClientSecret The OAuth 2.0 client secret that was created for the app used for authentication.
This setting is required for enabling Microsoft Account authentication.
Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm		 string
microsoftAccountClientSecretSettingName The app setting name containing the OAuth 2.0 client secret that was created for the
app used for authentication.		 string
microsoftAccountOAuthScopes The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.
This setting is optional. If not specified, "wl.basic" is used as the default scope.
Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx		 string[]
runtimeVersion The RuntimeVersion of the Authentication / Authorization feature in use for the current app.
The setting in this value can control the behavior of certain features in the Authentication / Authorization module.		 string
tokenRefreshExtensionHours The number of hours after session token expiration that a session token can be used to
call the token refresh API. The default is 72 hours.		 int
tokenStoreEnabled <code>true</code> to durably store platform-specific security tokens that are obtained during login flows; otherwise, <code>false</code>.
The default is <code>false</code>.		 bool
twitterConsumerKey The OAuth 1.0a consumer key of the Twitter application used for sign-in.
This setting is required for enabling Twitter Sign-In.
Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in		 string
twitterConsumerSecret The OAuth 1.0a consumer secret of the Twitter application used for sign-in.
This setting is required for enabling Twitter Sign-In.
Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in		 string
twitterConsumerSecretSettingName The app setting name that contains the OAuth 1.0a consumer secret of the Twitter
application used for sign-in.		 string
unauthenticatedClientAction The action to take when an unauthenticated client attempts to access the app. 'AllowAnonymous'
'RedirectToLoginPage'
validateIssuer Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. bool

SiteAuthSettingsV2Properties

Name Description Value
globalValidation GlobalValidation
httpSettings HttpSettings
identityProviders IdentityProviders
login Login
platform AuthPlatform

SiteConfig

Name Description Value
acrUseManagedIdentityCreds Flag to use Managed Identity Creds for ACR pull bool
acrUserManagedIdentityID If using user managed identity, the user managed identity ClientId string
alwaysOn <code>true</code> if Always On is enabled; otherwise, <code>false</code>. bool
apiDefinition Information about the formal API definition for the app. ApiDefinitionInfo
apiManagementConfig Azure API management settings linked to the app. ApiManagementConfig
appCommandLine App command line to launch. string
appSettings Application settings. NameValuePair[]
autoHealEnabled <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. bool
autoHealRules Auto Heal rules. AutoHealRules
autoSwapSlotName Auto-swap slot name. string
connectionStrings Connection strings. ConnStringInfo[]
cors Cross-Origin Resource Sharing (CORS) settings. CorsSettings
defaultDocuments Default documents. string[]
detailedErrorLoggingEnabled <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. bool
documentRoot Document root. string
experiments This is work around for polymorphic types. Experiments
ftpsState State of FTP / FTPS service 'AllAllowed'
'Disabled'
'FtpsOnly'
handlerMappings Handler mappings. HandlerMapping[]
healthCheckPath Health check path string
http20Enabled Http20Enabled: configures a web site to allow clients to connect over http2.0 bool
httpLoggingEnabled <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. bool
ipSecurityRestrictions IP security restrictions for main. IpSecurityRestriction[]
javaContainer Java container. string
javaContainerVersion Java container version. string
javaVersion Java version. string
limits Site limits. SiteLimits
linuxFxVersion Linux App Framework and version string
loadBalancing Site load balancing. 'LeastRequests'
'LeastResponseTime'
'RequestHash'
'WeightedRoundRobin'
'WeightedTotalTraffic'
localMySqlEnabled <code>true</code> to enable local MySQL; otherwise, <code>false</code>. bool
logsDirectorySizeLimit HTTP logs directory size limit. int
managedPipelineMode Managed pipeline mode. 'Classic'
'Integrated'
managedServiceIdentityId Managed Service Identity Id int
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
powerShellVersion Version of PowerShell. string
preWarmedInstanceCount Number of preWarmed instances.
This setting only applies to the Consumption and Elastic Plans		 int

Constraints:
Min value = 0
Max value = 10
publishingUsername Publishing user name. string
push Push endpoint settings. PushSettings
pythonVersion Version of Python. string
remoteDebuggingEnabled <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. bool
remoteDebuggingVersion Remote debugging version. string
requestTracingEnabled <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. bool
requestTracingExpirationTime Request tracing expiration time. string
scmIpSecurityRestrictions IP security restrictions for scm. IpSecurityRestriction[]
scmIpSecurityRestrictionsUseMain IP security restrictions for scm to use main. bool
scmMinTlsVersion ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site '1.0'
'1.1'
'1.2'
scmType SCM type. 'BitbucketGit'
'BitbucketHg'
'CodePlexGit'
'CodePlexHg'
'Dropbox'
'ExternalGit'
'ExternalHg'
'GitHub'
'LocalGit'
'None'
'OneDrive'
'Tfs'
'VSO'
'VSTSRM'
tracingOptions Tracing options. string
use32BitWorkerProcess <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. bool
virtualApplications Virtual applications. VirtualApplication[]
vnetName Virtual Network name. string
vnetPrivatePortsCount The number of private ports assigned to this app. These will be assigned dynamically on runtime. int
vnetRouteAllEnabled Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. bool
webSocketsEnabled <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. bool
windowsFxVersion Xenon App Framework and version string
xManagedServiceIdentityId Explicit Managed Service Identity Id int

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

SiteLogsConfigProperties

Name Description Value
applicationLogs Application logs configuration. ApplicationLogsConfig
detailedErrorMessages Detailed error messages configuration. EnabledConfig
failedRequestsTracing Failed requests tracing configuration. EnabledConfig
httpLogs HTTP logs configuration. HttpLogsConfig

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

StringDictionaryProperties

Name Description Value

StringDictionaryProperties

Name Description Value

TokenStore

Name Description Value
kind Kind of resource. string
properties TokenStore resource specific properties TokenStoreProperties

TokenStoreProperties

Name Description Value
azureBlobStorage BlobStorageTokenStore
enabled bool
fileSystem FileSystemTokenStore
tokenRefreshExtensionHours int

Twitter

Name Description Value
kind Kind of resource. string
properties Twitter resource specific properties TwitterProperties

TwitterProperties

Name Description Value
enabled bool
registration TwitterRegistration

TwitterRegistration

Name Description Value
kind Kind of resource. string
properties TwitterRegistration resource specific properties TwitterRegistrationProperties

TwitterRegistrationProperties

Name Description Value
consumerKey string
consumerSecretSettingName string

VirtualApplication

Name Description Value
physicalPath Physical path. string
preloadEnabled <code>true</code> if preloading is enabled; otherwise, <code>false</code>. 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