datastores

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

Overview

Name	datastores
Type	Resource
Id	azure.ml_services.datastores

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	[Required] Additional attributes of the entity. (x-ms-client-name: DatastoreProperties)

list

Name	Datatype	Description
properties	object	[Required] Additional attributes of the entity. (x-ms-client-name: DatastoreProperties)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, name
list	select	subscriptionId, resourceGroupName, workspaceName	$skip, count, isDefault, names, searchText, orderBy, orderByAsc
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, name, data__properties	skipValidation
delete	delete	subscriptionId, resourceGroupName, workspaceName, name

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
name	string	Datastore 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.
count	integer (int32)	Maximum number of results to return.
isDefault	boolean	Filter down to the workspace default datastore.
names	array	Names of datastores to return.
orderBy	string	Order by property (createdtime | modifiedtime | name).
orderByAsc	boolean	Order by property in ascending order.
searchText	string	Text to search for in the datastore names.
skipValidation	boolean	Flag to skip validation.

SELECT examples

get

Success

SELECT
properties
FROM azure.ml_services.datastores
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND name = '{{ name }}' -- required
;

list

Success

SELECT
properties
FROM azure.ml_services.datastores
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND $skip = '{{ $skip }}'
AND count = '{{ count }}'
AND isDefault = '{{ isDefault }}'
AND names = '{{ names }}'
AND searchText = '{{ searchText }}'
AND orderBy = '{{ orderBy }}'
AND orderByAsc = '{{ orderByAsc }}'
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure.ml_services.datastores (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
name,
skipValidation
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ name }}',
'{{ skipValidation }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: datastores
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the datastores resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the datastores resource.
    - name: workspaceName
      value: string
      description: Required parameter for the datastores resource.
    - name: name
      value: string
      description: Required parameter for the datastores resource.
    - name: properties
      value: object
      description: |
        [Required] Additional attributes of the entity.
    - name: skipValidation
      value: boolean
      description: Flag to skip validation.

DELETE examples

delete

No description available.

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