soft_deleted_resource

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

Overview

Name	soft_deleted_resource
Type	Resource
Id	azure.compute.soft_deleted_resource

Fields

The following fields are returned by SELECT queries:

list_by_artifact_name

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.
location	string	The geo-location where the resource lives. Required.
resourceArmId	string	arm id of the soft-deleted resource.
softDeletedArtifactType	string	artifact type of the soft-deleted resource. "Images" (Images)
softDeletedTime	string	The timestamp for when the resource is soft-deleted. In dateTime offset format.
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
list_by_artifact_name	select	resource_group_name, gallery_name, artifact_type, artifact_name, subscription_id		List soft-deleted resources of an artifact in the gallery, such as soft-deleted gallery image version of an image.

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
artifact_name	string	The artifact name to be listed. If artifact type is Images, then the artifact name should be the gallery image name. Required.
artifact_type	string	The type of the artifact to be listed, such as gallery image version. Required.
gallery_name	string	The name of the Shared Image Gallery. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

list_by_artifact_name

List soft-deleted resources of an artifact in the gallery, such as soft-deleted gallery image version of an image.

SELECT
id,
name,
location,
resourceArmId,
softDeletedArtifactType,
softDeletedTime,
systemData,
tags,
type
FROM azure.compute.soft_deleted_resource
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND gallery_name = '{{ gallery_name }}' -- required
AND artifact_type = '{{ artifact_type }}' -- required
AND artifact_name = '{{ artifact_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;