deployment

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

Overview

Name	deployment
Type	Resource
Id	azure.ai_language.deployment

Fields

The following fields are returned by SELECT queries:

get_deployment_delete_from_resources_status

Name	Datatype	Description
createdDateTime	string (date-time)	The creation date time of the job. Required.
errors	array	The errors encountered while executing the job.
expirationDateTime	string (date-time)	The expiration date time of the job.
jobId	string	The job ID. Required.
lastUpdatedDateTime	string (date-time)	The last date time the job was updated. Required.
status	string	The job status. Required. Known values are: "notStarted", "running", "succeeded", "failed", "cancelled", "cancelling", and "partiallyCompleted". (notStarted, running, succeeded, failed, cancelled, cancelling, partiallyCompleted)
warnings	array	The warnings that were encountered while executing the job.

get_deployment

Name	Datatype	Description
assignedResources	array	Represents the metadata of the assigned Azure resources. Required.
deploymentExpirationDate	string (date)	Represents deployment expiration date in the runtime. Required.
deploymentName	string	Represents deployment name. Required.
lastDeployedDateTime	string (date-time)	Represents deployment last deployed time. Required.
lastTrainedDateTime	string (date-time)	Represents deployment last trained time. Required.
modelId	string	Represents deployment modelId. Required.
modelTrainingConfigVersion	string	Represents model training config version. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_deployment_delete_from_resources_status	select	deployment_name, job_id, project_name, endpoint		Gets the status of an existing delete deployment from specific resources job.
get_deployment	select	deployment_name, project_name, endpoint		Gets the details of a deployment.
delete_deployment	delete	deployment_name, project_name, endpoint		Deletes a project deployment.
deploy_project	exec	deployment_name, project_name, endpoint, trainedModelLabel		Creates a new deployment or replaces an existing one.
get_deployment_status	exec	deployment_name, job_id, project_name, endpoint		Gets the status of an existing deployment job.
delete_deployment_from_resources	exec	deployment_name, project_name, endpoint		Deletes a deployment from the specified project-assigned resources.

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
deployment_name	string	The name of the specific deployment of the project to use. Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client Endpoint parameter. (default: )
job_id	string	The job ID. Required.
project_name	string

SELECT examples

get_deployment_delete_from_resources_status

Gets the status of an existing delete deployment from specific resources job.

SELECT
createdDateTime,
errors,
expirationDateTime,
jobId,
lastUpdatedDateTime,
status,
warnings
FROM azure.ai_language.deployment
WHERE deployment_name = '{{ deployment_name }}' -- required
AND job_id = '{{ job_id }}' -- required
AND project_name = '{{ project_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

get_deployment

Gets the details of a deployment.

SELECT
assignedResources,
deploymentExpirationDate,
deploymentName,
lastDeployedDateTime,
lastTrainedDateTime,
modelId,
modelTrainingConfigVersion
FROM azure.ai_language.deployment
WHERE deployment_name = '{{ deployment_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

DELETE examples

delete_deployment

Deletes a project deployment.

DELETE FROM azure.ai_language.deployment
WHERE deployment_name = '{{ deployment_name }}' --required
AND project_name = '{{ project_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

deploy_project

Creates a new deployment or replaces an existing one.

EXEC azure.ai_language.deployment.deploy_project 
@deployment_name='{{ deployment_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"trainedModelLabel": "{{ trainedModelLabel }}", 
"azureResourceIds": "{{ azureResourceIds }}"
}'
;

get_deployment_status

Gets the status of an existing deployment job.

EXEC azure.ai_language.deployment.get_deployment_status 
@deployment_name='{{ deployment_name }}' --required, 
@job_id='{{ job_id }}' --required, 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

delete_deployment_from_resources

Deletes a deployment from the specified project-assigned resources.

EXEC azure.ai_language.deployment.delete_deployment_from_resources 
@deployment_name='{{ deployment_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"azureResourceIds": "{{ azureResourceIds }}"
}'
;