basic_auths

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

Overview

Name	basic_auths
Type	Resource
Id	azure.app_service.basic_auths

Fields

The following fields are returned by SELECT queries:

get

OK.

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

list

OK.

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource Name.
kind	string	Kind of resource.
properties	object	StaticSiteBasicAuthPropertiesARMResource 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, basicAuthName, subscriptionId		Description for Gets the basic auth properties for a static site.
list	select	resourceGroupName, name, subscriptionId		Description for Gets the basic auth properties for a static site as a collection.
create_or_update	insert	resourceGroupName, name, basicAuthName, subscriptionId		Description for Adds or updates basic auth for a 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
basicAuthName	string	name of the basic auth entry.
name	string	Name of the static site.
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 basic auth properties for a static site.

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

list

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

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

INSERT examples

create_or_update

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

INSERT INTO azure.app_service.basic_auths (
data__kind,
data__properties,
resourceGroupName,
name,
basicAuthName,
subscriptionId
)
SELECT 
'{{ kind }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ name }}',
'{{ basicAuthName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
kind,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: basic_auths
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the basic_auths resource.
    - name: name
      value: string
      description: Required parameter for the basic_auths resource.
    - name: basicAuthName
      value: string
      description: Required parameter for the basic_auths resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the basic_auths resource.
    - name: kind
      value: string
      description: |
        Kind of resource.
    - name: properties
      value: object
      description: |
        StaticSiteBasicAuthPropertiesARMResource resource specific properties