storage_discovery_workspaces

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

Overview

Name	storage_discovery_workspaces
Type	Resource
Id	azure.storage_discovery.storage_discovery_workspaces

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.
description	string	The description of the storage discovery workspace.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
scopes	array	The scopes of the storage discovery workspace. Required.
sku	string	The storage discovery sku. Known values are: "Standard" and "Free". (Standard, Free)
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".
workspaceRoots	array	The view level storage discovery data estate. 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.
description	string	The description of the storage discovery workspace.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
scopes	array	The scopes of the storage discovery workspace. Required.
sku	string	The storage discovery sku. Known values are: "Standard" and "Free". (Standard, Free)
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".
workspaceRoots	array	The view level storage discovery data estate. 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.
description	string	The description of the storage discovery workspace.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
scopes	array	The scopes of the storage discovery workspace. Required.
sku	string	The storage discovery sku. Known values are: "Standard" and "Free". (Standard, Free)
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".
workspaceRoots	array	The view level storage discovery data estate. Required.

Methods

The following methods are available for this resource:

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

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

SELECT examples

get

Get a StorageDiscoveryWorkspace.

SELECT
id,
name,
description,
location,
provisioningState,
scopes,
sku,
systemData,
tags,
type,
workspaceRoots
FROM azure.storage_discovery.storage_discovery_workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_discovery_workspace_name = '{{ storage_discovery_workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List StorageDiscoveryWorkspace resources by resource group.

SELECT
id,
name,
description,
location,
provisioningState,
scopes,
sku,
systemData,
tags,
type,
workspaceRoots
FROM azure.storage_discovery.storage_discovery_workspaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List StorageDiscoveryWorkspace resources by subscription ID.

SELECT
id,
name,
description,
location,
provisioningState,
scopes,
sku,
systemData,
tags,
type,
workspaceRoots
FROM azure.storage_discovery.storage_discovery_workspaces
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a StorageDiscoveryWorkspace.

INSERT INTO azure.storage_discovery.storage_discovery_workspaces (
tags,
location,
properties,
resource_group_name,
storage_discovery_workspace_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ storage_discovery_workspace_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: storage_discovery_workspaces
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the storage_discovery_workspaces resource.
  - name: storage_discovery_workspace_name
    value: "{{ storage_discovery_workspace_name }}"
    description: Required parameter for the storage_discovery_workspaces resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the storage_discovery_workspaces 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:
      sku: "{{ sku }}"
      description: "{{ description }}"
      workspaceRoots:
        - "{{ workspaceRoots }}"
      scopes:
        - displayName: "{{ displayName }}"
          resourceTypes: "{{ resourceTypes }}"
          tagKeysOnly: "{{ tagKeysOnly }}"
          tags: "{{ tags }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update a StorageDiscoveryWorkspace.

UPDATE azure.storage_discovery.storage_discovery_workspaces
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND storage_discovery_workspace_name = '{{ storage_discovery_workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a StorageDiscoveryWorkspace.

REPLACE azure.storage_discovery.storage_discovery_workspaces
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND storage_discovery_workspace_name = '{{ storage_discovery_workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a StorageDiscoveryWorkspace.

DELETE FROM azure.storage_discovery.storage_discovery_workspaces
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND storage_discovery_workspace_name = '{{ storage_discovery_workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;