IntuneMobileAppsWin32CatalogAppWindows10¶
Parameters¶
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| AllowAvailableUninstall | Write | Boolean | Indicates whether the uninstall is supported from the company portal for the Win32 app with an available assignment. When TRUE, indicates that uninstall is supported from the company portal for the Windows app (Win32) with an available assignment. When FALSE, indicates that uninstall is not supported for the Windows app (Win32) with an Available assignment. Default value is FALSE. | |
| AllowedArchitectures | Write | String | Indicates the Windows architecture(s) this app should be installed on. The app will be treated as not applicable for devices with architectures not matching the selected value. When a non-null value is provided for the allowedArchitectures property, the value of the applicableArchitectures property is set to none. Possible values are: null, x86, x64, arm64. Possible values are: none, x86, x64, arm, neutral, arm64. | none, x86, x64, arm, neutral, arm64 |
| Assignments | Write | MSFT_DeviceManagementWin32CatalogAppAssignment[] | Represents the assignment to the Intune app. | |
| Description | Write | String | The description of the app. | |
| Developer | Write | String | The developer of the app. | |
| DisplayName | Key | String | The admin provided or imported title of the app. | |
| DisplayVersion | Write | String | Indicates the version displayed in the UX for this app. Used to set the version of the app. Example: 1.0.3.215. | |
| FileName | Write | String | The name of the main Lob application file. | |
| Id | Write | String | The unique identifier for an entity. Read-only. | |
| InformationUrl | Write | String | The more information Url. | |
| InstallCommandLine | Write | String | Indicates the command line to install this app. Used to install the Win32 app. Example: msiexec /i 'Orca.Msi' /qn. | |
| InstallExperience | Write | MSFT_MicrosoftGraphWin32LobAppInstallExperience1 | Indicates the install experience for this app. | |
| IsFeatured | Write | Boolean | The value indicating whether the app is marked as featured by the admin. | |
| LargeIcon | Write | MSFT_MicrosoftGraphMimeContent2 | The large icon, to be displayed in the app details and used for upload of the icon. | |
| MinimumCpuSpeedInMHz | Write | SInt32 | Indicates the value for the minimum CPU speed which is required to install this app. Allowed range from 0 to clock speed from WMI helper. | |
| MinimumFreeDiskSpaceInMB | Write | SInt32 | Indicates the value for the minimum free disk space which is required to install this app. Allowed range from 0 to driver's maximum available free space. | |
| MinimumMemoryInMB | Write | SInt32 | Indicates the value for the minimum physical memory which is required to install this app. Allowed range from 0 to total physical memory from WMI helper. | |
| MinimumNumberOfProcessors | Write | SInt32 | Indicates the value for the minimum number of processors which is required to install this app. Minimum value is 0. | |
| MinimumSupportedWindowsRelease | Write | String | Indicates the value for the minimum supported windows release. Example: Windows11_23H2. | |
| MobileAppCatalogPackageId | Write | String | The mobileAppCatalogPackageId property references the mobileAppCatalogPackage entity which contains information about an application catalog package that can be deployed to Intune-managed devices | |
| MsiInformation | Write | MSFT_MicrosoftGraphWin32LobAppMsiInformation1 | Indicates the MSI details if this Win32 app is an MSI app. | |
| Notes | Write | String | Notes for the app. | |
| Owner | Write | String | The owner of the app. | |
| PrivacyInformationUrl | Write | String | The privacy statement Url. | |
| Publisher | Write | String | The publisher of the app. | |
| ReturnCodes | Write | MSFT_MicrosoftGraphWin32LobAppReturnCode1[] | Indicates the return codes for post installation behavior. | |
| RoleScopeTagIds | Write | String[] | List of scope tag ids for this mobile app. | |
| Rules | Write | MSFT_MicrosoftGraphWin32LobAppRule1[] | Indicates the detection and requirement rules for this app. Possible values are: Win32LobAppFileSystemRule, Win32LobAppPowerShellScriptRule, Win32LobAppProductCodeRule, Win32LobAppRegistryRule. | |
| SetupFilePath | Write | String | Indicates the relative path of the setup file in the encrypted Win32LobApp package. Example: Intel-SA-00075 Detection and Mitigation Tool.msi. | |
| UninstallCommandLine | Write | String | Indicates the command line to uninstall this app. Used to uninstall the app. Example: msiexec /x '85F4CBCB-9BBC-4B50-A7D8-E1106771498D}' /qn. | |
| Ensure | Write | String | Specify if the app should exist. | Present, Absent |
| Credential | Write | PSCredential | Credentials of the Intune Admin | |
| ApplicationId | Write | String | Id of the Entra ID application to authenticate with. | |
| TenantId | Write | String | Id of the Entra ID tenant used for authentication. | |
| ApplicationSecret | Write | PSCredential | Secret of the Entra ID application to authenticate with. | |
| CertificateThumbprint | Write | String | Thumbprint of the Entra ID application's authentication certificate to use for authentication. | |
| CertificatePassword | Write | PSCredential | Username can be made up to anything but password will be used for CertificatePassword | |
| CertificatePath | Write | String | Path to certificate used in service principal usually a PFX file. | |
| ManagedIdentity | Write | Boolean | Managed ID being used for authentication. | |
| AccessTokens | Write | String[] | Access token used for authentication. |
Embedded Instances¶
MSFT_DeviceManagementWin32CatalogAppAssignment¶
Parameters¶
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| dataType | Write | String | The type of the target assignment. | #microsoft.graph.groupAssignmentTarget, #microsoft.graph.allLicensedUsersAssignmentTarget, #microsoft.graph.allDevicesAssignmentTarget, #microsoft.graph.exclusionGroupAssignmentTarget, #microsoft.graph.mobileAppAssignment |
| deviceAndAppManagementAssignmentFilterId | Write | String | The Id of the filter for the target assignment. | |
| deviceAndAppManagementAssignmentFilterDisplayName | Write | String | The display name of the filter for the target assignment. | |
| deviceAndAppManagementAssignmentFilterType | Write | String | The type of filter of the target assignment i.e. Exclude or Include. Possible values are: none, include, exclude. | none, include, exclude |
| groupId | Write | String | The group Id that is the target of the assignment. | |
| groupDisplayName | Write | String | The group Display Name that is the target of the assignment. | |
| intent | Write | String | Possible values for the install intent chosen by the admin. | available, required, uninstall, availableWithoutEnrollment |
| assignmentSettings | Write | MSFT_DeviceManagementWin32CatalogAppAssignmentSettings | The settings of the assignment. |
MSFT_MicrosoftGraphWin32LobAppInstallExperience1¶
Parameters¶
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| DeviceRestartBehavior | Write | String | Device restart behavior. Possible values are: basedOnReturnCode, allow, suppress, force. | basedOnReturnCode, allow, suppress, force |
| InUseBehavior | Write | String | Indicates whether app-in-use detection is enabled before app enforcement, and if enabled, the action to take when the app is detected to be in-use. Null indicates the feature is not enabled. Possible values are: notEnabled, fail, terminateWithoutUserInteraction, terminateWithUserInteraction. | notEnabled, fail, terminateWithoutUserInteraction, terminateWithUserInteraction, unknownFutureValue |
| MaxRunTimeInMinutes | Write | SInt32 | The number of minutes the system will wait for install program to finish. Default value is 60 minutes. | |
| RunAsAccount | Write | String | Indicates the type of execution context the app runs in. Possible values are: system, user. | system, user |
MSFT_MicrosoftGraphMimeContent2¶
Parameters¶
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| Type | Write | String | Indicates the content mime type. | |
| Value | Write | String | The byte array that contains the actual content. |
MSFT_MicrosoftGraphWin32LobAppMsiInformation1¶
Parameters¶
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| PackageType | Write | String | The MSI package type. Possible values are: perMachine, perUser, dualPurpose. | perMachine, perUser, dualPurpose |
| ProductCode | Write | String | The MSI product code. | |
| ProductName | Write | String | The MSI product name. | |
| ProductVersion | Write | String | The MSI product version. | |
| Publisher | Write | String | The MSI publisher. | |
| RequiresReboot | Write | Boolean | Whether the MSI app requires the machine to reboot to complete installation. | |
| UpgradeCode | Write | String | The MSI upgrade code. |
MSFT_MicrosoftGraphWin32LobAppReturnCode1¶
Parameters¶
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| ReturnCode | Write | SInt32 | Return code. | |
| Type | Write | String | The type of return code. Possible values are: failed, success, softReboot, hardReboot, retry. | failed, success, softReboot, hardReboot, retry |
MSFT_MicrosoftGraphWin32LobAppRule1¶
Parameters¶
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| Check32BitOn64System | Write | Boolean | A value indicating whether to expand environment variables in the 32-bit context on 64-bit systems. | |
| ComparisonValue | Write | String | The file or folder comparison value. | |
| DisplayName | Write | String | The display name for the rule. Do not specify this value if the rule is used for detection. | |
| EnforceSignatureCheck | Write | Boolean | A value indicating whether a signature check is enforced. | |
| FileOrFolderName | Write | String | The file or folder name to look up. | |
| KeyPath | Write | String | The full path of the registry entry containing the value to detect. | |
| ODataType | Write | String | The type of the entity. | #microsoft.graph.win32LobAppFileSystemRule, #microsoft.graph.win32LobAppPowerShellScriptRule, #microsoft.graph.win32LobAppProcessRule, #microsoft.graph.win32LobAppProductCodeRule, #microsoft.graph.win32LobAppRegistryRule |
| OperationType | Write | String | The file system operation type. Possible values are: notConfigured, exists, modifiedDate, createdDate, version, sizeInMB, doesNotExist, sizeInBytes, appVersion, unknownFutureValue. | notConfigured, exists, modifiedDate, createdDate, version, sizeInMB, doesNotExist, sizeInBytes, appVersion, unknownFutureValue, string, dateTime, integer, float, boolean |
| Operator | Write | String | The operator for file or folder detection. Possible values are: notConfigured, equal, notEqual, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual. | notConfigured, equal, notEqual, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual |
| Path | Write | String | The file or folder path to look up. | |
| ProcessDisplayName | Write | String | Indicates the display name for the process in the Intune admin console. Example: Microsoft Word. | |
| ProcessName | Write | String | Indicates the process name to be searched for on a managed device when enforcing a managed app. Example: TestApp.exe. | |
| ProductCode | Write | String | The product code of the app. | |
| ProductVersion | Write | String | The product version comparison value. | |
| ProductVersionOperator | Write | String | The product version comparison operator. Possible values are: notConfigured, equal, notEqual, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual. | notConfigured, equal, notEqual, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual |
| RuleType | Write | String | The rule type indicating the purpose of the rule. Possible values are: detection, requirement. | detection, requirement |
| RunAs32Bit | Write | Boolean | A value indicating whether the script should run as 32-bit. | |
| RunAsAccount | Write | String | The execution context of the script. Do not specify this value if the rule is used for detection. Script detection rules will run in the same context as the associated app install context. Possible values are: system, user. | system, user |
| ScriptContent | Write | String | The base64-encoded script content. | |
| ValueName | Write | String | The name of the registry value to detect. |
MSFT_DeviceManagementWin32CatalogAppAssignmentSettings¶
Parameters¶
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| odataType | Write | String | The odata type of the assignment settings. | #microsoft.graph.win32CatalogAppAssignmentSettings |
| AutoUpdateSettings | Write | MSFT_MicrosoftGraphWin32LobAppAutoUpdateSettings | The auto-update settings to apply for this app assignment. | |
| DeliveryOptimizationPriority | Write | String | The delivery optimization priority for this app assignment. This setting is not supported in National Cloud environments. The possible values are: notConfigured, foreground. | notConfigured, foreground |
| InstallTimeSettings | Write | MSFT_MicrosoftGraphMobileAppInstallTimeSettings | The install time settings to apply for this app assignment. | |
| Notifications | Write | String | The notification status for this app assignment. The possible values are: showAll, showReboot, hideAll. | showAll, showReboot, hideAll |
| RestartSettings | Write | MSFT_MicrosoftGraphWin32LobAppRestartSettings | The reboot settings to apply for this app assignment. |
MSFT_MicrosoftGraphWin32LobAppAutoUpdateSettings¶
Parameters¶
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| AutoUpdateSupersededAppsState | Write | String | The auto-update superseded apps state setting for the app assignment. Possible values are notConfigured and enabled. Default value is notConfigured. The possible values are: notConfigured, enabled, unknownFutureValue. | notConfigured, enabled, unknownFutureValue |
MSFT_MicrosoftGraphMobileAppInstallTimeSettings¶
Parameters¶
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| DeadlineDateTime | Write | String | The time at which the app should be installed. | |
| StartDateTime | Write | String | The time at which the app should be available for installation. | |
| UseLocalTime | Write | Boolean | Whether the local device time or UTC time should be used when determining the available and deadline times. |
MSFT_MicrosoftGraphWin32LobAppRestartSettings¶
Parameters¶
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| CountdownDisplayBeforeRestartInMinutes | Write | SInt32 | The number of minutes before the restart time to display the countdown dialog for pending restarts. | |
| GracePeriodInMinutes | Write | SInt32 | The number of minutes to wait before restarting the device after an app installation. | |
| RestartNotificationSnoozeDurationInMinutes | Write | SInt32 | The number of minutes to snooze the restart notification dialog when the snooze button is selected. |
Description¶
This resource configures a Intune Mobile Apps Win32 Catalog App for Windows10.
Permissions¶
Graph¶
To authenticate with the Graph API, this resource requires the following permissions:
Delegated permissions¶
- Read
-
GroupMember.Read.All, DeviceManagementApps.Read.All, DeviceManagementRBAC.Read.All
-
Update
- GroupMember.Read.All, DeviceManagementApps.ReadWrite.All, DeviceManagementRBAC.Read.All
Application permissions¶
- Read
-
GroupMember.Read.All, DeviceManagementApps.Read.All, DeviceManagementRBAC.Read.All
-
Update
- GroupMember.Read.All, DeviceManagementApps.ReadWrite.All, DeviceManagementRBAC.Read.All
Examples¶
Example 1¶
This example is used to test new resources and showcase the usage of new resources being worked on. It is not meant to use as a production baseline.
Configuration Example
{
param
(
[Parameter()]
[System.String]
$ApplicationId,
[Parameter()]
[System.String]
$TenantId,
[Parameter()]
[System.String]
$CertificateThumbprint
)
Import-DscResource -ModuleName Microsoft365DSC
Node localhost
{
IntuneMobileAppsWin32CatalogAppWindows10 'IntuneMobileAppsWin32CatalogAppWindows10-Example'
{
AllowAvailableUninstall = $true;
AllowedArchitectures = "x64";
Assignments = @(
MSFT_DeviceManagementWin32CatalogAppAssignment{
dataType = "#microsoft.graph.allLicensedUsersAssignmentTarget"
intent = "available"
}
);
Description = "A file archiver with a high compression ratio";
Developer = "Igor Pavlov";
DisplayName = "7-Zip (x64)";
DisplayVersion = "26.03";
FileName = "7z2603-x64.msi";
InformationUrl = "https://www.7-zip.org";
InstallCommandLine = "msiexec.exe /i `"7z2603-x64.msi`" /qn";
InstallExperience = MSFT_MicrosoftGraphWin32LobAppInstallExperience1{
DeviceRestartBehavior = "basedOnReturnCode"
InUseBehavior = "notEnabled"
MaxRunTimeInMinutes = 60
RunAsAccount = "system"
};
IsFeatured = $false;
LargeIcon = MSFT_MicrosoftGraphMimeContent2{
Type = "image/png"
Value = "<base64-encoded-app-icon>"
};
MinimumCpuSpeedInMHz = 1000;
MinimumFreeDiskSpaceInMB = 200;
MinimumMemoryInMB = 2048;
MinimumNumberOfProcessors = 1;
MinimumSupportedWindowsRelease = "1607";
MobileAppCatalogPackageId = "eac00000-af3f-4678-b9a7-ca22b5db724d";
MsiInformation = MSFT_MicrosoftGraphWin32LobAppMsiInformation1{
PackageType = "perMachine"
ProductCode = "{23170F69-40C1-2702-2603-000001000000}"
ProductName = "7-Zip"
ProductVersion = "26.03"
Publisher = "Igor Pavlov"
RequiresReboot = $false
UpgradeCode = "{23170F69-40C1-2702-0000-000004000000}"
};
Notes = "Published from the Enterprise App Catalog";
Owner = "Workplace Services";
PrivacyInformationUrl = "https://www.7-zip.org/faq.html";
Publisher = "Igor Pavlov";
ReturnCodes = @(
MSFT_MicrosoftGraphWin32LobAppReturnCode1{
ReturnCode = 0
Type = "success"
}
);
RoleScopeTagIds = @("0");
Rules = @(
MSFT_MicrosoftGraphWin32LobAppRule1{
Check32BitOn64System = $false
ComparisonValue = "26.03.00.0"
KeyPath = "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\{23170F69-40C1-2702-2603-000001000000}"
ODataType = "#microsoft.graph.win32LobAppRegistryRule"
OperationType = "string"
Operator = "equal"
RuleType = "detection"
ValueName = "DisplayVersion"
}
);
SetupFilePath = "7z2603-x64.msi";
UninstallCommandLine = "msiexec.exe /x {23170F69-40C1-2702-2603-000001000000} /qn";
Ensure = "Present";
ApplicationId = $ApplicationId;
TenantId = $TenantId;
CertificateThumbprint = $CertificateThumbprint;
}
}
}
Example 2¶
This example is used to test new resources and showcase the usage of new resources being worked on. It is not meant to use as a production baseline.
Configuration Example
{
param
(
[Parameter()]
[System.String]
$ApplicationId,
[Parameter()]
[System.String]
$TenantId,
[Parameter()]
[System.String]
$CertificateThumbprint
)
Import-DscResource -ModuleName Microsoft365DSC
Node localhost
{
IntuneMobileAppsWin32CatalogAppWindows10 'IntuneMobileAppsWin32CatalogAppWindows10-Example'
{
AllowAvailableUninstall = $true;
AllowedArchitectures = "x64";
Assignments = @(
MSFT_DeviceManagementWin32CatalogAppAssignment{
dataType = "#microsoft.graph.allLicensedUsersAssignmentTarget"
intent = "available"
}
);
Description = "A file archiver with a high compression ratio, published for all staff"; # Updated Property
Developer = "Igor Pavlov";
DisplayName = "7-Zip (x64)";
DisplayVersion = "26.03";
FileName = "7z2603-x64.msi";
InformationUrl = "https://www.7-zip.org";
InstallCommandLine = "msiexec.exe /i `"7z2603-x64.msi`" /qn";
InstallExperience = MSFT_MicrosoftGraphWin32LobAppInstallExperience1{
DeviceRestartBehavior = "basedOnReturnCode"
InUseBehavior = "notEnabled"
MaxRunTimeInMinutes = 60
RunAsAccount = "system"
};
IsFeatured = $false;
LargeIcon = MSFT_MicrosoftGraphMimeContent2{
Type = "image/png"
Value = "<base64-encoded-app-icon>"
};
MinimumCpuSpeedInMHz = 1000;
MinimumFreeDiskSpaceInMB = 200;
MinimumMemoryInMB = 2048;
MinimumNumberOfProcessors = 1;
MinimumSupportedWindowsRelease = "1607";
MobileAppCatalogPackageId = "eac00000-af3f-4678-b9a7-ca22b5db724d";
MsiInformation = MSFT_MicrosoftGraphWin32LobAppMsiInformation1{
PackageType = "perMachine"
ProductCode = "{23170F69-40C1-2702-2603-000001000000}"
ProductName = "7-Zip"
ProductVersion = "26.03"
Publisher = "Igor Pavlov"
RequiresReboot = $false
UpgradeCode = "{23170F69-40C1-2702-0000-000004000000}"
};
Notes = "Published from the Enterprise App Catalog";
Owner = "Workplace Services";
PrivacyInformationUrl = "https://www.7-zip.org/faq.html";
Publisher = "Igor Pavlov";
ReturnCodes = @(
MSFT_MicrosoftGraphWin32LobAppReturnCode1{
ReturnCode = 0
Type = "success"
}
);
RoleScopeTagIds = @("0");
Rules = @(
MSFT_MicrosoftGraphWin32LobAppRule1{
Check32BitOn64System = $false
ComparisonValue = "26.03.00.0"
KeyPath = "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\{23170F69-40C1-2702-2603-000001000000}"
ODataType = "#microsoft.graph.win32LobAppRegistryRule"
OperationType = "string"
Operator = "equal"
RuleType = "detection"
ValueName = "DisplayVersion"
}
);
SetupFilePath = "7z2603-x64.msi";
UninstallCommandLine = "msiexec.exe /x {23170F69-40C1-2702-2603-000001000000} /qn";
Ensure = "Present";
ApplicationId = $ApplicationId;
TenantId = $TenantId;
CertificateThumbprint = $CertificateThumbprint;
}
}
}
Example 3¶
This example is used to test new resources and showcase the usage of new resources being worked on. It is not meant to use as a production baseline.
Configuration Example
{
param
(
[Parameter()]
[System.String]
$ApplicationId,
[Parameter()]
[System.String]
$TenantId,
[Parameter()]
[System.String]
$CertificateThumbprint
)
Import-DscResource -ModuleName Microsoft365DSC
Node localhost
{
IntuneMobileAppsWin32CatalogAppWindows10 'IntuneMobileAppsWin32CatalogAppWindows10-Example'
{
DisplayName = "7-Zip (x64)";
Ensure = "Absent";
ApplicationId = $ApplicationId;
TenantId = $TenantId;
CertificateThumbprint = $CertificateThumbprint;
}
}
}