aml_filesystems

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

Overview

Name	aml_filesystems
Type	Resource
Id	azure.storage_cache.aml_filesystems

Fields

Name	Datatype	Description
identity	object	Managed Identity properties.
location	string	The geo-location where the resource lives
properties	object	Properties of the AML file system.
sku	object	SKU for the resource.
tags	object	Resource tags.
zones	array	Availability zones for resources. This field should only contain a single element in the array.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	amlFilesystemName, resourceGroupName, subscriptionId	Returns an AML file system.
list	SELECT	subscriptionId	Returns all AML file systems the user has access to under a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Returns all AML file systems the user has access to under a resource group.
create_or_update	INSERT	amlFilesystemName, resourceGroupName, subscriptionId	Create or update an AML file system.
delete	DELETE	amlFilesystemName, resourceGroupName, subscriptionId	Schedules an AML file system for deletion.
update	UPDATE	amlFilesystemName, resourceGroupName, subscriptionId	Update an AML file system instance.
archive	EXEC	amlFilesystemName, resourceGroupName, subscriptionId	Archive data from the AML file system.
cancel_archive	EXEC	amlFilesystemName, resourceGroupName, subscriptionId	Cancel archiving data from the AML file system.

SELECT examples

Returns all AML file systems the user has access to under a subscription.

SELECT
identity,
location,
properties,
sku,
tags,
zones
FROM azure.storage_cache.aml_filesystems
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new aml_filesystems resource.

All Properties

/*+ create */
INSERT INTO azure.storage_cache.aml_filesystems (
amlFilesystemName,
resourceGroupName,
subscriptionId,
tags,
location,
identity,
sku,
zones,
properties
)
SELECT 
'{{ amlFilesystemName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ tags }}',
'{{ location }}',
'{{ identity }}',
'{{ sku }}',
'{{ zones }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
        - name: userAssignedIdentities
          value: []
    - name: sku
      value:
        - name: name
          value: string
    - name: zones
      value:
        - string
    - name: properties
      value:
        - name: storageCapacityTiB
          value: number
        - name: health
          value:
            - name: state
              value: string
            - name: statusCode
              value: string
            - name: statusDescription
              value: string
        - name: provisioningState
          value: string
        - name: filesystemSubnet
          value: []
        - name: clientInfo
          value:
            - name: mgsAddress
              value: string
            - name: mountCommand
              value: string
            - name: lustreVersion
              value: string
            - name: containerStorageInterface
              value:
                - name: persistentVolumeClaim
                  value: string
                - name: persistentVolume
                  value: string
                - name: storageClass
                  value: string
        - name: throughputProvisionedMBps
          value: integer
        - name: encryptionSettings
          value:
            - name: keyEncryptionKey
              value:
                - name: keyUrl
                  value: string
                - name: sourceVault
                  value:
                    - name: id
                      value: string
        - name: maintenanceWindow
          value:
            - name: dayOfWeek
              value: string
            - name: timeOfDayUTC
              value: string
        - name: hsm
          value:
            - name: settings
              value:
                - name: importPrefix
                  value: string
                - name: importPrefixesInitial
                  value:
                    - string
            - name: archiveStatus
              value:
                - - name: filesystemPath
                    value: string
                  - name: status
                    value:
                      - name: state
                        value: string
                      - name: lastCompletionTime
                        value: string
                      - name: lastStartedTime
                        value: string
                      - name: percentComplete
                        value: integer
                      - name: errorCode
                        value: string
                      - name: errorMessage
                        value: string
        - name: rootSquashSettings
          value:
            - name: mode
              value: string
            - name: noSquashNidLists
              value: string
            - name: squashUID
              value: integer
            - name: squashGID
              value: integer
            - name: status
              value: string

UPDATE example

Updates a aml_filesystems resource.

/*+ update */
UPDATE azure.storage_cache.aml_filesystems
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
amlFilesystemName = '{{ amlFilesystemName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified aml_filesystems resource.

/*+ delete */
DELETE FROM azure.storage_cache.aml_filesystems
WHERE amlFilesystemName = '{{ amlFilesystemName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';