endpoints

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

Overview

Name	endpoints
Type	Resource
Id	azure.ml_services.endpoints

Fields

The following fields are returned by SELECT queries:

get

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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	endpointType, includeInferenceEndpoints, $skip, $expand
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, endpointName, data__properties
regenerate_keys	exec	subscriptionId, resourceGroupName, workspaceName, endpointName

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	Name of the endpoint resource.
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
$expand	string	Whether the endpoint resource will be expand to include deployment information, e.g. $expand=deployments
$skip	string	Continuation token for pagination.
endpointType	string	Endpoint type filter
includeInferenceEndpoints	boolean

SELECT examples

get

The request was successful; the request was well-formed and received properly.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.ml_services.endpoints
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND endpointName = '{{ endpointName }}' -- required
;

list

The request was successful; the request was well-formed and received properly.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.ml_services.endpoints
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND endpointType = '{{ endpointType }}'
AND includeInferenceEndpoints = '{{ includeInferenceEndpoints }}'
AND $skip = '{{ $skip }}'
AND $expand = '{{ $expand }}'
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure.ml_services.endpoints (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
endpointName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ endpointName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: endpoints
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the endpoints resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the endpoints resource.
    - name: workspaceName
      value: string
      description: Required parameter for the endpoints resource.
    - name: endpointName
      value: string
      description: Required parameter for the endpoints resource.
    - name: properties
      value: object

Lifecycle Methods

regenerate_keys

The request was successful; the request was well-formed and received properly.

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