LocalShellExecAction Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Execute a shell command on the server.
public class LocalShellExecAction : Azure.AI.AgentServer.Contracts.Generated.Common.IUtf8JsonSerializable, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.LocalShellExecAction>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.LocalShellExecAction>type LocalShellExecAction = class
interface IUtf8JsonSerializable
interface IJsonModel<LocalShellExecAction>
interface IPersistableModel<LocalShellExecAction>Public Class LocalShellExecAction
Implements IJsonModel(Of LocalShellExecAction), IPersistableModel(Of LocalShellExecAction), IUtf8JsonSerializable- Inheritance
-
LocalShellExecAction
- Implements
Constructors
| Name | Description |
|---|---|
| LocalShellExecAction() |
Initializes a new instance of LocalShellExecAction for deserialization. |
| LocalShellExecAction(IEnumerable<String>, IDictionary<String,String>) |
Initializes a new instance of LocalShellExecAction. |
| LocalShellExecAction(LocalShellExecActionType, IList<String>, Nullable<Int32>, String, IDictionary<String,String>, String, IDictionary<String,BinaryData>) |
Initializes a new instance of LocalShellExecAction. |
Properties
| Name | Description |
|---|---|
| Command |
The command to run. |
| Env |
Environment variables to set for the command. |
| TimeoutMs |
Optional timeout in milliseconds for the command. |
| Type |
The type of the local shell action. Always |
| User |
Optional user to run the command as. |
| WorkingDirectory |
Optional working directory to run the command in. |
Methods
| Name | Description |
|---|---|
| DeserializeLocalShellExecAction(JsonElement, ModelReaderWriterOptions) | |
| FromResponse(Response) |
Deserializes the model from a raw response. |
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
| ToRequestContent() |
Convert into a RequestContent. |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<LocalShellExecAction>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<LocalShellExecAction>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<LocalShellExecAction>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<LocalShellExecAction>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<LocalShellExecAction>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
| IUtf8JsonSerializable.Write(Utf8JsonWriter) | |
