macOSVpnConfiguration erstellen

Artikel
11/22/2024

Namespace: microsoft.graph

Wichtig: Microsoft Graph-APIs unter der /beta-Version können sich ändern. Die Verwendung in der Produktion wird nicht unterstützt.

Hinweis: Die Microsoft Graph-API für Intune setzt eine aktive Intune-Lizenz für den Mandanten voraus.

Erstellen Sie ein neues macOSVpnConfiguration-Objekt .

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service	US Government L4	US Government L5 (DOD)	China, betrieben von 21Vianet
✅	✅	✅	✅

Berechtigungen

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie unter Berechtigungen.

Berechtigungstyp	Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)
Delegiert (Geschäfts-, Schul- oder Unikonto)	DeviceManagementConfiguration.ReadWrite.All
Delegiert (persönliches Microsoft-Konto)	Nicht unterstützt
Anwendung	DeviceManagementConfiguration.ReadWrite.All

HTTP-Anforderung

POST /deviceManagement/deviceConfigurations
POST /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations

Anforderungsheader

Kopfzeile	Wert
Authorization	Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Annehmen	application/json

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung für das objekt macOSVpnConfiguration an.

In der folgenden Tabelle sind die Eigenschaften aufgeführt, die beim Erstellen der macOSVpnConfiguration erforderlich sind.

