Get-GitHubPublicKey¶
SYNOPSIS¶
Gets a public key.
SYNTAX¶
AuthenticatedUser (Default)¶
Get-GitHubPublicKey [-Type <String>] [-Context <Object>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Environment¶
Get-GitHubPublicKey -Owner <String> -Repository <String> -Environment <String> [-Type <String>]
[-Context <Object>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Repository¶
Get-GitHubPublicKey -Owner <String> -Repository <String> [-Type <String>] [-Context <Object>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Organization¶
Get-GitHubPublicKey -Owner <String> [-Type <String>] [-Context <Object>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION¶
Gets your public key, which you need to encrypt secrets.
EXAMPLES¶
EXAMPLE 1¶
Get-GitHubPublicKey
Gets a public key for the authenticated user.
EXAMPLE 2¶
Get-GitHubPublicKey -Organization 'octocat'
Gets a public key for the 'octocat' organization.
EXAMPLE 3¶
Get-GitHubPublicKey -Owner 'octocat' -Repository 'hello-world' -Type 'codespaces'
Gets a public key for the 'hello-world' repository in the 'octocat' organization for codespaces.
PARAMETERS¶
-Owner¶
The account owner of the repository. The name is not case sensitive.
Type: String
Parameter Sets: Environment, Repository, Organization
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Repository¶
The name of the repository. The name is not case sensitive.
Type: String
Parameter Sets: Environment, Repository
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Environment¶
The name of the repository environment.
Type: String
Parameter Sets: Environment
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Type¶
The context to run the command in. Used to get the details for the API call.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: Actions
Accept pipeline input: False
Accept wildcard characters: False
-Context¶
The context to run the command in. Used to get the details for the API call. Can be either a string or a GitHubContext object.
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: (Get-GitHubContext)
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction¶
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
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¶
OUTPUTS¶
GitHubPublicKey¶
NOTES¶
RELATED LINKS¶
https://psmodule.io/GitHub/Functions/Secrets/Get-GitHubPublicKey/