次の方法で共有

Set-AzureRmApiManagementProperty

  • リファレンス
モジュール:
AzureRM.ApiManagement

API Management プロパティを変更します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Set-AzureRmApiManagementProperty
   -Context <PsApiManagementContext>
   -PropertyId <String>
   [-Name <String>]
   [-Value <String>]
   [-Secret <Boolean>]
   [-Tag <String[]>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

Set-AzureRmApiManagementProperty コマンドレットは、Azure API Management プロパティを変更します。

例

例 1: プロパティのタグを変更する

PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>$Tags = 'sdk', 'powershell'
PS C:\> Set-AzureRmApiManagementProperty -Context $apimContext -PropertyId "Property11" -Tags $Tags -PassThru

最初のコマンドは、$Tags変数に 2 つの値を割り当てます。 2 番目のコマンドは、ID Property11 を持つプロパティを変更します。 このコマンドは、$Tags内の文字列をプロパティのタグとして割り当てます。

例 2: シークレット値を持つプロパティを変更する

PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Set-AzureRmApiManagementProperty -Context $apimContext -PropertyId "Property12" -Secret $True -PassThru

このコマンドは、プロパティを Encrypted に変更します。

パラメーター

-Context

PsApiManagementContext オブジェクトを指定します。

型:PsApiManagementContext
Position:Named
既定値:None
必須:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

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

型:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
既定値:None
必須:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

プロパティの名前を指定します。 最大長は 100 文字です。 名前には、文字、数字、ピリオド、ダッシュ、およびアンダースコア文字のみが含まれます。

型:String
Position:Named
既定値:None
必須:False
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

このコマンドレットが変更する PsApiManagementProperty を返すコマンドレットを示します。

型:SwitchParameter
Position:Named
既定値:None
必須:False
Accept pipeline input:True
Accept wildcard characters:False

-PropertyId

このコマンドレットが変更するプロパティの ID を指定します。

型:String
Position:Named
既定値:None
必須:True
Accept pipeline input:True
Accept wildcard characters:False

-Secret

プロパティ値がシークレットであり、暗号化する必要があることを示します。

型:Nullable<T>[Boolean]
Position:Named
既定値:None
必須:False
Accept pipeline input:True
Accept wildcard characters:False

-Tag

プロパティに関連付けられているタグ。 このパラメーターは省略可能です。

型:String[]
Position:Named
既定値:None
必須:False
Accept pipeline input:True
Accept wildcard characters:False

-Value

プロパティの値を指定します。 この値には、ポリシー式を含めることができます。 最大長は 1,000 文字です。 値を空にしたり、空白のみで構成したりすることはできません。

型:String
Position:Named
既定値:None
必須:False
Accept pipeline input:True
Accept wildcard characters:False

入力

PsApiManagementContext

String

Nullable<T>[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

String[]

SwitchParameter

出力

PsApiManagementProperty