StaticSite Class

Package:

com.azure.resourcemanager.appservice.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-appservice:2.55.0

• java.lang.Object
• • com.azure.resourcemanager.appservice.fluent.models.StaticSite

Implements

JsonSerializable<StaticSite>

public final class StaticSite
implements JsonSerializable<StaticSite>

A static site.

Constructor Summary

Constructor	Description
StaticSite()	Creates an instance of StaticSite class.

Method Summary

Modifier and Type	Method and Description
Boolean	allowConfigFileUpdates() Get the allowConfigFileUpdates property: false if config file is locked for this static web app; otherwise, true.
String	branch() Get the branch property: The target branch in the repository.
StaticSiteBuildProperties	buildProperties() Get the buildProperties property: Build properties to configure on the repository.
String	contentDistributionEndpoint() Get the contentDistributionEndpoint property: The content distribution endpoint for the static site.
List<String>	customDomains() Get the customDomains property: The custom domains associated with this static site.
List<DatabaseConnectionOverview>	databaseConnections() Get the databaseConnections property: Database connections for the static site.
String	defaultHostname() Get the defaultHostname property: The default autogenerated hostname for the static site.
EnterpriseGradeCdnStatus	enterpriseGradeCdnStatus() Get the enterpriseGradeCdnStatus property: State indicating the status of the enterprise grade CDN serving traffic to the static web app.
static StaticSite	fromJson(JsonReader jsonReader) Reads an instance of StaticSite from the JsonReader.
String	keyVaultReferenceIdentity() Get the keyVaultReferenceIdentity property: Identity to use for Key Vault Reference authentication.
List<StaticSiteLinkedBackend>	linkedBackends() Get the linkedBackends property: Backends linked to the static side.
List<ResponseMessageEnvelopeRemotePrivateEndpointConnection>	privateEndpointConnections() Get the privateEndpointConnections property: Private endpoint connections.
String	provider() Get the provider property: The provider that submitted the last deployment to the primary environment of the static site.
String	publicNetworkAccess() Get the publicNetworkAccess property: State indicating whether public traffic are allowed or not for a static web app.
String	repositoryToken() Get the repositoryToken property: A user's github repository token.
String	repositoryUrl() Get the repositoryUrl property: URL for the repository of the static site.
StagingEnvironmentPolicy	stagingEnvironmentPolicy() Get the stagingEnvironmentPolicy property: State indicating whether staging environments are allowed or not allowed for a static web app.
StaticSiteTemplateOptions	templateProperties() Get the templateProperties property: Template options for generating a new repository.
JsonWriter	toJson(JsonWriter jsonWriter)
List<StaticSiteUserProvidedFunctionApp>	userProvidedFunctionApps() Get the userProvidedFunctionApps property: User provided function apps registered with the static site.
void	validate() Validates the instance.
StaticSite	withAllowConfigFileUpdates(Boolean allowConfigFileUpdates) Set the allowConfigFileUpdates property: false if config file is locked for this static web app; otherwise, true.
StaticSite	withBranch(String branch) Set the branch property: The target branch in the repository.
StaticSite	withBuildProperties(StaticSiteBuildProperties buildProperties) Set the buildProperties property: Build properties to configure on the repository.
StaticSite	withEnterpriseGradeCdnStatus(EnterpriseGradeCdnStatus enterpriseGradeCdnStatus) Set the enterpriseGradeCdnStatus property: State indicating the status of the enterprise grade CDN serving traffic to the static web app.
StaticSite	withProvider(String provider) Set the provider property: The provider that submitted the last deployment to the primary environment of the static site.
StaticSite	withPublicNetworkAccess(String publicNetworkAccess) Set the publicNetworkAccess property: State indicating whether public traffic are allowed or not for a static web app.
StaticSite	withRepositoryToken(String repositoryToken) Set the repositoryToken property: A user's github repository token.
StaticSite	withRepositoryUrl(String repositoryUrl) Set the repositoryUrl property: URL for the repository of the static site.
StaticSite	withStagingEnvironmentPolicy(StagingEnvironmentPolicy stagingEnvironmentPolicy) Set the stagingEnvironmentPolicy property: State indicating whether staging environments are allowed or not allowed for a static web app.
StaticSite	withTemplateProperties(StaticSiteTemplateOptions templateProperties) Set the templateProperties property: Template options for generating a new repository.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

StaticSite

public StaticSite()

Creates an instance of StaticSite class.

Method Details

allowConfigFileUpdates

public Boolean allowConfigFileUpdates()

Get the allowConfigFileUpdates property: false if config file is locked for this static web app; otherwise, true.

Returns:

the allowConfigFileUpdates value.

branch

public String branch()

Get the branch property: The target branch in the repository.

Returns:

the branch value.

buildProperties

public StaticSiteBuildProperties buildProperties()

Get the buildProperties property: Build properties to configure on the repository.

Returns:

the buildProperties value.

contentDistributionEndpoint

public String contentDistributionEndpoint()

Get the contentDistributionEndpoint property: The content distribution endpoint for the static site.

Returns:

the contentDistributionEndpoint value.

customDomains

public List<String> customDomains()

Get the customDomains property: The custom domains associated with this static site.

Returns:

the customDomains value.

