New-EntraGroup
Microsoft Entra ID グループを作成します。
構文
Default (既定)
New-EntraGroup
-DisplayName <String>
[-GroupTypes <System.Collections.Generic.List`1[System.String]>]
-SecurityEnabled <Boolean>
[-Description <String>]
-MailEnabled <Boolean>
-MailNickname <String>
[-Visibility <String>]
[-IsAssignableToRole <Boolean>]
[<CommonParameters>]
説明
New-EntraGroup コマンドレットは、Microsoft Entra ID グループを作成します。 Microsoft Entra ID グループを作成するためのDisplayName、MailNickname、MailEnabled、およびSecurityEnabledパラメーターを指定します。
動的グループの作成の詳細については、「属性を 使用した高度なルールの作成」を参照してください。
アクセス許可に関する注意事項:
- ユーザーを所有者またはメンバーとしてグループを作成するには、アプリに少なくとも
User.Read.Allアクセス許可が必要です。 - 所有者またはメンバーとして他のサービス プリンシパルを持つグループを作成するには、アプリに少なくとも
Application.Read.Allアクセス許可が必要です。 - ユーザーまたはサービス プリンシパルを所有者またはメンバーとしてグループを作成するには、アプリに少なくとも
Directory.Read.Allアクセス許可が必要です。
例
例 1: グループを作成する
Connect-Entra -Scopes 'Group.ReadWrite.All','Group.Create'
$params = @{
DisplayName = 'HelpDesk admin group2'
MailEnabled = $False
MailNickname = 'helpDeskAdminGroup'
SecurityEnabled = $True
}
New-EntraGroup @params
DisplayName Id MailNickname Description GroupTypes
----------- -- ------------ ----------- ----------
HelpDesk admin group2 bbbbbbbb-5555-5555-0000-qqqqqqqqqqqq helpDeskAdminGroup {}
この例では、新しいグループを作成する方法を示します。
例 2: Description パラメーターを使用してグループを作成する
Connect-Entra -Scopes 'Group.ReadWrite.All','Group.Create'
$params = @{
DisplayName = 'HelpDesk admin group'
MailEnabled = $false
MailNickname = 'helpDeskAdminGroup'
SecurityEnabled = $true
Description = 'Group assignable to role'
}
New-EntraGroup @params
DisplayName Id MailNickname Description GroupTypes
----------- -- ------------ ----------- ----------
HelpDesk admin group zzzzzzzz-6666-8888-9999-pppppppppppp helpDeskAdminGroup Group assignable to role {}
この例では、description パラメーターを使用して新しいグループを作成する方法を示します。
例 3: IsAssignableToRole パラメーターを使用してグループを作成する
Connect-Entra -Scopes 'Group.ReadWrite.All','Group.Create'
$params = @{
DisplayName = 'HelpDesk admin group2'
Description = 'Group assignable to role'
MailEnabled = $False
MailNickname = 'helpDeskAdminGroup'
SecurityEnabled = $True
IsAssignableToRole = $True
}
New-EntraGroup @params
DisplayName Id MailNickname Description GroupTypes
----------- -- ------------ ----------- ----------
HelpDesk admin group2 vvvvvvvv-8888-9999-0000-jjjjjjjjjjjj helpDeskAdminGroup Group assignable to role {}
この例では、IsAssignableToRole パラメーターを使用して新しいグループを作成する方法を示します。
例 4: Visibility パラメーターを使用してグループを作成する
Connect-Entra -Scopes 'Group.ReadWrite.All','Group.Create'
$params = @{
DisplayName = 'HelpDesk admin group2'
Description = 'Group assignable to role'
MailEnabled = $False
MailNickname = 'helpDeskAdminGroup'
SecurityEnabled = $True
Visibility = 'Private'
}
New-EntraGroup @params
DisplayName Id MailNickname Description GroupTypes
----------- -- ------------ ----------- ----------
HelpDesk admin group2 gggggggg-0000-4444-3333-llllllllllll helpDeskAdminGroup Group assignable to role {}
この例では、Visibility パラメーターを使用して新しいグループを作成する方法を示します。
例 5: GroupTypes パラメーターを使用してグループを作成する
Connect-Entra -Scopes 'Group.ReadWrite.All','Group.Create'
$params = @{
DisplayName = 'HelpDesk admin group3'
Description = 'group des'
MailEnabled = $False
MailNickname = 'helpDeskAdminGroup1'
SecurityEnabled = $True
GroupTypes = 'Unified'
}
New-EntraGroup @params
DisplayName Id MailNickname Description GroupTypes
----------- -- ------------ ----------- ----------
HelpDesk admin group3 xxxxxxxx-8888-5555-9999-bbbbbbbbbbbb helpDeskAdminGroup1 group des {Unified}
この例では、GroupTypes パラメーターを使用して新しいグループを作成する方法を示します。
パラメーター
-Description
グループの説明を指定します。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DisplayName
グループの表示名を指定します。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-GroupTypes
グループが統合グループまたは動的グループであることを指定します。
メモ:
- 現在、このパラメーターを使用して動的グループを作成することはできません。 PowerShell で動的グループを作成するには、Entra モジュールを使用する必要があります。
パラメーターのプロパティ
| 型: | System.Collections.Generic.List`1[System.String] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-IsAssignableToRole
グループをロールに割り当てることができるかどうかを示します。 このプロパティは、グループの作成時にのみ設定でき、既存のグループでは変更できません。
パラメーターのプロパティ
| 型: | System.Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-MailEnabled
このグループがメールを有効にするかどうかを指定します。
現時点では、Microsoft Entra IDでメールが有効なグループを作成することはできません。
パラメーターのプロパティ
| 型: | System.Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-MailNickname
グループのメール ニックネームを指定します。 MailEnabled が$False場合でも、メールのニックネームを指定する必要があります。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SecurityEnabled
グループがセキュリティを有効にするかどうかを指定します。 セキュリティ グループの場合、この値は$Trueする必要があります。
パラメーターのプロパティ
| 型: | System.Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Visibility
このパラメーターは、グループのコンテンツとメンバーリストの可視性を決定します。
このパラメーターは、次のいずれかの値を受け取ることができます。
- "パブリック" - すべてのユーザーがグループの内容を表示できます
- "プライベート" - メンバーのみがグループのコンテンツを表示できます
- "HiddenMembership" - メンバーのみがグループのコンテンツを表示でき、メンバー、所有者、グローバル/会社管理者、ユーザー管理者、ヘルプデスク管理者のみがグループのメンバー リストを表示できます。
値が指定されていない場合、既定値は "Public" です。
メモ:
- このパラメーターは、groupType が "Unified" に設定されているグループに対してのみ有効です。
- グループにこの属性が "HiddenMembership" に設定されている場合、後で変更することはできません。
- この属性が "Public" に設定されているグループには、誰でも参加できます。 属性が Private または HiddenMembership に設定されている場合、所有者のみがグループに新しいメンバーを追加でき、グループへの参加を要求するには所有者の承認が必要です。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。