StaticSite Class

A static site.

Constructor

StaticSite(*args: Any, **kwargs: Any)

Variables

Name	Description
default_hostname	str The default autogenerated hostname for the static site.
repository_url	str URL for the repository of the static site.
branch	str The target branch in the repository.
custom_domains	list[str] The custom domains associated with this static site.
repository_token	str A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
build_properties	StaticSiteBuildProperties Build properties to configure on the repository.
private_endpoint_connections	list[ResponseMessageEnvelopeRemotePrivateEndpointConnection] Private endpoint connections.
staging_environment_policy	str or StagingEnvironmentPolicy State indicating whether staging environments are allowed or not allowed for a static web app. Known values are: "Enabled" and "Disabled".
allow_config_file_updates	bool false if config file is locked for this static web app; otherwise, true.
template_properties	StaticSiteTemplateOptions Template options for generating a new repository.
content_distribution_endpoint	str The content distribution endpoint for the static site.
key_vault_reference_identity	str Identity to use for Key Vault Reference authentication.
user_provided_function_apps	list[StaticSiteUserProvidedFunctionApp] User provided function apps registered with the static site.
linked_backends	list[StaticSiteLinkedBackend] Backends linked to the static side.
provider	str The provider that submitted the last deployment to the primary environment of the static site.
enterprise_grade_cdn_status	str or EnterpriseGradeCdnStatus State indicating the status of the enterprise grade CDN serving traffic to the static web app. Known values are: "Enabled", "Enabling", "Disabled", and "Disabling".
public_network_access	str State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string.
database_connections	list[DatabaseConnectionOverview] Database connections for the static site.

Attributes

allow_config_file_updates

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

allow_config_file_updates: bool | None

branch

The target branch in the repository.

branch: str | None

build_properties

Build properties to configure on the repository.

build_properties: _models.StaticSiteBuildProperties | None

content_distribution_endpoint

The content distribution endpoint for the static site.

content_distribution_endpoint: str | None

custom_domains

The custom domains associated with this static site.

custom_domains: list[str] | None

database_connections

Database connections for the static site.

database_connections: list['_models.DatabaseConnectionOverview'] | None

default_hostname

The default autogenerated hostname for the static site.

default_hostname: str | None

enterprise_grade_cdn_status

State indicating the status of the enterprise grade CDN serving traffic to the static web app. Known values are: "Enabled", "Enabling", "Disabled", and "Disabling".

enterprise_grade_cdn_status: str | _models.EnterpriseGradeCdnStatus | None

key_vault_reference_identity

Identity to use for Key Vault Reference authentication.

key_vault_reference_identity: str | None

linked_backends

Backends linked to the static side.

linked_backends: list['_models.StaticSiteLinkedBackend'] | None

private_endpoint_connections

Private endpoint connections.

private_endpoint_connections: list['_models.ResponseMessageEnvelopeRemotePrivateEndpointConnection'] | None

provider

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

provider: str | None

public_network_access

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

public_network_access: str | None

repository_token

A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.

repository_token: str | None

repository_url

URL for the repository of the static site.

repository_url: str | None

staging_environment_policy

State indicating whether staging environments are allowed or not allowed for a static web app. Known values are: "Enabled" and "Disabled".

staging_environment_policy: str | _models.StagingEnvironmentPolicy | None

template_properties

Template options for generating a new repository.

template_properties: _models.StaticSiteTemplateOptions | None

user_provided_function_apps

User provided function apps registered with the static site.

user_provided_function_apps: list['_models.StaticSiteUserProvidedFunctionApp'] | None