officeSuiteApp を更新する

[アーティクル]
03/21/2024

名前空間: microsoft.graph

大事な： /beta バージョンの Microsoft Graph API は変更される可能性があります。運用環境での使用はサポートされていません。

注:Intune 用 Microsoft Graph API には、テナントの有効な Intune ライセンスが必要です。

officeSuiteApp オブジェクトのプロパティを更新します。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	✅	✅

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	DeviceManagementConfiguration.ReadWrite.All、DeviceManagementApps.ReadWrite.All
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	DeviceManagementConfiguration.ReadWrite.All、DeviceManagementApps.ReadWrite.All

HTTP 要求

PATCH /deviceAppManagement/mobileApps/{mobileAppId}

要求ヘッダー

ヘッダー	値
Authorization	ベアラー {token}。必須です。認証と承認の詳細については、こちらをご覧ください。
承諾	application/json

要求本文

要求本文で、 officeSuiteApp オブジェクトの JSON 表現を指定します。

次の表は、 officeSuiteApp を作成するときに必要なプロパティを示しています。

プロパティ	型	説明
id	String	エンティティのキー。このプロパティは読み取り専用です。 mobileApp から継承します
displayName	String	管理者が提供またはインポートしたアプリのタイトル。 mobileApp から継承します
description	String	アプリの説明。 mobileApp から継承します
publisher	String	アプリの発行元。 mobileApp から継承します
largeIcon	mimeContent	アプリの詳細に表示され、アイコンのアップロードに使用される大きいアイコン。 mobileApp から継承します
createdDateTime	DateTimeOffset	アプリが作成された日時。このプロパティは読み取り専用です。 mobileApp から継承します
lastModifiedDateTime	DateTimeOffset	アプリが最後に変更された日時。このプロパティは読み取り専用です。 mobileApp から継承します
isFeatured	Boolean	アプリが管理者のおすすめとしてマークされたかどうかを示す値。mobileApp から継承します
privacyInformationUrl	String	プライバシーに関する声明の URL。 mobileApp から継承します
informationUrl	String	詳細情報の URL。 mobileApp から継承します
owner	String	アプリの所有者。 mobileApp から継承します
developer	String	アプリの開発者。 mobileApp から継承します
notes	String	アプリ用のメモ。 mobileApp から継承します
uploadState	Int32	アップロードの状態。使用可能な値は、0 から `Not Ready`、1 から `Ready`2 - `Processing`です。このプロパティは読み取り専用です。 mobileApp から継承します
publishingState	mobileAppPublishingState	アプリの発行の状態。アプリが発行されていない限り、アプリを割り当てることができません。このプロパティは読み取り専用です。 mobileApp から継承されます。可能な値は `notPublished`、`processing`、`published` です。
isAssigned	ブール型	アプリが少なくとも 1 つのグループに割り当てられているかどうかを示す値。このプロパティは読み取り専用です。 mobileApp から継承します
roleScopeTagIds	String collection	このモバイルアプリのスコープタグ ID の一覧。 mobileApp から継承します
dependentAppCount	Int32	子アプリに含まれる依存関係の合計数。このプロパティは読み取り専用です。 mobileApp から継承します
supersedingAppCount	Int32	このアプリが直接的または間接的に置き換わるアプリの合計数。このプロパティは読み取り専用です。 mobileApp から継承します
置き換えAppCount	Int32	このアプリが直接または間接的に置き換えられるアプリの合計数。このプロパティは読み取り専用です。 mobileApp から継承します
autoAcceptEula	ブール型	エンドユーザーのデバイスで EULA を自動的に受け入れる値。
productIds	officeProductId コレクション	Office365 Suite SKU を表す製品 ID。使用可能な値: `o365ProPlusRetail`、`o365BusinessRetail`、`visioProRetail`、`projectProRetail`。
excludedApps	excludedApps	選択した Office365 製品 ID から除外されるアプリを表すプロパティ。
useSharedComputerActivation	ブール型	共有コンピューターのライセンス認証が Office365 アプリスイートに対して使用されていないかどうかを表すプロパティ。
updateChannel	officeUpdateChannel	Office365 更新プログラムチャネルを表すプロパティ。使用可能な値: `none`、`current`、`deferred`、`firstReleaseCurrent`、`firstReleaseDeferred`、`monthlyEnterprise`。
officeSuiteAppDefaultFileFormat	officeSuiteDefaultFileFormatType	Office365 の既定のファイル形式の種類を表すプロパティ。使用可能な値: `notConfigured`、`officeOpenXMLFormat`、`officeOpenDocumentFormat`、`unknownFutureValue`。
officePlatformArchitecture	windowsArchitecture	Office365 アプリスイートバージョンを表すプロパティ。使用可能な値: `none`、`x86`、`x64`、`arm`、`neutral`、`arm64`。
localesToInstall	String collection	Office365 のアプリのインストール時にインストールされるロケールを表すプロパティ。標準 RFC 6033 を使用します。参照: https://technet.microsoft.com/library/cc179219(v=office.16).aspx\|
installProgressDisplayLevel	officeSuiteInstallProgressDisplayLevel	デバイスのインストール進行状況セットアップ UI の表示レベルを指定します。可能な値は、`none`、`full` です。
shouldUninstallOlderVersionsOfOffice	ブール型	Office365 アプリスイートがデバイスに展開されている場合に、既存の Office MSI をアンインストールするかどうかを決定するプロパティ。
targetVersion	String	デバイスに展開したままにする必要がある Office365 アプリスイートの特定のターゲットバージョンを表すプロパティ。
updateVersion	String	特定のターゲットバージョンが Office365 アプリスイートで使用できる更新プログラムのバージョンを表すプロパティ。
officeConfigurationXml	バイナリ	Office ProPlus Apps に指定できる XML 構成ファイルを表すプロパティ。その他のすべてのプロパティよりも優先されます。存在する場合、XML 構成ファイルを使用してアプリが作成されます。

