StaticSiteARMResource interface

Package:

@azure/arm-appservice

Static Site ARM resource.

Extends

Resource

Properties

allowConfigFileUpdates	false if config file is locked for this static web app; otherwise, true.
branch	The target branch in the repository.
buildProperties	Build properties to configure on the repository.
contentDistributionEndpoint	The content distribution endpoint for the static site. NOTE: This property will not be serialized. It can only be populated by the server.
customDomains	The custom domains associated with this static site. NOTE: This property will not be serialized. It can only be populated by the server.
databaseConnections	Database connections for the static site NOTE: This property will not be serialized. It can only be populated by the server.
defaultHostname	The default autogenerated hostname for the static site. NOTE: This property will not be serialized. It can only be populated by the server.
enterpriseGradeCdnStatus	State indicating the status of the enterprise grade CDN serving traffic to the static web app.
identity	Managed service identity.
keyVaultReferenceIdentity	Identity to use for Key Vault Reference authentication. NOTE: This property will not be serialized. It can only be populated by the server.
linkedBackends	Backends linked to the static side NOTE: This property will not be serialized. It can only be populated by the server.
privateEndpointConnections	Private endpoint connections NOTE: This property will not be serialized. It can only be populated by the server.
provider	The provider that submitted the last deployment to the primary environment of the static site.
publicNetworkAccess	State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string.
repositoryToken	A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
repositoryUrl	URL for the repository of the static site.
sku	Description of a SKU for a scalable resource.
stagingEnvironmentPolicy	State indicating whether staging environments are allowed or not allowed for a static web app.
templateProperties	Template options for generating a new repository.
userProvidedFunctionApps	User provided function apps registered with the static site NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.
kind	Kind of resource.
location	Resource Location.
name	Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
type	Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

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

StaticSiteBuildProperties

contentDistributionEndpoint

The content distribution endpoint for the static site. NOTE: This property will not be serialized. It can only be populated by the server.

contentDistributionEndpoint?: string

Property Value

string

customDomains

The custom domains associated with this static site. NOTE: This property will not be serialized. It can only be populated by the server.

customDomains?: string[]

Property Value

string[]

databaseConnections

Database connections for the static site NOTE: This property will not be serialized. It can only be populated by the server.

databaseConnections?: DatabaseConnectionOverview[]

Property Value

DatabaseConnectionOverview[]

defaultHostname

The default autogenerated hostname for the static site. NOTE: This property will not be serialized. It can only be populated by the server.

defaultHostname?: string

Property Value

string

enterpriseGradeCdnStatus

State indicating the status of the enterprise grade CDN serving traffic to the static web app.

enterpriseGradeCdnStatus?: string

Property Value

string

identity

Managed service identity.

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

keyVaultReferenceIdentity

Identity to use for Key Vault Reference authentication. NOTE: This property will not be serialized. It can only be populated by the server.

keyVaultReferenceIdentity?: string

Property Value

string

linkedBackends

Backends linked to the static side NOTE: This property will not be serialized. It can only be populated by the server.

linkedBackends?: StaticSiteLinkedBackend[]

Property Value

StaticSiteLinkedBackend[]

privateEndpointConnections

Private endpoint connections NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: ResponseMessageEnvelopeRemotePrivateEndpointConnection[]

Property Value

ResponseMessageEnvelopeRemotePrivateEndpointConnection[]

provider

The provider that submitted the last deployment to the primary environment of the static site.

provider?: string

Property Value

string

publicNetworkAccess

State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string.

publicNetworkAccess?: 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

sku

Description of a SKU for a scalable resource.

sku?: SkuDescription

Property Value

SkuDescription

stagingEnvironmentPolicy

State indicating whether staging environments are allowed or not allowed for a static web app.

stagingEnvironmentPolicy?: StagingEnvironmentPolicy

Property Value

StagingEnvironmentPolicy

templateProperties

Template options for generating a new repository.

templateProperties?: StaticSiteTemplateOptions

Property Value

StaticSiteTemplateOptions

userProvidedFunctionApps

User provided function apps registered with the static site NOTE: This property will not be serialized. It can only be populated by the server.

userProvidedFunctionApps?: StaticSiteUserProvidedFunctionApp[]

Property Value

StaticSiteUserProvidedFunctionApp[]

Inherited Property Details

id

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

kind

Kind of resource.

kind?: string

Property Value

string

Inherited From Resource.kind

location

Resource Location.

location: string

Property Value

string

Inherited From Resource.location

name

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type