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

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

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Context

PsApiManagementContext のインスタンス。このパラメーターは必須です。

型:	PsApiManagementContext
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Name

名前付き値の名前。最大長は 100 文字です。文字、数字、ピリオド、ダッシュ、アンダースコアのみを含めることができます。このパラメーターは省略可能です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-NamedValueId

更新する名前付き値の識別子。このパラメーターは必須です。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-PassThru

指定した場合、変更されたプロパティを表す Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProperty 型のインスタンスが出力に書き込まれます。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Secret

名前付き値がシークレットであり、その値を暗号化する必要があるかどうか。このパラメーターは省略可能です。

型:	Nullable<T>[Boolean]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Tag

名前付き値に関連付けられているタグ。このパラメーターは省略可能です。

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Value

名前付き値の値。ポリシー式を含めることができます。最大長は 1000 文字です。空白ではないか、空白のみで構成されている場合があります。このパラメーターは省略可能です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットを実行した場合の動作を示します。コマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False