data_stores

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

Overview

Name	data_stores
Type	Resource
Id	azure.hybrid_data_manager.data_stores

Fields

The following fields are returned by SELECT queries:

get

The data store/repository which matches the name given.

Name	Datatype	Description
id	string	Id of the object.
name	string	Name of the object.
properties	object	DataStore properties.
type	string	Type of the object.

list_by_data_manager

The list of data stores/repositories in the given resource.

Name	Datatype	Description
id	string	Id of the object.
name	string	Name of the object.
properties	object	DataStore properties.
type	string	Type of the object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	dataStoreName, subscriptionId, resourceGroupName, dataManagerName		This method gets the data store/repository by name.
list_by_data_manager	select	subscriptionId, resourceGroupName, dataManagerName	$filter	Gets all the data stores/repositories in the given resource.
create_or_update	insert	dataStoreName, subscriptionId, resourceGroupName, dataManagerName, data__properties		Creates or updates the data store/repository in the data manager.
delete	delete	dataStoreName, subscriptionId, resourceGroupName, dataManagerName		This method deletes the given data store/repository.

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
dataManagerName	string	The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only
dataStoreName	string	The data store/repository name to be deleted.
resourceGroupName	string	The Resource Group Name
subscriptionId	string	The Subscription Id
$filter	string	OData Filter options

SELECT examples

get

This method gets the data store/repository by name.

SELECT
id,
name,
properties,
type
FROM azure.hybrid_data_manager.data_stores
WHERE dataStoreName = '{{ dataStoreName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dataManagerName = '{{ dataManagerName }}' -- required
;

list_by_data_manager

Gets all the data stores/repositories in the given resource.

SELECT
id,
name,
properties,
type
FROM azure.hybrid_data_manager.data_stores
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dataManagerName = '{{ dataManagerName }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Creates or updates the data store/repository in the data manager.

INSERT INTO azure.hybrid_data_manager.data_stores (
data__properties,
dataStoreName,
subscriptionId,
resourceGroupName,
dataManagerName
)
SELECT 
'{{ properties }}' /* required */,
'{{ dataStoreName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ dataManagerName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: data_stores
  props:
    - name: dataStoreName
      value: string
      description: Required parameter for the data_stores resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the data_stores resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the data_stores resource.
    - name: dataManagerName
      value: string
      description: Required parameter for the data_stores resource.
    - name: properties
      value: object
      description: |
        DataStore properties.

DELETE examples

delete

This method deletes the given data store/repository.

DELETE FROM azure.hybrid_data_manager.data_stores
WHERE dataStoreName = '{{ dataStoreName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dataManagerName = '{{ dataManagerName }}' --required
;