IntuneMobileAppsAutoUpdateCatalogAppWindows10¶

Parameters¶

Parameter	Attribute	DataType	Description	Allowed Values
AllowedArchitectures	Write	String	Indicates the set of CPU architectures on which this application is allowed to be installed. When null, the app is eligible for installation on all the supported architectures. Possible values are: x86, x64, arm64, or a combination of them.	`none`, `x86`, `x64`, `arm`, `neutral`, `arm64`
Assignments	Write	MSFT_DeviceManagementWindowsAutoUpdateCatalogAppAssignment[]	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.
Id	Write	String	The unique identifier for an entity. Read-only.
InformationUrl	Write	String	The more information Url.
InstallExperience	Write	MSFT_MicrosoftGraphWindowsAutoUpdateCatalogAppInstallExperience	Describes how the app installer executes on the target device, including the account context (system or user) under which the installer runs and how the device handles restarts after installation completes. When omitted, the service applies default values (runAsAccount = system, deviceRestartBehavior = basedOnReturnCode).
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.
MobileAppCatalogPackageBranchId	Write	String	The identifier of a specific branch in a product, which is a specific subset of product functionality as defined by the publisher . This is run-time resolved to be the latest MobileAppCatalogPackage in the branch. (example:'31a4c766-f23d-8d41-4803-35e155be7389'). Read-Only
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.
RoleScopeTagIds	Write	String[]	List of scope tag ids for this mobile app.
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_DeviceManagementWindowsAutoUpdateCatalogAppAssignment¶

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_DeviceManagementWindowsAutoUpdateCatalogAppAssignmentSettings	The settings of the assignment.

MSFT_MicrosoftGraphWindowsAutoUpdateCatalogAppInstallExperience¶

Parameters¶

Parameter	Attribute	DataType	Description	Allowed Values
DeviceRestartBehavior	Write	String	Indicates how the device handles restarts after the app installation completes. This controls whether the Intune management extension initiates, suppresses, or forces a device restart based on the installer's exit code. Defaults to basedOnReturnCode if not specified. Possible values are: basedOnReturnCode, allow, suppress, force, unknownFutureValue.	`basedOnReturnCode`, `allow`, `suppress`, `force`, `unknownFutureValue`
RunAsAccount	Write	String	Indicates the account context under which the app installer runs on the device. When set to system, the installer runs with elevated privileges in the SYSTEM account context. When set to user, the installer runs in the context of the currently logged-in user. Defaults to system if not specified. 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_DeviceManagementWindowsAutoUpdateCatalogAppAssignmentSettings¶

Parameters¶

