Get-AzSupportFile

Reference

Module:: Az.Support

Returns details of a specific file in a work space.

Syntax

Get-AzSupportFile
   [-SubscriptionId <String[]>]
   -WorkspaceName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzSupportFile
   -Name <String>
   -FileWorkspaceInputObject <ISupportIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzSupportFile
   -Name <String>
   [-SubscriptionId <String[]>]
   -WorkspaceName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzSupportFile
   -InputObject <ISupportIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Returns details of a specific file in a work space.

Examples

Example 1: List all files from a file workspace

Get-AzSupportFile -WorkspaceName "testworkspace"

Name      CreatedOn           ChunkSize FileSize
----      ---------           --------- --------
test.txt  2/9/2024 3:53:15 PM 4         4
test2.txt 2/9/2024 3:53:29 PM 4         4

Lists all the Files information under a workspace for an Azure subscription.

Example 2: Get details of a file in a file workspace

Get-AzSupportFile -Name "test.txt" -WorkspaceName "testworkspace"

ChunkSize                    : 4
CreatedOn                    : 2/9/2024 3:53:15 PM
FileSize                     : 4
Id                           : /subscriptions/3bb7379e-e102-4603-a59c-60f5ca39ec55/providers/Microsoft.Support/fileWorkspaces/testworkspace/files/test.txt
Name                         : test.txt
NumberOfChunk                : 1
ResourceGroupName            :
SystemDataCreatedAt          :
SystemDataCreatedBy          :
SystemDataCreatedByType      :
SystemDataLastModifiedAt     :
SystemDataLastModifiedBy     :
SystemDataLastModifiedByType :
Type                         : Microsoft.Support/files

Returns details of a specific file in a workspace.

Example 3: List all files from a support ticket

Get-AzSupportFile -WorkspaceName "2402084010005835"

Name      CreatedOn           ChunkSize FileSize
----      ---------           --------- --------
test.txt  2/9/2024 3:53:15 PM 4         4
test2.txt 2/9/2024 3:53:29 PM 4         4

Lists all the Files information under a support ticket for an Azure subscription.

Example 2: Get details of a file under a support ticket

Get-AzSupportFile -Name "test.txt" -WorkspaceName "2402084010005835"

ChunkSize                    : 4
CreatedOn                    : 2/9/2024 3:53:15 PM
FileSize                     : 4
Id                           : /subscriptions/3bb7379e-e102-4603-a59c-60f5ca39ec55/providers/Microsoft.Support/fileWorkspaces/2402084010005835/files/test.txt
Name                         : test.txt
NumberOfChunk                : 1
ResourceGroupName            :
SystemDataCreatedAt          :
SystemDataCreatedBy          :
SystemDataCreatedByType      :
SystemDataLastModifiedAt     :
SystemDataLastModifiedBy     :
SystemDataLastModifiedByType :
Type                         : Microsoft.Support/files

Returns details of a specific file under a support ticket.

Parameters

-DefaultProfile

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

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FileWorkspaceInputObject

Identity Parameter

Type:	ISupportIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-InputObject

Identity Parameter

Type:	ISupportIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

File Name

Type:	String
Aliases:	FileName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Type:	String[]
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WorkspaceName

File Workspace Name

Type:	String
Aliases:	FileWorkspaceName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

ISupportIdentity

Outputs

IFileDetails

Share via