Deployments - Get

Service:

AI Foundry

API Version:

v1

Get a deployed model.

GET {endpoint}/deployments/{name}?api-version=v1

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (uri)	Project endpoint. In the form "https://<your-ai-services-account-name>.services.ai.azure.com/api/projects/_project" if your Foundry Hub has only one Project, or to use the default Project in your Hub. Or in the form "https://<your-ai-services-account-name>.services.ai.azure.com/api/projects/<your-project-name>" if you want to explicitly specify the Foundry Project name.
name	path	True	string	Name of the deployment
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Header

Name	Required	Type	Description
x-ms-client-request-id		string (uuid)	An opaque, globally-unique, client-generated string identifier for the request.

Responses

Name	Type	Description
200 OK	Deployment: ModelDeployment	The request has succeeded. Headers x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Scopes

Name	Description
https://ai.azure.com/.default

Examples

Deployments_Get_MaximumSet

Sample request

HTTP

GET {endpoint}/deployments/ft?api-version=v1

Sample response

Status code:

200

{
  "type": "Deployment",
  "name": "yfnhkglimmtfavwsetvoopcuyewygg"
}

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
DeploymentType
ModelDeployment	Model Deployment Definition
Sku	Sku information

Azure.Core.Foundations.Error

Object

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

DeploymentType

Enumeration

Value	Description
ModelDeployment	Model deployment

ModelDeployment

Object

Model Deployment Definition

Name	Type	Description
capabilities	object	Capabilities of deployed model
connectionName	string	Name of the connection the deployment comes from
modelName	string	Publisher-specific name of the deployed model
modelPublisher	string	Name of the deployed model's publisher
modelVersion	string	Publisher-specific version of the deployed model
name	string	Name of the deployment
sku	Sku	Sku of the model deployment
type	string: ModelDeployment	The type of the deployment

Sku

Object

Sku information

Name	Type	Description
capacity	integer (int64)	Sku capacity
family	string	Sku family
name	string	Sku name
size	string	Sku size
tier	string	Sku tier