Share via


CognitiveServicesAccountDeploymentProperties Class

Definition

Properties of Cognitive Services account deployment.

public class CognitiveServicesAccountDeploymentProperties : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CognitiveServices.Models.CognitiveServicesAccountDeploymentProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CognitiveServices.Models.CognitiveServicesAccountDeploymentProperties>
type CognitiveServicesAccountDeploymentProperties = class
    interface IJsonModel<CognitiveServicesAccountDeploymentProperties>
    interface IPersistableModel<CognitiveServicesAccountDeploymentProperties>
Public Class CognitiveServicesAccountDeploymentProperties
Implements IJsonModel(Of CognitiveServicesAccountDeploymentProperties), IPersistableModel(Of CognitiveServicesAccountDeploymentProperties)
Inheritance
CognitiveServicesAccountDeploymentProperties
Implements

Constructors

Name Description
CognitiveServicesAccountDeploymentProperties()

Initializes a new instance of CognitiveServicesAccountDeploymentProperties.

Properties

Name Description
CallRateLimit

The call rate limit Cognitive Services account.

Capabilities

The capabilities.

CapacitySettings

Internal use only.

CurrentCapacity

The current capacity.

DeploymentState

The state of the deployment. Controls whether the deployment is accepting inference requests. Use 'Running' for active deployments that process requests, or 'Paused' to temporarily stop inference while preserving the deployment configuration.

IsDynamicThrottlingEnabled

If the dynamic throttling is enabled.

Model

Properties of Cognitive Services account deployment model.

ParentDeploymentName

The name of parent deployment.

ProvisioningState

Gets the status of the resource at the time the operation was called.

RaiPolicyName

The name of RAI policy.

RateLimits

Gets the RateLimits.

Routing

Routing configuration for the deployment. This property is only applicable when the deployed model is 'model-router' version 2025-11-18 or later. Allows you to select the models subset for routing and the routing mode (balanced, accuracy, cost) for routing across all supported models or the model subset.

ScaleSettings

Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.).

ServiceTier

The service tier for the deployment. Determines the pricing and performance level for request processing. Use 'Default' for standard pricing or 'Priority' for higher-priority processing with premium pricing. Note: Pause operations are only supported on Standard, DataZoneStandard, and GlobalStandard SKUs.

SpilloverDeploymentName

Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit.

VersionUpgradeOption

Deployment model version upgrade option.

Methods

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

Explicit Interface Implementations

Name Description
IJsonModel<CognitiveServicesAccountDeploymentProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<CognitiveServicesAccountDeploymentProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CognitiveServicesAccountDeploymentProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CognitiveServicesAccountDeploymentProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<CognitiveServicesAccountDeploymentProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to