file_workspaces

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

Overview

Name	file_workspaces
Type	Resource
Id	azure.support.file_workspaces

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
createdOn	string (date-time)	Time in UTC (ISO 8601 format) when file workspace was created.
expirationTime	string (date-time)	Time in UTC (ISO 8601 format) when file workspace is going to expire.
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	select	file_workspace_name, subscription_id		Gets details for a specific file workspace in an Azure subscription.
create	insert	file_workspace_name, subscription_id		Creates a new file workspace for the specified subscription.

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
file_workspace_name	string	File workspace name. Required.
subscription_id	string

SELECT examples

get

Gets details for a specific file workspace in an Azure subscription.

SELECT
id,
name,
createdOn,
expirationTime,
systemData,
type
FROM azure.support.file_workspaces
WHERE file_workspace_name = '{{ file_workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a new file workspace for the specified subscription.

INSERT INTO azure.support.file_workspaces (
file_workspace_name,
subscription_id
)
SELECT 
'{{ file_workspace_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: file_workspaces
props:
  - name: file_workspace_name
    value: "{{ file_workspace_name }}"
    description: Required parameter for the file_workspaces resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the file_workspaces resource.