Edit

Share via


Get-AzStorageTaskAssignmentInstancesReport

Fetch the report summary of a single storage task assignment's instances

Syntax

List (Default)

Get-AzStorageTaskAssignmentInstancesReport
    -AccountName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-Filter <String>]
    [-Maxpagesize <Int32>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get

Get-AzStorageTaskAssignmentInstancesReport
    -AccountName <String>
    -ResourceGroupName <String>
    -StorageTaskAssignmentName <String>
    [-SubscriptionId <String[]>]
    [-Filter <String>]
    [-Maxpagesize <Int32>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityStorageAccount

Get-AzStorageTaskAssignmentInstancesReport
    -StorageTaskAssignmentName <String>
    -StorageAccountInputObject <IStorageIdentity>
    [-Filter <String>]
    [-Maxpagesize <Int32>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity

Get-AzStorageTaskAssignmentInstancesReport
    -InputObject <IStorageIdentity>
    [-Filter <String>]
    [-Maxpagesize <Int32>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Fetch the report summary of a single storage task assignment's instances

Examples

Example 1: List the reports of a task assignment in an account

Get-AzStorageTaskAssignmentInstancesReport -AccountName myaccount -ResourceGroupName myresourcegroup -StorageTaskAssignmentName mytaskassignment
FinishTime             : 2024-07-02T08:19:51.9238839Z
Id                     : /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/myaccount/storageTaskAssignments/mytaskassignment/reports/instance1
Name                   : instance1
ObjectFailedCount      : 0
ObjectsOperatedOnCount : 0
ObjectsSucceededCount  : 0
ObjectsTargetedCount   : 0
RunResult              : Succeeded
RunStatusEnum          : Finished
RunStatusError         : 0x0
StartTime              : 2024-07-02T08:10:55.0000000Z
StorageAccountId       : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/myaccount
SummaryReportPath      : https://myaccount.blob.core.windows.net/testc2/mytask/assignment1/2024-07-02T08:11:20/SummaryReport.json
TaskAssignmentId       : /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/myaccount/storageTaskAssignments/mytaskassignment
TaskId                 : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.StorageActions/storageTasks/mytask
TaskVersion            : 1
Type                   : Microsoft.Storage/storageAccounts/storageTaskAssignments/reports

This command lists the reports of task assignment "mytaskassignment".

Example 2: List the reports of all storage task assignments and instances in an account

Get-AzStorageTaskAssignmentInstancesReport -AccountName myaccount -ResourceGroupName myresourcegroup
FinishTime             : 2024-07-03T08:19:23.1774164Z
Id                     : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/myaccount/reports/instance1
Name                   : instance1
ObjectFailedCount      : 0
ObjectsOperatedOnCount : 0
ObjectsSucceededCount  : 0
ObjectsTargetedCount   : 0
RunResult              : Succeeded
RunStatusEnum          : Finished
RunStatusError         : 0x0
StartTime              : 2024-07-03T08:10:11.0000000Z
StorageAccountId       : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/myaccount
SummaryReportPath      : https://myaccount.blob.core.windows.net/testc2/mytask/mytaskassignment/2024-07-03T08:10:41/SummaryReport.json
TaskAssignmentId       : /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/myaccount/storageTaskAssignments/mytaskassignment
TaskId                 : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.StorageActions/storageTasks/mytask
TaskVersion            : 1
Type                   : Microsoft.Storage/storageAccounts/reports

FinishTime             : 2024-07-02T08:19:51.9238839Z
Id                     : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/myaccount/reports/instance2
Name                   : instance2
ObjectFailedCount      : 0
ObjectsOperatedOnCount : 0
ObjectsSucceededCount  : 0
ObjectsTargetedCount   : 0
RunResult              : Succeeded
RunStatusEnum          : Finished
RunStatusError         : 0x0
StartTime              : 2024-07-02T08:10:55.0000000Z
StorageAccountId       : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/myaccount
SummaryReportPath      : https://myaccount.blob.core.windows.net/testc2/mytaskassignment2/assignment1/2024-07-02T08:11:20/SummaryReport.json
TaskAssignmentId       : /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/myaccount/storageTaskAssignments/mytaskassignment2
TaskId                 : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.StorageActions/storageTasks/mytask
TaskVersion            : 1
Type                   : Microsoft.Storage/storageAccounts/reports

This command lists the reports of all storage task assignments and instances under storage account "myaccount".

Parameters

-AccountName

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Filter

Optional. When specified, it can be used to query using reporting properties. See Constructing Filter Strings for details.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter

Parameter properties

Type:IStorageIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Maxpagesize

Optional, specifies the maximum number of storage task assignment instances to be included in the list response.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StorageAccountInputObject

Identity Parameter

Parameter properties

Type:IStorageIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentityStorageAccount
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-StorageTaskAssignmentName

The name of the storage task assignment within the specified resource group. Storage task assignment names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetViaIdentityStorageAccount
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

The ID of the target subscription.

Parameter properties

Type:

String[]

Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

IStorageIdentity

Outputs

IStorageTaskReportInstance