static_site_users

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

Overview

Name	static_site_users
Type	Resource
Id	azure.app_service.static_site_users

Fields

The following fields are returned by SELECT queries:

list

OK.

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource Name.
kind	string	Kind of resource.
properties	object	StaticSiteUserARMResource resource specific properties
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resourceGroupName, name, authprovider, subscriptionId		Description for Gets the list of users of a static site.
update	update	resourceGroupName, name, authprovider, userid, subscriptionId		Description for Updates a user entry with the listed roles
delete	delete	resourceGroupName, name, authprovider, userid, subscriptionId		Description for Deletes the user entry from 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	The auth provider for this user.
name	string	Name of the staticsite.
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).
userid	string	The user id of the user.

SELECT examples

list

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

SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.static_site_users
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND authprovider = '{{ authprovider }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

UPDATE examples

update

Description for Updates a user entry with the listed roles

UPDATE azure.app_service.static_site_users
SET 
data__kind = '{{ kind }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND authprovider = '{{ authprovider }}' --required
AND userid = '{{ userid }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
kind,
properties,
type;

DELETE examples

delete

Description for Deletes the user entry from the static site.

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