container_apps_auth_configs

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

Overview

Name	container_apps_auth_configs
Type	Resource
Id	azure.app_containers.container_apps_auth_configs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
encryptionSettings	object	The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization.
globalValidation	object	The configuration settings that determines the validation flow of users using Service Authentication/Authorization.
httpSettings	object	The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization.
identityProviders	object	The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.
login	object	The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.
platform	object	The configuration settings of the platform of ContainerApp Service Authentication/Authorization.
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_by_container_app

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
encryptionSettings	object	The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization.
globalValidation	object	The configuration settings that determines the validation flow of users using Service Authentication/Authorization.
httpSettings	object	The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization.
identityProviders	object	The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.
login	object	The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.
platform	object	The configuration settings of the platform of ContainerApp Service Authentication/Authorization.
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	resource_group_name, container_app_name, auth_config_name, subscription_id		Get a AuthConfig of a Container App. Get a AuthConfig of a Container App.
list_by_container_app	select	resource_group_name, container_app_name, subscription_id		Get the Container App AuthConfigs in a given resource group. Get the Container App AuthConfigs in a given resource group.
create_or_update	insert	resource_group_name, container_app_name, auth_config_name, subscription_id		Create or update the AuthConfig for a Container App. Create or update the AuthConfig for a Container App.
create_or_update	replace	resource_group_name, container_app_name, auth_config_name, subscription_id		Create or update the AuthConfig for a Container App. Create or update the AuthConfig for a Container App.
delete	delete	resource_group_name, container_app_name, auth_config_name, subscription_id		Delete a Container App AuthConfig. 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
auth_config_name	string	Name of the Container App AuthConfig. Required.
container_app_name	string	Name of the Container App. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a AuthConfig of a Container App. Get a AuthConfig of a Container App.

SELECT
id,
name,
encryptionSettings,
globalValidation,
httpSettings,
identityProviders,
login,
platform,
systemData,
type
FROM azure.app_containers.container_apps_auth_configs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND container_app_name = '{{ container_app_name }}' -- required
AND auth_config_name = '{{ auth_config_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_container_app

Get the Container App AuthConfigs in a given resource group. Get the Container App AuthConfigs in a given resource group.

SELECT
id,
name,
encryptionSettings,
globalValidation,
httpSettings,
identityProviders,
login,
platform,
systemData,
type
FROM azure.app_containers.container_apps_auth_configs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND container_app_name = '{{ container_app_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update the AuthConfig for a Container App. Create or update the AuthConfig for a Container App.

