Update-AzADGroup

リファレンス

モジュール:: Az.Resources

グループ内のエンティティを更新する

構文

Update-AzADGroup
      -ObjectId <String>
      [-AdditionalProperties <Hashtable>]
      [-AppRoleAssignment <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>]
      [-Classification <String>]
      [-CreatedOnBehalfOf <IMicrosoftGraphDirectoryObject>]
      [-DeletedDateTime <DateTime>]
      [-Description <String>]
      [-DisplayName <String>]
      [-GroupType <String[]>]
      [-HasMembersWithLicenseError]
      [-IsArchived]
      [-IsAssignableToRole]
      [-MailEnabled]
      [-MailNickname <String>]
      [-MembershipRule <String>]
      [-MembershipRuleProcessingState <String>]
      [-PermissionGrant <IMicrosoftGraphResourceSpecificPermissionGrant[]>]
      [-PreferredDataLocation <String>]
      [-PreferredLanguage <String>]
      [-SecurityEnabled]
      [-SecurityIdentifier <String>]
      [-Theme <String>]
      [-Visibility <String>]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

グループ内のエンティティを更新する

例

例 1: グループの説明を更新する

Update-AzADGroup -ObjectId $objectid -Description $description

グループの説明を更新します。

パラメーター

-AdditionalProperties

追加のパラメーター

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

-AppRoleAssignment

アプリケーションに対してグループに付与されているアプリロールを表します。 $expandをサポートします。構築するには、APPROLEASSIGNMENT プロパティの NOTES セクションを参照し、ハッシュテーブルを作成します。

