Get-AzApiManagementSubscriptionKey
Gets subscription keys.
Syntax
Get-AzApiManagementSubscriptionKey
-Context <PsApiManagementContext>
-SubscriptionId <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzApiManagementSubscriptionKey cmdlet gets a keys of a specified subscription.
Examples
Example 1: Get a subscription keys with a specified ID
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-East-US" -ServiceName "contoso"
Get-AzApiManagementSubscriptionKey -Context $apimContext -SubscriptionId "0123456789"
PrimaryKey : 5e48532634114fe999a6979ce0d63a64
SecondaryKey : 0a8efaf85a664aa0a412241015c7c8f6
This command gets a subscription by ID.
Parameters
-Context
Specifies a PsApiManagementContext object.
Type: | PsApiManagementContext |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubscriptionId
Specifies a subscription identifier. If specified, this cmdlet finds subscription by the identifier.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
Outputs
PsApiManagementSubscriptionKey