static_sites

Creates, updates, deletes, gets or lists a static_sites resource.

Overview

Name	static_sites
Type	Resource
Id	azure.web.static_sites

Fields

The following fields are returned by SELECT queries:

get_build_database_connection

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
configurationFiles	array	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.
connectionString	string	The connection string to use to connect to the database.
kind	string	Kind of resource.
region	string	The region of the database resource. Required.
resourceId	string	The resource id of the database. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_user_provided_function_app_for_static_site_build

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
createdOn	string (date-time)	The date and time on which the function app was registered with the static site.
functionAppRegion	string	The region of the function app registered with the static site.
functionAppResourceId	string	The resource id of the function app registered with the static site.
kind	string	Kind of resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_linked_backend_for_build

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
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.
kind	string	Kind of resource.
provisioningState	string	The provisioning state of the linking process.
region	string	The region of the backend linked to the static site.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_static_site_users

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource Name.
displayName	string	The display name for the static site user.
kind	string	Kind of resource.
provider	string	The identity provider for the static site user.
roles	string	The roles for the static site user, in free-form string format.
type	string	Resource type.
userId	string	The user id for the static site user.

list_static_site_build_functions

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource Name.
functionName	string	The name for the function.
kind	string	Kind of resource.
triggerType	string	The trigger type of the function. Known values are: "HttpTrigger" and "Unknown". (HttpTrigger, Unknown)
type	string	Resource type.

get_private_endpoint_connection

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
ipAddresses	array	Private IPAddresses mapped to the remote private endpoint.
kind	string	Kind of resource.
privateEndpoint	object	PrivateEndpoint of a remote private endpoint connection.
privateLinkServiceConnectionState	object	The state of a private link connection.
provisioningState	string	:vartype provisioning_state: str
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_database_connection

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
configurationFiles	array	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.
connectionString	string	The connection string to use to connect to the database.
kind	string	Kind of resource.
region	string	The region of the database resource. Required.
resourceId	string	The resource id of the database. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_user_provided_function_app_for_static_site

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
createdOn	string (date-time)	The date and time on which the function app was registered with the static site.
functionAppRegion	string	The region of the function app registered with the static site.
functionAppResourceId	string	The resource id of the function app registered with the static site.
kind	string	Kind of resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_basic_auth

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
applicableEnvironmentsMode	string	State indicating if basic auth is enabled and for what environments it is active. Required.
environments	array	The list of enabled environments for Basic Auth if ApplicableEnvironmentsMode is set to SpecifiedEnvironments.
kind	string	Kind of resource.
password	string	The password for basic auth.
secretState	string	State indicating if basic auth has a secret and what type it is.
secretUrl	string	Url to the secret in Key Vault.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_static_site_custom_domain

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
createdOn	string (date-time)	The date and time on which the custom domain was created for the static site.
domainName	string	The domain name for the static site custom domain.
errorMessage	string	:vartype error_message: str
kind	string	Kind of resource.
status	string	The status of the custom domain. Known values are: "RetrievingValidationToken", "Validating", "Adding", "Ready", "Failed", "Deleting", and "Unhealthy". (RetrievingValidationToken, Validating, Adding, Ready, Failed, Deleting, Unhealthy)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationToken	string	The TXT record validation token.

get_linked_backend

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
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.
kind	string	Kind of resource.
provisioningState	string	The provisioning state of the linking process.
region	string	The region of the backend linked to the static site.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_static_site_functions

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource Name.
functionName	string	The name for the function.
kind	string	Kind of resource.
triggerType	string	The trigger type of the function. Known values are: "HttpTrigger" and "Unknown". (HttpTrigger, Unknown)
type	string	Resource type.

