Static Sites - Create Or Update Static Site

Service:

App Service

API Version:

2024-11-01

Description for Creates a new static site in an existing resource group, or updates an existing static site.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}?api-version=2024-11-01

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of the static site to create or update.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Name of the resource group to which the resource belongs.
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version

Request Body

Name	Required	Type	Description
location	True	string	Resource Location.
identity		ManagedServiceIdentity	Managed service identity.
kind		string	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.
properties.allowConfigFileUpdates		boolean	false if config file is locked for this static web app; otherwise, true.
properties.branch		string	The target branch in the repository.
properties.buildProperties		StaticSiteBuildProperties	Build properties to configure on the repository.
properties.enterpriseGradeCdnStatus		EnterpriseGradeCdnStatus	State indicating the status of the enterprise grade CDN serving traffic to the static web app.
properties.provider		string	The provider that submitted the last deployment to the primary environment of the static site.
properties.publicNetworkAccess		string	State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string.
properties.repositoryToken		string	A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
properties.repositoryUrl		string	URL for the repository of the static site.
properties.stagingEnvironmentPolicy		StagingEnvironmentPolicy	State indicating whether staging environments are allowed or not allowed for a static web app.
properties.templateProperties		StaticSiteTemplateOptions	Template options for generating a new repository.
sku		SkuDescription	Description of a SKU for a scalable resource.
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	StaticSiteARMResource	OK.
202 Accepted	StaticSiteARMResource	Asynchronous operation in progress.
Other Status Codes	DefaultErrorResponse	App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create or update a static site

Sample request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0?api-version=2024-11-01

{
  "location": "West US 2",
  "properties": {
    "repositoryUrl": "https://github.com/username/RepoName",
    "branch": "master",
    "repositoryToken": "repoToken123",
    "buildProperties": {
      "appLocation": "app",
      "apiLocation": "api",
      "appArtifactLocation": "build"
    }
  },
  "sku": {
    "name": "Basic",
    "tier": "Basic"
  }
}

Java

import com.azure.resourcemanager.appservice.fluent.models.StaticSiteArmResourceInner;
import com.azure.resourcemanager.appservice.models.SkuDescription;
import com.azure.resourcemanager.appservice.models.StaticSiteBuildProperties;

/**
 * Samples for StaticSites CreateOrUpdateStaticSite.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/CreateOrUpdateStaticSite.json
     */
    /**
     * Sample code: Create or update a static site.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createOrUpdateAStaticSite(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getStaticSites().createOrUpdateStaticSite("rg", "testStaticSite0",
            new StaticSiteArmResourceInner().withLocation("West US 2")
                .withSku(new SkuDescription().withName("Basic").withTier("Basic"))
                .withRepositoryUrl("https://github.com/username/RepoName").withBranch("master")
                .withRepositoryToken("fakeTokenPlaceholder").withBuildProperties(new StaticSiteBuildProperties()
                    .withAppLocation("app").withApiLocation("api").withAppArtifactLocation("build")),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python create_or_update_static_site.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.static_sites.begin_create_or_update_static_site(
        resource_group_name="rg",
        name="testStaticSite0",
        static_site_envelope={
            "location": "West US 2",
            "properties": {
                "branch": "master",
                "buildProperties": {"apiLocation": "api", "appArtifactLocation": "build", "appLocation": "app"},
                "repositoryToken": "repoToken123",
                "repositoryUrl": "https://github.com/username/RepoName",
            },
            "sku": {"name": "Basic", "tier": "Basic"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/CreateOrUpdateStaticSite.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/CreateOrUpdateStaticSite.json
func ExampleStaticSitesClient_BeginCreateOrUpdateStaticSite() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewStaticSitesClient().BeginCreateOrUpdateStaticSite(ctx, "rg", "testStaticSite0", armappservice.StaticSiteARMResource{
		Location: to.Ptr("West US 2"),
		Properties: &armappservice.StaticSite{
			Branch: to.Ptr("master"),
			BuildProperties: &armappservice.StaticSiteBuildProperties{
				APILocation:         to.Ptr("api"),
				AppArtifactLocation: to.Ptr("build"),
				AppLocation:         to.Ptr("app"),
			},
			RepositoryToken: to.Ptr("repoToken123"),
			RepositoryURL:   to.Ptr("https://github.com/username/RepoName"),
		},
		SKU: &armappservice.SKUDescription{
			Name: to.Ptr("Basic"),
			Tier: to.Ptr("Basic"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.StaticSiteARMResource = armappservice.StaticSiteARMResource{
	// 	Name: to.Ptr("testStaticSite0"),
	// 	Type: to.Ptr("Microsoft.Web/staticSites"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0"),
	// 	Location: to.Ptr("West US 2"),
	// 	Properties: &armappservice.StaticSite{
	// 		AllowConfigFileUpdates: to.Ptr(true),
	// 		Branch: to.Ptr("demo"),
	// 		ContentDistributionEndpoint: to.Ptr(""),
	// 		CustomDomains: []*string{
	// 		},
	// 		DefaultHostname: to.Ptr("happy-sea-15afae3e.azurestaticwebsites.net"),
	// 		KeyVaultReferenceIdentity: to.Ptr("SystemAssigned"),
	// 		LinkedBackends: []*armappservice.StaticSiteLinkedBackend{
	// 		},
	// 		PrivateEndpointConnections: []*armappservice.ResponseMessageEnvelopeRemotePrivateEndpointConnection{
	// 		},
	// 		RepositoryURL: to.Ptr("https://github.com/username/RepoName"),
	// 		StagingEnvironmentPolicy: to.Ptr(armappservice.StagingEnvironmentPolicyEnabled),
	// 	},
	// 	SKU: &armappservice.SKUDescription{
	// 		Name: to.Ptr("Basic"),
	// 		Tier: to.Ptr("Basic"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Creates a new static site in an existing resource group, or updates an existing static site.
 *
 * @summary Description for Creates a new static site in an existing resource group, or updates an existing static site.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/CreateOrUpdateStaticSite.json
 */