Parameter	Attribute	DataType	Description	Allowed Values
odataType	Write	String	The odata type of the assignment settings.	`#microsoft.graph.windowsAutoUpdateCatalogAppAssignmentSettings`
DeliveryOptimizationPriority	Write	String	Indicates the priority level for downloading the app content using Delivery Optimization. foreground prioritizes the download over background tasks, which may result in faster installation but higher bandwidth usage. Defaults to notConfigured (background priority) if not specified. When omitted from the request, the service applies notConfigured and the device downloads app content using normal background priority. In National Cloud environments (e.g., US Government, China), Delivery Optimization is not available the service accepts and stores any value provided, but the device agent ignores it at runtime and delivers content via CDN using background priority regardless of the configured value. Possible values are: notConfigured, foreground, unknownFutureValue.	`notConfigured`, `foreground`, `unknownFutureValue`
InstallTimeSettings	Write	MSFT_MicrosoftGraphWindowsAutoUpdateCatalogAppInstallTimeSettings	Specifies the deadline by which the app must be installed on the device. When null, the app is offered for immediate installation with no enforced deadline.
NotificationType	Write	String	Indicates which notifications the Intune management extension displays to the end user during app installation and restart. Defaults to showAll if not specified. Possible values are: showAll, showReboot, hideAll, unknownFutureValue.	`showAll`, `showReboot`, `hideAll`, `unknownFutureValue`
RestartSettings	Write	MSFT_MicrosoftGraphWindowsAutoUpdateCatalogAppRestartSettings	Specifies the restart coordination behavior after the app is installedincluding how long to wait before restarting, when to show a countdown, and how long the user can snooze. When null, no restart coordination is applied (the device may still restart based on the app's deviceRestartBehavior setting). Note: the service accepts restart settings regardless of the app's deviceRestartBehavior value the device agent determines which settings are actually honored at runtime.

MSFT_MicrosoftGraphWindowsAutoUpdateCatalogAppInstallTimeSettings¶

Parameters¶

Parameter	Attribute	DataType	Description
DeadlineDateTime	Write	String	The maximum allowed date and time by which the app must be installed on the device. After this deadline, the Intune management extension enforces installation automatically. When null, there is no enforced deadline.
StartDateTime	Write	String	The time at which the app should be available for installation on the device. When null, the app is available immediately.
UseLocalTime	Write	Boolean	Indicates whether the startDateTime and deadlineDateTime values should be interpreted using the device's local time zone. When false, the values are interpreted as UTC. Defaults to false if not specified.

MSFT_MicrosoftGraphWindowsAutoUpdateCatalogAppRestartSettings¶

Parameters¶

Parameter	Attribute	DataType	Description
CountdownDisplayBeforeRestartInMinutes	Write	SInt32	The number of minutes before the scheduled restart at which a countdown notification is displayed to the user. Must be between 1 and the value of gracePeriodInMinutes. This countdown is non-dismissible and warns the user that a restart is imminent. For example, a value of 15 means the countdown appears 15 minutes before the restart.
GracePeriodInMinutes	Write	SInt32	The number of minutes the device waits after app installation before initiating a restart. During this period, the user can continue working and save their documents. For example, a value of 1440 means the device waits 24 hours before restarting.
RestartNotificationSnoozeDurationInMinutes	Write	SInt32	The number of minutes by which the user can defer (snooze) the restart notification each time they press the snooze button. When null, the snooze option is not available and the user cannot defer the restart. For example, a value of 240 allows the user to defer the restart by 4 hours each time.

Description¶

This resource configures a Intune Mobile Apps Auto Update 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
    {
        IntuneMobileAppsAutoUpdateCatalogAppWindows10 'IntuneMobileAppsAutoUpdateCatalogAppWindows10-Example'
        {
            AllowedArchitectures            = "x64";
            Assignments                     = @(
                MSFT_DeviceManagementWindowsAutoUpdateCatalogAppAssignment{
                    dataType = "#microsoft.graph.allLicensedUsersAssignmentTarget"
                    intent   = "available"
                }
            );
            Description                     = "A file archiver with a high compression ratio, kept up to date automatically";
            Developer                       = "Igor Pavlov";
            DisplayName                     = "7-Zip (x64) automatic updates";
            InformationUrl                  = "https://www.7-zip.org";
            InstallExperience               = MSFT_MicrosoftGraphWindowsAutoUpdateCatalogAppInstallExperience{
                DeviceRestartBehavior = "basedOnReturnCode"
                RunAsAccount          = "system"
            };
            IsFeatured                      = $false;
            LargeIcon                       = MSFT_MicrosoftGraphMimeContent2{
                Type  = "image/png"
                Value = "<base64-encoded-app-icon>"
            };
            MobileAppCatalogPackageBranchId = "3da9c2f0-94e7-90b1-01e3-35e155728974";
            Notes                           = "Published from the Enterprise App Catalog";
            Owner                           = "Workplace Services";
            PrivacyInformationUrl           = "https://www.7-zip.org/faq.html";
            Publisher                       = "Igor Pavlov";
            RoleScopeTagIds                 = @("0");
            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
    {
        IntuneMobileAppsAutoUpdateCatalogAppWindows10 'IntuneMobileAppsAutoUpdateCatalogAppWindows10-Example'
        {
            AllowedArchitectures            = "x64";
            Assignments                     = @(
                MSFT_DeviceManagementWindowsAutoUpdateCatalogAppAssignment{
                    dataType = "#microsoft.graph.allLicensedUsersAssignmentTarget"
                    intent   = "available"
                }
            );
            Description                     = "A file archiver with a high compression ratio, kept up to date for all staff"; # Updated Property
            Developer                       = "Igor Pavlov";
            DisplayName                     = "7-Zip (x64) automatic updates";
            InformationUrl                  = "https://www.7-zip.org";
            InstallExperience               = MSFT_MicrosoftGraphWindowsAutoUpdateCatalogAppInstallExperience{
                DeviceRestartBehavior = "basedOnReturnCode"
                RunAsAccount          = "system"
            };
            IsFeatured                      = $false;
            LargeIcon                       = MSFT_MicrosoftGraphMimeContent2{
                Type  = "image/png"
                Value = "<base64-encoded-app-icon>"
            };
            MobileAppCatalogPackageBranchId = "3da9c2f0-94e7-90b1-01e3-35e155728974";
            Notes                           = "Published from the Enterprise App Catalog";
            Owner                           = "Workplace Services";
            PrivacyInformationUrl           = "https://www.7-zip.org/faq.html";
            Publisher                       = "Igor Pavlov";
            RoleScopeTagIds                 = @("0");
            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
    {
        IntuneMobileAppsAutoUpdateCatalogAppWindows10 'IntuneMobileAppsAutoUpdateCatalogAppWindows10-Example'
        {
            DisplayName           = "7-Zip (x64) automatic updates";
            Ensure                = "Absent";
            ApplicationId         = $ApplicationId;
            TenantId              = $TenantId;
            CertificateThumbprint = $CertificateThumbprint;
        }
    }
}