get_static_sites_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowConfigFileUpdates	boolean	false if config file is locked for this static web app; otherwise, true.
branch	string	The target branch in the repository.
buildProperties	object	Build properties to configure on the repository.
contentDistributionEndpoint	string	The content distribution endpoint for the static site.
customDomains	array	The custom domains associated with this static site.
databaseConnections	array	Database connections for the static site.
defaultHostname	string	The default autogenerated hostname for the static site.
enterpriseGradeCdnStatus	string	State indicating the status of the enterprise grade CDN serving traffic to the static web app. Known values are: "Enabled", "Enabling", "Disabled", and "Disabling". (Enabled, Enabling, Disabled, Disabling)
identity	object	Managed service identity.
keyVaultReferenceIdentity	string	Identity to use for Key Vault Reference authentication.
kind	string	Kind of resource.
linkedBackends	array	Backends linked to the static side.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	Private endpoint connections.
provider	string	The provider that submitted the last deployment to the primary environment of the static site.
publicNetworkAccess	string	State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string.
repositoryToken	string	A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
repositoryUrl	string	URL for the repository of the static site.
sku	object	Description of a SKU for a scalable resource.
stagingEnvironmentPolicy	string	State indicating whether staging environments are allowed or not allowed for a static web app. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
templateProperties	object	Template options for generating a new repository.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userProvidedFunctionApps	array	User provided function apps registered with the static site.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowConfigFileUpdates	boolean	false if config file is locked for this static web app; otherwise, true.
branch	string	The target branch in the repository.
buildProperties	object	Build properties to configure on the repository.
contentDistributionEndpoint	string	The content distribution endpoint for the static site.
customDomains	array	The custom domains associated with this static site.
databaseConnections	array	Database connections for the static site.
defaultHostname	string	The default autogenerated hostname for the static site.
enterpriseGradeCdnStatus	string	State indicating the status of the enterprise grade CDN serving traffic to the static web app. Known values are: "Enabled", "Enabling", "Disabled", and "Disabling". (Enabled, Enabling, Disabled, Disabling)
identity	object	Managed service identity.
keyVaultReferenceIdentity	string	Identity to use for Key Vault Reference authentication.
kind	string	Kind of resource.
linkedBackends	array	Backends linked to the static side.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	Private endpoint connections.
provider	string	The provider that submitted the last deployment to the primary environment of the static site.
publicNetworkAccess	string	State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string.
repositoryToken	string	A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
repositoryUrl	string	URL for the repository of the static site.
sku	object	Description of a SKU for a scalable resource.
stagingEnvironmentPolicy	string	State indicating whether staging environments are allowed or not allowed for a static web app. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
templateProperties	object	Template options for generating a new repository.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userProvidedFunctionApps	array	User provided function apps registered with the static site.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_build_database_connection	select	resource_group_name, name, environment_name, database_connection_name, subscription_id		Returns overview of a database connection for a static site build by name. Returns overview of a database connection for a static site build by name.
get_user_provided_function_app_for_static_site_build	select	resource_group_name, name, environment_name, function_app_name, subscription_id		Gets the details of the user provided function app registered with a static site build. Description for Gets the details of the user provided function app registered with a static site build.
get_linked_backend_for_build	select	resource_group_name, name, environment_name, linked_backend_name, subscription_id		Returns the details of a linked backend linked to a static site build by name. Returns the details of a linked backend linked to a static site build by name.
list_static_site_users	select	resource_group_name, name, authprovider, subscription_id		Gets the list of users of a static site. Description for Gets the list of users of a static site.
list_static_site_build_functions	select	resource_group_name, name, environment_name, subscription_id		Gets the functions of a particular static site build. Description for Gets the functions of a particular static site build.
get_private_endpoint_connection	select	resource_group_name, name, private_endpoint_connection_name, subscription_id		Gets a private endpoint connection. Description for Gets a private endpoint connection.
get_database_connection	select	resource_group_name, name, database_connection_name, subscription_id		Returns overview of a database connection for a static site by name. Returns overview of a database connection for a static site by name.
get_user_provided_function_app_for_static_site	select	resource_group_name, name, function_app_name, subscription_id		Gets the details of the user provided function app registered with a static site. Description for Gets the details of the user provided function app registered with a static site.
get_basic_auth	select	resource_group_name, name, basic_auth_name, subscription_id		Gets the basic auth properties for a static site. Description for Gets the basic auth properties for a static site.
get_static_site_custom_domain	select	resource_group_name, name, domain_name, subscription_id		Gets an existing custom domain for a particular static site. Description for Gets an existing custom domain for a particular static site.
get_linked_backend	select	resource_group_name, name, linked_backend_name, subscription_id		Returns the details of a linked backend linked to a static site by name. Returns the details of a linked backend linked to a static site by name.
list_static_site_functions	select	resource_group_name, name, subscription_id		Gets the functions of a static site. Description for Gets the functions of a static site.
get_static_sites_by_resource_group	select	resource_group_name, subscription_id		Gets all static sites in the specified resource group. Description for Gets all static sites in the specified resource group.
list	select	subscription_id		Get all Static Sites for a subscription. Description for Get all Static Sites for a subscription.
create_or_update_static_site	insert	resource_group_name, name, subscription_id, location		Creates a new static site in an existing resource group, or updates an existing static site. Description for Creates a new static site in an existing resource group, or updates an existing static site.
update_static_site	update	resource_group_name, name, subscription_id		Creates a new static site in an existing resource group, or updates an existing static site. Description for Creates a new static site in an existing resource group, or updates an existing static site.
create_or_update_static_site	replace	resource_group_name, name, subscription_id, location		Creates a new static site in an existing resource group, or updates an existing static site. Description for Creates a new static site in an existing resource group, or updates an existing static site.
detach_user_provided_function_app_from_static_site_build	delete	resource_group_name, name, environment_name, function_app_name, subscription_id		Detach the user provided function app from the static site build. Description for Detach the user provided function app from the static site build.
unlink_backend_from_build	delete	resource_group_name, name, environment_name, linked_backend_name, subscription_id	isCleaningAuthConfig	Unlink a backend from a static site build. Unlink a backend from a static site build.
detach_user_provided_function_app_from_static_site	delete	resource_group_name, name, function_app_name, subscription_id		Detach the user provided function app from the static site. Description for Detach the user provided function app from the static site.
unlink_backend	delete	resource_group_name, name, linked_backend_name, subscription_id	isCleaningAuthConfig	Unlink a backend from a static site. Unlink a backend from a static site.
delete_static_site	delete	resource_group_name, name, subscription_id		Deletes a static site. Description for Deletes a static site.
list_static_site_app_settings	exec	resource_group_name, name, subscription_id		Gets the application settings of a static site. Description for Gets the application settings of a static site.
list_static_site_configured_roles	exec	resource_group_name, name, subscription_id		Lists the roles configured for the static site. Description for Lists the roles configured for the static site.
list_static_site_function_app_settings	exec	resource_group_name, name, subscription_id		Gets the application settings of a static site. Description for Gets the application settings of a static site.
list_static_site_secrets	exec	resource_group_name, name, subscription_id		Lists the secrets for an existing static site. Description for Lists the secrets for an existing static site.
list_static_site_build_app_settings	exec	resource_group_name, name, environment_name, subscription_id		Gets the application settings of a static site build. Description for Gets the application settings of a static site build.
list_static_site_build_function_app_settings	exec	resource_group_name, name, environment_name, subscription_id		Gets the application settings of a static site build. Description for Gets the application settings of a static site build.
list_basic_auth	exec	resource_group_name, name, subscription_id		Gets the basic auth properties for a static site as a collection. Description for Gets the basic auth properties for a static site as a collection.
list_static_site_custom_domains	exec	resource_group_name, name, subscription_id		Gets all static site custom domains for a particular static site. Description for Gets all static site custom domains for a particular static site.
approve_or_reject_private_endpoint_connection	exec	resource_group_name, name, private_endpoint_connection_name, subscription_id		Approves or rejects a private endpoint connection. Description for Approves or rejects a private endpoint connection.
delete_private_endpoint_connection	exec	resource_group_name, name, private_endpoint_connection_name, subscription_id		Deletes a private endpoint connection. Description for Deletes a private endpoint connection.
get_private_endpoint_connection_list	exec	resource_group_name, name, subscription_id		Gets the list of private endpoint connections associated with a static site. Description for Gets the list of private endpoint connections associated with a static site.
get_static_site	exec	resource_group_name, name, subscription_id		Gets the details of a static site. Description for Gets the details of a static site.
get_private_link_resources	exec	resource_group_name, name, subscription_id		Gets the private link resources. Description for Gets the private link resources.
get_database_connections_with_details	exec	resource_group_name, name, subscription_id		Returns details of database connections for a static site. Returns details of database connections for a static site.
get_static_site_build	exec	resource_group_name, name, environment_name, subscription_id		Gets the details of a static site build. Description for Gets the details of a static site build.
delete_static_site_build	exec	resource_group_name, name, environment_name, subscription_id		Deletes a static site build. Description for Deletes a static site build.
get_static_site_builds	exec	resource_group_name, name, subscription_id		Gets all static site builds for a particular static site. Description for Gets all static site builds for a particular static site.
get_build_database_connections_with_details	exec	resource_group_name, name, environment_name, subscription_id		Returns details of database connections for a static site build. Returns details of database connections for a static site build.
create_or_update_build_database_connection	exec	resource_group_name, name, environment_name, database_connection_name, subscription_id		Create or update a database connection for a static site build. Description for Create or update a database connection for a static site build.
update_build_database_connection	exec	resource_group_name, name, environment_name, database_connection_name, subscription_id		Create or update a database connection for a static site build. Description for Create or update a database connection for a static site build.
delete_build_database_connection	exec	resource_group_name, name, environment_name, database_connection_name, subscription_id		Delete a database connection for a static site build. Delete a database connection for a static site build.
get_build_database_connections	exec	resource_group_name, name, environment_name, subscription_id		Returns overviews of database connections for a static site build. Returns overviews of database connections for a static site build.
get_build_database_connection_with_details	exec	resource_group_name, name, environment_name, database_connection_name, subscription_id		Returns details of a database connection for a static site build by name. Returns details of a database connection for a static site build by name.
create_or_update_database_connection	exec	resource_group_name, name, database_connection_name, subscription_id		Create or update a database connection for a static site. Description for Create or update a database connection for a static site.
update_database_connection	exec	resource_group_name, name, database_connection_name, subscription_id		Create or update a database connection for a static site. Description for Create or update a database connection for a static site.
delete_database_connection	exec	resource_group_name, name, database_connection_name, subscription_id		Delete a database connection for a static site. Delete a database connection for a static site.
get_database_connections	exec	resource_group_name, name, subscription_id		Returns overviews of database connections for a static site. Returns overviews of database connections for a static site.
get_database_connection_with_details	exec	resource_group_name, name, database_connection_name, subscription_id		Returns details of a database connection for a static site by name. Returns details of a database connection for a static site by name.
register_user_provided_function_app_with_static_site_build	exec	resource_group_name, name, environment_name, function_app_name, subscription_id	isForced	Register a user provided function app with a static site build. Description for Register a user provided function app with a static site build.
get_user_provided_function_apps_for_static_site_build	exec	resource_group_name, name, environment_name, subscription_id		Gets the details of the user provided function apps registered with a static site build. Description for Gets the details of the user provided function apps registered with a static site build.
register_user_provided_function_app_with_static_site	exec	resource_group_name, name, function_app_name, subscription_id	isForced	Register a user provided function app with a static site. Description for Register a user provided function app with a static site.
get_user_provided_function_apps_for_static_site	exec	resource_group_name, name, subscription_id		Gets the details of the user provided function apps registered with a static site. Description for Gets the details of the user provided function apps registered with a static site.
create_or_update_basic_auth	exec	resource_group_name, name, basic_auth_name, subscription_id		Adds or updates basic auth for a static site. Description for Adds or updates basic auth for a static site.
create_or_update_static_site_custom_domain	exec	resource_group_name, name, domain_name, subscription_id		Creates a new static site custom domain in an existing resource group and static site. Description for Creates a new static site custom domain in an existing resource group and static site.
delete_static_site_custom_domain	exec	resource_group_name, name, domain_name, subscription_id		Deletes a custom domain. Description for Deletes a custom domain.
link_backend	exec	resource_group_name, name, linked_backend_name, subscription_id		Link backend to a static site. Link backend to a static site.
get_linked_backends	exec	resource_group_name, name, subscription_id		Returns details of all backends linked to a static site. Returns details of all backends linked to a static site.
link_backend_to_build	exec	resource_group_name, name, environment_name, linked_backend_name, subscription_id		Link backend to a static site build. Link backend to a static site build.
get_linked_backends_for_build	exec	resource_group_name, name, environment_name, subscription_id		Returns details of all backends linked to a static site build. Returns details of all backends linked to a static site build.
delete_static_site_user	exec	resource_group_name, name, authprovider, userid, subscription_id		Deletes the user entry from the static site. Description for Deletes the user entry from the static site.
update_static_site_user	exec	resource_group_name, name, authprovider, userid, subscription_id		Updates a user entry with the listed roles. Description for Updates a user entry with the listed roles.
create_or_update_static_site_app_settings	exec	resource_group_name, name, subscription_id		Creates or updates the app settings of a static site. Description for Creates or updates the app settings of a static site.
create_or_update_static_site_function_app_settings	exec	resource_group_name, name, subscription_id		Creates or updates the function app settings of a static site. Description for Creates or updates the function app settings of a static site.
create_user_roles_invitation_link	exec	resource_group_name, name, subscription_id		Creates an invitation link for a user with the role. Description for Creates an invitation link for a user with the role.
detach_static_site	exec	resource_group_name, name, subscription_id		Detaches a static site. Description for Detaches a static site.
reset_static_site_api_key	exec	resource_group_name, name, subscription_id		Resets the api key for an existing static site. Description for Resets the api key for an existing static site.
create_zip_deployment_for_static_site	exec	resource_group_name, name, subscription_id		Deploys zipped content to a static site. Description for Deploys zipped content to a static site.
create_or_update_static_site_build_app_settings	exec	resource_group_name, name, environment_name, subscription_id		Creates or updates the app settings of a static site build. Description for Creates or updates the app settings of a static site build.
create_or_update_static_site_build_function_app_settings	exec	resource_group_name, name, environment_name, subscription_id		Creates or updates the function app settings of a static site build. Description for Creates or updates the function app settings of a static site build.
create_zip_deployment_for_static_site_build	exec	resource_group_name, name, environment_name, subscription_id		Deploys zipped content to a specific environment of a static site. Description for Deploys zipped content to a specific environment of a static site.
validate_custom_domain_can_be_added_to_static_site	exec	resource_group_name, name, domain_name, subscription_id		Validates a particular custom domain can be added to a static site. Description for Validates a particular custom domain can be added to a static site.
validate_backend	exec	resource_group_name, name, linked_backend_name, subscription_id		Validates that a backend can be linked to a static site. Validates that a backend can be linked to a static site.
validate_backend_for_build	exec	resource_group_name, name, environment_name, linked_backend_name, subscription_id		Validates that a backend can be linked to a static site build. Validates that a backend can be linked to a static site build.
preview_workflow	exec	location, subscription_id		Generates a preview workflow file for the static site. Description for Generates a preview workflow file for the static site.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
authprovider	string	Required.
basic_auth_name	string	name of the basic auth entry. "default" Required.
database_connection_name	string	Name of the database connection. Required.
domain_name	string	The custom domain name. Required.
environment_name	string	The stage site identifier. Required.
function_app_name	string	Name of the function app registered with the static site. Required.
linked_backend_name	string	Name of the linked backend that should be retrieved. Required.
location	string	The location name. Required.
name	string	Name of the static site. Required.
private_endpoint_connection_name	string	Name of the private endpoint connection. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
userid	string	Required.
isCleaningAuthConfig	boolean	Decides if Easy Auth configuration will be removed from backend configuration. Default value is None.
isForced	boolean	Specify true to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. The default is false. Default value is None.

