predictions

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

Overview

Name	predictions
Type	Resource
Id	azure_extras.customer_insights.predictions

Fields

The following fields are returned by SELECT queries:

get

OK. Successfully get the Prediction.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The prediction definition.
type	string	Resource type.

list_by_hub

OK. Successfully get all the predictions in the hub.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The prediction definition.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, hubName, predictionName, subscriptionId		Gets a Prediction in the hub.
list_by_hub	select	resourceGroupName, hubName, subscriptionId		Gets all the predictions in the specified hub.
create_or_update	insert	resourceGroupName, hubName, predictionName, subscriptionId		Creates a Prediction or updates an existing Prediction in the hub.
delete	delete	resourceGroupName, hubName, predictionName, subscriptionId		Deletes a Prediction in the hub.
model_status	exec	resourceGroupName, hubName, predictionName, subscriptionId, status		Creates or updates the model status of prediction.

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
hubName	string	The name of the hub.
predictionName	string	The name of the Prediction.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Gets a Prediction in the hub.

SELECT
id,
name,
properties,
type
FROM azure_extras.customer_insights.predictions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND hubName = '{{ hubName }}' -- required
AND predictionName = '{{ predictionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_hub

Gets all the predictions in the specified hub.

SELECT
id,
name,
properties,
type
FROM azure_extras.customer_insights.predictions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND hubName = '{{ hubName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates a Prediction or updates an existing Prediction in the hub.

INSERT INTO azure_extras.customer_insights.predictions (
data__properties,
resourceGroupName,
hubName,
predictionName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ hubName }}',
'{{ predictionName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: predictions
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the predictions resource.
    - name: hubName
      value: string
      description: Required parameter for the predictions resource.
    - name: predictionName
      value: string
      description: Required parameter for the predictions resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the predictions resource.
    - name: properties
      value: object
      description: |
        The prediction definition.

DELETE examples

delete

Deletes a Prediction in the hub.

DELETE FROM azure_extras.customer_insights.predictions
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND hubName = '{{ hubName }}' --required
AND predictionName = '{{ predictionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

model_status

Creates or updates the model status of prediction.

EXEC azure_extras.customer_insights.predictions.model_status 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@hubName='{{ hubName }}' --required, 
@predictionName='{{ predictionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"status": "{{ status }}"
}'
;