Eigenschaft	Typ	Beschreibung
id	String	Schlüssel der Entität Geerbt von deviceConfiguration.
lastModifiedDateTime	DateTimeOffset	Datum und Uhrzeit der letzten Änderung des Objekts. Geerbt von deviceConfiguration.
roleScopeTagIds	String collection	Liste der Bereichstags für diese entitätsbezogene instance. Geerbt von deviceConfiguration.
supportsScopeTags	Boolesch	Gibt an, ob die zugrunde liegende Gerätekonfiguration die Zuweisung von Bereichstags unterstützt. Die Zuweisung zur ScopeTags-Eigenschaft ist nicht zulässig, wenn dieser Wert false ist und Entitäten für bereichsbezogene Benutzer nicht sichtbar sind. Dies tritt bei legacy-Richtlinien auf, die in Silverlight erstellt wurden, und kann durch Löschen und Erneutes Erstellen der Richtlinie im Azure-Portal aufgelöst werden. Diese Eigenschaft ist schreibgeschützt. Geerbt von deviceConfiguration.
deviceManagementApplicabilityRuleOsEdition	deviceManagementApplicabilityRuleOsEdition	Die Anwendbarkeit der Betriebssystemedition für diese Richtlinie. Geerbt von deviceConfiguration.
deviceManagementApplicabilityRuleOsVersion	deviceManagementApplicabilityRuleOsVersion	Die Anwendbarkeitsregel der Betriebssystemversion für diese Richtlinie. Geerbt von deviceConfiguration.
deviceManagementApplicabilityRuleDeviceMode	deviceManagementApplicabilityRuleDeviceMode	Die Anwendbarkeitsregel für den Gerätemodus für diese Richtlinie. Geerbt von deviceConfiguration.
createdDateTime	DateTimeOffset	Datum und Uhrzeit der Erstellung des Objekts. Geerbt von deviceConfiguration.
description	String	Beschreibung der Gerätekonfiguration (vom Administrator festgelegt). Geerbt von deviceConfiguration.
displayName	String	Name der Gerätekonfiguration (vom Administrator festgelegt). Geerbt von deviceConfiguration.
Version	Int32	Version der Gerätekonfiguration. Geerbt von deviceConfiguration.
connectionName	String	Verbindungsname, der dem Benutzer angezeigt wird. Geerbt von appleVpnConfiguration
connectionType	appleVpnConnectionType	Verbindungsart. Geerbt von appleVpnConfiguration. Mögliche Werte sind: `ciscoAnyConnect`, `pulseSecure`, `f5EdgeClient`, `dellSonicWallMobileConnect`, `checkPointCapsuleVpn`, , `customVpn`, `ciscoIPSec`, `ciscoAnyConnectV2citrix`, `paloAltoGlobalProtectzscalerPrivateAccesspaloAltoGlobalProtectV2f5Access2018citrixSso`, `ikEv2`, . `alwaysOnmicrosoftTunnelnetMotionMobilitymicrosoftProtect`
loginGroupOrDomain	String	Anmeldegruppe oder Domäne, wenn der Verbindungstyp auf Dell SonicWALL Mobile Connection festgelegt ist. Geerbt von appleVpnConfiguration
role	String	Rolle, wenn der Verbindungstyp auf Pulse Secure festgelegt ist. Geerbt von appleVpnConfiguration
Reich	String	Bereich, wenn der Verbindungstyp auf Pulse Secure festgelegt ist. Geerbt von appleVpnConfiguration
Server	vpnServer	VPN-Server im Netzwerk. Stellen Sie sicher, dass Endbenutzer auf diesen Netzwerkspeicherort zugreifen können. Geerbt von appleVpnConfiguration
Bezeichner	String	Vom VPN-Anbieter bereitgestellter Bezeichner, wenn der Verbindungstyp auf Benutzerdefiniertes VPN festgelegt ist. Beispiel: Cisco AnyConnect verwendet einen Bezeichner im Format com.cisco.anyconnect.applevpn.plugin Geerbt von appleVpnConfiguration
customData	keyValue-Sammlung	Benutzerdefinierte Daten, wenn der Verbindungstyp auf Benutzerdefiniertes VPN festgelegt ist. Verwenden Sie dieses Feld, um Funktionen zu aktivieren, die von Intune nicht unterstützt werden, aber in Ihrer VPN-Lösung verfügbar sind. Wenden Sie sich an Ihren VPN-Anbieter, um zu erfahren, wie Sie diese Schlüssel-Wert-Paare hinzufügen. Diese Auflistung kann maximal 25 Elemente enthalten. Geerbt von appleVpnConfiguration
customKeyValueData	keyValuePair-Sammlung	Benutzerdefinierte Daten, wenn der Verbindungstyp auf Benutzerdefiniertes VPN festgelegt ist. Verwenden Sie dieses Feld, um Funktionen zu aktivieren, die von Intune nicht unterstützt werden, aber in Ihrer VPN-Lösung verfügbar sind. Wenden Sie sich an Ihren VPN-Anbieter, um zu erfahren, wie Sie diese Schlüssel-Wert-Paare hinzufügen. Diese Auflistung kann maximal 25 Elemente enthalten. Geerbt von appleVpnConfiguration
enableSplitTunneling	Boolesch	Senden Sie den gesamten Netzwerkdatenverkehr über VPN. Geerbt von appleVpnConfiguration
authenticationMethod	vpnAuthenticationMethod	Authentifizierungsmethode für diese VPN-Verbindung. Geerbt von appleVpnConfiguration. Mögliche Werte: `certificate`, `usernameAndPassword`, `sharedSecret`, `derivedCredential`, `azureAD`.
enablePerApp	Boolesch	Wenn Sie dies auf true festlegen, wird Per-App VPN-Nutzlast erstellt, die später Apps zugeordnet werden kann, die diese VPN-Verbindung auf dem iOS-Gerät des Endbenutzers auslösen können. Geerbt von appleVpnConfiguration
safariDomains	String collection	Safari-Domänen, wenn diese Vpn-pro-App-Einstellung aktiviert ist. Zusätzlich zu den Apps, die diesem VPN zugeordnet sind, können auch safari-Domänen, die hier angegeben sind, diese VPN-Verbindung auslösen. Geerbt von appleVpnConfiguration
onDemandRules	vpnOnDemandRule-Sammlung	On-Demand-Regeln. Diese Sammlung darf maximal 500 Elemente enthalten. Geerbt von appleVpnConfiguration
providerType	vpnProviderType	Anbietertyp für pro App-VPN. Geerbt von appleVpnConfiguration. Mögliche Werte sind: `notConfigured`, `appProxy` und `packetTunnel`.
associatedDomains	String collection	Zugeordnete Domänen, die von appleVpnConfiguration geerbt wurden
excludedDomains	String collection	Domänen, auf die über das öffentliche Internet statt über VPN zugegriffen wird, auch wenn pro App-VPN aktiviert ist Geerbt von appleVpnConfiguration
disableOnDemandUserOverride	Boolesch	Um zu verhindern, dass Benutzer automatisches VPN in der Einstellungs-App geerbt von appleVpnConfiguration deaktivieren
disconnectOnIdle	Boolesch	Ob die Verbindung nach bedarfsgesteuerten Verbindungs-Idles getrennt werden soll, die von appleVpnConfiguration geerbt wurden
disconnectOnIdleTimerInSeconds	Int32	Die Zeitspanne in Sekunden, die vor dem Trennen einer bedarfsgesteuerten Verbindung gewartet werden soll. Gültige Werte 0 bis 65535 Geerbt von appleVpnConfiguration
proxyServer	vpnProxyServer	Proxyserver. Geerbt von appleVpnConfiguration
optInToDeviceIdSharing	Boolesch	Opt-In zur Freigabe der Geräte-ID für VPN-Clients von Drittanbietern zur Verwendung während der Überprüfung der Netzwerkzugriffssteuerung. Geerbt von appleVpnConfiguration
deploymentChannel	appleDeploymentChannel	Gibt den Bereitstellungskanaltyp an, der zum Bereitstellen des Konfigurationsprofils verwendet wird. Mögliche Werte sind deviceChannel, userChannel. Mögliche Werte sind: `deviceChannel`, `userChannel` und `unknownFutureValue`.

Antwort

Bei erfolgreicher Ausführung gibt die Methode den 201 Created Antwortcode und ein macOSVpnConfiguration-Objekt im Antworttext zurück.

Beispiel

Anforderung

Nachfolgend sehen Sie ein Beispiel der Anforderung.

POST https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations
Content-type: application/json
Content-length: 3061

{
  "@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,
  "deploymentChannel": "userChannel"
}

Antwort

Nachfolgend sehen Sie ein Beispiel der Antwort. Hinweis: Das hier gezeigte Antwortobjekt ist möglicherweise aus Platzgründen abgeschnitten. Von einem tatsächlichen Aufruf werden alle Eigenschaften zurückgegeben.

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 3233

{
  "@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,
  "deploymentChannel": "userChannel"
}

Freigeben über

macOSVpnConfiguration erstellen

Berechtigungen

HTTP-Anforderung

Anforderungsheader

Anforderungstext

Antwort

Beispiel

Anforderung

Antwort

Feedback

Zusätzliche Ressourcen