Share via

StaticSiteOutput interface

Package:
@azure-rest/arm-appservice

A static site.

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.
customDomains

The custom domains associated with this static site.
defaultHostname

The default autogenerated hostname for the static site.
enterpriseGradeCdnStatus

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

Identity to use for Key Vault Reference authentication.
privateEndpointConnections

Private endpoint connections
provider

The provider that submitted the last deployment to the primary environment of the static site.
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.
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

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

Property Value

StaticSiteBuildPropertiesOutput

contentDistributionEndpoint

The content distribution endpoint for the static site.

contentDistributionEndpoint?: string

Property Value

string

customDomains

The custom domains associated with this static site.

customDomains?: string[]

Property Value

string[]

defaultHostname

The default autogenerated hostname for the static site.

defaultHostname?: string

Property Value

string

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"

keyVaultReferenceIdentity

Identity to use for Key Vault Reference authentication.

keyVaultReferenceIdentity?: string

Property Value

string

privateEndpointConnections

Private endpoint connections

privateEndpointConnections?: ResponseMessageEnvelopeRemotePrivateEndpointConnectionOutput[]

Property Value

ResponseMessageEnvelopeRemotePrivateEndpointConnectionOutput[]

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

Property Value

StaticSiteTemplateOptionsOutput

userProvidedFunctionApps

User provided function apps registered with the static site

userProvidedFunctionApps?: StaticSiteUserProvidedFunctionAppOutput[]

Property Value

StaticSiteUserProvidedFunctionAppOutput[]