Edit

Update windowsZtdnsConfiguration

Namespace: microsoft.graph

Important: Microsoft supports Intune /beta APIs, but they are subject to more frequent change. Microsoft recommends using version v1.0 when possible. Check an API's availability in version v1.0 using the Version selector.

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

Update the properties of a windowsZtdnsConfiguration object.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet
✅ ✅ ✅ ✅

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) DeviceManagementConfiguration.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application DeviceManagementConfiguration.ReadWrite.All

HTTP Request

PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId}
PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId}/groupAssignments/{deviceConfigurationGroupAssignmentId}/deviceConfiguration
PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations/{deviceConfigurationId}

Request headers

Header Value
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Accept application/json

Request body

In the request body, supply a JSON representation for the windowsZtdnsConfiguration object.

The following table shows the properties that are required when you create the windowsZtdnsConfiguration.

Property Type Description
id String Key of the entity. Inherited from deviceConfiguration
lastModifiedDateTime DateTimeOffset DateTime the object was last modified. Inherited from deviceConfiguration
roleScopeTagIds String collection List of Scope Tags for this Entity instance. Inherited from deviceConfiguration
supportsScopeTags Boolean Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. This property is read-only. Inherited from deviceConfiguration
deviceManagementApplicabilityRuleOsEdition deviceManagementApplicabilityRuleOsEdition The OS edition applicability for this Policy. Inherited from deviceConfiguration
deviceManagementApplicabilityRuleOsVersion deviceManagementApplicabilityRuleOsVersion The OS version applicability rule for this Policy. Inherited from deviceConfiguration
deviceManagementApplicabilityRuleDeviceMode deviceManagementApplicabilityRuleDeviceMode The device mode applicability rule for this Policy. Inherited from deviceConfiguration
createdDateTime DateTimeOffset DateTime the object was created. Inherited from deviceConfiguration
description String Admin provided description of the Device Configuration. Inherited from deviceConfiguration
displayName String Admin provided name of the device configuration. Inherited from deviceConfiguration
version Int32 Version of the device configuration. Inherited from deviceConfiguration
auditModeEnabled Boolean Indicates the audit operational mode. When true, unsecured traffic will be logged but not blocked. When false, unsecured DNS traffic will be blocked unless specifically exempted.
exemptionRules windowsZtdnsExemptionRule collection Exemptions to the ZTDNS rules, allowing access to specific addresses or subnets via unsecured lookup. This collection can contain a maximum of 500 elements.
extendedKeyUsagesForClientAuthentication extendedKeyUsage collection Extended key usage definitions for client authentication with secure DNS servers. This collection can contain a maximum of 500 elements.
hostsFileResolutionEnabled Boolean Indicates whether the DNS Client can resolve queries using the hosts file.
loopbackDnsForwarderEnabled Boolean Creates a localhost DNS server for securely forwarding plaintext queries to trusted DNS servers.
loopbackTrafficBlocked Boolean Indicates whether traffic to loopback addresses should be blocked.
maximumConnectionTimeInSeconds Int32 Maximum time in seconds for which connections to an IP address will be allowed after successful name resolution. Valid values 30 to 604800
secureDnsServers windowsZtdnsSecureDnsServer collection Collection of secure DNS servers used to resolve ZTDNS queries. Must contain at least one item. This collection can contain a maximum of 500 elements.

Response

If successful, this method returns a 200 OK response code and an updated windowsZtdnsConfiguration object in the response body.

Example

Request

Here is an example of the request.

PATCH https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations/{deviceConfigurationId}
Content-type: application/json
Content-length: 2331

