你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Set-AzApiManagementNamedValue

参考

模块:: Az.ApiManagement

修改API 管理命名值。

语法

Set-AzApiManagementNamedValue
   -Context <PsApiManagementContext>
   -NamedValueId <String>
   [-Name <String>]
   [-Value <String>]
   [-Secret <Boolean>]
   [-Tag <String[]>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

Set-AzApiManagementNamedValue cmdlet 修改 Azure API 管理命名值。

示例

示例 1：更改命名值上的标记

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$Tags = 'sdk', 'powershell'
Set-AzApiManagementNamedValue -Context $apimContext -NamedValueId "Property11" -Tag $Tags -PassThru

第一个命令将两个值分配给$Tags变量。第二个命令修改 ID Property11 的命名值。该命令将$Tags中的字符串指定为命名值的标记。

示例 2：将命名值修改为具有机密值

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementNamedValue -Context $apimContext -NamedValueId "Property12" -Secret $True -PassThru

此命令将命名值更改为 Encrypted。

示例 3

修改API 管理命名值。（自动生成）

Set-AzApiManagementNamedValue -Context <PsApiManagementContext> -Name 'ContosoApi' -NamedValueId 'Property11' -Secret $true -Tag <String[]> -Value 'Property Value'

参数

-Confirm

提示你在运行 cmdlet 之前进行确认。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Context

PsApiManagementContext 的实例。此参数是必需的。

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

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

命名值的名称。最大长度为 100 个字符。可能包含字母、数字、句点、短划线和下划线字符。此参数是可选的。

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

-NamedValueId

要更新的命名值的标识符。此参数是必需的。

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

-PassThru

如果指定，则表示修改的属性的 Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProperty 类型的实例将写入输出。

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

-Secret

命名值是否为机密及其值应加密。此参数是可选的。

Type:	Nullable<T>[Boolean]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Tag

与命名值关联的标记。此参数是可选的。

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

-Value

命名值的值。可以包含策略表达式。最大长度为 1000 个字符。不能为空或只由空格组成。此参数是可选的。

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

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

输入

PsApiManagementContext

String

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

String[]

SwitchParameter

输出

PsApiManagementNamedValue