endpoints

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

Overview

Name	endpoints
Type	Resource
Id	azure.ml_services.endpoints

Fields

vw_endpoints

Name	Datatype	Description
id	text	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	text	The name of the resource
associated_resource_id	text	field from the properties object
deployments	text	field from the properties object
endpointName	text	field from the properties object
endpoint_type	text	field from the properties object
endpoint_uri	text	field from the properties object
failure_reason	text	field from the properties object
location	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
should_create_ai_services_endpoint	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
type	text	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
workspaceName	text	field from the properties object

endpoints

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

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__properties
regenerate_keys	EXEC	endpointName, resourceGroupName, subscriptionId, workspaceName

SELECT examples

vw_endpoints

SELECT
id,
name,
associated_resource_id,
deployments,
endpointName,
endpoint_type,
endpoint_uri,
failure_reason,
location,
provisioning_state,
resourceGroupName,
should_create_ai_services_endpoint,
subscriptionId,
system_data,
type,
workspaceName
FROM azure.ml_services.vw_endpoints
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

endpoints

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.ml_services.endpoints (
endpointName,
resourceGroupName,
subscriptionId,
workspaceName,
data__properties,
properties
)
SELECT 
'{{ endpointName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ data__properties }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: properties
      value:
        - name: associatedResourceId
          value: string
        - name: deployments
          value:
            - - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: properties
                value:
                  - name: failureReason
                    value: string
                  - name: provisioningState
                    value: []
                  - name: type
                    value: string
        - name: endpointType
          value: string
        - name: endpointUri
          value: string
        - name: failureReason
          value: string
        - name: location
          value: string
        - name: name
          value: string
        - name: shouldCreateAiServicesEndpoint
          value: boolean