Feedback Edit

StaticSiteARMResource Class

  • Reference

Static Site ARM resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.mgmt.web.v2021_01_01.models._models_py3.Resource
StaticSiteARMResource

Constructor

StaticSiteARMResource(*, location: str, kind: Optional[str] = None, tags: Optional[Dict[str, str]] = None, sku: Optional[azure.mgmt.web.v2021_01_01.models._models_py3.SkuDescription] = None, identity: Optional[azure.mgmt.web.v2021_01_01.models._models_py3.ManagedServiceIdentity] = None, repository_url: Optional[str] = None, branch: Optional[str] = None, repository_token: Optional[str] = None, build_properties: Optional[azure.mgmt.web.v2021_01_01.models._models_py3.StaticSiteBuildProperties] = None, staging_environment_policy: Optional[Union[str, azure.mgmt.web.v2021_01_01.models._web_site_management_client_enums.StagingEnvironmentPolicy]] = None, allow_config_file_updates: Optional[bool] = None, template_properties: Optional[azure.mgmt.web.v2021_01_01.models._models_py3.StaticSiteTemplateOptions] = None, **kwargs)

Parameters

kind
str
Required

Kind of resource.

location
str
Required

Required. Resource Location.

tags
dict[str, str]
Required

A set of tags. Resource tags.

sku
SkuDescription
Required

Description of a SKU for a scalable resource.

identity
ManagedServiceIdentity
Required

Managed service identity.

repository_url
str
Required

URL for the repository of the static site.

branch
str
Required

The target branch in the repository.

repository_token
str
Required

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

build_properties
StaticSiteBuildProperties
Required

Build properties to configure on the repository.

staging_environment_policy
str or StagingEnvironmentPolicy
Required

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

allow_config_file_updates
bool
Required

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

template_properties
StaticSiteTemplateOptions
Required

Template options for generating a new repository.

Variables

id
str

Resource Id.

name
str

Resource Name.

type
str

Resource type.

default_hostname
str

The default autogenerated hostname for the static site.

custom_domains
list[str]

The custom domains associated with this static site.

private_endpoint_connections
list[ResponseMessageEnvelopeRemotePrivateEndpointConnection]

Private endpoint connections.

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.

provider
str

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