Microsoft.Graph グループ
重要
Microsoft Graph の /beta
バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、バージョン セレクターを使用します。
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合 、より高い特権またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 Permission の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。
Note
個人の Microsoft アカウントのアクセス許可を使用して、Bicep ファイルで宣言された Microsoft Graph リソースをデプロイすることはできません。
アクセス許可の種類 | 最小限の特権アクセス許可 | 高い特権のアクセス許可 |
---|---|---|
委任 (勤務先または学校アカウント) | Group.ReadWrite.All | Directory.ReadWrite.All |
委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
アプリケーション | Group.ReadWrite.All | Directory.ReadWrite.All |
リソース形式
Microsoft.Graph/groups リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Graph/groups@beta' = {
classification: 'string'
description: 'string'
displayName: 'string'
groupTypes: [
'string'
]
infoCatalogs: [
'string'
]
isAssignableToRole: bool
mailEnabled: bool
mailNickname: 'string'
members: [
'string'
]
membershipRule: 'string'
membershipRuleProcessingState: 'string'
organizationId: 'string'
owners: [
'string'
]
preferredDataLocation: 'string'
preferredLanguage: 'string'
resourceBehaviorOptions: [
'string'
]
resourceProvisioningOptions: [
'string'
]
securityEnabled: bool
serviceProvisioningErrors: [
{
createdDateTime: 'string'
isResolved: bool
serviceInstance: 'string'
}
]
theme: 'string'
uniqueName: 'string'
visibility: 'string'
writebackConfiguration: {
isEnabled: bool
onPremisesGroupType: 'string'
}
}
プロパティ値
groups
名前 | Description | Value |
---|---|---|
apiVersion | リソース API のバージョン | 'beta' (ReadOnly) |
分類 | グループの分類 (低、中、高のビジネスへの影響など) について説明します | string |
createdByAppId | グループの作成に使用されるアプリのアプリ ID。 一部のグループでは null を指定できます。 読み取り専用 | string (ReadOnly) |
createdDateTime | グループが作成された日時のタイムスタンプ。 値は変更できません。グループの作成時に自動的に設定されます。 タイムスタンプ型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC です。 たとえば、2014 年 1 月 1 日の午前 0 時 (UTC) は 2014-01-01T00:00:00Z です。 読み取り専用です。 | string (ReadOnly) |
deletedDateTime | このオブジェクトが削除された日時。 オブジェクトが削除されていない場合は常に null。 | string (ReadOnly) |
description | グループの説明 (省略可能) | string |
displayName | グループの表示名。 必須。 最大長は 256 文字です | string (必須) |
expirationDateTime | グループの有効期限が切れる時刻のタイムスタンプ。 セキュリティ グループの場合は null ですが、Microsoft 365 グループの場合は、groupLifecyclePolicy で定義されているようにグループの有効期限が切れるタイミングを表します。 タイムスタンプ型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC です。 たとえば、2014 年 1 月 1 日の午前 0 時 (UTC) は 2014-01-01T00:00:00Z です。 読み取り専用です。 | string (ReadOnly) |
groupTypes | グループの種類とそのメンバーシップを指定します。 コレクションに Unified が含まれている場合、グループは Microsoft 365 グループです。それ以外の場合は、セキュリティ グループまたは配布グループです。 詳細については、グループの概要を参照してください。コレクションに DynamicMembership が含まれている場合、グループには動的メンバーシップがあります。それ以外の場合、メンバーシップは静的です | string[] |
ID | エンティティの一意識別子。 読み取り専用です。 | string (ReadOnly) |
infoCatalogs | グループに割り当てられている情報セグメントを識別します | string[] |
isAssignableToRole | このグループを Microsoft Entra ロールに割り当てることができるかどうかを示します。 省略可能。 このプロパティは、グループの作成時にのみ設定でき、変更できません。 true に設定する場合、securityEnabled プロパティも true に設定する必要があります。可視性は非表示にする必要があり、グループを動的グループにすることはできません (つまり、groupTypes に DynamicMembership を含めることはできません)。 このプロパティを設定できるのは、少なくとも特権ロール管理者ロールを持つ呼び出し元だけです。 このプロパティを設定したり、そのようなグループのメンバーシップを更新したりするには、呼び出し元に RoleManagement.ReadWrite.Directory アクセス許可も割り当てる必要があります。 詳細については、「グループを使用して Microsoft Entra ロールの割り当てを管理する」を参照してください。この機能を使用するには、Microsoft Entra ID P1 ライセンスが必要です | [bool] |
isManagementRestricted | グループが制限付き管理管理単位のメンバーであるかどうかを示します。その場合、管理するには制限付き管理単位をスコープとするロールが必要です。 既定値は false です。 読み取り専用です。 制限付き管理単位のグループ メンバーを管理するには、呼び出し元アプリに Directory.Write.Restricted アクセス許可が割り当てられている必要があります。 委任されたシナリオでは、管理者は、制限された管理単位スコープでサポートされているロールを明示的に割り当てる必要もあります。 | bool (ReadOnly) |
メール | グループの SMTP アドレス (例: "serviceadmins@contoso.com")。 読み取り専用 | string (ReadOnly) |
mailEnabled | グループがメール対応かどうかを指定します。 必須 | bool (必須) |
mailNickname | 組織内の Microsoft 365 グループに固有のグループのメール エイリアス。 最大文字数は 64 文字です。 このプロパティには、ASCII 文字セット 0 から 127 の文字のみを含めることができます。ただし、@ () / [] ' を除きます。: <> 、 SPACE | string (必須) |
メンバー | 直接グループ メンバー。ユーザー、デバイス、その他のグループ、またはサービス プリンシパルを指定できます。 メンバーの一覧表示、メンバーの追加、およびメンバーの削除操作をサポートします。 NULL 値の使用 | string[] |
membershipRule | グループが動的グループの場合にこのグループのメンバーを決定するルール (groupTypes には DynamicMembership が含まれています)。 メンバーシップ ルールの構文の詳細については、「メンバーシップ ルールの構文」を参照してください。 | string |
membershipRuleProcessingState | 動的メンバーシップ処理がオンか一時停止かを示します。 有効な値は On または Paused です | string |
onPremisesDomainName | オンプレミス のドメイン FQDN (オンプレミス ディレクトリから同期される dnsDomainName とも呼ばれます) が含まれます。 読み取り専用です。 | string (ReadOnly) |
onPremisesLastSyncDateTime | グループがオンプレミス ディレクトリと同期された最後の時刻を示します。タイムスタンプ型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC です。 たとえば、2014 年 1 月 1 日の午前 0 時 (UTC) は 2014-01-01T00:00:00Z です。 読み取り専用 | string (ReadOnly) |
onPremisesNetBiosName | オンプレミスディレクトリから同期されたオンプレミスの netBios 名が含まれます。 読み取り専用です。 | string (ReadOnly) |
onPremisesProvisioningErrors | プロビジョニング中に Microsoft 同期製品を使用するときのエラー | MicrosoftGraphOnPremisesProvisioningError[] (ReadOnly) |
onPremisesSamAccountName | オンプレミス ディレクトリから同期されたオンプレミスの SAM アカウント名が含まれます。 読み取り専用です。 | string (ReadOnly) |
onPremisesSecurityIdentifier | オンプレミスからクラウドに同期されるグループのオンプレミス セキュリティ識別子 (SID) が含まれます。 読み取り専用 | string (ReadOnly) |
onPremisesSyncEnabled | このグループがオンプレミスのディレクトリから同期されている場合は true。このグループが最初にオンプレミスのディレクトリから同期されたが、同期されなくなった場合は false。このオブジェクトがオンプレミスのディレクトリから同期されていない場合は null (既定値)。 読み取り専用 | bool (ReadOnly) |
organizationId | string | |
owners | ユーザーまたはサービス プリンシパルにすることができるグループの所有者。 Null 許容。 Microsoft 365 グループの作成時にこのプロパティが指定されていない場合、呼び出し元のユーザーはグループ所有者として自動的に割り当てられます | string[] |
preferredDataLocation | Microsoft 365 グループの優先されるデータの場所。 既定では、グループはグループ作成者の優先データの場所を継承します。 このプロパティを設定するには、呼び出し元アプリに Directory.ReadWrite.All アクセス許可が付与され、ユーザーに少なくとも 1 つの Microsoft Entra ロールが割り当てられている必要があります。ユーザー アカウント管理者ディレクトリ ライター Exchange 管理者 SharePoint 管理者 このプロパティの詳細については、「OneDrive Online Multi-Geo」および「特定の PDL を使用して Microsoft 365 グループを作成する」を参照してください。 NULL 値の使用 | string |
preferredLanguage | Microsoft 365 グループの優先言語。 ISO 639-1 コードに従う必要があります。たとえば、en-US | string |
proxyAddresses | 同じグループ メールボックスに転送するグループの電子メール アドレス。 例: ["SMTP: bob@contoso.com"、"smtp: bob@sales.contoso.com"。 複数値プロパティのフィルター式には、任意の演算子が必要です。 読み取り専用です。 NULL 値は許可されません | string[] (ReadOnly) |
renewedDateTime | グループが最後に更新された日時のタイムスタンプ。 これは直接変更できず、サービスの更新アクションによってのみ更新されます。 タイムスタンプ型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC です。 たとえば、2014 年 1 月 1 日の午前 0 時 (UTC) は 2014-01-01T00:00:00Z です。 読み取り専用です。 | string (ReadOnly) |
resourceBehaviorOptions | 作成時に Microsoft 365 グループに対して設定できるグループの動作を指定します。 このプロパティは、作成 (POST) の一部としてのみ設定できます。 使用可能な値の一覧については、Microsoft 365 グループの動作とプロビジョニング オプションを参照してください。 | string[] |
resourceProvisioningOptions | Microsoft 365 グループに関連付けられているグループ リソースを指定します。 可能な値は Team です。 詳細については、「Microsoft 365 グループの動作とプロビジョニング オプション」を参照してください。 | string[] |
securityEnabled | グループがセキュリティ グループかどうかを指定します | bool (必須) |
securityIdentifier | Windows シナリオで使用されるグループのセキュリティ識別子。 読み取り専用 | string (ReadOnly) |
serviceProvisioningErrors | グループ オブジェクトからのプロパティまたはリンクに関する一時的でないサービス固有のエラーを記述するフェデレーション サービスによって発行されたエラー。 | MicrosoftGraphServiceProvisioningError[] |
theme | Microsoft 365 グループのカラー テーマを指定します。 使用できる値は、Teal、Purple、Green、Blue、Pink、Orange、Red です。 | string |
type | リソースの種類 | 'Microsoft.Graph/groups' (ReadOnly) |
uniqueName | グループに割り当て、代替キーとして使用できる一意の識別子。 変更不可 | string (必須) |
visibility | グループのグループ参加ポリシーとグループ コンテンツの可視性を指定します。 使用可能な値は、Private、Public、または HiddenMembership です。 HiddenMembership は、グループの作成時に Microsoft 365 グループにのみ設定できます。 後で更新することはできません。 その他の可視性の値は、グループの作成後に更新できます。 Microsoft Graph でのグループの作成時に可視性の値が指定されていない場合、セキュリティ グループは既定でプライベートとして作成され、Microsoft 365 グループはパブリックになります。 ロールに割り当て可能なグループは常にプライベートです。 詳細については、グループの表示オプションに関するページを参照してください。 Null 許容。 | string |
writebackConfiguration | グループ オブジェクトのプロパティをオンプレミスの Active Directoryに書き戻すグループを構成するかどうかを指定します。 これらのプロパティは、Microsoft Entra Connect 同期クライアントでグループ ライトバックが構成されている場合に使用されます。 | MicrosoftGraphGroupWritebackConfiguration |
MicrosoftGraphOnPremisesProvisioningError
名前 | Description | Value |
---|---|---|
category | プロビジョニング エラーのカテゴリ。 注: 現時点では、使用可能な値は 1 つだけです。 指定できる値: PropertyConflict - プロパティ値が一意ではないことを示します。 他のオブジェクトには、プロパティに同じ値が含まれています。 | string |
occurredDateTime | エラーが発生した日時。 | string |
propertyCausingError | エラーの原因となったディレクトリ プロパティの名前。 現在使用可能な値: UserPrincipalName または ProxyAddress | string |
値 | エラーの原因となっているプロパティの値。 | string |
MicrosoftGraphServiceProvisioningError
名前 | Description | Value |
---|---|---|
createdDateTime | エラーが発生した日時。 | string |
isResolved | エラーが発生したかどうかを示します。 | [bool] |
serviceInstance | サービス エラー情報を公開した修飾されたサービス インスタンス (たとえば、"SharePoint/Dublin")。 | string |
MicrosoftGraphGroupWritebackConfiguration
名前 | Description | Value |
---|---|---|
IsEnabled | クラウド グループのオンプレミス Active Directory への書き戻しが有効かどうかを示します。 既定値は Microsoft 365 グループの場合は true、セキュリティ グループの場合は false です。 | [bool] |
onPremisesGroupType | クラウド オブジェクトが書き戻されるターゲットのオンプレミス グループの種類を示します。 Null 許容。 指定できる値は、universalDistributionGroup、universalSecurityGroup、universalMailEnabledSecurityGroup です。クラウド グループが統合 (Microsoft 365) グループの場合、このプロパティには、universalDistributionGroup、universalSecurityGroup、universalMailEnabledSecurityGroup のいずれかを指定できます。 Microsoft Entra セキュリティ グループは、universalSecurityGroup として書き戻すことができます。 isEnabled または NewUnifiedGroupWritebackDefault グループ設定が true の場合、このプロパティは明示的に構成されていません。Microsoft 365 グループは、defaultSecurity グループによって universalDistributionGroup として書き戻されます。既定では universalSecurityGroup として書き戻されます | string |