INSERT INTO azure.app_containers.container_apps_auth_configs (
properties,
resource_group_name,
container_app_name,
auth_config_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ container_app_name }}',
'{{ auth_config_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: container_apps_auth_configs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the container_apps_auth_configs resource.
  - name: container_app_name
    value: "{{ container_app_name }}"
    description: Required parameter for the container_apps_auth_configs resource.
  - name: auth_config_name
    value: "{{ auth_config_name }}"
    description: Required parameter for the container_apps_auth_configs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the container_apps_auth_configs resource.
  - name: properties
    description: |
      AuthConfig resource specific properties.
    value:
      platform:
        enabled: {{ enabled }}
        runtimeVersion: "{{ runtimeVersion }}"
      globalValidation:
        unauthenticatedClientAction: "{{ unauthenticatedClientAction }}"
        redirectToProvider: "{{ redirectToProvider }}"
        excludedPaths:
          - "{{ excludedPaths }}"
      identityProviders:
        azureActiveDirectory:
          enabled: {{ enabled }}
          registration:
            openIdIssuer: "{{ openIdIssuer }}"
            clientId: "{{ clientId }}"
            clientSecretSettingName: "{{ clientSecretSettingName }}"
            clientSecretCertificateThumbprint: "{{ clientSecretCertificateThumbprint }}"
            clientSecretCertificateSubjectAlternativeName: "{{ clientSecretCertificateSubjectAlternativeName }}"
            clientSecretCertificateIssuer: "{{ clientSecretCertificateIssuer }}"
          login:
            loginParameters:
              - "{{ loginParameters }}"
            disableWWWAuthenticate: {{ disableWWWAuthenticate }}
          validation:
            jwtClaimChecks:
              allowedGroups: "{{ allowedGroups }}"
              allowedClientApplications: "{{ allowedClientApplications }}"
            allowedAudiences:
              - "{{ allowedAudiences }}"
            defaultAuthorizationPolicy:
              allowedPrincipals: "{{ allowedPrincipals }}"
              allowedApplications: "{{ allowedApplications }}"
          isAutoProvisioned: {{ isAutoProvisioned }}
        facebook:
          enabled: {{ enabled }}
          registration:
            appId: "{{ appId }}"
            appSecretSettingName: "{{ appSecretSettingName }}"
          graphApiVersion: "{{ graphApiVersion }}"
          login:
            scopes:
              - "{{ scopes }}"
        gitHub:
          enabled: {{ enabled }}
          registration:
            clientId: "{{ clientId }}"
            clientSecretSettingName: "{{ clientSecretSettingName }}"
          login:
            scopes:
              - "{{ scopes }}"
        google:
          enabled: {{ enabled }}
          registration:
            clientId: "{{ clientId }}"
            clientSecretSettingName: "{{ clientSecretSettingName }}"
          login:
            scopes:
              - "{{ scopes }}"
          validation:
            allowedAudiences:
              - "{{ allowedAudiences }}"
        twitter:
          enabled: {{ enabled }}
          registration:
            consumerKey: "{{ consumerKey }}"
            consumerSecretSettingName: "{{ consumerSecretSettingName }}"
        apple:
          enabled: {{ enabled }}
          registration:
            clientId: "{{ clientId }}"
            clientSecretSettingName: "{{ clientSecretSettingName }}"
          login:
            scopes:
              - "{{ scopes }}"
        azureStaticWebApps:
          enabled: {{ enabled }}
          registration:
            clientId: "{{ clientId }}"
        customOpenIdConnectProviders: "{{ customOpenIdConnectProviders }}"
      login:
        routes:
          logoutEndpoint: "{{ logoutEndpoint }}"
        tokenStore:
          enabled: {{ enabled }}
          tokenRefreshExtensionHours: {{ tokenRefreshExtensionHours }}
          azureBlobStorage:
            sasUrlSettingName: "{{ sasUrlSettingName }}"
        preserveUrlFragmentsForLogins: {{ preserveUrlFragmentsForLogins }}
        allowedExternalRedirectUrls:
          - "{{ allowedExternalRedirectUrls }}"
        cookieExpiration:
          convention: "{{ convention }}"
          timeToExpiration: "{{ timeToExpiration }}"
        nonce:
          validateNonce: {{ validateNonce }}
          nonceExpirationInterval: "{{ nonceExpirationInterval }}"
      httpSettings:
        requireHttps: {{ requireHttps }}
        routes:
          apiPrefix: "{{ apiPrefix }}"
        forwardProxy:
          convention: "{{ convention }}"
          customHostHeaderName: "{{ customHostHeaderName }}"
          customProtoHeaderName: "{{ customProtoHeaderName }}"
      encryptionSettings:
        containerAppAuthEncryptionSecretName: "{{ containerAppAuthEncryptionSecretName }}"
        containerAppAuthSigningSecretName: "{{ containerAppAuthSigningSecretName }}"

REPLACE examples

create_or_update

Create or update the AuthConfig for a Container App. Create or update the AuthConfig for a Container App.

REPLACE azure.app_containers.container_apps_auth_configs
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND container_app_name = '{{ container_app_name }}' --required
AND auth_config_name = '{{ auth_config_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a Container App AuthConfig. Delete a Container App AuthConfig.

DELETE FROM azure.app_containers.container_apps_auth_configs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND container_app_name = '{{ container_app_name }}' --required
AND auth_config_name = '{{ auth_config_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;