Set-AzApiManagementNamedValue

リファレンス

モジュール:: Az.ApiManagement

API Management の名前付き値を変更します。

構文

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

説明

Set-AzApiManagementNamedValue コマンドレットは、Azure API Management の名前付き値を変更します。

例

例 1: 名前付き値のタグを変更する

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

最初のコマンドは、$Tags変数に 2 つの値を割り当てます。 2 番目のコマンドは、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 Management の名前付き値を変更します。 (自動生成)

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

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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

名前付き値の値。ポリシー式を含めることができます。最大長は 1,000 文字です。空にすることはできません。スペースのみで構成することはできません。このパラメーターは省略可能です。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

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