Share via


StaticSite Class

Definition

A static site.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.StaticSiteTypeConverter))]
public class StaticSite : Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IStaticSite
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.StaticSiteTypeConverter))>]
type StaticSite = class
    interface IStaticSite
    interface IJsonSerializable
Public Class StaticSite
Implements IStaticSite
Inheritance
StaticSite
Attributes
Implements

Constructors

StaticSite()

Creates an new StaticSite instance.

Properties

AllowConfigFileUpdate

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

Branch

The target branch in the repository.

BuildPropertyApiBuildCommand

A custom command to run during deployment of the Azure Functions API application.

BuildPropertyApiLocation

The path to the api code within the repository.

BuildPropertyAppArtifactLocation

Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)

BuildPropertyAppBuildCommand

A custom command to run during deployment of the static content application.

BuildPropertyAppLocation

The path to the app code within the repository.

BuildPropertyGithubActionSecretNameOverride

Github Action secret name override.

BuildPropertyOutputLocation

The output path of the app after building.

BuildPropertySkipGithubActionWorkflowGeneration

Skip Github Action workflow generation.

ContentDistributionEndpoint

The content distribution endpoint for the static site.

CustomDomain

The custom domains associated with this static site.

DatabaseConnection

Database connections for the 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.

LinkedBackend

Backends linked to the static side

PrivateEndpointConnection

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.

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.

TemplatePropertyDescription

Description of the newly generated repository.

TemplatePropertyIsPrivate

Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public).

TemplatePropertyOwner

Owner of the newly generated repository.

TemplatePropertyRepositoryName

Name of the newly generated repository.

TemplatePropertyTemplateRepositoryUrl

URL of the template repository. The newly generated repository will be based on this one.

UserProvidedFunctionApp

User provided function apps registered with the static site

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of StaticSite.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of StaticSite.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IStaticSite.

FromJsonString(String)

Creates a new instance of StaticSite, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of StaticSite into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Applies to