file_systems

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

Overview

Name	file_systems
Type	Resource
Id	azure_isv.dellstorage.file_systems

Fields

The following fields are returned by SELECT queries:

get

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.
capacity	object	Capacity for Dell Filesystem, Will be received as part of Job Status.
delegatedSubnetCidr	string	Domain range for the delegated subnet. Required.
delegatedSubnetId	string	Delegated subnet id for Vnet injection. Required.
dellReferenceNumber	string	DellReferenceNumber of the resource. Required.
encryption	object	EncryptionProperties of the resource. Required.
fileSystemId	string	File system Id of the resource.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
marketplace	object	Marketplace details. Required.
oneFsUrl	string	OneFS url.
provisioningState	string	Provisioning State of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified". (Accepted, Creating, Updating, Deleting, Succeeded, Failed, Canceled, Deleted, NotSpecified)
smartConnectFqdn	string	Smart Connect FQDN of the resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
user	object	User Details. Required.

list_by_resource_group

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.
capacity	object	Capacity for Dell Filesystem, Will be received as part of Job Status.
delegatedSubnetCidr	string	Domain range for the delegated subnet. Required.
delegatedSubnetId	string	Delegated subnet id for Vnet injection. Required.
dellReferenceNumber	string	DellReferenceNumber of the resource. Required.
encryption	object	EncryptionProperties of the resource. Required.
fileSystemId	string	File system Id of the resource.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
marketplace	object	Marketplace details. Required.
oneFsUrl	string	OneFS url.
provisioningState	string	Provisioning State of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified". (Accepted, Creating, Updating, Deleting, Succeeded, Failed, Canceled, Deleted, NotSpecified)
smartConnectFqdn	string	Smart Connect FQDN of the resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
user	object	User Details. Required.

list_by_subscription

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.
capacity	object	Capacity for Dell Filesystem, Will be received as part of Job Status.
delegatedSubnetCidr	string	Domain range for the delegated subnet. Required.
delegatedSubnetId	string	Delegated subnet id for Vnet injection. Required.
dellReferenceNumber	string	DellReferenceNumber of the resource. Required.
encryption	object	EncryptionProperties of the resource. Required.
fileSystemId	string	File system Id of the resource.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
marketplace	object	Marketplace details. Required.
oneFsUrl	string	OneFS url.
provisioningState	string	Provisioning State of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified". (Accepted, Creating, Updating, Deleting, Succeeded, Failed, Canceled, Deleted, NotSpecified)
smartConnectFqdn	string	Smart Connect FQDN of the resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
user	object	User Details. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, filesystem_name, subscription_id		Get a FileSystemResource.
list_by_resource_group	select	resource_group_name, subscription_id		List FileSystemResource resources by resource group.
list_by_subscription	select	subscription_id		List FileSystemResource resources by subscription ID.
create_or_update	insert	resource_group_name, filesystem_name, subscription_id, location		Create a FileSystemResource.
update	update	resource_group_name, filesystem_name, subscription_id		Update a FileSystemResource.
create_or_update	replace	resource_group_name, filesystem_name, subscription_id, location		Create a FileSystemResource.
delete	delete	resource_group_name, filesystem_name, subscription_id		Delete a FileSystemResource.

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
filesystem_name	string	Name of the filesystem resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a FileSystemResource.

SELECT
id,
name,
capacity,
delegatedSubnetCidr,
delegatedSubnetId,
dellReferenceNumber,
encryption,
fileSystemId,
identity,
location,
marketplace,
oneFsUrl,
provisioningState,
smartConnectFqdn,
systemData,
tags,
type,
user
FROM azure_isv.dellstorage.file_systems
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND filesystem_name = '{{ filesystem_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List FileSystemResource resources by resource group.

SELECT
id,
name,
capacity,
delegatedSubnetCidr,
delegatedSubnetId,
dellReferenceNumber,
encryption,
fileSystemId,
identity,
location,
marketplace,
oneFsUrl,
provisioningState,
smartConnectFqdn,
systemData,
tags,
type,
user
FROM azure_isv.dellstorage.file_systems
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List FileSystemResource resources by subscription ID.

SELECT
id,
name,
capacity,
delegatedSubnetCidr,
delegatedSubnetId,
dellReferenceNumber,
encryption,
fileSystemId,
identity,
location,
marketplace,
oneFsUrl,
provisioningState,
smartConnectFqdn,
systemData,
tags,
type,
user
FROM azure_isv.dellstorage.file_systems
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a FileSystemResource.

INSERT INTO azure_isv.dellstorage.file_systems (
tags,
location,
properties,
identity,
resource_group_name,
filesystem_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ filesystem_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: file_systems
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the file_systems resource.
  - name: filesystem_name
    value: "{{ filesystem_name }}"
    description: Required parameter for the file_systems resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the file_systems resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      capacity:
        min: "{{ min }}"
        max: "{{ max }}"
        incremental: "{{ incremental }}"
        current: "{{ current }}"
      marketplace:
        marketplaceSubscriptionId: "{{ marketplaceSubscriptionId }}"
        planId: "{{ planId }}"
        offerId: "{{ offerId }}"
        publisherId: "{{ publisherId }}"
        privateOfferId: "{{ privateOfferId }}"
        planName: "{{ planName }}"
        marketplaceSubscriptionStatus: "{{ marketplaceSubscriptionStatus }}"
        endDate: "{{ endDate }}"
        termUnit: "{{ termUnit }}"
      provisioningState: "{{ provisioningState }}"
      delegatedSubnetId: "{{ delegatedSubnetId }}"
      delegatedSubnetCidr: "{{ delegatedSubnetCidr }}"
      user:
        email: "{{ email }}"
      fileSystemId: "{{ fileSystemId }}"
      smartConnectFqdn: "{{ smartConnectFqdn }}"
      oneFsUrl: "{{ oneFsUrl }}"
      dellReferenceNumber: "{{ dellReferenceNumber }}"
      encryption:
        encryptionType: "{{ encryptionType }}"
        keyUrl: "{{ keyUrl }}"
        encryptionIdentityProperties:
          identityType: "{{ identityType }}"
          identityResourceId: "{{ identityResourceId }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update a FileSystemResource.

UPDATE azure_isv.dellstorage.file_systems
SET 
identity = '{{ identity }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND filesystem_name = '{{ filesystem_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a FileSystemResource.

REPLACE azure_isv.dellstorage.file_systems
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND filesystem_name = '{{ filesystem_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a FileSystemResource.

DELETE FROM azure_isv.dellstorage.file_systems
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND filesystem_name = '{{ filesystem_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;