1. Packages
  2. Azure Native
  3. API Docs
  4. storageactions
  5. getStorageTask
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.storageactions.getStorageTask

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Get the storage task properties

Uses Azure REST API version 2023-01-01.

Using getStorageTask

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getStorageTask(args: GetStorageTaskArgs, opts?: InvokeOptions): Promise<GetStorageTaskResult>
function getStorageTaskOutput(args: GetStorageTaskOutputArgs, opts?: InvokeOptions): Output<GetStorageTaskResult>
Copy
def get_storage_task(resource_group_name: Optional[str] = None,
                     storage_task_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetStorageTaskResult
def get_storage_task_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                     storage_task_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetStorageTaskResult]
Copy
func LookupStorageTask(ctx *Context, args *LookupStorageTaskArgs, opts ...InvokeOption) (*LookupStorageTaskResult, error)
func LookupStorageTaskOutput(ctx *Context, args *LookupStorageTaskOutputArgs, opts ...InvokeOption) LookupStorageTaskResultOutput
Copy

> Note: This function is named LookupStorageTask in the Go SDK.

public static class GetStorageTask 
{
    public static Task<GetStorageTaskResult> InvokeAsync(GetStorageTaskArgs args, InvokeOptions? opts = null)
    public static Output<GetStorageTaskResult> Invoke(GetStorageTaskInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetStorageTaskResult> getStorageTask(GetStorageTaskArgs args, InvokeOptions options)
public static Output<GetStorageTaskResult> getStorageTask(GetStorageTaskArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:storageactions:getStorageTask
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
StorageTaskName
This property is required.
Changes to this property will trigger replacement.
string
The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
StorageTaskName
This property is required.
Changes to this property will trigger replacement.
string
The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
storageTaskName
This property is required.
Changes to this property will trigger replacement.
String
The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
storageTaskName
This property is required.
Changes to this property will trigger replacement.
string
The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
storage_task_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
storageTaskName
This property is required.
Changes to this property will trigger replacement.
String
The name of the storage task within the specified resource group. Storage task names must be between 3 and 18 characters in length and use numbers and lower-case letters only.

getStorageTask Result

The following output properties are available:

Action Pulumi.AzureNative.StorageActions.Outputs.StorageTaskActionResponse
The storage task action that is executed
AzureApiVersion string
The Azure API version of the resource.
CreationTimeInUtc string
The creation date and time of the storage task in UTC.
Description string
Text that describes the purpose of the storage task
Enabled bool
Storage Task is enabled when set to true and disabled when set to false
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Identity Pulumi.AzureNative.StorageActions.Outputs.ManagedServiceIdentityResponse
The managed service identity of the resource.
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
Represents the provisioning state of the storage task.
SystemData Pulumi.AzureNative.StorageActions.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TaskVersion double
Storage task version.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags Dictionary<string, string>
Resource tags.
Action StorageTaskActionResponse
The storage task action that is executed
AzureApiVersion string
The Azure API version of the resource.
CreationTimeInUtc string
The creation date and time of the storage task in UTC.
Description string
Text that describes the purpose of the storage task
Enabled bool
Storage Task is enabled when set to true and disabled when set to false
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Identity ManagedServiceIdentityResponse
The managed service identity of the resource.
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
Represents the provisioning state of the storage task.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TaskVersion float64
Storage task version.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags map[string]string
Resource tags.
action StorageTaskActionResponse
The storage task action that is executed
azureApiVersion String
The Azure API version of the resource.
creationTimeInUtc String
The creation date and time of the storage task in UTC.
description String
Text that describes the purpose of the storage task
enabled Boolean
Storage Task is enabled when set to true and disabled when set to false
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity ManagedServiceIdentityResponse
The managed service identity of the resource.
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
Represents the provisioning state of the storage task.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
taskVersion Double
Storage task version.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String,String>
Resource tags.
action StorageTaskActionResponse
The storage task action that is executed
azureApiVersion string
The Azure API version of the resource.
creationTimeInUtc string
The creation date and time of the storage task in UTC.
description string
Text that describes the purpose of the storage task
enabled boolean
Storage Task is enabled when set to true and disabled when set to false
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity ManagedServiceIdentityResponse
The managed service identity of the resource.
location string
The geo-location where the resource lives
name string
The name of the resource
provisioningState string
Represents the provisioning state of the storage task.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
taskVersion number
Storage task version.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags {[key: string]: string}
Resource tags.
action StorageTaskActionResponse
The storage task action that is executed
azure_api_version str
The Azure API version of the resource.
creation_time_in_utc str
The creation date and time of the storage task in UTC.
description str
Text that describes the purpose of the storage task
enabled bool
Storage Task is enabled when set to true and disabled when set to false
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity ManagedServiceIdentityResponse
The managed service identity of the resource.
location str
The geo-location where the resource lives
name str
The name of the resource
provisioning_state str
Represents the provisioning state of the storage task.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
task_version float
Storage task version.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Mapping[str, str]
Resource tags.
action Property Map
The storage task action that is executed
azureApiVersion String
The Azure API version of the resource.
creationTimeInUtc String
The creation date and time of the storage task in UTC.
description String
Text that describes the purpose of the storage task
enabled Boolean
Storage Task is enabled when set to true and disabled when set to false
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity Property Map
The managed service identity of the resource.
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
Represents the provisioning state of the storage task.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
taskVersion Number
Storage task version.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String>
Resource tags.

Supporting Types

ElseConditionResponse

Operations This property is required. List<Pulumi.AzureNative.StorageActions.Inputs.StorageTaskOperationResponse>
List of operations to execute in the else block
Operations This property is required. []StorageTaskOperationResponse
List of operations to execute in the else block
operations This property is required. List<StorageTaskOperationResponse>
List of operations to execute in the else block
operations This property is required. StorageTaskOperationResponse[]
List of operations to execute in the else block
operations This property is required. Sequence[StorageTaskOperationResponse]
List of operations to execute in the else block
operations This property is required. List<Property Map>
List of operations to execute in the else block

IfConditionResponse

Condition This property is required. string
Condition predicate to evaluate each object. See https://aka.ms/storagetaskconditions for valid properties and operators.
Operations This property is required. List<Pulumi.AzureNative.StorageActions.Inputs.StorageTaskOperationResponse>
List of operations to execute when the condition predicate satisfies.
Condition This property is required. string
Condition predicate to evaluate each object. See https://aka.ms/storagetaskconditions for valid properties and operators.
Operations This property is required. []StorageTaskOperationResponse
List of operations to execute when the condition predicate satisfies.
condition This property is required. String
Condition predicate to evaluate each object. See https://aka.ms/storagetaskconditions for valid properties and operators.
operations This property is required. List<StorageTaskOperationResponse>
List of operations to execute when the condition predicate satisfies.
condition This property is required. string
Condition predicate to evaluate each object. See https://aka.ms/storagetaskconditions for valid properties and operators.
operations This property is required. StorageTaskOperationResponse[]
List of operations to execute when the condition predicate satisfies.
condition This property is required. str
Condition predicate to evaluate each object. See https://aka.ms/storagetaskconditions for valid properties and operators.
operations This property is required. Sequence[StorageTaskOperationResponse]
List of operations to execute when the condition predicate satisfies.
condition This property is required. String
Condition predicate to evaluate each object. See https://aka.ms/storagetaskconditions for valid properties and operators.
operations This property is required. List<Property Map>
List of operations to execute when the condition predicate satisfies.

ManagedServiceIdentityResponse

PrincipalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.StorageActions.Inputs.UserAssignedIdentityResponse>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
PrincipalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities map[string]UserAssignedIdentityResponse
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. String
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. String
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<String,UserAssignedIdentityResponse>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principal_id This property is required. str
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id This property is required. str
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. str
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. String
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. String
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<Property Map>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

StorageTaskActionResponse

If This property is required. Pulumi.AzureNative.StorageActions.Inputs.IfConditionResponse
The if block of storage task operation
Else Pulumi.AzureNative.StorageActions.Inputs.ElseConditionResponse
The else block of storage task operation
If This property is required. IfConditionResponse
The if block of storage task operation
Else ElseConditionResponse
The else block of storage task operation
if_ This property is required. IfConditionResponse
The if block of storage task operation
else_ ElseConditionResponse
The else block of storage task operation
if This property is required. IfConditionResponse
The if block of storage task operation
else ElseConditionResponse
The else block of storage task operation
if_ This property is required. IfConditionResponse
The if block of storage task operation
else_ ElseConditionResponse
The else block of storage task operation
if This property is required. Property Map
The if block of storage task operation
else Property Map
The else block of storage task operation

StorageTaskOperationResponse

Name This property is required. string
The operation to be performed on the object.
OnFailure string
Action to be taken when the operation fails for a object.
OnSuccess string
Action to be taken when the operation is successful for a object.
Parameters Dictionary<string, string>
Key-value parameters for the operation.
Name This property is required. string
The operation to be performed on the object.
OnFailure string
Action to be taken when the operation fails for a object.
OnSuccess string
Action to be taken when the operation is successful for a object.
Parameters map[string]string
Key-value parameters for the operation.
name This property is required. String
The operation to be performed on the object.
onFailure String
Action to be taken when the operation fails for a object.
onSuccess String
Action to be taken when the operation is successful for a object.
parameters Map<String,String>
Key-value parameters for the operation.
name This property is required. string
The operation to be performed on the object.
onFailure string
Action to be taken when the operation fails for a object.
onSuccess string
Action to be taken when the operation is successful for a object.
parameters {[key: string]: string}
Key-value parameters for the operation.
name This property is required. str
The operation to be performed on the object.
on_failure str
Action to be taken when the operation fails for a object.
on_success str
Action to be taken when the operation is successful for a object.
parameters Mapping[str, str]
Key-value parameters for the operation.
name This property is required. String
The operation to be performed on the object.
onFailure String
Action to be taken when the operation fails for a object.
onSuccess String
Action to be taken when the operation is successful for a object.
parameters Map<String>
Key-value parameters for the operation.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

UserAssignedIdentityResponse

ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.
clientId This property is required. string
The client ID of the assigned identity.
principalId This property is required. string
The principal ID of the assigned identity.
client_id This property is required. str
The client ID of the assigned identity.
principal_id This property is required. str
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi