Partager via


Mettre à jour macOSVpnConfiguration

Espace de noms: microsoft.graph

Important: Les API Microsoft Graph sous la version /beta sont susceptibles d’être modifiées ; l’utilisation de production n’est pas prise en charge.

Remarque : l’API Microsoft Graph pour Intune requiert une licence Intune active pour le client.

Mettez à jour les propriétés d’un objet macOSVpnConfiguration .

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.

Type d’autorisation Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)
Déléguée (compte professionnel ou scolaire) DeviceManagementConfiguration.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge.
Application DeviceManagementConfiguration.ReadWrite.All

Requête HTTP

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

En-têtes de demande

En-tête Valeur
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Accepter application/json

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON pour l’objet macOSVpnConfiguration .

Le tableau suivant présente les propriétés requises lorsque vous créez macOSVpnConfiguration.

Propriété Type Description
id String Clé de l’entité. Hérité de deviceConfiguration.
lastModifiedDateTime DateTimeOffset Date et heure de dernière modification de l’objet. Hérité de deviceConfiguration.
roleScopeTagIds String collection Liste des balises d’étendue pour cette instance d’entité. Hérité de deviceConfiguration.
supportsScopeTags Valeur booléenne Indique si la configuration d’appareil sous-jacente prend en charge l’attribution des balises d’étendue. L’attribution à la propriété ScopeTags n’est pas autorisée lorsque cette valeur est false et que les entités ne sont pas visibles par les utilisateurs délimités. Cela se produit pour les stratégies héritées créées dans Silverlight et peut être résolu en supprimant et en recréant la stratégie dans le portail Azure. Cette propriété est en lecture seule. Hérité de deviceConfiguration.
deviceManagementApplicabilityRuleOsEdition deviceManagementApplicabilityRuleOsEdition Applicabilité de l’édition du système d’exploitation pour cette stratégie. Hérité de deviceConfiguration.
deviceManagementApplicabilityRuleOsVersion deviceManagementApplicabilityRuleOsVersion Règle d’applicabilité de la version du système d’exploitation pour cette stratégie. Hérité de deviceConfiguration.
deviceManagementApplicabilityRuleDeviceMode deviceManagementApplicabilityRuleDeviceMode Règle d’applicabilité du mode appareil pour cette stratégie. Hérité de deviceConfiguration.
createdDateTime DateTimeOffset Date et heure de création de l’objet. Hérité de deviceConfiguration.
description String Description de la configuration de l’appareil fournie par l’administrateur. Hérité de deviceConfiguration.
displayName String Nom de la configuration de l’appareil fourni par l’administrateur. Hérité de deviceConfiguration.
version Int32 Version de la configuration de l’appareil. Hérité de deviceConfiguration.
connectionName Chaîne Nom de la connexion affiché à l’utilisateur. Héritée d’appleVpnConfiguration
connectionType appleVpnConnectionType Type de connexion. Hérité d’appleVpnConfiguration. Les valeurs possibles sont , pulseSecureciscoAnyConnect, f5EdgeClient, dellSonicWallMobileConnect, checkPointCapsuleVpn, customVpnciscoIPSec, citrix, ciscoAnyConnectV2, zscalerPrivateAccesspaloAltoGlobalProtectV2citrixSsoikEv2alwaysOnf5Access2018paloAltoGlobalProtect, , microsoftTunnel, . microsoftProtectnetMotionMobility
loginGroupOrDomain Chaîne Groupe ou domaine de connexion lorsque le type de connexion est défini sur Dell SonicWALL Mobile Connection. Héritée d’appleVpnConfiguration
role Chaîne Rôle lorsque le type de connexion est défini sur Pulse Secure. Héritée d’appleVpnConfiguration
Royaume Chaîne Domaine lorsque le type de connexion est défini sur Pulse Secure. Héritée d’appleVpnConfiguration
Serveur vpnServer Serveur VPN sur le réseau. Assurez-vous que les utilisateurs finaux peuvent accéder à cet emplacement réseau. Héritée d’appleVpnConfiguration
identifiant Chaîne Identificateur fourni par le fournisseur VPN lorsque le type de connexion est défini sur VPN personnalisé. Par exemple : Cisco AnyConnect utilise un identificateur au format com.cisco.anyconnect.applevpn.plugin Hérité d’appleVpnConfiguration
Customdata Collection keyValue Données personnalisées lorsque le type de connexion est défini sur VPN personnalisé. Utilisez ce champ pour activer les fonctionnalités non prises en charge par Intune, mais disponibles dans votre solution VPN. Contactez votre fournisseur VPN pour savoir comment ajouter ces paires clé/valeur. Cette collection peut contenir un maximum de 25 éléments. Héritée d’appleVpnConfiguration
customKeyValueData Collection keyValuePair Données personnalisées lorsque le type de connexion est défini sur VPN personnalisé. Utilisez ce champ pour activer les fonctionnalités non prises en charge par Intune, mais disponibles dans votre solution VPN. Contactez votre fournisseur VPN pour savoir comment ajouter ces paires clé/valeur. Cette collection peut contenir un maximum de 25 éléments. Héritée d’appleVpnConfiguration
enableSplitTunneling Valeur booléenne Envoyer tout le trafic réseau via UN VPN. Héritée d’appleVpnConfiguration
authenticationMethod vpnAuthenticationMethod Méthode d’authentification pour cette connexion VPN. Hérité d’appleVpnConfiguration. Les valeurs possibles sont les suivantes : certificate, usernameAndPassword, sharedSecret, derivedCredential, azureAD.
enablePerApp Valeur booléenne La définition de cette valeur sur true crée Per-App charge utile VPN qui peut être associée ultérieurement à des applications qui peuvent déclencher cette connexion VPN sur l’appareil iOS de l’utilisateur final. Héritée d’appleVpnConfiguration
safariDomains String collection Domaines Safari lorsque ce paramètre VPN par application est activé. En plus des applications associées à ce VPN, les domaines Safari spécifiés ici pourront également déclencher cette connexion VPN. Héritée d’appleVpnConfiguration
onDemandRules collection vpnOnDemandRule Règles à la demande. Cette collection peut contenir 500 éléments au maximum. Héritée d’appleVpnConfiguration
providerType vpnProviderType Type de fournisseur pour le VPN par application. Hérité d’appleVpnConfiguration. Les valeurs possibles sont notConfigured, appProxy et packetTunnel.
associatedDomains String collection Domaines associés hérités d’appleVpnConfiguration
excludedDomains String collection Domaines accessibles via l’Internet public au lieu d’un VPN, même lorsque le VPN par application est activé Hérité d’appleVpnConfiguration
disableOnDemandUserOverride Valeur booléenne Bascule pour empêcher l’utilisateur de désactiver le VPN automatique dans l’application Paramètres Héritée d’appleVpnConfiguration
disconnectOnIdle Valeur booléenne Indique s’il faut se déconnecter après l’inactivité de la connexion à la demande Héritée d’appleVpnConfiguration
disconnectOnIdleTimerInSeconds Int32 Durée d’attente en secondes avant de déconnecter une connexion à la demande. Valeurs valides 0 à 65535 Héritées d’appleVpnConfiguration
Proxyserver vpnProxyServer Serveur proxy. Héritée d’appleVpnConfiguration
optInToDeviceIdSharing Valeur booléenne Opt-In de partager l’ID de l’appareil avec des clients VPN tiers à utiliser lors de la validation du contrôle d’accès réseau. Héritée d’appleVpnConfiguration

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et un objet macOSVpnConfiguration mis à jour dans le corps de la réponse.

Exemple

Demande

Voici un exemple de demande.

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

{
  "@odata.type": "#microsoft.graph.macOSVpnConfiguration",
  "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,
  "connectionName": "Connection Name value",
  "connectionType": "pulseSecure",
  "loginGroupOrDomain": "Login Group Or Domain value",
  "role": "Role value",
  "realm": "Realm value",
  "server": {
    "@odata.type": "microsoft.graph.vpnServer",
    "description": "Description value",
    "address": "Address value",
    "isDefaultServer": true
  },
  "identifier": "Identifier value",
  "customData": [
    {
      "@odata.type": "microsoft.graph.keyValue",
      "key": "Key value",
      "value": "Value value"
    }
  ],
  "customKeyValueData": [
    {
      "@odata.type": "microsoft.graph.keyValuePair",
      "name": "Name value",
      "value": "Value value"
    }
  ],
  "enableSplitTunneling": true,
  "authenticationMethod": "usernameAndPassword",
  "enablePerApp": true,
  "safariDomains": [
    "Safari Domains value"
  ],
  "onDemandRules": [
    {
      "@odata.type": "microsoft.graph.vpnOnDemandRule",
      "ssids": [
        "Ssids value"
      ],
      "dnsSearchDomains": [
        "Dns Search Domains value"
      ],
      "probeUrl": "https://example.com/probeUrl/",
      "action": "evaluateConnection",
      "domainAction": "neverConnect",
      "domains": [
        "Domains value"
      ],
      "probeRequiredUrl": "https://example.com/probeRequiredUrl/",
      "interfaceTypeMatch": "ethernet",
      "dnsServerAddressMatch": [
        "Dns Server Address Match value"
      ]
    }
  ],
  "providerType": "appProxy",
  "associatedDomains": [
    "Associated Domains value"
  ],
  "excludedDomains": [
    "Excluded Domains value"
  ],
  "disableOnDemandUserOverride": true,
  "disconnectOnIdle": true,
  "disconnectOnIdleTimerInSeconds": 14,
  "proxyServer": {
    "@odata.type": "microsoft.graph.vpnProxyServer",
    "automaticConfigurationScriptUrl": "https://example.com/automaticConfigurationScriptUrl/",
    "address": "Address value",
    "port": 4
  },
  "optInToDeviceIdSharing": true
}

Réponse

Voici un exemple de réponse. Remarque : l’objet de réponse illustré ici peut être tronqué à des fins de concision. Toutes les propriétés sont renvoyées à partir d’un appel réel.

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

{
  "@odata.type": "#microsoft.graph.macOSVpnConfiguration",
  "id": "8ce00178-0178-8ce0-7801-e08c7801e08c",
  "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,
  "connectionName": "Connection Name value",
  "connectionType": "pulseSecure",
  "loginGroupOrDomain": "Login Group Or Domain value",
  "role": "Role value",
  "realm": "Realm value",
  "server": {
    "@odata.type": "microsoft.graph.vpnServer",
    "description": "Description value",
    "address": "Address value",
    "isDefaultServer": true
  },
  "identifier": "Identifier value",
  "customData": [
    {
      "@odata.type": "microsoft.graph.keyValue",
      "key": "Key value",
      "value": "Value value"
    }
  ],
  "customKeyValueData": [
    {
      "@odata.type": "microsoft.graph.keyValuePair",
      "name": "Name value",
      "value": "Value value"
    }
  ],
  "enableSplitTunneling": true,
  "authenticationMethod": "usernameAndPassword",
  "enablePerApp": true,
  "safariDomains": [
    "Safari Domains value"
  ],
  "onDemandRules": [
    {
      "@odata.type": "microsoft.graph.vpnOnDemandRule",
      "ssids": [
        "Ssids value"
      ],
      "dnsSearchDomains": [
        "Dns Search Domains value"
      ],
      "probeUrl": "https://example.com/probeUrl/",
      "action": "evaluateConnection",
      "domainAction": "neverConnect",
      "domains": [
        "Domains value"
      ],
      "probeRequiredUrl": "https://example.com/probeRequiredUrl/",
      "interfaceTypeMatch": "ethernet",
      "dnsServerAddressMatch": [
        "Dns Server Address Match value"
      ]
    }
  ],
  "providerType": "appProxy",
  "associatedDomains": [
    "Associated Domains value"
  ],
  "excludedDomains": [
    "Excluded Domains value"
  ],
  "disableOnDemandUserOverride": true,
  "disconnectOnIdle": true,
  "disconnectOnIdleTimerInSeconds": 14,
  "proxyServer": {
    "@odata.type": "microsoft.graph.vpnProxyServer",
    "automaticConfigurationScriptUrl": "https://example.com/automaticConfigurationScriptUrl/",
    "address": "Address value",
    "port": 4
  },
  "optInToDeviceIdSharing": true
}