Skip to content

Get GitHubReleaseAsset

Howard Wolosky edited this page Oct 5, 2020 · 1 revision

Get-GitHubReleaseAsset

SYNOPSIS

Gets a a list of assets for a release, or downloads a single release asset.

SYNTAX

Elements-Download

Get-GitHubReleaseAsset [-OwnerName <String>] [-RepositoryName <String>] [-Asset] <Int64> [-Path] <String>
 [-Force] [-AccessToken <String>] [<CommonParameters>]

Elements-Info

Get-GitHubReleaseAsset [-OwnerName <String>] [-RepositoryName <String>] [-Asset] <Int64>
 [-AccessToken <String>] [<CommonParameters>]

Elements-List

Get-GitHubReleaseAsset [-OwnerName <String>] [-RepositoryName <String>] [-Release] <Int64>
 [-AccessToken <String>] [<CommonParameters>]

Uri-List

Get-GitHubReleaseAsset [-Uri] <String> [-Release] <Int64> [-AccessToken <String>] [<CommonParameters>]

Uri-Download

Get-GitHubReleaseAsset [-Uri] <String> [-Asset] <Int64> [-Path] <String> [-Force] [-AccessToken <String>]
 [<CommonParameters>]

Uri-Info

Get-GitHubReleaseAsset [-Uri] <String> [-Asset] <Int64> [-AccessToken <String>] [<CommonParameters>]

DESCRIPTION

Gets a a list of assets for a release, or downloads a single release asset.

The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub

EXAMPLES

EXAMPLE 1

Get-GitHubReleaseAsset -OwnerName microsoft -RepositoryName PowerShellForGitHub -Release 1234567890

Gets a list of all the assets associated with this release

EXAMPLE 2

Get-GitHubReleaseAsset -OwnerName microsoft -RepositoryName PowerShellForGitHub -Asset 1234567890 -Path 'c:\users\PowerShellForGitHub\downloads\asset.zip' -Force

Downloads the asset 1234567890 to 'c:\users\PowerShellForGitHub\downloads\asset.zip' and overwrites the file that may already be there.

PARAMETERS

-AccessToken

If provided, this will be used as the AccessToken for authentication with the REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-Asset

The ID of the specific asset to download.

Type: System.Int64
Parameter Sets: Elements-Download, Elements-Info, Uri-Download, Uri-Info
Aliases: AssetId

Required: True
Position: 2
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Force

If specified, will overwrite any file located at Path when downloading Asset.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: Elements-Download, Uri-Download
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-OwnerName

Owner of the repository. If not supplied here, the DefaultOwnerName configuration property value will be used.

Type: System.String
Parameter Sets: Elements-Download, Elements-Info, Elements-List
Aliases:

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

-Path

The path where the downloaded asset should be stored.

Type: System.String
Parameter Sets: Elements-Download, Uri-Download
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Release

The ID of a specific release to see the assets for.

Type: System.Int64
Parameter Sets: Elements-List, Uri-List
Aliases: ReleaseId

Required: True
Position: 2
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-RepositoryName

Name of the repository. If not supplied here, the DefaultRepositoryName configuration property value will be used.

Type: System.String
Parameter Sets: Elements-Download, Elements-Info, Elements-List
Aliases:

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

-Uri

Uri for the repository. The OwnerName and RepositoryName will be extracted from here instead of needing to provide them individually.

Type: System.String
Parameter Sets: Uri-List, Uri-Download, Uri-Info
Aliases: RepositoryUrl

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

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

INPUTS

GitHub.Branch

GitHub.Content

GitHub.Event

GitHub.Issue

GitHub.IssueComment

GitHub.Label

GitHub.Milestone

GitHub.PullRequest

GitHub.Project

GitHub.ProjectCard

GitHub.ProjectColumn

GitHub.Release

GitHub.ReleaseAsset

GitHub.Repository

OUTPUTS

GitHub.ReleaseAsset

NOTES

RELATED LINKS

PowerShellForGitHub

Docs

PowerShellForGitHub

Functions

Clone this wiki locally