async function createOrUpdateAStaticSite() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "rg";
  const name = "testStaticSite0";
  const staticSiteEnvelope = {
    branch: "master",
    buildProperties: {
      apiLocation: "api",
      appArtifactLocation: "build",
      appLocation: "app",
    },
    location: "West US 2",
    repositoryToken: "repoToken123",
    repositoryUrl: "https://github.com/username/RepoName",
    sku: { name: "Basic", tier: "Basic" },
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.staticSites.beginCreateOrUpdateStaticSiteAndWait(
    resourceGroupName,
    name,
    staticSiteEnvelope,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-11-01/examples/CreateOrUpdateStaticSite.json
// this example is just showing the usage of "StaticSites_CreateOrUpdateStaticSite" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "rg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this StaticSiteResource
StaticSiteCollection collection = resourceGroupResource.GetStaticSites();

// invoke the operation
string name = "testStaticSite0";
StaticSiteData data = new StaticSiteData(new AzureLocation("West US 2"))
{
    Sku = new AppServiceSkuDescription
    {
        Name = "Basic",
        Tier = "Basic",
    },
    RepositoryUri = new Uri("https://github.com/username/RepoName"),
    Branch = "master",
    RepositoryToken = "repoToken123",
    BuildProperties = new StaticSiteBuildProperties
    {
        AppLocation = "app",
        ApiLocation = "api",
        AppArtifactLocation = "build",
    },
};
ArmOperation<StaticSiteResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, name, data);
StaticSiteResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
StaticSiteData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0",
  "name": "testStaticSite0",
  "type": "Microsoft.Web/staticSites",
  "location": "West US 2",
  "properties": {
    "defaultHostname": "happy-sea-15afae3e.azurestaticwebsites.net",
    "repositoryUrl": "https://github.com/username/RepoName",
    "branch": "demo",
    "customDomains": [],
    "privateEndpointConnections": [],
    "contentDistributionEndpoint": "",
    "keyVaultReferenceIdentity": "SystemAssigned",
    "userProvidedFunctionApps": null,
    "linkedBackends": [],
    "stagingEnvironmentPolicy": "Enabled",
    "allowConfigFileUpdates": true
  },
  "sku": {
    "name": "Basic",
    "tier": "Basic"
  }
}

Status code:

202

azure-asyncoperation: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0",
  "name": "testStaticSite0",
  "type": "Microsoft.Web/staticSites",
  "location": "West US 2",
  "properties": {
    "defaultHostname": "happy-sea-15afae3e.azurestaticwebsites.net",
    "repositoryUrl": "https://github.com/username/RepoName",
    "branch": "demo",
    "customDomains": [],
    "privateEndpointConnections": [],
    "contentDistributionEndpoint": "",
    "keyVaultReferenceIdentity": "SystemAssigned",
    "userProvidedFunctionApps": null,
    "linkedBackends": [],
    "stagingEnvironmentPolicy": "Enabled",
    "allowConfigFileUpdates": true
  },
  "sku": {
    "name": "Basic",
    "tier": "Basic"
  }
}

Definitions

