authentication_methods_policy_authentication_method_configurations

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

Overview

Name	authentication_methods_policy_authentication_method_configurations
Type	Resource
Id	entra_id.policies.authentication_methods_policy_authentication_method_configurations

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
excludeTargets	array	Groups of users that are excluded from a policy.
state		The state of the policy. The possible values are: enabled, disabled.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
excludeTargets	array	Groups of users that are excluded from a policy.
state		The state of the policy. The possible values are: enabled, disabled.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	authentication_method_configuration_id		Read the properties and relationships of an externalAuthenticationMethodConfiguration object.
list	select			Read the properties and relationships of an externalAuthenticationMethodConfiguration object.
insert	insert
update	update	authentication_method_configuration_id		Update the properties of an externalAuthenticationMethodConfiguration object.
delete	delete	authentication_method_configuration_id	If-Match	Delete an externalAuthenticationMethodConfiguration object.

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
authentication_method_configuration_id	string	The unique identifier of authenticationMethodConfiguration
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of an externalAuthenticationMethodConfiguration object.

SELECT
id,
excludeTargets,
state
FROM entra_id.policies.authentication_methods_policy_authentication_method_configurations
WHERE authentication_method_configuration_id = '{{ authentication_method_configuration_id }}' -- required
;

list

Read the properties and relationships of an externalAuthenticationMethodConfiguration object.

SELECT
id,
excludeTargets,
state
FROM entra_id.policies.authentication_methods_policy_authentication_method_configurations
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.policies.authentication_methods_policy_authentication_method_configurations (
id,
excludeTargets,
state
)
SELECT 
'{{ id }}',
'{{ excludeTargets }}',
'{{ state }}'
RETURNING
id,
excludeTargets,
state
;

Manifest

# Description fields are for documentation purposes
- name: authentication_methods_policy_authentication_method_configurations
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: excludeTargets
    description: |
      Groups of users that are excluded from a policy.
    value:
      - id: "{{ id }}"
        targetType: "{{ targetType }}"
  - name: state
    value: "{{ state }}"
    description: |
      The state of the policy. The possible values are: enabled, disabled.

UPDATE examples

update

Update the properties of an externalAuthenticationMethodConfiguration object.

UPDATE entra_id.policies.authentication_methods_policy_authentication_method_configurations
SET 
id = '{{ id }}',
excludeTargets = '{{ excludeTargets }}',
state = '{{ state }}'
WHERE 
authentication_method_configuration_id = '{{ authentication_method_configuration_id }}' --required
RETURNING
id,
excludeTargets,
state;

DELETE examples

delete

Delete an externalAuthenticationMethodConfiguration object.

DELETE FROM entra_id.policies.authentication_methods_policy_authentication_method_configurations
WHERE authentication_method_configuration_id = '{{ authentication_method_configuration_id }}' --required
AND If-Match = '{{ If-Match }}'
;