file_share_snapshots

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

Overview

Name	file_share_snapshots
Type	Resource
Id	azure.file_shares.file_share_snapshots

Fields

The following fields are returned by SELECT queries:

get_file_share_snapshot

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.
initiatorId	string	The initiator of the FileShareSnapshot. This is a user-defined value.
metadata	object	The metadata.
snapshotTime	string	The FileShareSnapshot time in UTC in string representation.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_file_share

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.
initiatorId	string	The initiator of the FileShareSnapshot. This is a user-defined value.
metadata	object	The metadata.
snapshotTime	string	The FileShareSnapshot time in UTC in string representation.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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_file_share_snapshot	select	resource_group_name, resource_name, name, subscription_id		Get a FileShareSnapshot.
list_by_file_share	select	resource_group_name, resource_name, subscription_id		List FileShareSnapshot by FileShare.
create_or_update_file_share_snapshot	insert	resource_group_name, resource_name, name, subscription_id		Create a FileShareSnapshot.
update_file_share_snapshot	update	resource_group_name, resource_name, name, subscription_id		Update a FileShareSnapshot.
create_or_update_file_share_snapshot	replace	resource_group_name, resource_name, name, subscription_id		Create a FileShareSnapshot.
delete_file_share_snapshot	delete	resource_group_name, resource_name, name, subscription_id		Delete a FileShareSnapshot.

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	The name of the FileShareSnapshot. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The resource name of the file share, as seen by the administrator through Azure Resource Manager. Required.
subscription_id	string

SELECT examples

get_file_share_snapshot

Get a FileShareSnapshot.

SELECT
id,
name,
initiatorId,
metadata,
snapshotTime,
systemData,
type
FROM azure.file_shares.file_share_snapshots
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_file_share

List FileShareSnapshot by FileShare.

SELECT
id,
name,
initiatorId,
metadata,
snapshotTime,
systemData,
type
FROM azure.file_shares.file_share_snapshots
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update_file_share_snapshot

Create a FileShareSnapshot.

INSERT INTO azure.file_shares.file_share_snapshots (
properties,
resource_group_name,
resource_name,
name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: file_share_snapshots
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the file_share_snapshots resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the file_share_snapshots resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the file_share_snapshots resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the file_share_snapshots resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      snapshotTime: "{{ snapshotTime }}"
      initiatorId: "{{ initiatorId }}"
      metadata: "{{ metadata }}"

UPDATE examples

update_file_share_snapshot

Update a FileShareSnapshot.

UPDATE azure.file_shares.file_share_snapshots
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update_file_share_snapshot

Create a FileShareSnapshot.

REPLACE azure.file_shares.file_share_snapshots
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete_file_share_snapshot

Delete a FileShareSnapshot.

DELETE FROM azure.file_shares.file_share_snapshots
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;