Microsoft.Web staticSites/basicAuth

ARM template resource definition

The staticSites/basicAuth 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/staticSites/basicAuth resource, add the following JSON to your template.

{
  "type": "Microsoft.Web/staticSites/basicAuth",
  "apiVersion": "2022-09-01",
  "name": "default",
  "kind": "string",
  "properties": {
    "applicableEnvironmentsMode": "string",
    "environments": [ "string" ],
    "password": "string",
    "secretUrl": "string"
  }
}

Property values

staticSites/basicAuth

Name Description Value
type The resource type 'Microsoft.Web/staticSites/basicAuth'
apiVersion The resource api version '2022-09-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
'default'
kind Kind of resource. string
properties StaticSiteBasicAuthPropertiesARMResource resource specific properties StaticSiteBasicAuthPropertiesARMResourceProperties

StaticSiteBasicAuthPropertiesARMResourceProperties

Name Description Value
applicableEnvironmentsMode State indicating if basic auth is enabled and for what environments it is active. string (required)
environments The list of enabled environments for Basic Auth if ApplicableEnvironmentsMode is set to SpecifiedEnvironments. string[]
password The password for basic auth. string
secretUrl Url to the secret in Key Vault. string