online_endpoints

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

Overview

Name	online_endpoints
Type	Resource
Id	azure.ml_services.online_endpoints

Fields

The following fields are returned by SELECT queries:

get

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	[Required] Additional attributes of the entity. (x-ms-client-name: OnlineEndpointProperties)
sku	object	The resource model definition representing SKU
tags	object	Resource tags.

list

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	[Required] Additional attributes of the entity. (x-ms-client-name: OnlineEndpointProperties)
sku	object	The resource model definition representing SKU
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, endpointName
list	select	subscriptionId, resourceGroupName, workspaceName	name, count, computeType, $skip, tags, properties, orderBy
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, endpointName, data__location, data__properties
update	update	subscriptionId, resourceGroupName, workspaceName, endpointName
delete	delete	subscriptionId, resourceGroupName, workspaceName, endpointName
regenerate_keys	exec	subscriptionId, resourceGroupName, workspaceName, endpointName, keyType

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
endpointName	string	Online Endpoint name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	Azure Machine Learning Workspace Name
$skip	string	Continuation token for pagination.
computeType	string	EndpointComputeType to be filtered by.
count	integer (int32)	Number of endpoints to be retrieved in a page of results.
name	string	Name of the endpoint.
orderBy	string	The option to order the response.
properties	string	A set of properties with which to filter the returned models. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 .
tags	string	A set of tags with which to filter the returned models. It is a comma separated string of tags key or tags key=value. Example: tagKey1,tagKey2,tagKey3=value3 .

SELECT examples

get

Success

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

list

Success

SELECT
identity,
kind,
location,
properties,
sku,
tags
FROM azure.ml_services.online_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND name = '{{ name }}'
AND count = '{{ count }}'
AND computeType = '{{ computeType }}'
AND $skip = '{{ $skip }}'
AND tags = '{{ tags }}'
AND properties = '{{ properties }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure.ml_services.online_endpoints (
data__tags,
data__location,
data__identity,
data__kind,
data__properties,
data__sku,
subscriptionId,
resourceGroupName,
workspaceName,
endpointName
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ identity }}',
'{{ kind }}',
'{{ properties }}' /* required */,
'{{ sku }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ endpointName }}'
RETURNING
identity,
kind,
location,
properties,
sku,
tags
;

Manifest

# Description fields are for documentation purposes
- name: online_endpoints
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the online_endpoints resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the online_endpoints resource.
    - name: workspaceName
      value: string
      description: Required parameter for the online_endpoints resource.
    - name: endpointName
      value: string
      description: Required parameter for the online_endpoints resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: identity
      value: object
      description: |
        Managed service identity (system assigned and/or user assigned identities)
    - name: kind
      value: string
      description: |
        Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
    - name: properties
      value: object
      description: |
        [Required] Additional attributes of the entity.
    - name: sku
      value: object
      description: |
        The resource model definition representing SKU

UPDATE examples

update

No description available.

UPDATE azure.ml_services.online_endpoints
SET 
data__tags = '{{ tags }}',
data__identity = '{{ identity }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND endpointName = '{{ endpointName }}' --required
RETURNING
identity,
kind,
location,
properties,
sku,
tags;

DELETE examples

delete

No description available.

DELETE FROM azure.ml_services.online_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND endpointName = '{{ endpointName }}' --required
;

Lifecycle Methods

regenerate_keys

Success

EXEC azure.ml_services.online_endpoints.regenerate_keys 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@endpointName='{{ endpointName }}' --required 
@@json=
'{
"keyType": "{{ keyType }}", 
"keyValue": "{{ keyValue }}"
}'
;