online_deployments

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

Overview

Name	online_deployments
Type	Resource
Id	azure.ml_services.online_deployments

Fields

vw_online_deployments

Name	Datatype	Description
description	text	field from the properties object
app_insights_enabled	text	field from the properties object
code_configuration	text	field from the properties object
data_collector	text	field from the properties object
deploymentName	text	field from the properties object
egress_public_network_access	text	field from the properties object
endpointName	text	field from the properties object
endpoint_compute_type	text	field from the properties object
environment_id	text	field from the properties object
environment_variables	text	field from the properties object
identity	text	Managed service identity (system assigned and/or user assigned identities)
instance_type	text	field from the properties object
kind	text	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
liveness_probe	text	field from the properties object
location	text	The geo-location where the resource lives
model	text	field from the properties object
model_mount_path	text	field from the properties object
properties	text	field from the properties object
provisioning_state	text	field from the properties object
readiness_probe	text	field from the properties object
request_settings	text	field from the properties object
resourceGroupName	text	field from the properties object
scale_settings	text	field from the properties object
sku	text	The resource model definition representing SKU
subscriptionId	text	field from the properties object
tags	text	Resource tags.
workspaceName	text	field from the properties object

online_deployments

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities)
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
location	string	The geo-location where the resource lives
properties	object
sku	object	The resource model definition representing SKU
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	deploymentName, endpointName, resourceGroupName, subscriptionId, workspaceName
list	SELECT	endpointName, resourceGroupName, subscriptionId, workspaceName
create_or_update	INSERT	deploymentName, endpointName, resourceGroupName, subscriptionId, workspaceName, data__location, data__properties
delete	DELETE	deploymentName, endpointName, resourceGroupName, subscriptionId, workspaceName
update	UPDATE	deploymentName, endpointName, resourceGroupName, subscriptionId, workspaceName

SELECT examples

vw_online_deployments

SELECT
description,
app_insights_enabled,
code_configuration,
data_collector,
deploymentName,
egress_public_network_access,
endpointName,
endpoint_compute_type,
environment_id,
environment_variables,
identity,
instance_type,
kind,
liveness_probe,
location,
model,
model_mount_path,
properties,
provisioning_state,
readiness_probe,
request_settings,
resourceGroupName,
scale_settings,
sku,
subscriptionId,
tags,
workspaceName
FROM azure.ml_services.vw_online_deployments
WHERE endpointName = '{{ endpointName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

online_deployments

SELECT
identity,
kind,
location,
properties,
sku,
tags
FROM azure.ml_services.online_deployments
WHERE endpointName = '{{ endpointName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

INSERT example

Use the following StackQL query and manifest file to create a new online_deployments resource.

All Properties

/*+ create */
INSERT INTO azure.ml_services.online_deployments (
deploymentName,
endpointName,
resourceGroupName,
subscriptionId,
workspaceName,
data__location,
data__properties,
tags,
location,
identity,
kind,
properties,
sku
)
SELECT 
'{{ deploymentName }}',
'{{ endpointName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ data__location }}',
'{{ data__properties }}',
'{{ tags }}',
'{{ location }}',
'{{ identity }}',
'{{ kind }}',
'{{ properties }}',
'{{ sku }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: []
        - name: userAssignedIdentities
          value: []
    - name: kind
      value: string
    - name: properties
      value:
        - name: codeConfiguration
          value:
            - name: codeId
              value: string
            - name: scoringScript
              value: string
        - name: description
          value: string
        - name: environmentId
          value: string
        - name: environmentVariables
          value: object
        - name: properties
          value: object
        - name: appInsightsEnabled
          value: boolean
        - name: dataCollector
          value:
            - name: collections
              value: object
            - name: requestLogging
              value:
                - name: captureHeaders
                  value:
                    - string
            - name: rollingRate
              value: []
        - name: egressPublicNetworkAccess
          value: []
        - name: endpointComputeType
          value: []
        - name: instanceType
          value: string
        - name: livenessProbe
          value:
            - name: failureThreshold
              value: integer
            - name: initialDelay
              value: string
            - name: period
              value: string
            - name: successThreshold
              value: integer
            - name: timeout
              value: string
        - name: model
          value: string
        - name: modelMountPath
          value: string
        - name: provisioningState
          value: []
        - name: requestSettings
          value:
            - name: maxConcurrentRequestsPerInstance
              value: integer
            - name: maxQueueWait
              value: string
            - name: requestTimeout
              value: string
        - name: scaleSettings
          value:
            - name: scaleType
              value: []
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: []
        - name: size
          value: string
        - name: family
          value: string
        - name: capacity
          value: integer

UPDATE example

Updates a online_deployments resource.

/*+ update */
UPDATE azure.ml_services.online_deployments
SET 
tags = '{{ tags }}',
sku = '{{ sku }}'
WHERE 
deploymentName = '{{ deploymentName }}'
AND endpointName = '{{ endpointName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

DELETE example

Deletes the specified online_deployments resource.

/*+ delete */
DELETE FROM azure.ml_services.online_deployments
WHERE deploymentName = '{{ deploymentName }}'
AND endpointName = '{{ endpointName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';