Edit

Share via


Get-AzApiManagementNamedValueSecretValue

Gets a secret value of the particular Named Value.

Syntax

Default (Default)

Get-AzApiManagementNamedValueSecretValue
    -Context <PsApiManagementContext>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

GetByNamedValueId

Get-AzApiManagementNamedValueSecretValue
    -Context <PsApiManagementContext>
    -NamedValueId <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

Gets a secret value of the particular Named Value.

Examples

Example 1: Get named value by name

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementNamedValueSecretValue -Context $apimContext -NamedValueId "sql-connectionstring"

This command gets the named value details given the named value name.

Parameters

-Context

Instance of PsApiManagementContext. This parameter is required.

Parameter properties

Type:PsApiManagementContext
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NamedValueId

Identifier of a the named value. This parameter is required.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetByNamedValueId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

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

PsApiManagementContext

String

Outputs

PsApiManagementNamedValueSecretValue