StaticSite interface
A static site.
Properties
| allow |
|
| branch | The target branch in the repository. |
| build |
Build properties to configure on the repository. |
| enterprise |
State indicating the status of the enterprise grade CDN serving traffic to the static web app. |
| provider | The provider that submitted the last deployment to the primary environment of the static site. |
| repository |
A user's github repository token. This is used to setup the Github Actions workflow file and API secrets. |
| repository |
URL for the repository of the static site. |
| staging |
State indicating whether staging environments are allowed or not allowed for a static web app. |
| template |
Template options for generating a new repository. |
Property Details
allowConfigFileUpdates
false if config file is locked for this static web app; otherwise, true.
allowConfigFileUpdates?: boolean
Property Value
boolean
branch
The target branch in the repository.
branch?: string
Property Value
string
buildProperties
Build properties to configure on the repository.
buildProperties?: StaticSiteBuildProperties
Property Value
enterpriseGradeCdnStatus
State indicating the status of the enterprise grade CDN serving traffic to the static web app.
enterpriseGradeCdnStatus?: "Disabled" | "Enabled" | "Enabling" | "Disabling"
Property Value
"Disabled" | "Enabled" | "Enabling" | "Disabling"
provider
The provider that submitted the last deployment to the primary environment of the static site.
provider?: string
Property Value
string
repositoryToken
A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
repositoryToken?: string
Property Value
string
repositoryUrl
URL for the repository of the static site.
repositoryUrl?: string
Property Value
string
stagingEnvironmentPolicy
State indicating whether staging environments are allowed or not allowed for a static web app.
stagingEnvironmentPolicy?: "Disabled" | "Enabled"
Property Value
"Disabled" | "Enabled"
templateProperties
Template options for generating a new repository.
templateProperties?: StaticSiteTemplateOptions