Criar macOSVpnConfiguration

Artigo
07/03/2024

Namespace: microsoft.graph

Importante: As APIs do Microsoft Graph na versão /beta estão sujeitas a alterações; a utilização de produção não é suportada.

Observação: A API do Microsoft Graph para Intune requer uma licença ativa do Intune para o locatário.

Crie um novo objeto macOSVpnConfiguration .

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global	US Government L4	US Government L5 (DOD)	China operada pela 21Vianet
✅	✅	✅	✅

Permissões

Uma das seguintes permissões é necessária para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão	Permissões (da com menos para a com mais privilégios)
Delegado (conta corporativa ou de estudante)	DeviceManagementConfiguration.ReadWrite.All
Delegado (conta pessoal da Microsoft)	Sem suporte.
Application	DeviceManagementConfiguration.ReadWrite.All

Solicitação HTTP

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

Cabeçalhos de solicitação

Cabeçalho	Valor
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Aceitar	application/json

Corpo da solicitação

No corpo do pedido, forneça uma representação JSON para o objeto macOSVpnConfiguration.

A tabela seguinte mostra as propriedades necessárias quando cria o macOSVpnConfiguration.

Propriedade	Tipo	Descrição
id	String	Chave da entidade. Herdada de deviceConfiguration
lastModifiedDateTime	DateTimeOffset	DateTime da última modificação do objeto. Herdada de deviceConfiguration
roleScopeTagIds	Coleção de cadeias de caracteres	Lista de Etiquetas de Âmbito para esta Instância de entidade. Herdada de deviceConfiguration
supportsScopeTags	Booliano	Indica se a Configuração do Dispositivo subjacente suporta ou não a atribuição de etiquetas de âmbito. A atribuição à propriedade ScopeTags não é permitida quando este valor é falso e as entidades não serão visíveis para os utilizadores no âmbito. Isto ocorre em políticas legadas criadas no Silverlight e pode ser resolvida ao eliminar e recriar a política no Portal do Azure. Essa propriedade é somente leitura. Herdada de deviceConfiguration
deviceManagementApplicabilityRuleOsEdition	deviceManagementApplicabilityRuleOsEdition	A aplicabilidade da edição do SO para esta Política. Herdada de deviceConfiguration
deviceManagementApplicabilityRuleOsVersion	deviceManagementApplicabilityRuleOsVersion	A regra de aplicabilidade da versão do SO para esta Política. Herdada de deviceConfiguration
deviceManagementApplicabilityRuleDeviceMode	deviceManagementApplicabilityRuleDeviceMode	A regra de aplicabilidade do modo de dispositivo para esta Política. Herdada de deviceConfiguration
createdDateTime	DateTimeOffset	DateTime em que o objeto foi criado. Herdada de deviceConfiguration
description	String	O administrador forneceu a descrição da Configuração do dispositivo. Herdada de deviceConfiguration
displayName	String	O administrador forneceu o nome da Configuração do dispositivo. Herdada de deviceConfiguration
versão	Int32	Versão da configuração do dispositivo. Herdada de deviceConfiguration
connectionName	Cadeia de caracteres	Nome da ligação apresentado ao utilizador. Herdado de appleVpnConfiguration
connectionType	appleVpnConnectionType	Tipo de ligação. Herdado de appleVpnConfiguration. Os valores possíveis são: `ciscoAnyConnect`, , `pulseSecure`, `dellSonicWallMobileConnectf5EdgeClient`, `checkPointCapsuleVpn`, `customVpn`, `ciscoIPSec`, `citrix`, `ciscoAnyConnectV2`, `paloAltoGlobalProtect`, `zscalerPrivateAccess`, , `f5Access2018`, `citrixSso`, , `paloAltoGlobalProtectV2`, `ikEv2`, `alwaysOn`, `microsoftTunnel`, `netMotionMobilitymicrosoftProtect`.
loginGroupOrDomain	Cadeia de caracteres	Grupo ou domínio de início de sessão quando o tipo de ligação está definido como Dell SonicWALL Mobile Connection. Herdado de appleVpnConfiguration
role	Cadeia de caracteres	Função quando o tipo de ligação está definido como Pulse Secure. Herdado de appleVpnConfiguration
realm	Cadeia de caracteres	Realm quando o tipo de ligação está definido como Pulse Secure. Herdado de appleVpnConfiguration
servidor	vpnServer	Servidor VPN na rede. Certifique-se de que os utilizadores finais podem aceder a esta localização de rede. Herdado de appleVpnConfiguration
identificador	Cadeia de caracteres	Identificador fornecido pelo fornecedor de VPN quando o tipo de ligação está definido como VPN Personalizada. Por exemplo: o Cisco AnyConnect utiliza um identificador do formulário com.cisco.anyconnect.applevpn.plugin Herdado de appleVpnConfiguration
customData	Coleção KeyValue	Dados personalizados quando o tipo de ligação está definido como VPN Personalizada. Utilize este campo para ativar a funcionalidade não suportada pelo Intune, mas disponível na sua solução de VPN. Contacte o fornecedor da VPN para saber como adicionar estes pares chave/valor. Esta coleção pode conter um máximo de 25 elementos. Herdado de appleVpnConfiguration
customKeyValueData	Coleção keyValuePair	Dados personalizados quando o tipo de ligação está definido como VPN Personalizada. Utilize este campo para ativar a funcionalidade não suportada pelo Intune, mas disponível na sua solução de VPN. Contacte o fornecedor da VPN para saber como adicionar estes pares chave/valor. Esta coleção pode conter um máximo de 25 elementos. Herdado de appleVpnConfiguration
enableSplitTunneling	Booliano	Enviar todo o tráfego de rede através da VPN. Herdado de appleVpnConfiguration
authenticationMethod	vpnAuthenticationMethod	Método de autenticação para esta ligação VPN. Herdado de appleVpnConfiguration. Os valores possíveis são: `certificate`, `usernameAndPassword`, `sharedSecret`, `derivedCredential`, `azureAD`.
enablePerApp	Booliano	Definir isto como verdadeiro cria Per-App payload de VPN que mais tarde pode ser associado a Aplicações que podem acionar esta conneciton VPN no dispositivo iOS do utilizador final. Herdado de appleVpnConfiguration
safariDomains	String collection	Domínios do Safari quando esta definição de VPN por Aplicação está ativada. Além das aplicações associadas a esta VPN, os domínios safari especificados aqui também poderão acionar esta ligação VPN. Herdado de appleVpnConfiguration
onDemandRules	Coleção vpnOnDemandRule	Regras a pedido. Esta coleção pode conter um máximo de 500 elementos. Herdado de appleVpnConfiguration
providerType	vpnProviderType	Tipo de fornecedor para VPN por aplicação. Herdado de appleVpnConfiguration. Os valores possíveis são: `notConfigured`, `appProxy`, `packetTunnel`.
associatedDomains	String collection	Domínios Associados Herdados de appleVpnConfiguration
excludedDomains	String collection	Domínios que são acedidos através da Internet pública em vez de através de VPN, mesmo quando a VPN por aplicação é ativada Herdada da appleVpnConfiguration
disableOnDemandUserOverride	Booliano	Ativar/desativar para impedir o utilizador de desativar a VPN automática na aplicação Definições Herdada de appleVpnConfiguration
disconnectOnIdle	Booliano	Se pretende desligar após inativos de ligação a pedido Herdados de appleVpnConfiguration
disconnectOnIdleTimerInSeconds	Int32	O período de tempo em segundos a aguardar antes de desligar uma ligação a pedido. Valores válidos de 0 a 65535 Herdados de appleVpnConfiguration
proxyServer	vpnProxyServer	Servidor Proxy. Herdado de appleVpnConfiguration
optInToDeviceIdSharing	Booliano	Opt-In para partilhar o ID do dispositivo com clientes vpn de terceiros para utilização durante a validação do controlo de acesso à rede. Herdado de appleVpnConfiguration
deploymentChannel	appleDeploymentChannel	Indica o tipo de canal de implementação utilizado para implementar o perfil de configuração. Os valores possíveis são deviceChannel, userChannel. Os valores possíveis são: `deviceChannel`, `userChannel`, `unknownFutureValue`.

Resposta

Se for bem-sucedido, este método devolve um 201 Created código de resposta e um objeto macOSVpnConfiguration no corpo da resposta.

Exemplo

Solicitação

Este é um exemplo da solicitação.

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"
}

Resposta

Veja a seguir um exemplo da resposta. Observação: o objeto response mostrado aqui pode estar truncado por motivos de concisão. Todas as propriedades serão retornadas de uma chamada real.

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"
}

Compartilhar via

Criar macOSVpnConfiguration

Permissões

Solicitação HTTP

Cabeçalhos de solicitação

Corpo da solicitação

Resposta

Exemplo

Solicitação

Resposta

Comentários

Comentários

Recursos adicionais