public_key_infrastructure_certificate_based_auth_configurations

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

Overview

Name	public_key_infrastructure_certificate_based_auth_configurations
Type	Resource
Id	entra_id.directory.public_key_infrastructure_certificate_based_auth_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.
certificateAuthorities	array	The collection of certificate authorities contained in this public key infrastructure resource.
deletedDateTime	string (date-time)	Date and time when this object was deleted. Always null when the object hasn't been deleted. (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])$)
displayName	string	The name of the object. Maximum length is 256 characters.
lastModifiedDateTime	string (date-time)	The date and time when the object was created or last modified. (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])$)
status	string	The status of any asynchronous jobs runs on the object which can be upload or delete.
statusDetails	string	The status details of the upload/deleted operation of PKI (Public Key Infrastructure).

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
certificateAuthorities	array	The collection of certificate authorities contained in this public key infrastructure resource.
deletedDateTime	string (date-time)	Date and time when this object was deleted. Always null when the object hasn't been deleted. (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])$)
displayName	string	The name of the object. Maximum length is 256 characters.
lastModifiedDateTime	string (date-time)	The date and time when the object was created or last modified. (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])$)
status	string	The status of any asynchronous jobs runs on the object which can be upload or delete.
statusDetails	string	The status details of the upload/deleted operation of PKI (Public Key Infrastructure).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	certificate_based_auth_pki_id		Read the properties and relationships of a certificateBasedAuthPki object.
list	select			Get a list of the certificateBasedAuthPki objects and their properties.
insert	insert			Create a new certificateBasedAuthPki object.
update	update	certificate_based_auth_pki_id		Update the properties of a certificateBasedAuthPki object.
delete	delete	certificate_based_auth_pki_id	If-Match	Delete a certificateBasedAuthPki object.
upload	exec	certificate_based_auth_pki_id		Append additional certificate authority details to a certificateBasedAuthPki resource. Only one operation can run at a time and this operation can take up to 30 minutes to complete. To know whether another upload is in progress, call the Get certificateBasedAuthPki. The status property will have the value running.

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

SELECT examples

get

Read the properties and relationships of a certificateBasedAuthPki object.

SELECT
id,
certificateAuthorities,
deletedDateTime,
displayName,
lastModifiedDateTime,
status,
statusDetails
FROM entra_id.directory.public_key_infrastructure_certificate_based_auth_configurations
WHERE certificate_based_auth_pki_id = '{{ certificate_based_auth_pki_id }}' -- required
;

list

Get a list of the certificateBasedAuthPki objects and their properties.

SELECT
id,
certificateAuthorities,
deletedDateTime,
displayName,
lastModifiedDateTime,
status,
statusDetails
FROM entra_id.directory.public_key_infrastructure_certificate_based_auth_configurations
;

INSERT examples

insert

Create a new certificateBasedAuthPki object.

INSERT INTO entra_id.directory.public_key_infrastructure_certificate_based_auth_configurations (
id,
deletedDateTime,
displayName,
lastModifiedDateTime,
status,
statusDetails,
certificateAuthorities
)
SELECT 
'{{ id }}',
'{{ deletedDateTime }}',
'{{ displayName }}',
'{{ lastModifiedDateTime }}',
'{{ status }}',
'{{ statusDetails }}',
'{{ certificateAuthorities }}'
RETURNING
id,
certificateAuthorities,
deletedDateTime,
displayName,
lastModifiedDateTime,
status,
statusDetails
;

Manifest

# Description fields are for documentation purposes
- name: public_key_infrastructure_certificate_based_auth_configurations
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: deletedDateTime
    value: "{{ deletedDateTime }}"
    description: |
      Date and time when this object was deleted. Always null when the object hasn't been deleted.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The name of the object. Maximum length is 256 characters.
  - name: lastModifiedDateTime
    value: "{{ lastModifiedDateTime }}"
    description: |
      The date and time when the object was created or last modified.
  - name: status
    value: "{{ status }}"
    description: |
      The status of any asynchronous jobs runs on the object which can be upload or delete.
  - name: statusDetails
    value: "{{ statusDetails }}"
    description: |
      The status details of the upload/deleted operation of PKI (Public Key Infrastructure).
  - name: certificateAuthorities
    description: |
      The collection of certificate authorities contained in this public key infrastructure resource.
    value:
      - id: "{{ id }}"
        deletedDateTime: "{{ deletedDateTime }}"
        certificate: "{{ certificate }}"
        certificateAuthorityType: "{{ certificateAuthorityType }}"
        certificateRevocationListUrl: "{{ certificateRevocationListUrl }}"
        createdDateTime: "{{ createdDateTime }}"
        deltaCertificateRevocationListUrl: "{{ deltaCertificateRevocationListUrl }}"
        displayName: "{{ displayName }}"
        expirationDateTime: "{{ expirationDateTime }}"
        isIssuerHintEnabled: {{ isIssuerHintEnabled }}
        issuer: "{{ issuer }}"
        issuerSubjectKeyIdentifier: "{{ issuerSubjectKeyIdentifier }}"
        thumbprint: "{{ thumbprint }}"

UPDATE examples

update

Update the properties of a certificateBasedAuthPki object.

UPDATE entra_id.directory.public_key_infrastructure_certificate_based_auth_configurations
SET 
id = '{{ id }}',
deletedDateTime = '{{ deletedDateTime }}',
displayName = '{{ displayName }}',
lastModifiedDateTime = '{{ lastModifiedDateTime }}',
status = '{{ status }}',
statusDetails = '{{ statusDetails }}',
certificateAuthorities = '{{ certificateAuthorities }}'
WHERE 
certificate_based_auth_pki_id = '{{ certificate_based_auth_pki_id }}' --required
RETURNING
id,
certificateAuthorities,
deletedDateTime,
displayName,
lastModifiedDateTime,
status,
statusDetails;

DELETE examples

delete

Delete a certificateBasedAuthPki object.

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

Lifecycle Methods

upload

Append additional certificate authority details to a certificateBasedAuthPki resource. Only one operation can run at a time and this operation can take up to 30 minutes to complete. To know whether another upload is in progress, call the Get certificateBasedAuthPki. The status property will have the value running.

EXEC entra_id.directory.public_key_infrastructure_certificate_based_auth_configurations.upload 
@certificate_based_auth_pki_id='{{ certificate_based_auth_pki_id }}' --required 
@@json=
'{
"uploadUrl": "{{ uploadUrl }}", 
"sha256FileHash": "{{ sha256FileHash }}"
}'
;