SELECT examples

get_build_database_connection

Returns overview of a database connection for a static site build by name. Returns overview of a database connection for a static site build by name.

SELECT
id,
name,
configurationFiles,
connectionIdentity,
connectionString,
kind,
region,
resourceId,
systemData,
type
FROM azure.web.static_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND database_connection_name = '{{ database_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_user_provided_function_app_for_static_site_build

Gets the details of the user provided function app registered with a static site build. Description for Gets the details of the user provided function app registered with a static site build.

SELECT
id,
name,
createdOn,
functionAppRegion,
functionAppResourceId,
kind,
systemData,
type
FROM azure.web.static_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND function_app_name = '{{ function_app_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_linked_backend_for_build

Returns the details of a linked backend linked to a static site build by name. Returns the details of a linked backend linked to a static site build by name.

SELECT
id,
name,
backendResourceId,
createdOn,
kind,
provisioningState,
region,
systemData,
type
FROM azure.web.static_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND linked_backend_name = '{{ linked_backend_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_static_site_users

Gets the list of users of a static site. Description for Gets the list of users of a static site.

SELECT
id,
name,
displayName,
kind,
provider,
roles,
type,
userId
FROM azure.web.static_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND authprovider = '{{ authprovider }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_static_site_build_functions

Gets the functions of a particular static site build. Description for Gets the functions of a particular static site build.

