deployments

Creates, updates, deletes, gets or lists a deployments resource.

Overview

Name	deployments
Type	Resource
Id	azure.ai_projects.deployments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Name of the deployment. Required.
type	string	The type of the deployment. Required. "ModelDeployment"

list

Name	Datatype	Description
name	string	Name of the deployment. Required.
type	string	The type of the deployment. Required. "ModelDeployment"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	name, endpoint		Get a deployment. Gets a deployed model.
list	select	endpoint	modelPublisher, modelName, deploymentType	List deployments. Returns the deployed models available in the current project, optionally filtered by publisher, model name, or deployment type.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
name	string	Name of the deployment. Required.
deploymentType	string	Type of deployment to filter list by. "ModelDeployment" Default value is None.
modelName	string	Model name (the publisher specific name) to filter models by. Default value is None.
modelPublisher	string	Model publisher to filter models by. Default value is None.

SELECT examples

get

Get a deployment. Gets a deployed model.

SELECT
name,
type
FROM azure.ai_projects.deployments
WHERE name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List deployments. Returns the deployed models available in the current project, optionally filtered by publisher, model name, or deployment type.

SELECT
name,
type
FROM azure.ai_projects.deployments
WHERE endpoint = '{{ endpoint }}' -- required
AND modelPublisher = '{{ modelPublisher }}'
AND modelName = '{{ modelName }}'
AND deploymentType = '{{ deploymentType }}'
;