次の方法で共有

Set-AzureRmApiManagementGroup

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

API 管理グループを構成します。

警告

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

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

構文

Set-AzureRmApiManagementGroup
   -Context <PsApiManagementContext>
   -GroupId <String>
   [-Name <String>]
   [-Description <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

Set-AzureRmApiManagementGroup コマンドレットは、API 管理グループを構成します。

例

例 1: 管理グループを構成する

PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Set-AzureRmApiManagementGroup -Context $apimContext -Description "Updated Management Group" -Name "Group0001"

このコマンドは、Group0001 という名前の管理グループを構成します。

パラメーター

-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

-Description

管理グループの説明を指定します。

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

-GroupId

管理グループの識別子を指定します。

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

-Name

管理グループの名前を指定します。

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

-PassThru

Passthru

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

入力

PsApiManagementContext

String

SwitchParameter

出力

PsApiManagementGroup