Name	Description
ArmIdWrapper	A wrapper for an ARM resource id
ArmPlan	The plan object in Azure Resource Manager, represents a marketplace plan.
Capability	Describes the capabilities/features allowed for a specific SKU.
DatabaseConnectionOverview	Static Site Database Connection overview.
DefaultErrorResponse	App Service error response.
Details
EnterpriseGradeCdnStatus	State indicating the status of the enterprise grade CDN serving traffic to the static web app.
Error	Error model.
ErrorEntity	Body of the error response returned from the API.
ManagedServiceIdentity	Managed service identity.
ManagedServiceIdentityType	Type of managed service identity.
PrivateLinkConnectionState	The state of a private link connection
RemotePrivateEndpointConnection	A remote private endpoint connection
ResponseMessageEnvelope[RemotePrivateEndpointConnection]	Message envelope that contains the common Azure resource manager properties and the resource provider specific content.
SkuCapacity	Description of the App Service plan scale options.
SkuDescription	Description of a SKU for a scalable resource.
StagingEnvironmentPolicy	State indicating whether staging environments are allowed or not allowed for a static web app.
StaticSiteARMResource	Static Site ARM resource.
StaticSiteBuildProperties	Build properties for the static site.
StaticSiteDatabaseConnectionConfigurationFileOverview	A database connection configuration file
StaticSiteLinkedBackend	Static Site Linked Backend ARM resource.
StaticSiteTemplateOptions	Template Options for the static site.
StaticSiteUserProvidedFunctionApp	A static site user provided function.
userAssignedIdentity	User Assigned identity.

ArmIdWrapper

Object

A wrapper for an ARM resource id

Name	Type	Description
id	string

ArmPlan

Object

The plan object in Azure Resource Manager, represents a marketplace plan.

Name	Type	Description
name	string	The name.
product	string	The product.
promotionCode	string	The promotion code.
publisher	string	The publisher.
version	string	Version of product.

Capability

Object

Describes the capabilities/features allowed for a specific SKU.

Name	Type	Description
name	string	Name of the SKU capability.
reason	string	Reason of the SKU capability.
value	string	Value of the SKU capability.

DatabaseConnectionOverview

Object

Static Site Database Connection overview.

Name	Type	Description
configurationFiles	StaticSiteDatabaseConnectionConfigurationFileOverview[]	A list of configuration files associated with this database connection.
connectionIdentity	string	If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.
name	string	If present, the name of this database connection resource.
region	string	The region of the database resource.
resourceId	string	The resource id of the database.

DefaultErrorResponse

Object

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Object

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

EnterpriseGradeCdnStatus

Enumeration

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

Value	Description
Enabled
Enabling
Disabled
Disabling

Error

Object

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

ErrorEntity

Object

Body of the error response returned from the API.

Name	Type	Description
code	string	Basic error code.
details	ErrorEntity[]	Error Details.
extendedCode	string	Type of error.
innerErrors	ErrorEntity[]	Inner errors.
message	string	Any details of the error.
messageTemplate	string	Message template.
parameters	string[]	Parameters for the template.
target	string	The error target.

ManagedServiceIdentity

Object

Managed service identity.

Name	Type	Description
principalId	string	Principal Id of managed service identity.
tenantId	string	Tenant of managed service identity.
type	ManagedServiceIdentityType	Type of managed service identity.
userAssignedIdentities	<string,  userAssignedIdentity>	The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Enumeration

Type of managed service identity.

Value	Description
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

PrivateLinkConnectionState

Object

The state of a private link connection

Name	Type	Description
actionsRequired	string	ActionsRequired for a private link connection
description	string	Description of a private link connection
status	string	Status of a private link connection

RemotePrivateEndpointConnection

Object

A remote private endpoint connection

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.ipAddresses	string[]	Private IPAddresses mapped to the remote private endpoint
properties.privateEndpoint	ArmIdWrapper	PrivateEndpoint of a remote private endpoint connection
properties.privateLinkServiceConnectionState	PrivateLinkConnectionState	The state of a private link connection
properties.provisioningState	string
type	string	Resource type.

ResponseMessageEnvelope[RemotePrivateEndpointConnection]

Object

Message envelope that contains the common Azure resource manager properties and the resource provider specific content.

Name	Type	Description
error	ErrorEntity	Azure-AsyncOperation Error info.
id	string	Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this value for GET requests only. For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}
identity	ManagedServiceIdentity	MSI resource
location	string	Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia.
name	string	Name of resource.
plan	ArmPlan	Azure resource manager plan.
properties	RemotePrivateEndpointConnection	Resource specific properties.
sku	SkuDescription	SKU description of the resource.
status	string	Azure-AsyncOperation Status info.
tags	object	Tags associated with resource.
type	string	Type of resource e.g "Microsoft.Web/sites".
zones	string[]	Logical Availability Zones the service is hosted in

SkuCapacity

Object

Description of the App Service plan scale options.

Name	Type	Description
default	integer (int32)	Default number of workers for this App Service plan SKU.
elasticMaximum	integer (int32)	Maximum number of Elastic workers for this App Service plan SKU.
maximum	integer (int32)	Maximum number of workers for this App Service plan SKU.
minimum	integer (int32)	Minimum number of workers for this App Service plan SKU.
scaleType	string	Available scale configurations for an App Service plan.

