Microsoft.Web staticSites 2019-08-01

The staticSites resource type can be deployed to: Resource groups.

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

Template format

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

resource symbolicname 'Microsoft.Web/staticSites@2019-08-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capabilities: [
      {
        name: 'string'
        reason: 'string'
        value: 'string'
      }
    ]
    capacity: int
    family: 'string'
    locations: [
      'string'
    ]
    name: 'string'
    size: 'string'
    skuCapacity: {
      default: int
      maximum: int
      minimum: int
      scaleType: 'string'
    }
    tier: 'string'
  }
  kind: 'string'
  properties: {
    branch: 'string'
    buildProperties: {
      apiLocation: 'string'
      appArtifactLocation: 'string'
      appLocation: 'string'
    }
    repositoryToken: 'string'
    repositoryUrl: 'string'
  }
}

Property values

staticSites

Name Description Value
type The resource type

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

For Bicep, set this value in the resource declaration.
'2019-08-01'
name The resource name string (required)
location Resource Location. string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku Description of a SKU for a scalable resource. SkuDescription
kind Kind of resource. string
properties A static site. StaticSite

StaticSite

Name Description Value
branch The target branch in the repository. string
buildProperties Build properties for the static site. StaticSiteBuildProperties
repositoryToken A user's github repository token. This is used to setup the Github Actions workflow file and API secrets. string
repositoryUrl URL for the repository of the static site. string

StaticSiteBuildProperties

Name Description Value
apiLocation The path to the api code within the repository. string
appArtifactLocation The path of the app artifacts after building. string
appLocation The path to the app code within the repository. string

SkuDescription

Name Description Value
capabilities Capabilities of the SKU, e.g., is traffic manager enabled? Capability[]
capacity Current number of instances assigned to the resource. int
family Family code of the resource SKU. string
locations Locations of the SKU. string[]
name Name of the resource SKU. string
size Size specifier of the resource SKU. string
skuCapacity Description of the App Service plan scale options. SkuCapacity
tier Service tier of the resource SKU. string

Capability

Name Description Value
name Name of the SKU capability. string
reason Reason of the SKU capability. string
value Value of the SKU capability. string

SkuCapacity

Name Description Value
default Default number of workers for this App Service plan SKU. int
maximum Maximum number of workers for this App Service plan SKU. int
minimum Minimum number of workers for this App Service plan SKU. int
scaleType Available scale configurations for an App Service plan. string