SELECT
id,
name,
functionName,
kind,
triggerType,
type
FROM azure.web.static_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_private_endpoint_connection

Gets a private endpoint connection. Description for Gets a private endpoint connection.

SELECT
id,
name,
ipAddresses,
kind,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.web.static_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_database_connection

Returns overview of a database connection for a static site by name. Returns overview of a database connection for a static site by name.

SELECT
id,
name,
configurationFiles,
connectionIdentity,
connectionString,
kind,
region,
resourceId,
systemData,
type
FROM azure.web.static_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND database_connection_name = '{{ database_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_user_provided_function_app_for_static_site

Gets the details of the user provided function app registered with a static site. Description for Gets the details of the user provided function app registered with a static site.

SELECT
id,
name,
createdOn,
functionAppRegion,
functionAppResourceId,
kind,
systemData,
type
FROM azure.web.static_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND function_app_name = '{{ function_app_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_basic_auth

Gets the basic auth properties for a static site. Description for Gets the basic auth properties for a static site.

SELECT
id,
name,
applicableEnvironmentsMode,
environments,
kind,
password,
secretState,
secretUrl,
systemData,
type
FROM azure.web.static_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND basic_auth_name = '{{ basic_auth_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_static_site_custom_domain

Gets an existing custom domain for a particular static site. Description for Gets an existing custom domain for a particular static site.

