Microsoft.Web staticSites 2020-10-01
Article 09/01/2023
1 contributor
Feedback
In this article
Bicep resource definition
The staticSites resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Web/staticSites resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Web/staticSites@2020-10-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
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
Core resource properties
StaticSite
StaticSite
Name
Description
Value
branch
The target branch in the repository.
string
buildProperties
Build properties to configure on the repository.
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
Min, max, and default scale values of the SKU.
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
ARM template resource definition
The staticSites resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Web/staticSites resource, add the following JSON to your template.
{
"type": "Microsoft.Web/staticSites",
"apiVersion": "2020-10-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
'Microsoft.Web/staticSites'
apiVersion
The resource api version
'2020-10-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
Core resource properties
StaticSite
StaticSite
Name
Description
Value
branch
The target branch in the repository.
string
buildProperties
Build properties to configure on the repository.
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
Min, max, and default scale values of the SKU.
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
The staticSites resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
To create a Microsoft.Web/staticSites resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Web/staticSites@2020-10-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
branch = "string"
buildProperties = {
apiLocation = "string"
appArtifactLocation = "string"
appLocation = "string"
}
repositoryToken = "string"
repositoryUrl = "string"
}
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"
})
}
Property values
staticSites
Name
Description
Value
type
The resource type
"Microsoft.Web/staticSites@2020-10-01"
name
The resource name
string (required)
location
Resource Location.
string (required)
parent_id
To deploy to a resource group, use the ID of that resource group.
string (required)
tags
Resource tags.
Dictionary of tag names and values.
sku
Description of a SKU for a scalable resource.
SkuDescription
kind
Kind of resource.
string
properties
Core resource properties
StaticSite
StaticSite
Name
Description
Value
branch
The target branch in the repository.
string
buildProperties
Build properties to configure on the repository.
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
Min, max, and default scale values of the SKU.
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