Type:	IMicrosoftGraphAppRoleAssignmentAutoGenerated[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Classification

グループの分類 (低、中、高のビジネスへの影響など) について説明します。このプロパティの有効な値は、テンプレート定義に基づいて ClassificationList 設定値を作成することによって定義されます。既定で返されます。 $filter (eq、ne、NOT、ge、le、startsWith) をサポートします。

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

-Confirm

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CreatedOnBehalfOf

Microsoft Entra オブジェクトを表します。 directoryObject 型は、他の多くのディレクトリエンティティ型の基本型です。構築するには、CREATEDONBEHALFOF プロパティの NOTES セクションを参照し、ハッシュテーブルを作成します。

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

-DefaultProfile

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

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeletedDateTime

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

-Description

オプションでグループに付ける説明。既定で返されます。 $filter (eq、ne、NOT、ge、le、startsWith) と$searchをサポートします。

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

-DisplayName

ディレクトリに表示される名前

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

-GroupType

グループの種類とそのメンバーシップを指定します。コレクションに Unified が含まれている場合、グループは Microsoft 365 グループです。それ以外の場合は、セキュリティグループまたは配布グループです。詳細については、グループの概要を参照してください。コレクションに DynamicMembership が含まれている場合、グループには動的メンバーシップがあります。それ以外の場合、メンバーシップは静的です。既定で返されます。 $filter (eq、NOT) をサポートします。

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

-HasMembersWithLicenseError

グループベースのライセンス割り当てでライセンスエラーが発生したメンバーがこのグループに存在するかどうかを示します。このプロパティは、GET 操作では返されません。これを$filter引数として使用して、ライセンスエラーのあるメンバーを持つグループを取得できます (つまり、このプロパティを true にフィルター処理します)。 $filter (eq) をサポートします。

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

-IsArchived

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

-IsAssignableToRole

このグループを Microsoft Entra ロールに割り当てることができるかどうかを示します。このプロパティは、グループの作成時にのみ設定でき、変更できません。 true に設定した場合、securityEnabled プロパティも true に設定する必要があり、グループを動的グループにすることはできません (つまり、groupTypes に DynamicMembership を含めることはできません)。このプロパティを設定できるのは、グローバル管理者ロールと特権ロール管理者ロールの呼び出し元だけです。このプロパティを設定するには、呼び出し元に Directory.AccessAsUser.All アクセス許可も割り当てる必要があります。詳細については、「グループを使用して Microsoft Entra ロールの割り当てを管理する」を参照してください。既定で戻されます。 $filter (eq、ne、NOT) をサポートします。

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

-MailEnabled

グループがメール対応かどうかを指定します。既定で返されます。 $filter (eq、ne、NOT) をサポートします。

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

-MailNickname

組織内で一意のグループのメールエイリアス。このプロパティは、グループの作成時に指定する必要があります。これらの文字は、mailNickName: @()/[]';:.,<>SPACE では使用できません。既定で返されます。 $filter (eq、ne、NOT、ge、le、in、startsWith) をサポートします。

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

-MembershipRule

グループが動的グループの場合にこのグループのメンバーを決定するルール (groupTypes には DynamicMembership が含まれています)。メンバーシップルールの構文の詳細については、「メンバーシップルールの構文」を参照してください。既定で返されます。 $filter (eq、ne、NOT、ge、le、startsWith) をサポートします。

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

-MembershipRuleProcessingState

動的メンバーシップ処理がオンか一時停止かを示します。有効な値は[オン]または[一時停止]です。既定で返されます。 $filter (eq、ne、NOT、in) をサポートします。

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

-ObjectId

キー: グループの ID

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

-PassThru

コマンドが成功したときに true を返します。

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

-PermissionGrant

特定のアプリケーションに対してグループに付与されたアクセス許可。 $expandをサポートします。構築するには、PERMISSIONGRANT プロパティの NOTES セクションを参照し、ハッシュテーブルを作成します。

Type:	IMicrosoftGraphResourceSpecificPermissionGrant[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PreferredDataLocation

グループの優先されるデータの場所。詳細については、「OneDrive Online Multi-Geo」を参照してください。既定で返されます。

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

-PreferredLanguage

Microsoft 365 グループの優先言語。 ISO639-1 コードに従う必要があります; たとえば、「en-US」。既定で返されます。 $filter (eq、ne、NOT、ge、le、in、startsWith) をサポートします。

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

-SecurityEnabled

グループがセキュリティグループかどうかを指定します。既定で返されます。 $filter (eq、ne、NOT、in) をサポートします。

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

-SecurityIdentifier

Windows シナリオで使用されるグループのセキュリティ識別子。既定で返されます。

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

-Theme

Microsoft 365 グループのカラーテーマを指定します。指定できる値は、Teal、Purple、Green、Blue、Pink、Orange、Red です。既定で返されます。

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

-Visibility

グループのグループ参加ポリシーとグループコンテンツの可視性を指定します。使用可能な値は、Private、Public、または Hiddenmembership です。 Hiddenmembership は、グループの作成時に Microsoft 365 グループに対してのみ設定できます。後で更新することはできません。その他の可視性の値は、グループの作成後に更新できます。 Microsoft Graph でのグループの作成時に可視性の値が指定されていない場合、セキュリティグループは既定でプライベートとして作成され、Microsoft 365 グループはパブリックになります。詳細については、グループの表示オプションを参照してください。既定で返されます。

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

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

出力

Boolean

メモ

別名

複合パラメーターのプロパティ

以下で説明するパラメーターを作成するには、適切なプロパティを含むハッシュテーブルを作成します。ハッシュテーブルの詳細については、Get-Help about_Hash_Tablesを実行します。

APPROLEASSIGNMENT <IMicrosoftGraphAppRoleAssignmentAutoGenerated[]>: グループがアプリケーションに付与されているアプリロールを表します。 $expandをサポートします。

[DeletedDateTime <DateTime?>]:
[DisplayName <String>]: ディレクトリに表示される名前
[AppRoleId <String>]: プリンシパルに割り当てられているアプリロールの識別子 (ID)。このアプリロールは、リソースアプリケーションのサービスプリンシパル (resourceId) の appRoles プロパティで公開する必要があります。リソースアプリケーションがアプリロールを宣言していない場合は、既定のアプリロール ID 00000000-0000-0000-000000000000 を指定して、プリンシパルが特定のアプリロールなしでリソースアプリに割り当てられていることを通知できます。作成時に必要です。
[CreatedDateTime <DateTime?>]: アプリロールの割り当てが作成された時刻。Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時刻です。たとえば、2014 年 1 月 1 日の午前 0 時 (UTC) は 2014-01-01T00:00:00Z です。読み取り専用です。
[PrincipalDisplayName <String>]: アプリロールの割り当てが付与されたユーザー、グループ、またはサービスプリンシパルの表示名。読み取り専用です。 $filter (eq と startswith) をサポートします。
[PrincipalId <String>]: アプリロールが付与されているユーザー、グループ、またはサービスプリンシパルの一意識別子 (ID)。作成時に必要です。
[PrincipalType <String>]: 割り当てられたプリンシパルの型。 User、Group、ServicePrincipal のいずれかを指定できます。読み取り専用です。
[ResourceDisplayName <String>]: 割り当てが行われるリソースアプリのサービスプリンシパルの表示名。
[ResourceId <String>]: 割り当てが行われるリソースサービスプリンシパルの一意識別子 (ID)。作成時に必要です。 $filterをサポートします (eq のみ)。

CREATEDONBEHALFOF <IMicrosoftGraphDirectoryObject>: Microsoft Entra オブジェクトを表します。 directoryObject 型は、他の多くのディレクトリエンティティ型の基本型です。

[DeletedDateTime <DateTime?>]:
[DisplayName <String>]: ディレクトリに表示される名前

PERMISSIONGRANT <IMicrosoftGraphResourceSpecificPermissionGrant[]>: 特定のアプリケーションに対してグループに付与されたアクセス許可。 $expandをサポートします。

[DeletedDateTime <DateTime?>]:
[DisplayName <String>]: ディレクトリに表示される名前
[ClientAppId <String>]: アクセス権が付与されている Microsoft Entra アプリのサービスプリンシパルの ID。読み取り専用です。
[ClientId <String>]: アクセス権が付与されている Microsoft Entra アプリの ID。読み取り専用です。
[Permission <String>]: リソース固有のアクセス許可の名前。読み取り専用です。
[PermissionType <String>]: アクセス許可の種類。使用可能な値は、Application、Delegated です。読み取り専用です。
[ResourceAppId <String>]: リソースをホストしている Microsoft Entra アプリの ID。読み取り専用です。