---
updatedAt: 2026-09-23T12:07:34.000Z
agentTools:
  siteIndex: https://techdocs.akamai.com/llms.txt
  projectIndex: https://techdocs.akamai.com/quick-deploy-apps/llms.txt
---

# Microsoft Agent Framework

Deploy Microsoft Agent Framework, an open source framework for building, orchestrating, and deploying AI agents and multi-agent applications to automate complex workflows.

## 1. Deploy Microsoft Agent Framework

<div class="aligned">
   <img src="https://techdocs.akamai.com/terraform-images/img/clock.png" alt="" height="25" width="25" />
   <span class="span-header">&nbsp;Estimated deployment time:</span><span>&nbsp;5 minutes</span>
</div>

<div><p></p></div>

Follow the [deployment instructions](https://techdocs.akamai.com/quick-deploy-apps/docs/get-started) from the **Get started** section to configure the app, deploy it, and verify software installation.

For information on the app-specific configurations, see the [Configuration options](#configuration-options) section.

### Base distribution and plan

* **Supported distribution:** Ubuntu 24.04 LTS
* **Recommended plans:** All plan types and sizes can be used.

### Configuration options

Configure the required options to deploy your instance. For additional customization, add advanced options.

The table maps the Cloud Manager UI fields to their corresponding API/CLI keys (`stackscript_data`) required for automated deployments.

**StackScript ID:** `2165612`

<table>
    <thead>
        <tr>
            <th>UI field</th>
            <th>API/CLI key</th>
            <th>Description</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td colspan="3">Required options</td>
        </tr>
        <tr>
            <td><b>Limited sudo user</b></td>
            <td><code>user_name</code></td>
            <td>Your preferred username for the limited sudo user, entered without any capital letters, spaces, or special characters.<br /> When adding a limited sudo user, the user is created with a strong generated password for your new Linode instance, and the account is assigned to the <code>sudo</code> group, which provides elevated permissions when running commands with the <code>sudo</code> prefix.
                <blockquote>
                    <b>Note:</b> For easier and more secure access with the sudo user, add an <a href="https://techdocs.akamai.com/cloud-computing/docs/manage-ssh-keys">account SSH key</a> for the Cloud Manager user during deployment and select that user as an <code>authorized_user</code>. Their SSH pubkey will be assigned to both the root and limited sudo users.
                </blockquote>
            </td>
        </tr>
        <tr>
            <td colspan="3">Advanced options</td>
        </tr>
        <tr>
            <td><b>Disable root access over SSH</b></td>
            <td><code>disable_root</code></td>
            <td><i>Applies to a limited sudo user.</i> To block the root user from logging in over SSH, select <i>Yes</i>. Defaults to <i>No</i>. <br />
                <blockquote>
                    <b>Note:</b> When you disable the root user from logging in over SSH and don't provide a valid Account SSH Key assigned to the <code>authorized_user</code>, you can still switch to the root user. To do that, log in as root via the <a href="https://techdocs.akamai.com/cloud-computing/docs/access-your-system-console-using-lish">Lish console</a> and run <code>cat /home/$USERNAME/.credentials</code> to view the generated password for the limited sudo user.
                </blockquote>
            </td>
        </tr>
    </tbody>
</table>

> **Note:** After the app deployment completes, the password for your limited sudo user is generated and stored in the `.credentials` file in the home directory, along with application-specific passwords. Log in to your instance as `root` through the Lish console or SSH, then run `cat /home/$USERNAME/.credentials` to view its contents.

### Use API, CLI, or Terraform

In addition to deploying the app to a new Linode instance via Cloud Manager, you can also use the Linode API, CLI, or Terraform. When running the operation, you need to provide the StackScript ID, supported Linux distribution, and [app-specific fields](#configuration-options) along with the standard Linode deployment configurations.

> **Note:** [Generate a personal access token](https://techdocs.akamai.com/linode-api/reference/get-started#personal-access-tokens) to authenticate your [API](https://techdocs.akamai.com/linode-api/reference/api), [CLI](https://techdocs.akamai.com/cloud-computing/docs/cli-1), or [Terraform](https://registry.terraform.io/providers/linode/linode/latest/docs) requests.

```bash API
curl --location 'https://api.linode.com/v4/linode/instances' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer abc123def456hij789klm' \
    --data-raw '{
        "region": "us-east",
        "type": "g6-standard-2",
        "image": "linode/ubuntu24.04",
        "label": "my-microsoft-agent-framework-one-click-app",
        "root_pass": "@C0mpl3x#P@ssw0rd",
        "stackscript_id": 2165612,
        "stackscript_data": {
            "user_name":"jsmith"
        }
    }'
```
```bash CLI
linode-cli linodes create \
    --region us-east \
    --type g6-standard-2 \
    --label my-microsoft-agent-framework-one-click-app \
    --image linode/ubuntu24.04 \
    --root_pass @C0mpl3x#P@ssw0rd \
    --stackscript_id 2165612 \
    --stackscript_data '{"user_name":"jsmith"}'
```
```json Terraform
resource "linode_instance" "my-linode" {
    region         = "us-east"
    type           = "g6-standard-2"
    label          = "my-microsoft-agent-framework-one-click-app"
    image          = "linode/ubuntu24.04"
    root_pass      = "@C0mpl3x#P@ssw0rd"
    stackscript_id = 2165612
    stackscript_data = {
        "user_name" = "jsmith"
    }
}
```

## 2. Test the Python SDK

Once the deployment is complete, the `agent-framework` library gets installed on your instance. This allows you to import the library into your software. To get started:

1. Create an example directory named `science`.

   ```bash
   mkdir science
   ```

2. Create a test Python file, `agent.py`. It allows you to use our AI model.

   ```bash
   cd science
   vim agent.py
   ```

3. Enter this code into the `agent.py` Python file.

   ```python
   import asyncio
   from openai import AsyncOpenAI
   from agent_framework import Agent
   from agent_framework.openai import OpenAIChatClient

   async def main():
       client = OpenAIChatClient(
           model="Qwen/Qwen3-14B-AWQ",
           base_url="http://localhost:8000/v1",
           api_key="dummy",
       )

       agent = client.as_agent(
           name="Assistant",
           instructions="You are a helpful assistant.",
       )

       result = await agent.run("Why is the sky blue?")

       print(result)

   if __name__ == "__main__":
       asyncio.run(main())
   ```

4. Once you save the file, execute it with the `python3 agent.py` command.

## Additional resources

This example uses a self-hosted model exposed via the LLM’s API. To use a provider model, refer to the [Microsoft Agent Framework documentation](https://learn.microsoft.com/en-us/agent-framework/).

> 📘
>
> Note that we can't vouch for the accuracy or timeliness of externally hosted resources.

# Sibling pages

* [CrewAI](https://techdocs.akamai.com/quick-deploy-apps/docs/crewai.md)
* [Haystack](https://techdocs.akamai.com/quick-deploy-apps/docs/haystack.md)
* [Langflow](https://techdocs.akamai.com/quick-deploy-apps/docs/langflow.md)