static_sites

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

Overview

Name	static_sites
Type	Resource
Id	azure.app_service.static_sites

Fields

The following fields are returned by SELECT queries:

get

OK.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
identity	object	Managed service identity.
properties	object	Core resource properties
sku	object	Description of a SKU for a scalable 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"

list

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
identity	object	Managed service identity.
properties	object	Core resource properties
sku	object	Description of a SKU for a scalable 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"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, name, subscriptionId		Description for Gets the details of a static site.
list	select	subscriptionId		Description for Get all Static Sites for a subscription.
create_or_update	insert	resourceGroupName, name, subscriptionId		Description for Creates a new static site in an existing resource group, or updates an existing static site.
update	update	resourceGroupName, name, subscriptionId		Description for Creates a new static site in an existing resource group, or updates an existing static site.
delete	delete	resourceGroupName, name, subscriptionId		Description for Deletes a static site.
preview_workflow	exec	location, subscriptionId		Description for Generates a preview workflow file for the static site
register_user_provided_function_app_with_static_site_build	exec	resourceGroupName, name, environmentName, functionAppName, subscriptionId	isForced	Description for Register a user provided function app with a static site build
detach_user_provided_function_app_from_static_site_build	exec	resourceGroupName, name, environmentName, functionAppName, subscriptionId		Description for Detach the user provided function app from the static site build
validate_custom_domain_can_be_added_to_static_site	exec	resourceGroupName, name, domainName, subscriptionId		Description for Validates a particular custom domain can be added to a static site.
detach_static_site	exec	resourceGroupName, name, subscriptionId		Description for Detaches a static site.
approve_or_reject_private_endpoint_connection	exec	resourceGroupName, name, privateEndpointConnectionName, subscriptionId		Description for Approves or rejects a private endpoint connection
reset_static_site_api_key	exec	resourceGroupName, name, subscriptionId		Description for Resets the api key for an existing static site.
register_user_provided_function_app_with_static_site	exec	resourceGroupName, name, functionAppName, subscriptionId	isForced	Description for Register a user provided function app with a static site
detach_user_provided_function_app_from_static_site	exec	resourceGroupName, name, functionAppName, subscriptionId		Description for Detach the user provided function app from the static site
validate_backend	exec	resourceGroupName, name, linkedBackendName, subscriptionId
validate_backend_for_build	exec	resourceGroupName, name, environmentName, linkedBackendName, subscriptionId
link_backend	exec	resourceGroupName, name, linkedBackendName, subscriptionId
unlink_backend	exec	resourceGroupName, name, linkedBackendName, subscriptionId	isCleaningAuthConfig
link_backend_to_build	exec	resourceGroupName, name, environmentName, linkedBackendName, subscriptionId
unlink_backend_from_build	exec	resourceGroupName, name, environmentName, linkedBackendName, subscriptionId	isCleaningAuthConfig

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
domainName	string	The custom domain to validate.
environmentName	string	The stage site identifier
functionAppName	string	Name of the function app registered with the static site.
linkedBackendName	string	Name of the backend linked to the static site
location	string	Location where you plan to create the static site.
name	string	Name of the static site
privateEndpointConnectionName	string	Name of the private endpoint connection.
resourceGroupName	string	Name of the resource group to which the resource belongs.
subscriptionId	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
isCleaningAuthConfig	boolean	Decides if auth will be removed from backend configuration
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.

SELECT examples

get

Description for Gets the details of a static site.

SELECT
id,
name,
identity,
properties,
sku,
systemData,
type
FROM azure.app_service.static_sites
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Description for Get all Static Sites for a subscription.

SELECT
id,
name,
identity,
properties,
sku,
systemData,
type
FROM azure.app_service.static_sites
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.app_service.static_sites (
data__properties,
data__sku,
data__identity,
resourceGroupName,
name,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ sku }}',
'{{ identity }}',
'{{ resourceGroupName }}',
'{{ name }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
identity,
properties,
sku,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: static_sites
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the static_sites resource.
    - name: name
      value: string
      description: Required parameter for the static_sites resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the static_sites resource.
    - name: properties
      value: object
      description: |
        Core resource properties
    - name: sku
      value: object
      description: |
        Description of a SKU for a scalable resource.
    - name: identity
      value: object
      description: |
        Managed service identity.

UPDATE examples

update

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

UPDATE azure.app_service.static_sites
SET 
data__kind = '{{ kind }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
identity,
properties,
sku,
systemData,
type;

DELETE examples

delete

Description for Deletes a static site.

DELETE FROM azure.app_service.static_sites
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

preview_workflow

Description for Generates a preview workflow file for the static site

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

register_user_provided_function_app_with_static_site_build

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

EXEC azure.app_service.static_sites.register_user_provided_function_app_with_static_site_build 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@environmentName='{{ environmentName }}' --required, 
@functionAppName='{{ functionAppName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@isForced={{ isForced }} 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

detach_user_provided_function_app_from_static_site_build

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

EXEC azure.app_service.static_sites.detach_user_provided_function_app_from_static_site_build 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@environmentName='{{ environmentName }}' --required, 
@functionAppName='{{ functionAppName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

validate_custom_domain_can_be_added_to_static_site

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

EXEC azure.app_service.static_sites.validate_custom_domain_can_be_added_to_static_site 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@domainName='{{ domainName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

detach_static_site

Description for Detaches a static site.

EXEC azure.app_service.static_sites.detach_static_site 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

approve_or_reject_private_endpoint_connection

Description for Approves or rejects a private endpoint connection

EXEC azure.app_service.static_sites.approve_or_reject_private_endpoint_connection 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@privateEndpointConnectionName='{{ privateEndpointConnectionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

reset_static_site_api_key

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

EXEC azure.app_service.static_sites.reset_static_site_api_key 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

register_user_provided_function_app_with_static_site

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

EXEC azure.app_service.static_sites.register_user_provided_function_app_with_static_site 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@functionAppName='{{ functionAppName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@isForced={{ isForced }} 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

detach_user_provided_function_app_from_static_site

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

EXEC azure.app_service.static_sites.detach_user_provided_function_app_from_static_site 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@functionAppName='{{ functionAppName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

validate_backend

Asynchronous operation in progress.

EXEC azure.app_service.static_sites.validate_backend 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@linkedBackendName='{{ linkedBackendName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

validate_backend_for_build

Asynchronous operation in progress.

EXEC azure.app_service.static_sites.validate_backend_for_build 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@environmentName='{{ environmentName }}' --required, 
@linkedBackendName='{{ linkedBackendName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

link_backend

OK

EXEC azure.app_service.static_sites.link_backend 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@linkedBackendName='{{ linkedBackendName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

unlink_backend

OK.

EXEC azure.app_service.static_sites.unlink_backend 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@linkedBackendName='{{ linkedBackendName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@isCleaningAuthConfig={{ isCleaningAuthConfig }}
;

link_backend_to_build

OK

EXEC azure.app_service.static_sites.link_backend_to_build 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@environmentName='{{ environmentName }}' --required, 
@linkedBackendName='{{ linkedBackendName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"kind": "{{ kind }}", 
"properties": "{{ properties }}"
}'
;

unlink_backend_from_build

OK.

EXEC azure.app_service.static_sites.unlink_backend_from_build 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@environmentName='{{ environmentName }}' --required, 
@linkedBackendName='{{ linkedBackendName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@isCleaningAuthConfig={{ isCleaningAuthConfig }}
;