Share via

DeploymentProperties Class

Properties of Cognitive Services account deployment.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

DeploymentProperties(*, model: _models.DeploymentModel | None = None, scale_settings: _models.DeploymentScaleSettings | None = None, rai_policy_name: str | None = None, version_upgrade_option: str | _models.DeploymentModelVersionUpgradeOption | None = None, current_capacity: int | None = None, capacity_settings: _models.DeploymentCapacitySettings | None = None, parent_deployment_name: str | None = None, spillover_deployment_name: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
model
DeploymentModel

Properties of Cognitive Services account deployment model.

Default value: None
scale_settings
DeploymentScaleSettings

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

Default value: None
rai_policy_name
str

The name of RAI policy.

Default value: None
version_upgrade_option
str or DeploymentModelVersionUpgradeOption

Deployment model version upgrade option. Known values are: "OnceNewDefaultVersionAvailable", "OnceCurrentVersionExpired", and "NoAutoUpgrade".

Default value: None
current_capacity
int

The current capacity.

Default value: None
capacity_settings
DeploymentCapacitySettings

Internal use only.

Default value: None
parent_deployment_name
str

The name of parent deployment.

Default value: None
spillover_deployment_name
str

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

Default value: None

Variables

Name Description
provisioning_state
str or DeploymentProvisioningState

Gets the status of the resource at the time the operation was called. Known values are: "Accepted", "Creating", "Deleting", "Moving", "Failed", "Succeeded", "Disabled", and "Canceled".
model
DeploymentModel

Properties of Cognitive Services account deployment model.
scale_settings
DeploymentScaleSettings

Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.).
capabilities
dict[str, str]

The capabilities.
rai_policy_name
str

The name of RAI policy.
call_rate_limit
CallRateLimit

The call rate limit Cognitive Services account.
rate_limits
list[ThrottlingRule]
version_upgrade_option
str or DeploymentModelVersionUpgradeOption

Deployment model version upgrade option. Known values are: "OnceNewDefaultVersionAvailable", "OnceCurrentVersionExpired", and "NoAutoUpgrade".
dynamic_throttling_enabled
bool

If the dynamic throttling is enabled.
current_capacity
int

The current capacity.
capacity_settings
DeploymentCapacitySettings

Internal use only.
parent_deployment_name
str

The name of parent deployment.
spillover_deployment_name
str

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