Online Deployments - Get Logs

Service:

Machine Learning

API Version:

2023-10-01

Polls an Endpoint operation.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/onlineEndpoints/{endpointName}/deployments/{deploymentName}/getLogs?api-version=2023-10-01

URI Parameters

Name	In	Required	Type	Description
deploymentName	path	True	string	The name and identifier for the endpoint.
endpointName	path	True	string	Inference endpoint name.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
workspaceName	path	True	string	Name of Azure Machine Learning workspace. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
containerType	ContainerType	The type of container to retrieve logs from.
tail	integer	The maximum number of lines to tail.

Responses

Name	Type	Description
200 OK	DeploymentLogs	Success
Other Status Codes	ErrorResponse	Error

Examples

Get Online Deployment Logs.

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspace123/onlineEndpoints/testEndpoint/deployments/testDeployment/getLogs?api-version=2023-10-01

{
  "containerType": "StorageInitializer",
  "tail": 0
}

Sample response

Status code:

200

{
  "content": "string"
}

Definitions

Name	Description
ContainerType
DeploymentLogs
DeploymentLogsRequest
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

ContainerType

Name	Type	Description
InferenceServer	string
StorageInitializer	string

DeploymentLogs

Name	Type	Description
content	string	The retrieved online deployment logs.

DeploymentLogsRequest

Name	Type	Default value	Description
containerType	ContainerType	InferenceServer	The type of container to retrieve logs from.
tail	integer		The maximum number of lines to tail.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.