SELECT
id,
name,
createdOn,
domainName,
errorMessage,
kind,
status,
systemData,
type,
validationToken
FROM azure.web.static_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND domain_name = '{{ domain_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_linked_backend

Returns the details of a linked backend linked to a static site by name. Returns the details of a linked backend linked to a static site by name.

SELECT
id,
name,
backendResourceId,
createdOn,
kind,
provisioningState,
region,
systemData,
type
FROM azure.web.static_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND linked_backend_name = '{{ linked_backend_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_static_site_functions

Gets the functions of a static site. Description for Gets the functions of a static site.

SELECT
id,
name,
functionName,
kind,
triggerType,
type
FROM azure.web.static_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_static_sites_by_resource_group

Gets all static sites in the specified resource group. Description for Gets all static sites in the specified resource group.

SELECT
id,
name,
allowConfigFileUpdates,
branch,
buildProperties,
contentDistributionEndpoint,
customDomains,
databaseConnections,
defaultHostname,
enterpriseGradeCdnStatus,
identity,
keyVaultReferenceIdentity,
kind,
linkedBackends,
location,
privateEndpointConnections,
provider,
publicNetworkAccess,
repositoryToken,
repositoryUrl,
sku,
stagingEnvironmentPolicy,
systemData,
tags,
templateProperties,
type,
userProvidedFunctionApps
FROM azure.web.static_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get all Static Sites for a subscription. Description for Get all Static Sites for a subscription.

SELECT
id,
name,
allowConfigFileUpdates,
branch,
buildProperties,
contentDistributionEndpoint,
customDomains,
databaseConnections,
defaultHostname,
enterpriseGradeCdnStatus,
identity,
keyVaultReferenceIdentity,
kind,
linkedBackends,
location,
privateEndpointConnections,
provider,
publicNetworkAccess,
repositoryToken,
repositoryUrl,
sku,
stagingEnvironmentPolicy,
systemData,
tags,
templateProperties,
type,
userProvidedFunctionApps
FROM azure.web.static_sites
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update_static_site

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

