Salad.Cloud.IMDS.SDK 0.9.0-alpha.3

Prefix Reserved
This is a prerelease version of Salad.Cloud.IMDS.SDK.
dotnet add package Salad.Cloud.IMDS.SDK --version 0.9.0-alpha.3                
NuGet\Install-Package Salad.Cloud.IMDS.SDK -Version 0.9.0-alpha.3                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Salad.Cloud.IMDS.SDK" Version="0.9.0-alpha.3" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Salad.Cloud.IMDS.SDK --version 0.9.0-alpha.3                
#r "nuget: Salad.Cloud.IMDS.SDK, 0.9.0-alpha.3"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Salad.Cloud.IMDS.SDK as a Cake Addin
#addin nuget:?package=Salad.Cloud.IMDS.SDK&version=0.9.0-alpha.3&prerelease

// Install Salad.Cloud.IMDS.SDK as a Cake Tool
#tool nuget:?package=Salad.Cloud.IMDS.SDK&version=0.9.0-alpha.3&prerelease                

SaladCloudImdsSdk C# SDK 0.9.0-alpha.3

Welcome to the SaladCloudImdsSdk SDK documentation. This guide will help you get started with integrating and using the SaladCloudImdsSdk SDK in your project.

Versions

  • API version: 0.9.0-alpha.1
  • SDK version: 0.9.0-alpha.3

About the API

The SaladCloud Instance Metadata Service (IMDS). Please refer to the SaladCloud API Documentation for more details.

Table of Contents

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: C# >= .NET 6

Installation

To get started with the SDK, we recommend installing using nuget:

dotnet add package Salad.Cloud.IMDS.SDK

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

using Salad.Cloud.IMDS.SDK;
using Salad.Cloud.IMDS.SDK.Config;
using Environment = Salad.Cloud.IMDS.SDK.Http.Environment;

var config = new SaladCloudImdsSdkConfig
{
  Environment = Environment.Default
};

var client = new SaladCloudImdsSdkClient(config);

var response = await client.Metadata.GetContainerStatusAsync();

Console.WriteLine(response);

Services

The SDK provides various services to interact with the API.

<details> <summary>Below is a list of all available services with links to their detailed documentation:</summary>

Name
MetadataService

</details>

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

<details> <summary>Below is a list of all available models with links to their detailed documentation:</summary>

Name Description
ReallocateContainer Represents a request to reallocate a container.
ContainerStatus Represents the health statuses of the running container.
ContainerToken Represents the identity token of the running container.

</details>

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net6.0

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.9.0-alpha.3 56 9/17/2024
0.9.0-alpha.2 48 9/11/2024
0.9.0-alpha.1 54 9/6/2024