shares

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

Overview

Name	shares
Type	Resource
Id	azure.data_share.shares

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The resource id of the azure resource
name	string	Name of the azure resource
properties	object	Properties on the share
systemData	object	System Data of the Azure resource.
type	string	Type of the azure resource

list_by_account

Name	Datatype	Description
id	string	The resource id of the azure resource
name	string	Name of the azure resource
properties	object	Properties on the share
systemData	object	System Data of the Azure resource.
type	string	Type of the azure resource

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, shareName	api-version	Get a share
list_by_account	select	subscriptionId, resourceGroupName, accountName	api-version, $skipToken, $filter, $orderby	List shares in an account
create	insert	subscriptionId, resourceGroupName, accountName, shareName	api-version	Create a share
delete	delete	subscriptionId, resourceGroupName, accountName, shareName	api-version	Delete a share

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
accountName	string	The name of the share account.
resourceGroupName	string	The resource group name.
shareName	string	The name of the share.
subscriptionId	string	The subscription identifier
$filter	string	Filters the results using OData syntax.
$orderby	string	Sorts the results using OData syntax.
$skipToken	string	Continuation Token
api-version	string	The api version to use.

SELECT examples

get

Get a share

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_share.shares
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND shareName = '{{ shareName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_account

List shares in an account

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_share.shares
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND api-version = '{{ api-version }}'
AND $skipToken = '{{ $skipToken }}'
AND $filter = '{{ $filter }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create

Create a share

INSERT INTO azure.data_share.shares (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
shareName,
api-version
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ shareName }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: shares
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the shares resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the shares resource.
    - name: accountName
      value: string
      description: Required parameter for the shares resource.
    - name: shareName
      value: string
      description: Required parameter for the shares resource.
    - name: properties
      value: object
      description: |
        Properties on the share
    - name: api-version
      value: string
      description: The api version to use.

DELETE examples

delete

Delete a share

DELETE FROM azure.data_share.shares
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND shareName = '{{ shareName }}' --required
AND api-version = '{{ api-version }}'
;