Windows App

https://learn.microsoft.com/en-us/windows-app
Admin
Windows App enables secure connections to Windows devices and apps including Azure Virtual Desktop,...
Tokens:220,241
Snippets:1,886
Trust Score:10
Update:8 months ago
Show doc for...
Tokens:
Raw
### Windows App CLI - Getting Started

Source: https://learn.microsoft.com/en-us/windows-app/cli-macos

This section covers the initial steps to run commands using the Windows App CLI on macOS, including navigating to the correct directory and printing the general help message.

```APIDOC
## GET /websites/learn_microsoft_en-us_windows-app

### Description
This documentation explains how to use the command line interface (CLI) for Windows App on macOS. The CLI allows for efficient task automation and management of connections.

### Method
GET

### Endpoint
/websites/learn_microsoft_en-us_windows-app

### Parameters

#### Query Parameters
None

### Request Example
N/A (This is documentation, not an executable endpoint)

### Response
N/A (This is documentation, not an executable endpoint)

## Navigating to the Windows App Directory

### Description
Change the current directory in the Terminal app to the location of the Windows App executable.

### Method
N/A (Shell command)

### Endpoint
N/A

### Command
```bash
cd '/Applications/Windows App.app/Contents/MacOS'
```

## Printing General Help Message

### Description
Run the Windows App executable with the `--script` flag to display the available modules and general usage instructions.

### Method
N/A (Shell command)

### Endpoint
N/A

### Command
```bash
./'Windows App' --script
```

### Response Example
```
Usage:

  --script <module> <parameters>

  Modules:

    bookmark  Create, edit or delete a connection bookmark.
    feed      Subscribe to a resource feed, or edit or delete a subscription.
    gateway   Create, edit or delete a Remote Desktop gateway.
    defaults  Display client settings configurable through the defaults command

  To get help for a specific module:

    --script <module> help

  Examples:

    --script bookmark help
    --script feed help
    --script gateway help
```
```

--------------------------------

### Example Azure Virtual Desktop Direct Launch URL

Source: https://learn.microsoft.com/en-us/windows-app/direct-launch-urls

A complete example of an Azure Virtual Desktop direct launch URL, demonstrating the inclusion of workspace ID, resource ID, tenant ID, and a login hint.

```url
https://windows.cloud.microsoft/webclient/avd/00000000-0000-0000-0000-000000000000/11111111-1111-1111-1111-111111111111?tenant=22222222-2222-2222-2222-222222222222#loginHint=user@contoso.com
```

--------------------------------

### Example of a Fully Formatted Windows App URL

Source: https://learn.microsoft.com/en-us/windows-app/direct-launch-urls_source=recommendations&tabs=avd

This is an example of a complete URL incorporating a workspace ID, tenant ID, and a login hint for a specific user. The login hint fragment must always be at the end of the URL.

```url
https://windows.cloud.microsoft/webclient/ent/00000000-0000-0000-0000-000000000000?tenant=11111111-1111-1111-1111-111111111111#loginHint=user@contoso.com
```
Tokens:
Raw