New-AzApiManagementNamedValue

建立新的具名值。

Syntax

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

Description

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