online_endpoints

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

Overview

Name	online_endpoints
Type	Resource
Id	azure.ml_services.online_endpoints

Fields

vw_online_endpoints

Name	Datatype	Description
description	text	field from the properties object
auth_mode	text	field from the properties object
compute	text	field from the properties object
endpointName	text	field from the properties object
identity	text	Managed service identity (system assigned and/or user assigned identities)
keys	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.
location	text	The geo-location where the resource lives
mirror_traffic	text	field from the properties object
properties	text	Online endpoint configuration
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
resourceGroupName	text	field from the properties object
scoring_uri	text	field from the properties object
sku	text	The resource model definition representing SKU
subscriptionId	text	field from the properties object
swagger_uri	text	field from the properties object
tags	text	Resource tags.
traffic	text	field from the properties object
workspaceName	text	field from the properties object

online_endpoints

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	Online endpoint configuration
sku	object	The resource model definition representing SKU
tags	object	Resource tags.

Methods

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

SELECT examples

vw_online_endpoints

SELECT
description,
auth_mode,
compute,
endpointName,
identity,
keys,
kind,
location,
mirror_traffic,
properties,
provisioning_state,
public_network_access,
resourceGroupName,
scoring_uri,
sku,
subscriptionId,
swagger_uri,
tags,
traffic,
workspaceName
FROM azure.ml_services.vw_online_endpoints
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

online_endpoints

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.ml_services.online_endpoints (
endpointName,
resourceGroupName,
subscriptionId,
workspaceName,
data__location,
data__properties,
tags,
location,
identity,
kind,
properties,
sku
)
SELECT 
'{{ 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: authMode
          value: []
        - name: description
          value: string
        - name: keys
          value:
            - name: primaryKey
              value: string
            - name: secondaryKey
              value: string
        - name: properties
          value: object
        - name: scoringUri
          value: string
        - name: swaggerUri
          value: string
        - name: compute
          value: string
        - name: mirrorTraffic
          value: object
        - name: provisioningState
          value: []
        - name: publicNetworkAccess
          value: []
        - name: traffic
          value: object
    - 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_endpoints resource.

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

DELETE example

Deletes the specified online_endpoints resource.

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