KuduApi.Client

A .NET client wrapper for using the Kudu API with strong-typed requests and responses.

Getting Started

The KuduApi.Client can be installed using the Nuget package manager or the dotnet CLI.

dotnet add package KuduApi.Client

You can instatie a new Kudu API client by calling the factory:

using KuduApi.Client;

var settings = new KuduApiClientSettings()
{
    Endpoint = "https://yourwebsite.scm.azurewebsites.net/api/",
    DeploymentUsername = "$yourwebsite",
    DeploymentCredentials = "P@$$W0RD!",
    HttpClient = new HttpClient(); // Optional Bring Your Own HttpClient (BYOH).
};

var client = KuduApiClientFactory.Create(settings);

var webJobs = await client.WebJobs.GetAll();

Endpoints

Not all endpoints are currently implemented.

• Commands (interface)
• Environment (interface)
• WebJobs API* (interface)
• Deployments* (interface)
• scm
• VFS
• Zip
• Zip Deployment
• SSHKey
• Settings
• Diagnostics
• Diagnostics/Settings
• SiteExtensions

* Some endpoints are currently not implemented.

Roadmap

If you want to see a new feature or new endpoint available feel free to create a new issue or pull request. Here are some features which are planned when there is enough enthusiasm for this NuGet package.

• Wrapper implemented for /api/commands/
• Wrapper implemented for /api/environment/
• Minimal wrappers for /api/deployments and /api/webjobs/
• Create method uploading a new triggered and continuous webjob.
• Creating methods for missing endpoints of /api/deployments/
• Creating wrappers for all other endpoints.
• Probably better documentation for usages.

Usefull resources

• How to get your deployment credentials.