INSERT INTO azure.web.static_sites (
tags,
location,
properties,
kind,
sku,
identity,
resource_group_name,
name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ kind }}',
'{{ sku }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: static_sites
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the static_sites resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the static_sites resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the static_sites resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Core resource properties.
    value:
      defaultHostname: "{{ defaultHostname }}"
      repositoryUrl: "{{ repositoryUrl }}"
      branch: "{{ branch }}"
      customDomains:
        - "{{ customDomains }}"
      repositoryToken: "{{ repositoryToken }}"
      buildProperties:
        appLocation: "{{ appLocation }}"
        apiLocation: "{{ apiLocation }}"
        appArtifactLocation: "{{ appArtifactLocation }}"
        outputLocation: "{{ outputLocation }}"
        appBuildCommand: "{{ appBuildCommand }}"
        apiBuildCommand: "{{ apiBuildCommand }}"
        skipGithubActionWorkflowGeneration: {{ skipGithubActionWorkflowGeneration }}
        githubActionSecretNameOverride: "{{ githubActionSecretNameOverride }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          location: "{{ location }}"
          tags: "{{ tags }}"
          plan:
            name: "{{ name }}"
            publisher: "{{ publisher }}"
            product: "{{ product }}"
            promotionCode: "{{ promotionCode }}"
            version: "{{ version }}"
          properties:
            id: "{{ id }}"
            name: "{{ name }}"
            kind: "{{ kind }}"
            type: "{{ type }}"
            properties:
              provisioningState: "{{ provisioningState }}"
              privateEndpoint:
                id: "{{ id }}"
              privateLinkServiceConnectionState:
                status: "{{ status }}"
                description: "{{ description }}"
                actionsRequired: "{{ actionsRequired }}"
              ipAddresses:
                - "{{ ipAddresses }}"
          sku:
            name: "{{ name }}"
            tier: "{{ tier }}"
            size: "{{ size }}"
            family: "{{ family }}"
            capacity: {{ capacity }}
            skuCapacity:
              minimum: {{ minimum }}
              maximum: {{ maximum }}
              elasticMaximum: {{ elasticMaximum }}
              default: {{ default }}
              scaleType: "{{ scaleType }}"
            locations:
              - "{{ locations }}"
            capabilities:
              - name: "{{ name }}"
                value: "{{ value }}"
                reason: "{{ reason }}"
          status: "{{ status }}"
          error:
            extendedCode: "{{ extendedCode }}"
            messageTemplate: "{{ messageTemplate }}"
            parameters:
              - "{{ parameters }}"
            innerErrors:
              - extendedCode: "{{ extendedCode }}"
                messageTemplate: "{{ messageTemplate }}"
                parameters: "{{ parameters }}"
                innerErrors: "{{ innerErrors }}"
                details: "{{ details }}"
                target: "{{ target }}"
                code: "{{ code }}"
                message: "{{ message }}"
            details:
              - extendedCode: "{{ extendedCode }}"
                messageTemplate: "{{ messageTemplate }}"
                parameters: "{{ parameters }}"
                innerErrors: "{{ innerErrors }}"
                details: "{{ details }}"
                target: "{{ target }}"
                code: "{{ code }}"
                message: "{{ message }}"
            target: "{{ target }}"
            code: "{{ code }}"
            message: "{{ message }}"
          identity:
            type: "{{ type }}"
            tenantId: "{{ tenantId }}"
            principalId: "{{ principalId }}"
            userAssignedIdentities: "{{ userAssignedIdentities }}"
          zones: "{{ zones }}"
      stagingEnvironmentPolicy: "{{ stagingEnvironmentPolicy }}"
      allowConfigFileUpdates: {{ allowConfigFileUpdates }}
      templateProperties:
        templateRepositoryUrl: "{{ templateRepositoryUrl }}"
        owner: "{{ owner }}"
        repositoryName: "{{ repositoryName }}"
        description: "{{ description }}"
        isPrivate: {{ isPrivate }}
      contentDistributionEndpoint: "{{ contentDistributionEndpoint }}"
      keyVaultReferenceIdentity: "{{ keyVaultReferenceIdentity }}"
      userProvidedFunctionApps:
        - id: "{{ id }}"
          name: "{{ name }}"
          kind: "{{ kind }}"
          type: "{{ type }}"
          properties:
            functionAppResourceId: "{{ functionAppResourceId }}"
            functionAppRegion: "{{ functionAppRegion }}"
            createdOn: "{{ createdOn }}"
      linkedBackends:
        - backendResourceId: "{{ backendResourceId }}"
          region: "{{ region }}"
          createdOn: "{{ createdOn }}"
          provisioningState: "{{ provisioningState }}"
      provider: "{{ provider }}"
      enterpriseGradeCdnStatus: "{{ enterpriseGradeCdnStatus }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      databaseConnections:
        - resourceId: "{{ resourceId }}"
          connectionIdentity: "{{ connectionIdentity }}"
          region: "{{ region }}"
          configurationFiles: "{{ configurationFiles }}"
          name: "{{ name }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      Kind of resource.
  - name: sku
    description: |
      Description of a SKU for a scalable resource.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      size: "{{ size }}"
      family: "{{ family }}"
      capacity: {{ capacity }}
      skuCapacity:
        minimum: {{ minimum }}
        maximum: {{ maximum }}
        elasticMaximum: {{ elasticMaximum }}
        default: {{ default }}
        scaleType: "{{ scaleType }}"
      locations:
        - "{{ locations }}"
      capabilities:
        - name: "{{ name }}"
          value: "{{ value }}"
          reason: "{{ reason }}"
  - name: identity
    description: |
      Managed service identity.
    value:
      type: "{{ type }}"
      tenantId: "{{ tenantId }}"
      principalId: "{{ principalId }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update_static_site

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

UPDATE azure.web.static_sites
SET 
kind = '{{ kind }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update_static_site

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

REPLACE azure.web.static_sites
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
kind = '{{ kind }}',
sku = '{{ sku }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

detach_user_provided_function_app_from_static_site_build

Detach the user provided function app from the static site build. Description for Detach the user provided function app from the static site build.

DELETE FROM azure.web.static_sites
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND function_app_name = '{{ function_app_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

unlink_backend_from_build

Unlink a backend from a static site build. Unlink a backend from a static site build.

DELETE FROM azure.web.static_sites
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND linked_backend_name = '{{ linked_backend_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND isCleaningAuthConfig = '{{ isCleaningAuthConfig }}'
;

detach_user_provided_function_app_from_static_site

Detach the user provided function app from the static site. Description for Detach the user provided function app from the static site.

DELETE FROM azure.web.static_sites
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND function_app_name = '{{ function_app_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

unlink_backend

Unlink a backend from a static site. Unlink a backend from a static site.

DELETE FROM azure.web.static_sites
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND linked_backend_name = '{{ linked_backend_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND isCleaningAuthConfig = '{{ isCleaningAuthConfig }}'
;

delete_static_site

Deletes a static site. Description for Deletes a static site.

DELETE FROM azure.web.static_sites
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_static_site_app_settings

Gets the application settings of a static site. Description for Gets the application settings of a static site.

EXEC azure.web.static_sites.list_static_site_app_settings 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_static_site_configured_roles

Lists the roles configured for the static site. Description for Lists the roles configured for the static site.

EXEC azure.web.static_sites.list_static_site_configured_roles 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_static_site_function_app_settings

Gets the application settings of a static site. Description for Gets the application settings of a static site.

