health_status
Creates, updates, deletes, gets or lists a health_status resource.
Overview​
| Name | health_status |
| Type | Resource |
| Id | azure.ai_text_analytics.health_status |
Fields​
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
health_status | exec | job_id, endpoint | $top, $skip, showStats | Get healthcare analysis job status and results. Get details of the healthcare prediction job specified by the jobId. |
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 |
|---|---|---|
endpoint | string | The service endpoint host (no scheme). (default: ) |
job_id | string | Job ID. Required. |
$skip | integer | (Optional) Set the number of elements to offset in the response. When both $top and $skip are specified, $skip is applied first. Default value is 0. |
$top | integer | (Optional) Set the maximum number of results per task. When both $top and $skip are specified, $skip is applied first. Default value is 20. |
showStats | boolean | (Optional) if set to true, response will contain request and document level statistics. Default value is None. |
Lifecycle Methods​
- health_status
Get healthcare analysis job status and results. Get details of the healthcare prediction job specified by the jobId.
EXEC azure.ai_text_analytics.health_status.health_status
@job_id='{{ job_id }}' --required,
@endpoint='{{ endpoint }}' --required,
@$top='{{ $top }}',
@$skip='{{ $skip }}',
@showStats={{ showStats }}
;