Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add app advanced settings, execution aliases and apps for websites #146

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .github/actions/spelling/allow.txt
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,9 @@ websites
wekyb
Hmmss
MMdd
MMdd
MMdd
Aic
Cdp
reparsepoint
Stubification
XExe
2 changes: 1 addition & 1 deletion .github/actions/spelling/expect/generic_terms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ ssh
usr
versioning
VGpu
ADDLOCAL
ADDLOCAL
1 change: 1 addition & 0 deletions .github/actions/spelling/expect/software.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ NUnit
reportgenerator
markdownlint
msiexec
fsutil
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
external help file: Microsoft.Windows.Setting.Apps.psm1-Help.xml
Module Name: Microsoft.Windows.Setting.Apps
ms.date: 01/10/2025
online version:
schema: 2.0.0
title: AdvancedAppSettings
---

# AppExecutionAliases

## SYNOPSIS

The `AdvancedAppSettings` DSC Resource allows you to manage advanced application settings on Windows, including app source preferences, device experience sharing, and app archiving.

## DESCRIPTION

The `AdvancedAppSettings` DSC Resource allows you to manage advanced application settings on Windows, including app source preferences, device experience sharing, and app archiving.

## PARAMETERS

| **Parameter** | **Attribute** | **DataType** | **Description** | **Allowed Values** |
|-------------------------|---------------|--------------|---------------------------------------------------------------------------------|-------------------------------------------------------|
| `SID` | Key | String | The security identifier. This is a key property and should not be set manually. | N/A |
| `AppSourcePreference` | Optional | String | Specifies the source preference for installing applications. | { Anywhere, Recommendations, PreferStore, StoreOnly } |
| `ShareDeviceExperience` | Optional | String | Specifies the device experience sharing setting. | { Off, Device, Everyone } |
| `ArchiveApp` | Optional | Boolean | Indicates whether to enable app archiving. | `True` or `False` |

## EXAMPLES

### EXAMPLE 1 - Example that adds `myAppAlias.exe` as app execution alias

```powershell
Invoke-DscResource -ModuleName Microsoft.Windows.Setting.Apps -Name AppExecutionAliases -Method Set -Property @{
ExecutionAliasName = 'myAppAlias.exe';
Exist = $true;
}

# This example ensures that the execution alias 'myAppAlias.exe' exists.
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
external help file: Microsoft.Windows.Setting.Apps.psm1-Help.xml
Module Name: Microsoft.Windows.Setting.Apps
ms.date: 01/10/2025
online version:
schema: 2.0.0
title: AppExecutionAliases
---

# AppExecutionAliases

## SYNOPSIS

The `AppExecutionAliases` DSC Resource allows you to manage execution aliases for applications on Windows.

## DESCRIPTION

The `AppExecutionAliases` DSC Resource allows you to manage execution aliases for applications on Windows.

## PARAMETERS

| **Parameter** | **Attribute** | **DataType** | **Description** | **Allowed Values** |
| -------------------- | -------------- | ------------ | ----------------------------------------------------------------------------------------------------- | --------------------- |
| `ExecutionAliasName` | Key, Mandatory | String | The path to the image file that will be used as the desktop background picture. | Any valid image path. |
| `Exist` | Optional | Boolean | Indicates whether the execution alias should exist. This is an optional parameter. Defaults to `True` | `True` or `False` |

## EXAMPLES

### EXAMPLE 1 - Example that adds `myAppAlias.exe` as app execution alias

```powershell
Invoke-DscResource -ModuleName Microsoft.Windows.Setting.Apps -Name AppExecutionAliases -Method Set -Property @{
ExecutionAliasName = 'myAppAlias.exe';
Exist = $true;
}

# This example ensures that the execution alias 'myAppAlias.exe' exists.
```
38 changes: 38 additions & 0 deletions resources/Help/Microsoft.Windows.Setting.Apps/AppsForWebsites.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
external help file: Microsoft.Windows.Setting.Apps.psm1-Help.xml
Module Name: Microsoft.Windows.Setting.Apps
ms.date: 01/10/2025
online version:
schema: 2.0.0
title: AppsForWebsites
---

# AppsForWebsites

## SYNOPSIS

The `AppsForWebsites` DSC Resource allows you to manage application associations for websites on Windows.

## DESCRIPTION

The `AppsForWebsites` DSC Resource allows you to manage application associations for websites on Windows.

## PARAMETERS

| **Parameter** | **Attribute** | **DataType** | **Description** | **Allowed Values** |
| ------------- | -------------- | ------------ | ------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
| `LinkUri` | Key, Mandatory | String | The link URI. | Any valid URI that is associated with an URI handler |
| `Exist` | Optional | Boolean | Indicates whether the application association should be turned on or off. Default is `True` | `True` or `False` |

## EXAMPLES

### EXAMPLE 1 - Turn off Adobe Acrobat to open links in the app

```powershell
Invoke-DscResource -ModuleName Microsoft.Windows.Setting.Apps -Name AppsForWebsites -Method Set -Property @{
LinkUri = 'acrobat.adobe.com'
Exist = $false
}

# This example ensures that the application association for 'acrobat.adobe.com' is turned off.
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
@{
RootModule = 'Microsoft.Windows.Setting.Apps.psm1'
ModuleVersion = '0.1.0'
GUID = 'ac5fb135-25ec-4029-b8d4-534216a9b6ea'
Author = 'Microsoft Corporation'
CompanyName = 'Microsoft Corporation'
Copyright = '(c) Microsoft Corp. All rights reserved.'
Description = 'The DSC module for Windows Apps'
PowerShellVersion = '7.4'
DscResourcesToExport = @(
'AdvancedAppSettings',
'AppExecutionAliases',
'AppsForWebsites'
)
PrivateData = @{
PSData = @{
# Tags applied to this module. These help with module discovery in online galleries.
Tags = @(
'PSDscResource_AdvancedAppSettings',
'PSDscResource_AppExecutionAliases',
'PSDscResource_AppsForWebsites'
)

# A URL to the license for this module.
LicenseUri = 'https://github.com/microsoft/winget-dsc/blob/main/LICENSE'

# A URL to the main website for this project.
ProjectUri = 'https://github.com/microsoft/winget-dsc'

# Prerelease string of this module
Prerelease = 'alpha'
}
}
}
Loading
Loading