Get-GitHubPublicKey¶
SYNOPSIS¶
Gets a public key.
SYNTAX¶
AuthenticatedUser (Default)¶
Get-GitHubPublicKey [-Type <string>] [-Context <Object>] [<CommonParameters>]
Environment¶
Get-GitHubPublicKey -Owner <string> -Repository <string> -Environment <string> [-Type <string>]
[-Context <Object>] [<CommonParameters>]
Repository¶
Get-GitHubPublicKey -Owner <string> -Repository <string> [-Type <string>] [-Context <Object>]
[<CommonParameters>]
Organization¶
Get-GitHubPublicKey -Owner <string> [-Type <string>] [-Context <Object>] [<CommonParameters>]
ALIASES¶
This cmdlet has the following aliases, {{Insert list of aliases}}
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¶
-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: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Environment¶
The name of the repository environment.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Environment
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: true
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Owner¶
The account owner of the repository. The name is not case sensitive.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Environment
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: true
ValueFromRemainingArguments: false
- Name: Repository
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: true
ValueFromRemainingArguments: false
- Name: Organization
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: true
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Repository¶
The name of the repository. The name is not case sensitive.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Environment
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: true
ValueFromRemainingArguments: false
- Name: Repository
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: true
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Type¶
The context to run the command in. Used to get the details for the API call.
Type: System.String
DefaultValue: actions
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
Position: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
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¶
System.String¶
{{ Fill in the Description }}
OUTPUTS¶
GitHubPublicKey¶
{{ Fill in the Description }}