EXEC azure.web.static_sites.list_static_site_function_app_settings 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_static_site_secrets

Lists the secrets for an existing static site. Description for Lists the secrets for an existing static site.

EXEC azure.web.static_sites.list_static_site_secrets 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_static_site_build_app_settings

Gets the application settings of a static site build. Description for Gets the application settings of a static site build.

EXEC azure.web.static_sites.list_static_site_build_app_settings 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_static_site_build_function_app_settings

Gets the application settings of a static site build. Description for Gets the application settings of a static site build.

EXEC azure.web.static_sites.list_static_site_build_function_app_settings 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_basic_auth

Gets the basic auth properties for a static site as a collection. Description for Gets the basic auth properties for a static site as a collection.

EXEC azure.web.static_sites.list_basic_auth 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_static_site_custom_domains

Gets all static site custom domains for a particular static site. Description for Gets all static site custom domains for a particular static site.

EXEC azure.web.static_sites.list_static_site_custom_domains 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

approve_or_reject_private_endpoint_connection

Approves or rejects a private endpoint connection. Description for Approves or rejects a private endpoint connection.

EXEC azure.web.static_sites.approve_or_reject_private_endpoint_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@private_endpoint_connection_name='{{ private_endpoint_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"kind": "{{ kind }}"
}'
;

delete_private_endpoint_connection

Deletes a private endpoint connection. Description for Deletes a private endpoint connection.

EXEC azure.web.static_sites.delete_private_endpoint_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@private_endpoint_connection_name='{{ private_endpoint_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_private_endpoint_connection_list

Gets the list of private endpoint connections associated with a static site. Description for Gets the list of private endpoint connections associated with a static site.

EXEC azure.web.static_sites.get_private_endpoint_connection_list 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_static_site

Gets the details of a static site. Description for Gets the details of a static site.

EXEC azure.web.static_sites.get_static_site 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_private_link_resources

Gets the private link resources. Description for Gets the private link resources.

EXEC azure.web.static_sites.get_private_link_resources 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_database_connections_with_details

Returns details of database connections for a static site. Returns details of database connections for a static site.

EXEC azure.web.static_sites.get_database_connections_with_details 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_static_site_build

Gets the details of a static site build. Description for Gets the details of a static site build.

EXEC azure.web.static_sites.get_static_site_build 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

delete_static_site_build

Deletes a static site build. Description for Deletes a static site build.

EXEC azure.web.static_sites.delete_static_site_build 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_static_site_builds

Gets all static site builds for a particular static site. Description for Gets all static site builds for a particular static site.

EXEC azure.web.static_sites.get_static_site_builds 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_build_database_connections_with_details

Returns details of database connections for a static site build. Returns details of database connections for a static site build.

EXEC azure.web.static_sites.get_build_database_connections_with_details 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_or_update_build_database_connection

Create or update a database connection for a static site build. Description for Create or update a database connection for a static site build.

EXEC azure.web.static_sites.create_or_update_build_database_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@database_connection_name='{{ database_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"kind": "{{ kind }}"
}'
;

update_build_database_connection

Create or update a database connection for a static site build. Description for Create or update a database connection for a static site build.

EXEC azure.web.static_sites.update_build_database_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@database_connection_name='{{ database_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete_build_database_connection

Delete a database connection for a static site build. Delete a database connection for a static site build.

EXEC azure.web.static_sites.delete_build_database_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@database_connection_name='{{ database_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_build_database_connections

Returns overviews of database connections for a static site build. Returns overviews of database connections for a static site build.

EXEC azure.web.static_sites.get_build_database_connections 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_build_database_connection_with_details

Returns details of a database connection for a static site build by name. Returns details of a database connection for a static site build by name.

EXEC azure.web.static_sites.get_build_database_connection_with_details 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@database_connection_name='{{ database_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_or_update_database_connection

Create or update a database connection for a static site. Description for Create or update a database connection for a static site.

EXEC azure.web.static_sites.create_or_update_database_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@database_connection_name='{{ database_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"kind": "{{ kind }}"
}'
;

update_database_connection

Create or update a database connection for a static site. Description for Create or update a database connection for a static site.

EXEC azure.web.static_sites.update_database_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@database_connection_name='{{ database_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete_database_connection

Delete a database connection for a static site. Delete a database connection for a static site.

EXEC azure.web.static_sites.delete_database_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@database_connection_name='{{ database_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_database_connections

Returns overviews of database connections for a static site. Returns overviews of database connections for a static site.

EXEC azure.web.static_sites.get_database_connections 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_database_connection_with_details

Returns details of a database connection for a static site by name. Returns details of a database connection for a static site by name.

EXEC azure.web.static_sites.get_database_connection_with_details 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@database_connection_name='{{ database_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

register_user_provided_function_app_with_static_site_build

Register a user provided function app with a static site build. Description for Register a user provided function app with a static site build.

EXEC azure.web.static_sites.register_user_provided_function_app_with_static_site_build 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@function_app_name='{{ function_app_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@isForced={{ isForced }} 
@@json=
'{
"properties": "{{ properties }}", 
"kind": "{{ kind }}"
}'
;

get_user_provided_function_apps_for_static_site_build

Gets the details of the user provided function apps registered with a static site build. Description for Gets the details of the user provided function apps registered with a static site build.

EXEC azure.web.static_sites.get_user_provided_function_apps_for_static_site_build 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

register_user_provided_function_app_with_static_site

