service_configuration_records

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

Overview

Name	service_configuration_records
Type	Resource
Id	entra_id.domains.service_configuration_records

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.
isOptional	boolean	If false, the customer must configure this record at the DNS host for Microsoft Online Services to operate correctly with the domain.
label	string	Value used when configuring the name of the DNS record at the DNS host.
recordType	string	Indicates what type of DNS record this entity represents. The value can be CName, Mx, Srv, or Txt.
supportedService	string	Microsoft Online Service or feature that has a dependency on this DNS record. Can be one of the following values: null, Email, Sharepoint, EmailInternalRelayOnly, OfficeCommunicationsOnline, SharePointDefaultDomain, FullRedelegation, SharePointPublic, OrgIdAuthentication, Yammer, Intune.
ttl	number (int32)	Value to use when configuring the time-to-live (ttl) property of the DNS record at the DNS host. Not nullable.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
isOptional	boolean	If false, the customer must configure this record at the DNS host for Microsoft Online Services to operate correctly with the domain.
label	string	Value used when configuring the name of the DNS record at the DNS host.
recordType	string	Indicates what type of DNS record this entity represents. The value can be CName, Mx, Srv, or Txt.
supportedService	string	Microsoft Online Service or feature that has a dependency on this DNS record. Can be one of the following values: null, Email, Sharepoint, EmailInternalRelayOnly, OfficeCommunicationsOnline, SharePointDefaultDomain, FullRedelegation, SharePointPublic, OrgIdAuthentication, Yammer, Intune.
ttl	number (int32)	Value to use when configuring the time-to-live (ttl) property of the DNS record at the DNS host. Not nullable.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain_id, domain_dns_record_id		DNS records the customer adds to the DNS zone file of the domain before the domain can be used by Microsoft Online services. Read-only, Nullable. Doesn't support $expand.
list	select	domain_id		Retrieves a list of domainDnsRecord objects needed to enable services for the domain. Use the returned list to add records to the zone file of the domain. This can be done through the domain registrar or DNS server configuration.
insert	insert	domain_id
update	update	domain_id, domain_dns_record_id
delete	delete	domain_id, domain_dns_record_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
domain_dns_record_id	string	The unique identifier of domainDnsRecord
domain_id	string	The unique identifier of domain
If-Match	string	ETag

SELECT examples

get

DNS records the customer adds to the DNS zone file of the domain before the domain can be used by Microsoft Online services. Read-only, Nullable. Doesn't support $expand.

SELECT
id,
isOptional,
label,
recordType,
supportedService,
ttl
FROM entra_id.domains.service_configuration_records
WHERE domain_id = '{{ domain_id }}' -- required
AND domain_dns_record_id = '{{ domain_dns_record_id }}' -- required
;

list

Retrieves a list of domainDnsRecord objects needed to enable services for the domain. Use the returned list to add records to the zone file of the domain. This can be done through the domain registrar or DNS server configuration.

SELECT
id,
isOptional,
label,
recordType,
supportedService,
ttl
FROM entra_id.domains.service_configuration_records
WHERE domain_id = '{{ domain_id }}' -- required
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.domains.service_configuration_records (
id,
isOptional,
label,
recordType,
supportedService,
ttl,
domain_id
)
SELECT 
'{{ id }}',
{{ isOptional }},
'{{ label }}',
'{{ recordType }}',
'{{ supportedService }}',
{{ ttl }},
'{{ domain_id }}'
RETURNING
id,
isOptional,
label,
recordType,
supportedService,
ttl
;

Manifest

# Description fields are for documentation purposes
- name: service_configuration_records
props:
  - name: domain_id
    value: "{{ domain_id }}"
    description: Required parameter for the service_configuration_records resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: isOptional
    value: {{ isOptional }}
    description: |
      If false, the customer must configure this record at the DNS host for Microsoft Online Services to operate correctly with the domain.
  - name: label
    value: "{{ label }}"
    description: |
      Value used when configuring the name of the DNS record at the DNS host.
  - name: recordType
    value: "{{ recordType }}"
    description: |
      Indicates what type of DNS record this entity represents. The value can be CName, Mx, Srv, or Txt.
  - name: supportedService
    value: "{{ supportedService }}"
    description: |
      Microsoft Online Service or feature that has a dependency on this DNS record. Can be one of the following values: null, Email, Sharepoint, EmailInternalRelayOnly, OfficeCommunicationsOnline, SharePointDefaultDomain, FullRedelegation, SharePointPublic, OrgIdAuthentication, Yammer, Intune.
  - name: ttl
    value: {{ ttl }}
    description: |
      Value to use when configuring the time-to-live (ttl) property of the DNS record at the DNS host. Not nullable.

UPDATE examples

update

No description available.

UPDATE entra_id.domains.service_configuration_records
SET 
id = '{{ id }}',
isOptional = {{ isOptional }},
label = '{{ label }}',
recordType = '{{ recordType }}',
supportedService = '{{ supportedService }}',
ttl = {{ ttl }}
WHERE 
domain_id = '{{ domain_id }}' --required
AND domain_dns_record_id = '{{ domain_dns_record_id }}' --required
RETURNING
id,
isOptional,
label,
recordType,
supportedService,
ttl;

DELETE examples

delete

No description available.

DELETE FROM entra_id.domains.service_configuration_records
WHERE domain_id = '{{ domain_id }}' --required
AND domain_dns_record_id = '{{ domain_dns_record_id }}' --required
AND If-Match = '{{ If-Match }}'
;