CognitiveServicesAgentDeploymentProperties Class

Definition

Type representing an agent deployment as a management construct. Please note this is the abstract base class. The derived classes available for instantiation are: CognitiveServicesManagedAgentDeployment and CognitiveServicesHostedAgentDeployment.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.ResourceManager.CognitiveServices.Models.UnknownCognitiveServicesAgentDeploymentProperties))]
public abstract class CognitiveServicesAgentDeploymentProperties : Azure.ResourceManager.CognitiveServices.Models.CognitiveServicesResourceBase, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CognitiveServices.Models.CognitiveServicesAgentDeploymentProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CognitiveServices.Models.CognitiveServicesAgentDeploymentProperties>
[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.ResourceManager.CognitiveServices.Models.UnknownCognitiveServicesAgentDeploymentProperties))>]
type CognitiveServicesAgentDeploymentProperties = class
    inherit CognitiveServicesResourceBase
    interface IJsonModel<CognitiveServicesAgentDeploymentProperties>
    interface IPersistableModel<CognitiveServicesAgentDeploymentProperties>
Public MustInherit Class CognitiveServicesAgentDeploymentProperties
Inherits CognitiveServicesResourceBase
Implements IJsonModel(Of CognitiveServicesAgentDeploymentProperties), IPersistableModel(Of CognitiveServicesAgentDeploymentProperties)
Inheritance
CognitiveServicesAgentDeploymentProperties
Derived
Attributes
Implements

Properties

Name Description
Agents

Returns a flat list of agent:version deployed in this deployment.

DeploymentId

Gets or sets the unique identifier of the deployment.

Description

The asset description text.

(Inherited from CognitiveServicesResourceBase)
DisplayName

Gets or sets the display name of the deployment.

Protocols

Gets or sets the supported protocol types and versions exposed by this deployment.

ProvisioningState

Gets or sets the provisioning state of the agent deployment.

State

Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents).

Tags

Tag dictionary. Tags can be added, removed, and updated.

(Inherited from CognitiveServicesResourceBase)

Methods

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

Explicit Interface Implementations

Name Description
IJsonModel<CognitiveServicesAgentDeploymentProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<CognitiveServicesAgentDeploymentProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<CognitiveServicesResourceBase>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from CognitiveServicesResourceBase)
IJsonModel<CognitiveServicesResourceBase>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from CognitiveServicesResourceBase)
IPersistableModel<CognitiveServicesAgentDeploymentProperties>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<CognitiveServicesAgentDeploymentProperties>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<CognitiveServicesAgentDeploymentProperties>.Write(ModelReaderWriterOptions)
IPersistableModel<CognitiveServicesResourceBase>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from CognitiveServicesResourceBase)
IPersistableModel<CognitiveServicesResourceBase>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from CognitiveServicesResourceBase)
IPersistableModel<CognitiveServicesResourceBase>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from CognitiveServicesResourceBase)

Applies to