Register a user provided function app with a static site. Description for Register a user provided function app with a static site.

EXEC azure.web.static_sites.register_user_provided_function_app_with_static_site 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@function_app_name='{{ function_app_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@isForced={{ isForced }} 
@@json=
'{
"properties": "{{ properties }}", 
"kind": "{{ kind }}"
}'
;

get_user_provided_function_apps_for_static_site

Gets the details of the user provided function apps registered with a static site. Description for Gets the details of the user provided function apps registered with a static site.

EXEC azure.web.static_sites.get_user_provided_function_apps_for_static_site 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_or_update_basic_auth

Adds or updates basic auth for a static site. Description for Adds or updates basic auth for a static site.

EXEC azure.web.static_sites.create_or_update_basic_auth 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@basic_auth_name='{{ basic_auth_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"kind": "{{ kind }}"
}'
;

create_or_update_static_site_custom_domain

Creates a new static site custom domain in an existing resource group and static site. Description for Creates a new static site custom domain in an existing resource group and static site.

EXEC azure.web.static_sites.create_or_update_static_site_custom_domain 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@domain_name='{{ domain_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

delete_static_site_custom_domain

Deletes a custom domain. Description for Deletes a custom domain.

EXEC azure.web.static_sites.delete_static_site_custom_domain 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@domain_name='{{ domain_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

link_backend

Link backend to a static site. Link backend to a static site.

EXEC azure.web.static_sites.link_backend 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@linked_backend_name='{{ linked_backend_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"kind": "{{ kind }}"
}'
;

get_linked_backends

Returns details of all backends linked to a static site. Returns details of all backends linked to a static site.

EXEC azure.web.static_sites.get_linked_backends 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

link_backend_to_build

Link backend to a static site build. Link backend to a static site build.

EXEC azure.web.static_sites.link_backend_to_build 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@linked_backend_name='{{ linked_backend_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"kind": "{{ kind }}"
}'
;

get_linked_backends_for_build

Returns details of all backends linked to a static site build. Returns details of all backends linked to a static site build.

EXEC azure.web.static_sites.get_linked_backends_for_build 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

delete_static_site_user

Deletes the user entry from the static site. Description for Deletes the user entry from the static site.

EXEC azure.web.static_sites.delete_static_site_user 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@authprovider='{{ authprovider }}' --required, 
@userid='{{ userid }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_static_site_user

Updates a user entry with the listed roles. Description for Updates a user entry with the listed roles.

EXEC azure.web.static_sites.update_static_site_user 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@authprovider='{{ authprovider }}' --required, 
@userid='{{ userid }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

create_or_update_static_site_app_settings

Creates or updates the app settings of a static site. Description for Creates or updates the app settings of a static site.

EXEC azure.web.static_sites.create_or_update_static_site_app_settings 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

create_or_update_static_site_function_app_settings

Creates or updates the function app settings of a static site. Description for Creates or updates the function app settings of a static site.

EXEC azure.web.static_sites.create_or_update_static_site_function_app_settings 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

create_user_roles_invitation_link

Creates an invitation link for a user with the role. Description for Creates an invitation link for a user with the role.

EXEC azure.web.static_sites.create_user_roles_invitation_link 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

detach_static_site

Detaches a static site. Description for Detaches a static site.

EXEC azure.web.static_sites.detach_static_site 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

reset_static_site_api_key

Resets the api key for an existing static site. Description for Resets the api key for an existing static site.

EXEC azure.web.static_sites.reset_static_site_api_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

create_zip_deployment_for_static_site

Deploys zipped content to a static site. Description for Deploys zipped content to a static site.

EXEC azure.web.static_sites.create_zip_deployment_for_static_site 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

create_or_update_static_site_build_app_settings

Creates or updates the app settings of a static site build. Description for Creates or updates the app settings of a static site build.

EXEC azure.web.static_sites.create_or_update_static_site_build_app_settings 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

create_or_update_static_site_build_function_app_settings

Creates or updates the function app settings of a static site build. Description for Creates or updates the function app settings of a static site build.

EXEC azure.web.static_sites.create_or_update_static_site_build_function_app_settings 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

create_zip_deployment_for_static_site_build

Deploys zipped content to a specific environment of a static site. Description for Deploys zipped content to a specific environment of a static site.

EXEC azure.web.static_sites.create_zip_deployment_for_static_site_build 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

validate_custom_domain_can_be_added_to_static_site

Validates a particular custom domain can be added to a static site. Description for Validates a particular custom domain can be added to a static site.

EXEC azure.web.static_sites.validate_custom_domain_can_be_added_to_static_site 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@domain_name='{{ domain_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

validate_backend

Validates that a backend can be linked to a static site. Validates that a backend can be linked to a static site.

EXEC azure.web.static_sites.validate_backend 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@linked_backend_name='{{ linked_backend_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"kind": "{{ kind }}"
}'
;

validate_backend_for_build

Validates that a backend can be linked to a static site build. Validates that a backend can be linked to a static site build.

EXEC azure.web.static_sites.validate_backend_for_build 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@environment_name='{{ environment_name }}' --required, 
@linked_backend_name='{{ linked_backend_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"kind": "{{ kind }}"
}'
;

preview_workflow

Generates a preview workflow file for the static site. Description for Generates a preview workflow file for the static site.

EXEC azure.web.static_sites.preview_workflow 
@location='{{ location }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;