Share via


StaticSite Class

Definition

StaticSite.

public class StaticSite : Azure.Provisioning.Primitives.ProvisionableResource
type StaticSite = class
    inherit ProvisionableResource
Public Class StaticSite
Inherits ProvisionableResource
Inheritance

Constructors

Name Description
StaticSite(String, String)

Creates a new StaticSite.

Properties

Name Description
AllowConfigFileUpdates

<code>false</code> if config file is locked for this static web app; otherwise, <code>true</code>.

BicepIdentifier

Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores.

(Inherited from NamedProvisionableConstruct)
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.

DatabaseConnections

Database connections for the static site.

DefaultHostname

The default autogenerated hostname for the static site.

DependsOn

Declares explicit dependencies on other resources.

(Inherited from ProvisionableResource)
EnterpriseGradeCdnStatus

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

Id

Gets the Id.

Identity

Managed service identity.

IsExistingResource

Gets whether this is referencing an existing resource or we're defining a new resource.

(Inherited from ProvisionableResource)
KeyVaultReferenceIdentity

Identity to use for Key Vault Reference authentication.

Kind

Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.

LinkedBackends

Backends linked to the static side.

Location

Gets or sets the Location.

Name

Name of the static site to create or update.

PrivateEndpointConnections

Private endpoint connections.

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.

RepositoryUri

URL for the repository of the static site.

ResourceType

Gets the type of the resource.

(Inherited from ProvisionableResource)
ResourceVersion

Gets or sets the version of the resource.

(Inherited from ProvisionableResource)
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.

SystemData

Gets the SystemData.

Tags

Gets or sets the Tags.

TemplateProperties

Template options for generating a new repository.

UserFunctionApps

User provided function apps registered with the static site.

Methods

Name Description
AssignOrReplace<T>(T, T) (Inherited from ProvisionableConstruct)
Build(ProvisioningBuildOptions)

Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly.

(Inherited from ProvisionableResource)
Compile()

Compile the resource into a set of Bicep statements.

(Inherited from ProvisionableResource)
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], T, Boolean, Boolean, Boolean, String) (Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) (Inherited from ProvisionableConstruct)
DefineProvisionableProperties()

Define all the provisionable properties of StaticSite.

DefineResource<T>(String, String[], Boolean, Boolean, T) (Inherited from ProvisionableResource)
FromExisting(String, String)

Creates a reference to an existing StaticSite.

GetProvisionableResources()

Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure.

(Inherited from Provisionable)
Initialize()

Initialize this construct.

(Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression) (Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)

Resolve any resources or properties that were not explicitly specified.

(Inherited from ProvisionableConstruct)
Validate(ProvisioningBuildOptions)

Validate the presence of any required members.

(Inherited from ProvisionableResource)

Explicit Interface Implementations

Name Description
IBicepValue.Assign(IBicepValue)

Assign a value to this property.

(Inherited from ProvisionableConstruct)
IBicepValue.Compile()

Compile this value to a Bicep expression.

(Inherited from ProvisionableConstruct)
IBicepValue.Expression

Gets the expression for this value if it's not a literal.

(Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty

Gets whether this value is unset or empty.

(Inherited from ProvisionableConstruct)
IBicepValue.IsOutput

Tracks whether this is an output only property.

(Inherited from ProvisionableConstruct)
IBicepValue.IsRequired

Tracks whether this property is required.

(Inherited from ProvisionableConstruct)
IBicepValue.IsSecure

Tracks whether this contains a secure value.

(Inherited from ProvisionableConstruct)
IBicepValue.Kind

Gets the kind of this value (a literal value, an expression, or it's unset).

(Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue

Get the value of this expression, if it's literal.

(Inherited from ProvisionableConstruct)
IBicepValue.Self

Gets information about where this value was defined.

(Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()

Make this value readonly.

(Inherited from ProvisionableConstruct)
IBicepValue.Source

Gets information about where this value was assigned from.

(Inherited from ProvisionableConstruct)

Extension Methods

Name Description
ToBicepExpression(IBicepValue)

Convert a IBicepValue into a BicepExpression by its reference to represent its hierarchy.

Applies to