device_local_credentials

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

Overview

Name	device_local_credentials
Type	Resource
Id	entra_id.directory.device_local_credentials

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.
credentials	array	The credentials of the device's local administrator account backed up to Azure Active Directory.
deviceName	string	Display name of the device that the local credentials are associated with.
lastBackupDateTime	string (date-time)	When the local administrator account credential was backed up to Azure Active Directory. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
refreshDateTime	string (date-time)	When the local administrator account credential will be refreshed and backed up to Azure Active Directory. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
credentials	array	The credentials of the device's local administrator account backed up to Azure Active Directory.
deviceName	string	Display name of the device that the local credentials are associated with.
lastBackupDateTime	string (date-time)	When the local administrator account credential was backed up to Azure Active Directory. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
refreshDateTime	string (date-time)	When the local administrator account credential will be refreshed and backed up to Azure Active Directory. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	device_local_credential_info_id		Retrieve the properties of a deviceLocalCredentialInfo for a specified device object.
list	select			Get a list of the deviceLocalCredentialInfo objects and their properties, excluding the credentials property.
insert	insert
update	update	device_local_credential_info_id
delete	delete	device_local_credential_info_id	If-Match

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

SELECT examples

get

Retrieve the properties of a deviceLocalCredentialInfo for a specified device object.

SELECT
id,
credentials,
deviceName,
lastBackupDateTime,
refreshDateTime
FROM entra_id.directory.device_local_credentials
WHERE device_local_credential_info_id = '{{ device_local_credential_info_id }}' -- required
;

list

Get a list of the deviceLocalCredentialInfo objects and their properties, excluding the credentials property.

SELECT
id,
credentials,
deviceName,
lastBackupDateTime,
refreshDateTime
FROM entra_id.directory.device_local_credentials
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.directory.device_local_credentials (
id,
credentials,
deviceName,
lastBackupDateTime,
refreshDateTime
)
SELECT 
'{{ id }}',
'{{ credentials }}',
'{{ deviceName }}',
'{{ lastBackupDateTime }}',
'{{ refreshDateTime }}'
RETURNING
id,
credentials,
deviceName,
lastBackupDateTime,
refreshDateTime
;

Manifest

# Description fields are for documentation purposes
- name: device_local_credentials
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: credentials
    description: |
      The credentials of the device's local administrator account backed up to Azure Active Directory.
    value:
      - id: "{{ id }}"
        accountName: "{{ accountName }}"
        accountSid: "{{ accountSid }}"
        backupDateTime: "{{ backupDateTime }}"
        passwordBase64: "{{ passwordBase64 }}"
  - name: deviceName
    value: "{{ deviceName }}"
    description: |
      Display name of the device that the local credentials are associated with.
  - name: lastBackupDateTime
    value: "{{ lastBackupDateTime }}"
    description: |
      When the local administrator account credential was backed up to Azure Active Directory.
  - name: refreshDateTime
    value: "{{ refreshDateTime }}"
    description: |
      When the local administrator account credential will be refreshed and backed up to Azure Active Directory.

UPDATE examples

update

No description available.

UPDATE entra_id.directory.device_local_credentials
SET 
id = '{{ id }}',
credentials = '{{ credentials }}',
deviceName = '{{ deviceName }}',
lastBackupDateTime = '{{ lastBackupDateTime }}',
refreshDateTime = '{{ refreshDateTime }}'
WHERE 
device_local_credential_info_id = '{{ device_local_credential_info_id }}' --required
RETURNING
id,
credentials,
deviceName,
lastBackupDateTime,
refreshDateTime;

DELETE examples

delete

No description available.

DELETE FROM entra_id.directory.device_local_credentials
WHERE device_local_credential_info_id = '{{ device_local_credential_info_id }}' --required
AND If-Match = '{{ If-Match }}'
;