jwt_authenticators

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

Overview

Name	jwt_authenticators
Type	Resource
Id	azure.container_service.jwt_authenticators

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.
claimMappings	object	The mappings that define how user attributes are extracted from the token claims. Required.
claimValidationRules	array	The rules that are applied to validate token claims to authenticate users. All the expressions must evaluate to true for validation to succeed.
issuer	object	The JWT OIDC issuer details. Required.
provisioningState	string	The current provisioning state of the JWT authenticator. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
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".
userValidationRules	array	The rules that are applied to the mapped user before completing authentication. All the expressions must evaluate to true for validation to succeed.

list_by_managed_cluster

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.
claimMappings	object	The mappings that define how user attributes are extracted from the token claims. Required.
claimValidationRules	array	The rules that are applied to validate token claims to authenticate users. All the expressions must evaluate to true for validation to succeed.
issuer	object	The JWT OIDC issuer details. Required.
provisioningState	string	The current provisioning state of the JWT authenticator. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
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".
userValidationRules	array	The rules that are applied to the mapped user before completing authentication. All the expressions must evaluate to true for validation to succeed.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, jwt_authenticator_name, subscription_id		Gets the specified JWT authenticator of a managed cluster.
list_by_managed_cluster	select	resource_group_name, resource_name, subscription_id		Gets a list of JWT authenticators in the specified managed cluster.
create_or_update	insert	resource_group_name, resource_name, jwt_authenticator_name, subscription_id, properties		Creates or updates JWT authenticator in the managed cluster and updates the managed cluster to apply the settings.
create_or_update	replace	resource_group_name, resource_name, jwt_authenticator_name, subscription_id, properties		Creates or updates JWT authenticator in the managed cluster and updates the managed cluster to apply the settings.
delete	delete	resource_group_name, resource_name, jwt_authenticator_name, subscription_id		Deletes a JWT authenticator and updates the managed cluster to apply the settings.

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
jwt_authenticator_name	string	The name of the JWT authenticator. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the managed cluster resource. Required.
subscription_id	string

SELECT examples

get

Gets the specified JWT authenticator of a managed cluster.

SELECT
id,
name,
claimMappings,
claimValidationRules,
issuer,
provisioningState,
systemData,
type,
userValidationRules
FROM azure.container_service.jwt_authenticators
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND jwt_authenticator_name = '{{ jwt_authenticator_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_managed_cluster

Gets a list of JWT authenticators in the specified managed cluster.

SELECT
id,
name,
claimMappings,
claimValidationRules,
issuer,
provisioningState,
systemData,
type,
userValidationRules
FROM azure.container_service.jwt_authenticators
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates JWT authenticator in the managed cluster and updates the managed cluster to apply the settings.

INSERT INTO azure.container_service.jwt_authenticators (
properties,
resource_group_name,
resource_name,
jwt_authenticator_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ jwt_authenticator_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: jwt_authenticators
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the jwt_authenticators resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the jwt_authenticators resource.
  - name: jwt_authenticator_name
    value: "{{ jwt_authenticator_name }}"
    description: Required parameter for the jwt_authenticators resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the jwt_authenticators resource.
  - name: properties
    description: |
      The properties of JWTAuthenticator. For details on how to configure the properties of a JWT authenticator, please refer to the Kubernetes documentation: `https://kubernetes.io/docs/reference/access-authn-authz/authentication/#using-authentication-configuration `_. Please note that not all fields available in the Kubernetes documentation are supported by AKS. For troubleshooting, please see `https://aka.ms/aks-external-issuers-docs `_. Required.
    value:
      provisioningState: "{{ provisioningState }}"
      issuer:
        url: "{{ url }}"
        audiences:
          - "{{ audiences }}"
      claimValidationRules:
        - expression: "{{ expression }}"
          message: "{{ message }}"
      claimMappings:
        username:
          expression: "{{ expression }}"
        groups:
          expression: "{{ expression }}"
        uid:
          expression: "{{ expression }}"
        extra:
          - key: "{{ key }}"
            valueExpression: "{{ valueExpression }}"
      userValidationRules:
        - expression: "{{ expression }}"
          message: "{{ message }}"

REPLACE examples

create_or_update

Creates or updates JWT authenticator in the managed cluster and updates the managed cluster to apply the settings.

REPLACE azure.container_service.jwt_authenticators
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND jwt_authenticator_name = '{{ jwt_authenticator_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a JWT authenticator and updates the managed cluster to apply the settings.

DELETE FROM azure.container_service.jwt_authenticators
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND jwt_authenticator_name = '{{ jwt_authenticator_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;