名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
ディレクトリに登録されているデバイスを表します。 デバイスは、Device Registration Service を使用するか、Intune によってクラウドで作成されます。 これは、多要素認証の条件付きアクセス ポリシーで使用されます。 該当するデバイスの範囲は、デスクトップやノート PC から携帯電話やタブレットに及びます。 directoryObject から継承します。
このリソースは、ここに記載されているもの以外の追加のプロパティを許可するオープン型です。
このリソースは以下をサポートしています。
- 拡張機能として、カスタム プロパティに独自のデータを追加します。
- デルタ関数を提供することにより、デルタ クエリを使用して、増分の追加、削除、更新を追跡します。
-
$select、$filter、$search、$topなどの OData クエリ機能。 特定の使用は、 高度なクエリ機能でのみサポートされます。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| List | device コレクション | ディレクトリに登録されたデバイスの一覧を取得します。 |
| Create | device | ディレクトリに新しいデバイスを登録します。 |
| Get | device | デバイス オブジェクトのプロパティと関係を読み取ります。 |
| Update | device | デバイス オブジェクトのプロパティを更新します。 |
| Delete | なし | デバイス オブジェクトを削除します。 |
| Get delta | device コレクション | デバイスの増分変更を取得する。 |
| 所属を一覧表示する | directoryObject コレクション | デバイスが直接のメンバーであるグループと管理単位を一覧表示します。 |
| 推移的な所属を一覧表示する | directoryObject コレクション | デバイスがメンバーになっているグループと管理単位を一覧表示します。 この操作は推移的です。 |
| 登録済み所有者を一覧表示する | directoryObject コレクション | registeredOwners ナビゲーション プロパティから、デバイスの登録済み所有者であるユーザーを取得します。 |
| 登録済み所有者を追加する | directoryObject コレクション | デバイスの登録済み所有者を追加します。 |
| 登録済み所有者を削除する | directoryObject コレクション | 登録された所有者をデバイスから削除します。 |
| 登録済みユーザーを一覧表示する | directoryObject コレクション | registeredUsers ナビゲーション プロパティから、デバイスの登録済みユーザーを取得します。 |
| 登録済みユーザーを追加する | directoryObject コレクション | デバイスの登録済みユーザーを追加します。 |
| 登録済みユーザーを削除する | directoryObject コレクション | デバイスから登録済みユーザーを削除します。 |
| 使用権限の一覧表示 | usageRight コレクション | デバイスに付与された使用権のコレクションを取得します。 |
| メンバー グループをチェックする | String collection | グループの一覧内のメンバーシップを確認します。 チェックは推移的です。 |
| メンバー グループを取得する | String collection | デバイスがメンバーであるすべてのグループを返します。 チェックは推移的です。 |
| メンバー オブジェクトを確認する | String collection | グループ、ディレクトリ ロール、または管理単位オブジェクトの一覧のメンバーシップを確認します。 |
| メンバー オブジェクトを取得する | String コレクション | デバイスがメンバーであるすべてのグループ、管理単位、およびディレクトリ ロールを返します。 チェックは推移的です。 |
| Open extensions | ||
| Create open extension | openTypeExtension | オープン拡張機能を作成し、新規または既存のリソースにカスタム プロパティを追加します。 |
| Get open extension | openTypeExtension コレクション | 拡張機能の名前で識別されるオープン拡張機能を取得します。 |
メモ: スキーマ拡張では、定義を作成し、それを使用してカスタム型のデータをリソースに追加できます。 詳細については、「 スキーマ拡張値の追加」を参照してください。
プロパティ
重要
$filter および $search クエリ パラメーターの具体的な使用方法は、ConsistencyLevel ヘッダーの設定を eventual と $count に使用する場合にのみサポートされます。 詳細については、「ディレクトリ オブジェクトの詳細クエリ機能」を参照してください。
| プロパティ | 型 | 説明 |
|---|---|---|
| accountEnabled | Boolean | アカウントが有効な場合は true であり、それ以外の場合は false です。 既定値は true です。 $filter (eq、ne、not、in) をサポートします。 このプロパティを設定できるのは、少なくともクラウド デバイス管理者ロールを持つ呼び出し元のみです。 |
| alternativeNames | String コレクション | デバイスの代替名の一覧。 |
| alternativeSecurityIds | alternativeSecurityId コレクション | 内部使用のみ。 null 許容ではありません。
$filter (eq、not、ge、le) をサポートします。 |
| approximateLastSignInDateTime | DateTimeOffset | タイムスタンプの種類は、ISO 8601 形式を使用して日付と時刻情報を表し、常に UTC 時刻になります。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 読み取り専用です。
$filter (null値で eq、ne、not、ge、le、eq) と$orderbyをサポートします。 |
| コンプライアンスExpirationDateTime | DateTimeOffset | デバイスが準拠していないと見なされなくなったときのタイムスタンプ。 タイムスタンプの種類は、ISO 8601 形式を使用して日付と時刻情報を表し、常に UTC 時刻になります。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 読み取り専用です。 |
| deviceCategory | 文字列 | デバイスをグループに自動的に追加し、デバイスの管理を簡素化するために Intune によって設定されたユーザー定義プロパティ。 |
| deviceId | 文字列 | 登録時に Azure の Device Registration Service により設定された一意の識別子。 この ID は、デバイス オブジェクトを参照するために使用できる代替キーです。
$filter (eq、ne、not、startsWith) もサポートしています。 |
| deviceMetadata | String | 内部使用のみ。
null に設定します。 |
| deviceOwnership | 文字列 | デバイスの所有権。 Intune によって、このプロパティが設定されます。 使用可能な値: unknown、company、personal。 |
| deviceVersion | Int32 | 内部使用のみ。 |
| displayName | String | デバイスの表示名。 最大文字数は 256 文字です。 必須です。
$filter (eq、ne、not、ge、le、in、startsWith、および eq の null値)、$search、および $orderby をサポートします。 |
| domainName | 文字列 | Microsoft Entra ハイブリッドに参加しているデバイスのオンプレミス ドメイン名。 Intune によって、このプロパティが設定されます。 |
| enrollmentProfileName | 文字列 | デバイスに適用された登録プロファイル。 (Apple Device Enrollment Profile、Device enrollment - Corporate device identifiers、または Windows Autopilot profile name など)。 Intune によって、このプロパティが設定されます。 |
| enrollmentType | String | デバイスの登録の種類。 Intune によって、このプロパティが設定されます。 有効な値は、 unknown、 userEnrollment、 deviceEnrollmentManager、 appleBulkWithUser、 appleBulkWithoutUser、 windowsAzureADJoin、 windowsBulkUserless、 windowsAutoEnrollment、 windowsBulkAzureDomainJoin、 windowsCoManagement、 windowsAzureADJoinUsingDeviceAuth、appleUserEnrollment、 appleUserEnrollmentWithServiceAccount です。 注: このプロパティは、リストされている値以外の値を返す場合があります。 |
| extensionAttributes | onPremisesExtensionAttributes | デバイスの拡張属性 1 から 15 が含まれます。 個々の拡張機能属性は選択できません。 これらのプロパティはクラウドでマスターされ、Microsoft Entra ID でのデバイス オブジェクトの作成または更新中に設定できます。 $filter (eq、not、startsWith、および eq の null 値) をサポートします。 |
| hostnames | String collection | デバイスのホスト名の一覧。 |
| id | String | デバイスの一意識別子。
directoryObject から継承されます。 キー、null 許容型ではありません。 読み取り専用です。
$filter (eq、ne、not、in) をサポートします。 |
| isCompliant | ブール型 |
trueデバイスがモバイル デバイス管理 (MDM) ポリシーに準拠している場合。それ以外の場合はfalse。 読み取り専用です。 これは、任意のデバイスの OS の種類の Intune、または Windows OS デバイス用の承認された MDM アプリによってのみ更新できます。
$filter (eq、ne、not) をサポートします。 |
| isManaged | ブール型 |
trueデバイスがモバイル デバイス管理 (MDM) アプリによって管理されている場合は、それ以外の場合はfalse。 これは、任意のデバイスの OS の種類の Intune、または Windows OS デバイス用の承認された MDM アプリによってのみ更新できます。
$filter (eq、ne、not) をサポートします。 |
| isManagementRestricted | ブール型 | デバイスが制限された管理単位のメンバーであるかどうかを示します。 設定されていない場合、既定値は null で、既定の動作は false です。 読み取り専用です。 制限された管理単位のメンバーであるデバイスを管理するには、管理者または呼び出し元アプリに、制限された管理管理単位の範囲で Microsoft Entra ロールを割り当てる必要があります。 |
| isRooted | ブール型 |
true デバイスがルート化されているか、ジェイル ブレイクされている場合。 このプロパティは Intune によってのみ更新できます。 |
| kind | 文字列 | デバイスのフォーム ファクター。 ユーザーが Project Rome の一部として Microsoft アカウントを使用してサインインした場合にのみ返されます。 |
| managementType | 文字列 | デバイスの管理チャネル。 Intune によって、このプロパティが設定されます。 有効な値は、 eas、 mdm、 easMdm、 intuneClient、 easIntuneClient、 configurationManagerClient、 configurationManagerClientMdm、 configurationManagerClientMdmEas、 unknown、 jamf、 googleCloudDevicePolicyController です。 |
| manufacturer | 文字列 | デバイスの製造元。 読み取り専用です。 |
| mdmAppId | 文字列 | デバイスを MDM に登録するために使用されるアプリケーション識別子。 読み取り専用です。
$filter (eq、ne、not、startsWith) をサポートします。 |
| model | 文字列 | デバイスのモデル。 読み取り専用です。 |
| name | String | デバイスのフレンドリ名。 ユーザーが Project Rome の一部として Microsoft アカウントを使用してサインインした場合にのみ返されます。 |
| onPremisesLastSyncDateTime | DateTimeOffset | オブジェクトが最後にオンプレミス ディレクトリと同期された時刻。 Timestamp 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 たとえば、2014 年 1 月 1 日の午前 0 時 UTC は読み取り専用 2014-01-01T00:00:00Z です。
$filter (eq、ne、not、ge、le、in) をサポートします。 |
| onPremisesSecurityIdentifier | String | オンプレミスからクラウドに同期されたユーザーのオンプレミス セキュリティ識別子 (SID)。 読み取り専用です。 取得に $select が必要です。
$filter (eq)をサポートしています。 |
| onPremisesSyncEnabled | Boolean | このオブジェクトがオンプレミスのディレクトリから同期される場合は true、このオブジェクトが最初にオンプレミスのディレクトリから同期されていて、今後は同期しない場合は false、このオブジェクトがオンプレミスのディレクトリから 1 度も同期されたことがない場合は null (既定値)。 読み取り専用です。
$filter (eq、ne、not、in、および eq の null 値) をサポートします。 |
| operatingSystem | String | デバイス上のオペレーティング システムの種類。 必須です。
$filter (null値で eq、ne、not、ge、le、startsWith、eq) をサポートします。 |
| operatingSystemVersion | String | デバイスのオペレーティング システムのバージョン。 必須です。
$filter (null値で eq、ne、not、ge、le、startsWith、eq) をサポートします。 |
| physicalIds | String collection | 内部使用のみ。 null 許容ではありません。
$filter (eq、not、ge、le、startsWith、/$count eq 0、/$count ne 0 をサポートしています。 |
| platform | 文字列 | デバイスのプラットフォーム。 ユーザーが Project Rome の一部として Microsoft アカウントを使用してサインインした場合にのみ返されます。 |
| profileType | 文字列 | デバイスのプロファイルの種類。 使用可能な値: RegisteredDevice (既定値)、 SecureVM、 Printer、 Shared、 IoT。 |
| registrationDateTime | DateTimeOffset | デバイスが登録された日時。 タイムスタンプの種類は、ISO 8601 形式を使用して日付と時刻情報を表し、常に UTC 時刻になります。 たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、2014-01-01T00:00:00Z です。 読み取り専用です。 |
| status | String | デバイスは online または offlineです。 ユーザーが Project Rome の一部として Microsoft アカウントを使用してサインインした場合にのみ返されます。 |
| systemLabels | String collection | システムによってデバイスに適用されているラベルの一覧。
$filter (/$count eq 0、/$count ne 0) をサポートします。 |
| trustType | String | 参加済みデバイスの信頼の種類。 読み取り専用です。 使用可能な値: Workplace (個人用デバイスを持ち込むことを示します)、AzureAd (クラウドのみに参加しているデバイス)、ServerAd (Microsoft Entra ID に参加しているオンプレミス ドメインに参加しているデバイス)。 詳細については、「Microsoft Entra ID でのデバイス管理の概要」を参照してください。
$filter (eq、ne、not、in) をサポートします。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| コマンド | コマンド コレクション | このデバイスに送信されたコマンドのセット。 |
| deviceTemplate | deviceTemplate コレクション | このデバイスをインスタンス化するために使用されるデバイス テンプレート。 Null 許容型。 読み取り専用です。 |
| extensions | extension コレクション | デバイスに定義されているオープン拡張機能のコレクション。 読み取り専用です。 Null 許容型。 |
| memberOf | directoryObject コレクション | このデバイスがメンバーになっているグループと管理単位。 読み取り専用です。 Null 許容型。
$expand をサポートします。 |
| registeredOwners | directoryObject コレクション | デバイスがクラウドに参加済みか、または個人用デバイスが登録済みのユーザー。 登録済み所有者は、登録時に設定されます。 読み取り専用です。 Null 許容型。
$expand をサポートします。 |
| registeredUsers | directoryObject コレクション | デバイスの登録済みユーザーのコレクション。 クラウドに参加済みのデバイスと登録済みの個人用デバイスの場合、登録済みのユーザーは、登録時に登録済み所有者と同じ値に設定されます。 読み取り専用です。 Null 許容型。
$expand をサポートします。 |
| transitiveMemberOf | directoryObject コレクション | このデバイスがメンバーになっているグループと管理単位。 この操作は推移的です。
$expand をサポートします。 |
| usageRights | usageRight コレクション | デバイスに付与されている使用権限を表します。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"accountEnabled": "Boolean",
"alternativeNames": ["String"],
"approximateLastSignInDateTime": "String (timestamp)",
"complianceExpirationDateTime": "String (timestamp)",
"deviceCategory": "String",
"deviceId": "String",
"deviceMetadata": "String",
"deviceOwnership": "String",
"deviceVersion": "Int32",
"displayName": "String",
"domainName": "String",
"enrollmentProfileName": "String",
"enrollmentType": "String",
"extensionAttributes": {"@odata.type": "microsoft.graph.onPremisesExtensionAttributes"},
"hostnames" : ["String"],
"id": "String (identifier)",
"isCompliant": "Boolean",
"isManaged": "Boolean",
"isManagementRestricted": "Boolean",
"isRooted": "Boolean",
"kind": "String",
"managementType": "String",
"manufacturer": "String",
"mdmAppId": "String",
"model": "String",
"name": "String",
"onPremisesLastSyncDateTime": "String (timestamp)",
"onPremisesSecurityIdentifier": "String",
"onPremisesSyncEnabled": "Boolean",
"operatingSystem": "String",
"operatingSystemVersion": "String",
"physicalIds": ["String"],
"platform": "String",
"profileType": "String",
"registrationDateTime": "String (timestamp)",
"status": "String",
"systemLabels": ["String"],
"trustType": "String"
}