macOSWiFiConfiguration resource type

Namespace: microsoft.graph

Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.

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

By providing the configurations in this profile you can instruct the macOS device to connect to desired Wi-Fi endpoint. By specifying the authentication method and security types expected by Wi-Fi endpoint you can make the Wi-Fi connection seamless for end user.

Inherits from deviceConfiguration

Methods

Method	Return Type	Description
List macOSWiFiConfigurations	macOSWiFiConfiguration collection	List properties and relationships of the macOSWiFiConfiguration objects.
Get macOSWiFiConfiguration	macOSWiFiConfiguration	Read properties and relationships of the macOSWiFiConfiguration object.
Create macOSWiFiConfiguration	macOSWiFiConfiguration	Create a new macOSWiFiConfiguration object.
Delete macOSWiFiConfiguration	None	Deletes a macOSWiFiConfiguration.
Update macOSWiFiConfiguration	macOSWiFiConfiguration	Update the properties of a macOSWiFiConfiguration object.

Properties

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
networkName	String	Network Name
ssid	String	This is the name of the Wi-Fi network that is broadcast to all devices.
connectAutomatically	Boolean	Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network.
connectWhenNetworkNameIsHidden	Boolean	Connect when the network is not broadcasting its name (SSID). When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices.
wiFiSecurityType	wiFiSecurityType	Indicates whether Wi-Fi endpoint uses an EAP based security type. Possible values are: open, wpaPersonal, wpaEnterprise, wep, wpa2Personal, wpa2Enterprise.
proxySettings	wiFiProxySetting	Proxy Type for this Wi-Fi connection. Possible values are: none, manual, automatic, unknownFutureValue.
proxyManualAddress	String	IP Address or DNS hostname of the proxy server when manual configuration is selected.
proxyManualPort	Int32	Port of the proxy server when manual configuration is selected.
proxyAutomaticConfigurationUrl	String	URL of the proxy server automatic configuration script when automatic configuration is selected. This URL is typically the location of PAC (Proxy Auto Configuration) file.
deploymentChannel	appleDeploymentChannel	Indicates the deployment channel type used to deploy the configuration profile. Possible values are deviceChannel, userChannel. Possible values are: deviceChannel, userChannel, unknownFutureValue.
preSharedKey	String	This is the pre-shared key for WPA Personal Wi-Fi network.

Relationships

Relationship	Type	Description
groupAssignments	deviceConfigurationGroupAssignment collection	The list of group assignments for the device configuration profile. Inherited from deviceConfiguration
assignments	deviceConfigurationAssignment collection	The list of assignments for the device configuration profile. Inherited from deviceConfiguration
deviceStatuses	deviceConfigurationDeviceStatus collection	Device configuration installation status by device. Inherited from deviceConfiguration
userStatuses	deviceConfigurationUserStatus collection	Device configuration installation status by user. Inherited from deviceConfiguration
deviceStatusOverview	deviceConfigurationDeviceOverview	Device Configuration devices status overview Inherited from deviceConfiguration
userStatusOverview	deviceConfigurationUserOverview	Device Configuration users status overview Inherited from deviceConfiguration
deviceSettingStateSummaries	settingStateDeviceSummary collection	Device Configuration Setting State Device Summary Inherited from deviceConfiguration

JSON Representation

Here is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.macOSWiFiConfiguration",
  "id": "String (identifier)",
  "lastModifiedDateTime": "String (timestamp)",
  "roleScopeTagIds": [
    "String"
  ],
  "supportsScopeTags": true,
  "deviceManagementApplicabilityRuleOsEdition": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition",
    "osEditionTypes": [
      "String"
    ],
    "name": "String",
    "ruleType": "String"
  },
  "deviceManagementApplicabilityRuleOsVersion": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion",
    "minOSVersion": "String",
    "maxOSVersion": "String",
    "name": "String",
    "ruleType": "String"
  },
  "deviceManagementApplicabilityRuleDeviceMode": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode",
    "deviceMode": "String",
    "name": "String",
    "ruleType": "String"
  },
  "createdDateTime": "String (timestamp)",
  "description": "String",
  "displayName": "String",
  "version": 1024,
  "networkName": "String",
  "ssid": "String",
  "connectAutomatically": true,
  "connectWhenNetworkNameIsHidden": true,
  "wiFiSecurityType": "String",
  "proxySettings": "String",
  "proxyManualAddress": "String",
  "proxyManualPort": 1024,
  "proxyAutomaticConfigurationUrl": "String",
  "deploymentChannel": "String",
  "preSharedKey": "String"
}