ConversationAuthoringClient.GetDeployment Method

Definition

Namespace:

Azure.AI.Language.Conversations.Authoring

Assembly:

Azure.AI.Language.Conversations.dll

Package:

Azure.AI.Language.Conversations v1.1.0

Source:

ConversationAuthoringClient.cs

Gets the deployment details for a specified project and deployment name.

public virtual Azure.Response GetDeployment (string projectName, string deploymentName, Azure.RequestContext context = default);

abstract member GetDeployment : string * string * Azure.RequestContext -> Azure.Response
override this.GetDeployment : string * string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetDeployment (projectName As String, deploymentName As String, Optional context As RequestContext = Nothing) As Response

Parameters

projectName

String

The name of the project.

deploymentName

String

The name of the deployment.

context

RequestContext

The request context.

Returns

Response

A Response containing the deployment details.

Exceptions

ArgumentNullException

projectName or deploymentName is null.

ArgumentException

projectName or deploymentName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetDeployment with required parameters and parse the result.

var credential = new AzureKeyCredential("<key>");
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ConversationAuthoringClient(endpoint, credential);

Response response = client.GetDeployment("<projectName>", "<deploymentName>");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("deploymentName").ToString());
Console.WriteLine(result.GetProperty("modelId").ToString());
Console.WriteLine(result.GetProperty("lastTrainedDateTime").ToString());
Console.WriteLine(result.GetProperty("lastDeployedDateTime").ToString());
Console.WriteLine(result.GetProperty("deploymentExpirationDate").ToString());
Console.WriteLine(result.GetProperty("modelTrainingConfigVersion").ToString());

Remarks

Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/get-deployment