{
  "@odata.type": "#microsoft.graph.windowsZtdnsConfiguration",
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ],
  "supportsScopeTags": true,
  "deviceManagementApplicabilityRuleOsEdition": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition",
    "osEditionTypes": [
      "windows10EnterpriseN"
    ],
    "name": "Name value",
    "ruleType": "exclude"
  },
  "deviceManagementApplicabilityRuleOsVersion": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion",
    "minOSVersion": "Min OSVersion value",
    "maxOSVersion": "Max OSVersion value",
    "name": "Name value",
    "ruleType": "exclude"
  },
  "deviceManagementApplicabilityRuleDeviceMode": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode",
    "deviceMode": "sModeConfiguration",
    "name": "Name value",
    "ruleType": "exclude"
  },
  "description": "Description value",
  "displayName": "Display Name value",
  "version": 7,
  "auditModeEnabled": true,
  "exemptionRules": [
    {
      "@odata.type": "microsoft.graph.windowsZtdnsExemptionRule",
      "description": "Description value",
      "displayName": "Display Name value",
      "ipAddresses": [
        "Ip Addresses value"
      ]
    }
  ],
  "extendedKeyUsagesForClientAuthentication": [
    {
      "@odata.type": "microsoft.graph.extendedKeyUsage",
      "name": "Name value",
      "objectIdentifier": "Object Identifier value"
    }
  ],
  "hostsFileResolutionEnabled": true,
  "loopbackDnsForwarderEnabled": true,
  "loopbackTrafficBlocked": true,
  "maximumConnectionTimeInSeconds": 14,
  "secureDnsServers": [
    {
      "@odata.type": "microsoft.graph.windowsZtdnsSecureDnsServer",
      "displayName": "Display Name value",
      "dnsOverHttpsConfiguration": {
        "@odata.type": "microsoft.graph.windowsZtdnsSecureDnsServerDnsOverHttpsConfiguration",
        "httpsPort": 9,
        "queryUrl": "https://example.com/queryUrl/"
      },
      "dnsOverTlsConfiguration": {
        "@odata.type": "microsoft.graph.windowsZtdnsSecureDnsServerDnsOverTlsConfiguration",
        "certificateSubjectName": "Certificate Subject Name value",
        "tlsPort": 7
      },
      "ipAddress": "Ip Address value"
    }
  ]
}

Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2503

{
  "@odata.type": "#microsoft.graph.windowsZtdnsConfiguration",
  "id": "2d6a5581-5581-2d6a-8155-6a2d81556a2d",
  "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ],
  "supportsScopeTags": true,
  "deviceManagementApplicabilityRuleOsEdition": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition",
    "osEditionTypes": [
      "windows10EnterpriseN"
    ],
    "name": "Name value",
    "ruleType": "exclude"
  },
  "deviceManagementApplicabilityRuleOsVersion": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion",
    "minOSVersion": "Min OSVersion value",
    "maxOSVersion": "Max OSVersion value",
    "name": "Name value",
    "ruleType": "exclude"
  },
  "deviceManagementApplicabilityRuleDeviceMode": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode",
    "deviceMode": "sModeConfiguration",
    "name": "Name value",
    "ruleType": "exclude"
  },
  "createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
  "description": "Description value",
  "displayName": "Display Name value",
  "version": 7,
  "auditModeEnabled": true,
  "exemptionRules": [
    {
      "@odata.type": "microsoft.graph.windowsZtdnsExemptionRule",
      "description": "Description value",
      "displayName": "Display Name value",
      "ipAddresses": [
        "Ip Addresses value"
      ]
    }
  ],
  "extendedKeyUsagesForClientAuthentication": [
    {
      "@odata.type": "microsoft.graph.extendedKeyUsage",
      "name": "Name value",
      "objectIdentifier": "Object Identifier value"
    }
  ],
  "hostsFileResolutionEnabled": true,
  "loopbackDnsForwarderEnabled": true,
  "loopbackTrafficBlocked": true,
  "maximumConnectionTimeInSeconds": 14,
  "secureDnsServers": [
    {
      "@odata.type": "microsoft.graph.windowsZtdnsSecureDnsServer",
      "displayName": "Display Name value",
      "dnsOverHttpsConfiguration": {
        "@odata.type": "microsoft.graph.windowsZtdnsSecureDnsServerDnsOverHttpsConfiguration",
        "httpsPort": 9,
        "queryUrl": "https://example.com/queryUrl/"
      },
      "dnsOverTlsConfiguration": {
        "@odata.type": "microsoft.graph.windowsZtdnsSecureDnsServerDnsOverTlsConfiguration",
        "certificateSubjectName": "Certificate Subject Name value",
        "tlsPort": 7
      },
      "ipAddress": "Ip Address value"
    }
  ]
}
  • Last updated on