| title | domainDnsCnameRecord resource type |
|---|---|
| description | Represents a CNAME record added to the DNS zone file of a particular domain in the tenant. |
| author | tafra00 |
| ms.localizationpriority | medium |
| ms.subservice | entra-directory-management |
| doc_type | resourcePageType |
| ms.date | 04/25/2024 |
Namespace: microsoft.graph
[!INCLUDE beta-disclaimer]
Represents a CNAME record added to the DNS zone file of a particular domain in the tenant. Inherited from DomainDnsRecord entity.
Direct queries to this resource aren't supported. See the domain article for information on how to query for domain service records.
| Property | Type | Description |
|---|---|---|
| canonicalName | String | The canonical name of the CNAME record. Used to configure the CNAME record at the DNS host. |
| id | String | Unique identifier assigned to this entity. Not nullable, Read-only |
| isOptional | Boolean | If false, the CNAME record must be configured by the customer at the DNS host for Microsoft Online Services to operate correctly with the domain. Not nullable |
| label | String | Value used when configuring the alias/host/name of the CNAME record at the DNS host. |
| recordType | String | Type of DNS record. The value is always CName. Key |
| supportedService | String | Microsoft Online Service or feature that has a dependency on this CNAME record. Can be one of the following values: null, Email, Sharepoint, EmailInternalRelayOnly, OfficeCommunicationsOnline, SharePointDefaultDomain, FullRedelegation, SharePointPublic, OrgIdAuthentication, Yammer, Intune |
| ttl | Int32 | Value to use when configuring the time-to-live (ttl) property of the CNAME record at the DNS host. Not nullable |
None
The following JSON representation shows the resource type.
{
"canonicalName": "String",
"id": "String (identifier)",
"isOptional": true,
"label": "String",
"recordType": "String",
"supportedService": "String",
"ttl": 1024
}