auth_configs

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

Overview

Name	auth_configs
Type	Resource
Id	azure.container_apps.auth_configs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	AuthConfig resource specific properties

list_by_container_app

Name	Datatype	Description
properties	object	AuthConfig resource specific properties

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, containerAppName, authConfigName
list_by_container_app	select	subscriptionId, resourceGroupName, containerAppName
create_or_update	insert	subscriptionId, resourceGroupName, containerAppName, authConfigName		Create or update the AuthConfig for a Container App.
delete	delete	subscriptionId, resourceGroupName, containerAppName, authConfigName		Delete a Container App AuthConfig.

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
authConfigName	string	Name of the Container App AuthConfig.
containerAppName	string	Name of the Container App.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

OK

SELECT
properties
FROM azure.container_apps.auth_configs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND containerAppName = '{{ containerAppName }}' -- required
AND authConfigName = '{{ authConfigName }}' -- required
;

list_by_container_app

OK

SELECT
properties
FROM azure.container_apps.auth_configs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND containerAppName = '{{ containerAppName }}' -- required
;

INSERT examples

create_or_update

Create or update the AuthConfig for a Container App.

INSERT INTO azure.container_apps.auth_configs (
data__properties,
subscriptionId,
resourceGroupName,
containerAppName,
authConfigName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ containerAppName }}',
'{{ authConfigName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: auth_configs
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the auth_configs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the auth_configs resource.
    - name: containerAppName
      value: string
      description: Required parameter for the auth_configs resource.
    - name: authConfigName
      value: string
      description: Required parameter for the auth_configs resource.
    - name: properties
      value: object
      description: |
        AuthConfig resource specific properties

DELETE examples

delete

Delete a Container App AuthConfig.

DELETE FROM azure.container_apps.auth_configs
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND containerAppName = '{{ containerAppName }}' --required
AND authConfigName = '{{ authConfigName }}' --required
;