Get-AzApiManagementNamedValue

Module:

Az.ApiManagement

Gets a list or a particular Named Value.

Syntax

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

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

Get-AzApiManagementNamedValue
   -Context <PsApiManagementContext>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzApiManagementNamedValue
   -Context <PsApiManagementContext>
   [-Tag <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzApiManagementNamedValue cmdlet gets a list or a particular named value. Value will not be included into result details if the named value marked as a secret. To get secret value, use Get-AzApiManagementNamedValueSecretValue.

Examples

Example 1: Get Named Value by name

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

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

Parameters

-Context

Instance of PsApiManagementContext. This parameter is required.

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

-Name

Finds named values with names containing the string Name. This parameter is optional.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-NamedValueId

Identifier of the named value. If specified will try to find named value by the identifier. This parameter is optional.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Tag

Finds named values associated with a Tag. If specified will return all properties associated with a tag. This parameter is optional.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

PsApiManagementContext

String

Outputs

PsApiManagementNamedValue