Get-AzSshKey
Gets the properties of SSH Public Key resources.
Note
This is the previous version of our documentation. Please consult the most recent version for up-to-date information.
Syntax
Get-AzSshKey
[-ResourceGroupName <String>]
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzSshKey
[-ResourceId] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
Gets the properties of SSH Public Key resources.
Examples
Example 1
Get-AzSshKey -ResourceGroupName "testRG" -Name "SshKey1"This example retrieves a specific Ssh Public Key resource.
Example 2
Get-AzSshKey -ResourceGroupName "testRG"This example retrieves a list of Ssh Public Key resources that are in Resource Group: "testRG"
Example 3
Get-AzSshKeyThis example retrieves all the Ssh Public Key resources in the subscription.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of the Ssh Public Key resource to get.
| Type: | String |
| Aliases: | sshkeyName |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-ResourceGroupName
Specifies the name of a resource group.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-ResourceId
Resource ID for your SSH Public Key Resource.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |