Share via

Question Answering Projects - List Deployments

Service:
Azure AI Services
API Version:
2021-10-01

List all deployments of a project.

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/deployments?api-version=2021-10-01
With optional parameters: 
GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/deployments?api-version=2021-10-01&top={top}&skip={skip}&maxpagesize={maxpagesize}

URI Parameters

Name In Required Type Description
Endpoint
 path True

string

Supported Cognitive Services endpoint (e.g., https://<resource-name>.api.cognitiveservices.azure.com).
projectName
 path True

string

maxLength: 100

The name of the project to use.
api-version
 query True

string

Client API version.
maxpagesize
 query

integer (int32)

The maximum number of resources to include in a single response.
skip
 query

integer (int32)

An offset into the collection of the first resource to be returned.
top
 query

integer (int32)

The maximum number of resources to return from the collection.

Request Header

Name Required Type Description
Ocp-Apim-Subscription-Key True

string

Responses

Name Type Description
200 OK

ProjectDeployments

List of deployments of a project.
Other Status Codes

ErrorResponse

Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful query

Sample request

GET {Endpoint}/language/query-knowledgebases/projects/proj1/deployments?api-version=2021-10-01

Sample response

Status code:
200 
{
  "value": [
    {
      "deploymentName": "production",
      "lastDeployedDateTime": "2021-05-01T15:13:22Z"
    }
  ]
}

Definitions

Name Description
Error

The error object.
ErrorCode

Human-readable error code.
ErrorResponse

Error response.
InnerErrorCode

Human-readable error code.
InnerErrorModel

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectDeployment

Project deployment details.
ProjectDeployments

All deployments of a project.

Error

Object

The error object.

Name Type Description
code

ErrorCode

One of a server-defined set of error codes.
details

Error[]

An array of details about specific errors that led to this reported error.
innererror

InnerErrorModel

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.

ErrorCode

Enumeration

Human-readable error code.

Value Description
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable

ErrorResponse

Object

Error response.

Name Type Description
error

Error

The error object.

InnerErrorCode

Enumeration

Human-readable error code.

Value Description
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure

InnerErrorModel

Object

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

Name Type Description
code

InnerErrorCode

One of a server-defined set of error codes.
details

object

Error details.
innererror

InnerErrorModel

An object containing more specific information than the current object about the error.
message

string

Error message.
target

string

Error target.

ProjectDeployment

Object

Project deployment details.

Name Type Description
deploymentName

string

Name of the deployment.
lastDeployedDateTime

string (date-time)

Represents the project last deployment date-time.

ProjectDeployments

Object

All deployments of a project.

Name Type Description
nextLink

string

value

ProjectDeployment[]

List of deployments of a project.