Compartir a través de

Actualizar macOSVpnConfiguration

  • Artículo

Espacio de nombres: microsoft.graph

Importante: Las API de Microsoft Graph en la versión /beta están sujetas a cambios; no se admite el uso de producción.

Nota: la API de Microsoft Graph para Intune requiere una licencia activa de Intune para el espacio empresarial.

Actualice las propiedades de un objeto macOSVpnConfiguration .

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet
✅ ✅ ✅ ✅

Permisos

Se requiere uno de los siguientes permisos para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, vea Permisos.

Tipo de permiso Permisos (de menos a más privilegiados)
Delegado (cuenta profesional o educativa) DeviceManagementConfiguration.ReadWrite.All
Delegado (cuenta personal de Microsoft) No admitida.
Aplicación DeviceManagementConfiguration.ReadWrite.All

Solicitud HTTP

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

Encabezados de solicitud

Encabezado Valor
Authorization {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Aceptar application/json

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una representación JSON para el objeto macOSVpnConfiguration .

En la tabla siguiente se muestran las propiedades necesarias al crear macOSVpnConfiguration.

Propiedad Tipo Descripción
id Cadena Clave de la entidad. Heredado de deviceConfiguration
lastModifiedDateTime DateTimeOffset Fecha y hora en la que se modificó el objeto por última vez. Heredado de deviceConfiguration
roleScopeTagIds Colección string Lista de etiquetas de ámbito para esta instancia de entity. Heredado de deviceConfiguration
supportsScopeTags Booleano Indica si la configuración de dispositivo subyacente admite o no la asignación de etiquetas de ámbito. No se permite asignar a la propiedad ScopeTags cuando este valor es false y las entidades no serán visibles para los usuarios con ámbito. Esto ocurre para las directivas heredadas creadas en Silverlight y se pueden resolver mediante la eliminación y la recreación de la directiva en Azure Portal. Esta propiedad es de sólo lectura. Heredado de deviceConfiguration
deviceManagementApplicabilityRuleOsEdition deviceManagementApplicabilityRuleOsEdition Aplicabilidad de la edición del sistema operativo para esta directiva. Heredado de deviceConfiguration
deviceManagementApplicabilityRuleOsVersion deviceManagementApplicabilityRuleOsVersion Regla de aplicabilidad de la versión del sistema operativo para esta directiva. Heredado de deviceConfiguration
deviceManagementApplicabilityRuleDeviceMode deviceManagementApplicabilityRuleDeviceMode Regla de aplicabilidad del modo de dispositivo para esta directiva. Heredado de deviceConfiguration
createdDateTime DateTimeOffset Fecha y hora en la que se creó el objeto. Heredado de deviceConfiguration
description Cadena Descripción proporcionada por el administrador de la configuración del dispositivo. Heredado de deviceConfiguration
displayName Cadena Nombre proporcionado por el administrador de la configuración del dispositivo. Heredado de deviceConfiguration
version Int32 Versión de la configuración del dispositivo. Heredado de deviceConfiguration
Connectionname Cadena Nombre de conexión mostrado al usuario. Heredado de appleVpnConfiguration
connectionType appleVpnConnectionType Tipo de conexión. Se hereda de appleVpnConfiguration. Los valores posibles son: ciscoAnyConnect, pulseSecure, f5EdgeClient, dellSonicWallMobileConnect, checkPointCapsuleVpn, customVpn, ciscoIPSec, citrix, ciscoAnyConnectV2, paloAltoGlobalProtect, , zscalerPrivateAccess, f5Access2018, citrixSso, paloAltoGlobalProtectV2, ikEv2, alwaysOn, , microsoftTunnel, netMotionMobility, microsoftProtect.
loginGroupOrDomain Cadena Grupo o dominio de inicio de sesión cuando el tipo de conexión está establecido en Dell SonicWALL Mobile Connection. Heredado de appleVpnConfiguration
role Cadena Rol cuando el tipo de conexión está establecido en Pulse Secure. Heredado de appleVpnConfiguration
Reino Cadena Dominio cuando el tipo de conexión está establecido en Pulse Secure. Heredado de appleVpnConfiguration
Servidor vpnServer SERVIDOR VPN en la red. Asegúrese de que los usuarios finales puedan acceder a esta ubicación de red. Heredado de appleVpnConfiguration
identificador Cadena Identificador proporcionado por el proveedor de VPN cuando el tipo de conexión se establece en VPN personalizada. Por ejemplo: Cisco AnyConnect utiliza un identificador del formulario com.cisco.anyconnect.applevpn.plugin heredado de appleVpnConfiguration
customData Colección keyvalue Datos personalizados cuando el tipo de conexión se establece en VPN personalizada. Use este campo para habilitar la funcionalidad no admitida por Intune, pero disponible en la solución VPN. Póngase en contacto con el proveedor de VPN para obtener información sobre cómo agregar estos pares clave-valor. Esta colección puede contener un máximo de 25 elementos. Heredado de appleVpnConfiguration
customKeyValueData Colección keyValuePair Datos personalizados cuando el tipo de conexión se establece en VPN personalizada. Use este campo para habilitar la funcionalidad no admitida por Intune, pero disponible en la solución VPN. Póngase en contacto con el proveedor de VPN para obtener información sobre cómo agregar estos pares clave-valor. Esta colección puede contener un máximo de 25 elementos. Heredado de appleVpnConfiguration
enableSplitTunneling Booleano Envíe todo el tráfico de red a través de VPN. Heredado de appleVpnConfiguration
authenticationMethod vpnAuthenticationMethod Método de autenticación para esta conexión VPN. Se hereda de appleVpnConfiguration. Los valores posibles son: certificate, usernameAndPassword, sharedSecret, derivedCredential y azureAD.
enablePerApp Booleano Si se establece en true, se crea Per-App carga de VPN que más adelante se puede asociar a aplicaciones que pueden desencadenar esta conneciton VPN en el dispositivo iOS del usuario final. Heredado de appleVpnConfiguration
safariDomains Colección string Dominios de Safari cuando esta configuración de VPN por aplicación está habilitada. Además de las aplicaciones asociadas a esta VPN, los dominios safari especificados aquí también podrán desencadenar esta conexión VPN. Heredado de appleVpnConfiguration
onDemandRules colección vpnOnDemandRule Reglas a petición. Esta colección puede contener un máximo de 500 elementos. Heredado de appleVpnConfiguration
providerType vpnProviderType Tipo de proveedor para VPN por aplicación. Se hereda de appleVpnConfiguration. Los valores posibles son: notConfigured, appProxy y packetTunnel.
associatedDomains Colección string Dominios asociados heredados de appleVpnConfiguration
excludedDomains Colección string Dominios a los que se accede a través de internet público en lugar de a través de VPN, incluso cuando la VPN por aplicación se activa Heredada de appleVpnConfiguration
disableOnDemandUserOverride Booleano Alternar para evitar que el usuario deshabilite la VPN automática en la aplicación Configuración heredada de appleVpnConfiguration
disconnectOnIdle Booleano Si se debe desconectar después de inactividades de conexión a petición heredadas de appleVpnConfiguration
disconnectOnIdleTimerInSeconds Int32 Tiempo de espera en segundos antes de desconectar una conexión a petición. Valores válidos de 0 a 65535 heredados de appleVpnConfiguration
proxyServer vpnProxyServer Servidor proxy. Heredado de appleVpnConfiguration
optInToDeviceIdSharing Booleano Opt-In compartir el identificador del dispositivo con clientes vpn de terceros para usarlos durante la validación del control de acceso de red. Heredado de appleVpnConfiguration

Respuesta

Si se ejecuta correctamente, este método devuelve un 200 OK código de respuesta y un objeto macOSVpnConfiguration actualizado en el cuerpo de la respuesta.

Ejemplo

Solicitud

Aquí tiene un ejemplo de la solicitud.

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
}

Respuesta

Aquí tiene un ejemplo de la respuesta. Nota: Es posible que el objeto de respuesta que aparezca aquí esté truncado para abreviar. Todas las propiedades se devolverán desde una llamada real.

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
}