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

New-AzApiManagementNamedValue

创建新的命名值。

语法

New-AzApiManagementNamedValue
   -Context <PsApiManagementContext>
   [-NamedValueId <String>]
   [-Name <String>]
   [-Value <String>]
   [-Secret]
   [-Tag <String[]>]
   [-KeyVault <PsApiManagementKeyVaultEntity>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

New-AzApiManagementNamedValue cmdlet 创建 Azure API 管理命名值

示例

示例 1:创建包含标记的命名值

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

第一个命令将两个值分配给$Tags变量。 第二个命令创建命名值,并将$Tags中的字符串指定为属性上的标记。

示例 2:创建具有机密值的命名值

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementNamedValue -Context $apimContext -NamedValueId "Property12" -Name "Secret Property" -Value "Secret Property Value" -Secret

此命令创建 具有加密值的命名值

示例 3:创建 keyVault Namedvalue

$secretIdentifier = 'https://contoso.vault.azure.net/secrets/xxxx'
$keyvault = New-AzApiManagementKeyVaultObject -SecretIdentifier $secretIdentifier 
$keyVaultNamedValue = New-AzApiManagementNamedValue -Context $context -NamedValueId $keyVaultNamedValueId -Name $keyVaultNamedValueName -keyVault $keyvault -Secret

第一个命令创建 keyvault。 第二个命令使用此 keyvault 中的机密创建命名值。

参数

-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

-KeyVault

用于提取 Namedvalue 数据的 KeyVault。如果未指定 Value,则此参数是必需的。 有关详细信息,请参阅 New-AzApiManagementKeyVaultObject。

Type:PsApiManagementKeyVaultEntity
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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:False
Accept pipeline input:True
Accept wildcard characters:False

-Secret

确定值是否为密钥以及是否应加密。 此参数是可选的。 默认值为 false。

Type:SwitchParameter
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

SwitchParameter

String[]

输出

PsApiManagementNamedValue