応答

成功した場合、このメソッドは 200 OK 応答コードと更新された officeSuiteApp オブジェクトを応答本文に返します。

例

要求

以下は、要求の例です。

PATCH https://graph.microsoft.com/beta/deviceAppManagement/mobileApps/{mobileAppId}
Content-type: application/json
Content-length: 1736

{
  "@odata.type": "#microsoft.graph.officeSuiteApp",
  "displayName": "Display Name value",
  "description": "Description value",
  "publisher": "Publisher value",
  "largeIcon": {
    "@odata.type": "microsoft.graph.mimeContent",
    "type": "Type value",
    "value": "dmFsdWU="
  },
  "isFeatured": true,
  "privacyInformationUrl": "https://example.com/privacyInformationUrl/",
  "informationUrl": "https://example.com/informationUrl/",
  "owner": "Owner value",
  "developer": "Developer value",
  "notes": "Notes value",
  "uploadState": 11,
  "publishingState": "processing",
  "isAssigned": true,
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ],
  "dependentAppCount": 1,
  "supersedingAppCount": 3,
  "supersededAppCount": 2,
  "autoAcceptEula": true,
  "productIds": [
    "o365BusinessRetail"
  ],
  "excludedApps": {
    "@odata.type": "microsoft.graph.excludedApps",
    "access": true,
    "bing": true,
    "excel": true,
    "groove": true,
    "infoPath": true,
    "lync": true,
    "oneDrive": true,
    "oneNote": true,
    "outlook": true,
    "powerPoint": true,
    "publisher": true,
    "sharePointDesigner": true,
    "teams": true,
    "visio": true,
    "word": true
  },
  "useSharedComputerActivation": true,
  "updateChannel": "current",
  "officeSuiteAppDefaultFileFormat": "officeOpenXMLFormat",
  "officePlatformArchitecture": "x86",
  "localesToInstall": [
    "Locales To Install value"
  ],
  "installProgressDisplayLevel": "full",
  "shouldUninstallOlderVersionsOfOffice": true,
  "targetVersion": "Target Version value",
  "updateVersion": "Update Version value",
  "officeConfigurationXml": "b2ZmaWNlQ29uZmlndXJhdGlvblhtbA=="
}

応答

以下は、応答の例です。注: 簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。実際の呼び出しではすべてのプロパティが返されます。

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1908

{
  "@odata.type": "#microsoft.graph.officeSuiteApp",
  "id": "9b263b46-3b46-9b26-463b-269b463b269b",
  "displayName": "Display Name value",
  "description": "Description value",
  "publisher": "Publisher value",
  "largeIcon": {
    "@odata.type": "microsoft.graph.mimeContent",
    "type": "Type value",
    "value": "dmFsdWU="
  },
  "createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
  "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
  "isFeatured": true,
  "privacyInformationUrl": "https://example.com/privacyInformationUrl/",
  "informationUrl": "https://example.com/informationUrl/",
  "owner": "Owner value",
  "developer": "Developer value",
  "notes": "Notes value",
  "uploadState": 11,
  "publishingState": "processing",
  "isAssigned": true,
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ],
  "dependentAppCount": 1,
  "supersedingAppCount": 3,
  "supersededAppCount": 2,
  "autoAcceptEula": true,
  "productIds": [
    "o365BusinessRetail"
  ],
  "excludedApps": {
    "@odata.type": "microsoft.graph.excludedApps",
    "access": true,
    "bing": true,
    "excel": true,
    "groove": true,
    "infoPath": true,
    "lync": true,
    "oneDrive": true,
    "oneNote": true,
    "outlook": true,
    "powerPoint": true,
    "publisher": true,
    "sharePointDesigner": true,
    "teams": true,
    "visio": true,
    "word": true
  },
  "useSharedComputerActivation": true,
  "updateChannel": "current",
  "officeSuiteAppDefaultFileFormat": "officeOpenXMLFormat",
  "officePlatformArchitecture": "x86",
  "localesToInstall": [
    "Locales To Install value"
  ],
  "installProgressDisplayLevel": "full",
  "shouldUninstallOlderVersionsOfOffice": true,
  "targetVersion": "Target Version value",
  "updateVersion": "Update Version value",
  "officeConfigurationXml": "b2ZmaWNlQ29uZmlndXJhdGlvblhtbA=="
}