SkuDescription

Object

Description of a SKU for a scalable resource.

Name	Type	Description
capabilities	Capability[]	Capabilities of the SKU, e.g., is traffic manager enabled?
capacity	integer (int32)	Current number of instances assigned to the resource.
family	string	Family code of the resource SKU.
locations	string[]	Locations of the SKU.
name	string	Name of the resource SKU.
size	string	Size specifier of the resource SKU.
skuCapacity	SkuCapacity	Min, max, and default scale values of the SKU.
tier	string	Service tier of the resource SKU.

StagingEnvironmentPolicy

Enumeration

State indicating whether staging environments are allowed or not allowed for a static web app.

Value	Description
Enabled
Disabled

StaticSiteARMResource

Object

Static Site ARM resource.

Name	Type	Description
id	string	Resource Id.
identity	ManagedServiceIdentity	Managed service identity.
kind	string	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.
location	string	Resource Location.
name	string	Resource Name.
properties.allowConfigFileUpdates	boolean	false if config file is locked for this static web app; otherwise, true.
properties.branch	string	The target branch in the repository.
properties.buildProperties	StaticSiteBuildProperties	Build properties to configure on the repository.
properties.contentDistributionEndpoint	string	The content distribution endpoint for the static site.
properties.customDomains	string[]	The custom domains associated with this static site.
properties.databaseConnections	DatabaseConnectionOverview[]	Database connections for the static site
properties.defaultHostname	string	The default autogenerated hostname for the static site.
properties.enterpriseGradeCdnStatus	EnterpriseGradeCdnStatus	State indicating the status of the enterprise grade CDN serving traffic to the static web app.
properties.keyVaultReferenceIdentity	string	Identity to use for Key Vault Reference authentication.
properties.linkedBackends	StaticSiteLinkedBackend[]	Backends linked to the static side
properties.privateEndpointConnections	ResponseMessageEnvelope[RemotePrivateEndpointConnection][]	Private endpoint connections
properties.provider	string	The provider that submitted the last deployment to the primary environment of the static site.
properties.publicNetworkAccess	string	State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string.
properties.repositoryToken	string	A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
properties.repositoryUrl	string	URL for the repository of the static site.
properties.stagingEnvironmentPolicy	StagingEnvironmentPolicy	State indicating whether staging environments are allowed or not allowed for a static web app.
properties.templateProperties	StaticSiteTemplateOptions	Template options for generating a new repository.
properties.userProvidedFunctionApps	StaticSiteUserProvidedFunctionApp[]	User provided function apps registered with the static site
sku	SkuDescription	Description of a SKU for a scalable resource.
tags	object	Resource tags.
type	string	Resource type.

StaticSiteBuildProperties

Object

Build properties for the static site.

Name	Type	Description
apiBuildCommand	string	A custom command to run during deployment of the Azure Functions API application.
apiLocation	string	The path to the api code within the repository.
appArtifactLocation	string	Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)
appBuildCommand	string	A custom command to run during deployment of the static content application.
appLocation	string	The path to the app code within the repository.
githubActionSecretNameOverride	string	Github Action secret name override.
outputLocation	string	The output path of the app after building.
skipGithubActionWorkflowGeneration	boolean	Skip Github Action workflow generation.

StaticSiteDatabaseConnectionConfigurationFileOverview

Object

A database connection configuration file

Name	Type	Description
contents	string	The Base64 encoding of the file contents.
fileName	string	The name of the configuration file.
type	string	The type of configuration file.

StaticSiteLinkedBackend

Object

Static Site Linked Backend ARM resource.

Name	Type	Description
backendResourceId	string	The resource id of the backend linked to the static site
createdOn	string (date-time)	The date and time on which the backend was linked to the static site.
provisioningState	string	The provisioning state of the linking process.
region	string	The region of the backend linked to the static site

StaticSiteTemplateOptions

Object

Template Options for the static site.

Name	Type	Description
description	string	Description of the newly generated repository.
isPrivate	boolean	Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public).
owner	string	Owner of the newly generated repository.
repositoryName	string	Name of the newly generated repository.
templateRepositoryUrl	string	URL of the template repository. The newly generated repository will be based on this one.

StaticSiteUserProvidedFunctionApp

Object

A static site user provided function.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.createdOn	string (date-time)	The date and time on which the function app was registered with the static site.
properties.functionAppRegion	string	The region of the function app registered with the static site
properties.functionAppResourceId	string	The resource id of the function app registered with the static site
type	string	Resource type.

userAssignedIdentity

Object

User Assigned identity.

Name	Type	Description
clientId	string	Client Id of user assigned identity
principalId	string	Principal Id of user assigned identity