databaseConnections

public List<DatabaseConnectionOverview> databaseConnections()

Get the databaseConnections property: Database connections for the static site.

Returns:

the databaseConnections value.

defaultHostname

public String defaultHostname()

Get the defaultHostname property: The default autogenerated hostname for the static site.

Returns:

the defaultHostname value.

enterpriseGradeCdnStatus

public EnterpriseGradeCdnStatus enterpriseGradeCdnStatus()

Get the enterpriseGradeCdnStatus property: State indicating the status of the enterprise grade CDN serving traffic to the static web app.

Returns:

the enterpriseGradeCdnStatus value.

fromJson

public static StaticSite fromJson(JsonReader jsonReader)

Reads an instance of StaticSite from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of StaticSite if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the StaticSite.

keyVaultReferenceIdentity

public String keyVaultReferenceIdentity()

Get the keyVaultReferenceIdentity property: Identity to use for Key Vault Reference authentication.

Returns:

the keyVaultReferenceIdentity value.

linkedBackends

public List<StaticSiteLinkedBackend> linkedBackends()

Get the linkedBackends property: Backends linked to the static side.

Returns:

the linkedBackends value.

privateEndpointConnections

public List<ResponseMessageEnvelopeRemotePrivateEndpointConnection> privateEndpointConnections()

Get the privateEndpointConnections property: Private endpoint connections.

Returns:

the privateEndpointConnections value.

provider

public String provider()

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

Returns:

the provider value.

publicNetworkAccess

public String publicNetworkAccess()

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

Returns:

the publicNetworkAccess value.

repositoryToken

public String repositoryToken()

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

Returns:

the repositoryToken value.

repositoryUrl

public String repositoryUrl()

Get the repositoryUrl property: URL for the repository of the static site.

Returns:

the repositoryUrl value.

stagingEnvironmentPolicy

public StagingEnvironmentPolicy stagingEnvironmentPolicy()

Get the stagingEnvironmentPolicy property: State indicating whether staging environments are allowed or not allowed for a static web app.

Returns:

the stagingEnvironmentPolicy value.

templateProperties

public StaticSiteTemplateOptions templateProperties()

Get the templateProperties property: Template options for generating a new repository.

Returns:

the templateProperties value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

userProvidedFunctionApps

public List<StaticSiteUserProvidedFunctionApp> userProvidedFunctionApps()

Get the userProvidedFunctionApps property: User provided function apps registered with the static site.

Returns:

the userProvidedFunctionApps value.

validate

public void validate()

Validates the instance.

withAllowConfigFileUpdates

public StaticSite withAllowConfigFileUpdates(Boolean allowConfigFileUpdates)

Set the allowConfigFileUpdates property: false if config file is locked for this static web app; otherwise, true.

Parameters:

allowConfigFileUpdates - the allowConfigFileUpdates value to set.

Returns:

the StaticSite object itself.

withBranch

public StaticSite withBranch(String branch)

Set the branch property: The target branch in the repository.

Parameters:

branch - the branch value to set.

Returns:

the StaticSite object itself.

withBuildProperties

public StaticSite withBuildProperties(StaticSiteBuildProperties buildProperties)

Set the buildProperties property: Build properties to configure on the repository.

Parameters:

buildProperties - the buildProperties value to set.

Returns:

the StaticSite object itself.

withEnterpriseGradeCdnStatus

public StaticSite withEnterpriseGradeCdnStatus(EnterpriseGradeCdnStatus enterpriseGradeCdnStatus)

Set the enterpriseGradeCdnStatus property: State indicating the status of the enterprise grade CDN serving traffic to the static web app.

Parameters:

enterpriseGradeCdnStatus - the enterpriseGradeCdnStatus value to set.

Returns:

the StaticSite object itself.

withProvider

public StaticSite withProvider(String provider)

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

Parameters:

provider - the provider value to set.

Returns:

the StaticSite object itself.

withPublicNetworkAccess

public StaticSite withPublicNetworkAccess(String publicNetworkAccess)

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

Parameters:

publicNetworkAccess - the publicNetworkAccess value to set.

Returns:

the StaticSite object itself.

withRepositoryToken

public StaticSite withRepositoryToken(String repositoryToken)

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

Parameters:

repositoryToken - the repositoryToken value to set.

Returns:

the StaticSite object itself.

withRepositoryUrl

public StaticSite withRepositoryUrl(String repositoryUrl)

Set the repositoryUrl property: URL for the repository of the static site.

Parameters:

repositoryUrl - the repositoryUrl value to set.

Returns:

the StaticSite object itself.

withStagingEnvironmentPolicy

public StaticSite withStagingEnvironmentPolicy(StagingEnvironmentPolicy stagingEnvironmentPolicy)

Set the stagingEnvironmentPolicy property: State indicating whether staging environments are allowed or not allowed for a static web app.

Parameters:

stagingEnvironmentPolicy - the stagingEnvironmentPolicy value to set.

Returns:

the StaticSite object itself.

withTemplateProperties

public StaticSite withTemplateProperties(StaticSiteTemplateOptions templateProperties)

Set the templateProperties property: Template options for generating a new repository.

Parameters:

templateProperties - the templateProperties value to set.

Returns:

the StaticSite object itself.