Share via


VoiceLiveMcpServerDefinition Class

Definition

The definition of an MCP server as used by the voicelive endpoint.

public class VoiceLiveMcpServerDefinition : Azure.AI.VoiceLive.VoiceLiveToolDefinition, System.ClientModel.Primitives.IJsonModel<Azure.AI.VoiceLive.VoiceLiveMcpServerDefinition>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.VoiceLive.VoiceLiveMcpServerDefinition>
type VoiceLiveMcpServerDefinition = class
    inherit VoiceLiveToolDefinition
    interface IJsonModel<VoiceLiveMcpServerDefinition>
    interface IPersistableModel<VoiceLiveMcpServerDefinition>
Public Class VoiceLiveMcpServerDefinition
Inherits VoiceLiveToolDefinition
Implements IJsonModel(Of VoiceLiveMcpServerDefinition), IPersistableModel(Of VoiceLiveMcpServerDefinition)
Inheritance
VoiceLiveMcpServerDefinition
Implements

Constructors

Name Description
VoiceLiveMcpServerDefinition(String, String)

Initializes a new instance of VoiceLiveMcpServerDefinition.

Properties

Name Description
AllowedTools

Gets the AllowedTools.

Authorization

Gets or sets the Authorization.

Headers

Gets the Headers.

RequireApproval

Gets or sets the RequireApproval.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

<remarks> Supported types:

</remarks>

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

ServerLabel

Gets or sets the ServerLabel.

ServerUrl

Gets or sets the ServerUrl.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<VoiceLiveMcpServerDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<VoiceLiveMcpServerDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<VoiceLiveToolDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from VoiceLiveToolDefinition)
IJsonModel<VoiceLiveToolDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from VoiceLiveToolDefinition)
IPersistableModel<VoiceLiveMcpServerDefinition>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<VoiceLiveMcpServerDefinition>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<VoiceLiveMcpServerDefinition>.Write(ModelReaderWriterOptions)
IPersistableModel<VoiceLiveToolDefinition>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from VoiceLiveToolDefinition)
IPersistableModel<VoiceLiveToolDefinition>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from VoiceLiveToolDefinition)
IPersistableModel<VoiceLiveToolDefinition>.Write(ModelReaderWriterOptions) (Inherited from VoiceLiveToolDefinition)

Applies to