storage_assets

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

Overview

Name	storage_assets
Type	Resource
Id	azure.discovery.storage_assets

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. Required.
location	string	The geo-location where the resource lives. Required.
path	string	The path to the data within its parent container. This should be relative to the root of the parent container.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Provisioning, Updating, Deleting)
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".

list_by_storage_container

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. Required.
location	string	The geo-location where the resource lives. Required.
path	string	The path to the data within its parent container. This should be relative to the root of the parent container.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Provisioning, Updating, Deleting)
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, storage_container_name, storage_asset_name, subscription_id		Get a StorageAsset.
list_by_storage_container	select	resource_group_name, storage_container_name, subscription_id		List StorageAsset resources by StorageContainer.
create_or_update	insert	resource_group_name, storage_container_name, storage_asset_name, subscription_id, location		Create a StorageAsset.
update	update	resource_group_name, storage_container_name, storage_asset_name, subscription_id, location		Update a StorageAsset.
create_or_update	replace	resource_group_name, storage_container_name, storage_asset_name, subscription_id, location		Create a StorageAsset.
delete	delete	resource_group_name, storage_container_name, storage_asset_name, subscription_id		Delete a StorageAsset.

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_asset_name	string	The name of the StorageAsset. Required.
storage_container_name	string	The name of the StorageContainer. Required.
subscription_id	string

SELECT examples

get

Get a StorageAsset.

SELECT
id,
name,
description,
location,
path,
provisioningState,
systemData,
tags,
type
FROM azure.discovery.storage_assets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_container_name = '{{ storage_container_name }}' -- required
AND storage_asset_name = '{{ storage_asset_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_storage_container

List StorageAsset resources by StorageContainer.

SELECT
id,
name,
description,
location,
path,
provisioningState,
systemData,
tags,
type
FROM azure.discovery.storage_assets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_container_name = '{{ storage_container_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a StorageAsset.

INSERT INTO azure.discovery.storage_assets (
tags,
location,
properties,
resource_group_name,
storage_container_name,
storage_asset_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ storage_container_name }}',
'{{ storage_asset_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: storage_assets
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the storage_assets resource.
  - name: storage_container_name
    value: "{{ storage_container_name }}"
    description: Required parameter for the storage_assets resource.
  - name: storage_asset_name
    value: "{{ storage_asset_name }}"
    description: Required parameter for the storage_assets resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the storage_assets 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:
      description: "{{ description }}"
      provisioningState: "{{ provisioningState }}"
      path: "{{ path }}"

UPDATE examples

update

Update a StorageAsset.

UPDATE azure.discovery.storage_assets
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND storage_container_name = '{{ storage_container_name }}' --required
AND storage_asset_name = '{{ storage_asset_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a StorageAsset.

REPLACE azure.discovery.storage_assets
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND storage_container_name = '{{ storage_container_name }}' --required
AND storage_asset_name = '{{ storage_asset_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 StorageAsset.

DELETE FROM azure.discovery.storage_assets
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND storage_container_name = '{{ storage_container_name }}' --required
AND storage_asset_name = '{{ storage_asset_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;