auth_settings

Creates, updates, deletes, gets or lists an auth_settings resource.

Overview

Name	auth_settings
Type	Resource
Id	azure.app_service.auth_settings

Fields

The following fields are returned by SELECT queries:

get

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

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 Authentication/Authorization settings of an app.
update	replace	resourceGroupName, name, subscriptionId		Description for Updates the Authentication / Authorization settings associated with web app.

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
name	string	Name of web app.
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).

SELECT examples

get

Description for Gets the Authentication/Authorization settings of an app.

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

REPLACE examples

update

Description for Updates the Authentication / Authorization settings associated with web app.

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