OfficeSuiteApp を作成するCreate officeSuiteApp

重要: ベータ版の Microsoft Graph Api は変更される可能性があります。運用環境での使用はサポートされていません。Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.

注: Microsoft Graph API for Intune では、テナントに対してアクティブな intune ライセンスが必要です。Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

新しいofficeSuiteAppオブジェクトを作成します。Create a new officeSuiteApp object.

前提条件Prerequisites

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の大きいものから小さいものへ)Permissions (from most to least privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) DeviceManagementApps.ReadWrite.AllDeviceManagementApps.ReadWrite.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication DeviceManagementApps.ReadWrite.AllDeviceManagementApps.ReadWrite.All

HTTP 要求HTTP Request

POST /deviceAppManagement/mobileApps

要求ヘッダーRequest headers

ヘッダーHeader Value
AuthorizationAuthorization ベアラー <トークン> が必要です。Bearer <token> Required.
承諾Accept application/jsonapplication/json

要求本文Request body

要求本文で、officeSuiteApp オブジェクトの JSON 表記を指定します。In the request body, supply a JSON representation for the officeSuiteApp object.

次の表に、officeSuiteApp の作成時に必要なプロパティを示します。The following table shows the properties that are required when you create the officeSuiteApp.

プロパティProperty Type 説明Description
idid 文字列String エンティティのキー。Key of the entity. mobileApp から継承しますInherited from mobileApp
displayNamedisplayName 文字列String 管理者が提供またはインポートしたアプリのタイトル。The admin provided or imported title of the app. mobileApp から継承しますInherited from mobileApp
説明description StringString アプリの説明。The description of the app. mobileApp から継承しますInherited from mobileApp
publisherpublisher StringString アプリの発行元。The publisher of the app. mobileApp から継承しますInherited from mobileApp
largeIconlargeIcon mimeContentmimeContent アプリの詳細に表示され、アイコンのアップロードに使用される大きいアイコン。The large icon, to be displayed in the app details and used for upload of the icon. mobileApp から継承しますInherited from mobileApp
createdDateTimecreatedDateTime DateTimeOffsetDateTimeOffset アプリが作成された日時。The date and time the app was created. mobileApp から継承しますInherited from mobileApp
lastModifiedDateTimelastModifiedDateTime DateTimeOffsetDateTimeOffset アプリが最後に変更された日時。The date and time the app was last modified. mobileApp から継承しますInherited from mobileApp
isFeaturedisFeatured BooleanBoolean アプリが管理者のおすすめとしてマークされたかどうかを示す値。mobileApp から継承しますThe value indicating whether the app is marked as featured by the admin. Inherited from mobileApp
privacyInformationUrlprivacyInformationUrl StringString プライバシーに関する声明の URL。The privacy statement Url. mobileApp から継承しますInherited from mobileApp
informationUrlinformationUrl StringString 詳細情報の URL。The more information Url. mobileApp から継承しますInherited from mobileApp
ownerowner StringString アプリの所有者。The owner of the app. mobileApp から継承しますInherited from mobileApp
developerdeveloper StringString アプリの開発者。The developer of the app. mobileApp から継承しますInherited from mobileApp
notesnotes StringString アプリ用のメモ。Notes for the app. mobileApp から継承しますInherited from mobileApp
uploadStateuploadState Int32Int32 アップロード状態。The upload state. mobileApp から継承しますInherited from mobileApp
publishingStatepublishingState mobileAppPublishingStatemobileAppPublishingState アプリの発行の状態。The publishing state for the app. アプリが発行されていない限り、アプリを割り当てることができません。The app cannot be assigned unless the app is published. MobileAppから継承されます。Inherited from mobileApp. 可能な値は notPublishedprocessingpublished です。Possible values are: notPublished, processing, published.
isAssignedisAssigned BooleanBoolean アプリが少なくとも1つのグループに割り当てられているかどうかを示す値。The value indicating whether the app is assigned to at least one group. mobileApp から継承しますInherited from mobileApp
roleScopeTagIdsroleScopeTagIds String コレクションString collection このモバイルアプリの範囲タグ id のリスト。List of scope tag ids for this mobile app. mobileApp から継承しますInherited from mobileApp
dependentAppCountdependentAppCount Int32Int32 子アプリが持つ依存関係の合計数。The total number of dependencies the child app has. mobileApp から継承しますInherited from mobileApp
autoAcceptEulaautoAcceptEula ブール値Boolean Enduser のデバイスで EULA に自動的に同意する値。The value to accept the EULA automatically on the enduser's device.
productIdsproductIds OfficeproductidコレクションofficeProductId collection Office365 スイート SKU を表す製品 Id。The Product Ids that represent the Office365 Suite SKU. 使用可能な値は、o365ProPlusRetailo365BusinessRetailvisioProRetailprojectProRetail です。Possible values are: o365ProPlusRetail, o365BusinessRetail, visioProRetail, projectProRetail.
excludedAppsexcludedApps excludedAppsexcludedApps 選択した Office365 製品 Id から除外されるアプリを表すプロパティ。The property to represent the apps which are excluded from the selected Office365 Product Id.
。 UsesharedcomputeractivationuseSharedComputerActivation ブール値Boolean Office 365 アプリスイートに対して共有コンピューターのライセンス認証が使用されていないかどうかを表すプロパティ。The property to represent that whether the shared computer activation is used not for Office365 app suite.
updateChannelupdateChannel officeUpdateChannelofficeUpdateChannel Office365 更新チャネルを表すプロパティ。The property to represent the Office365 Update Channel. 可能な値は、nonecurrentdeferredfirstReleaseCurrentfirstReleaseDeferred です。Possible values are: none, current, deferred, firstReleaseCurrent, firstReleaseDeferred.
officePlatformArchitectureofficePlatformArchitecture windowsArchitecturewindowsArchitecture Office365 アプリスイートのバージョンを表すプロパティ。The property to represent the Office365 app suite version. 使用可能な値: nonex86x64armneutralarm64Possible values are: none, x86, x64, arm, neutral, arm64.
localesToInstall String コレクションString collection Office365 のアプリをインストールするときにインストールされるロケールを表すプロパティ。The property to represent the locales which are installed when the apps from Office365 is installed. 標準の RFC 6033 を使用します。It uses standard RFC 6033. Refhttps://technet.microsoft.com/en-us/library/cc179219(v=office.16).aspxRef: https://technet.microsoft.com/en-us/library/cc179219(v=office.16).aspx
Install進捗 DisplaylevelinstallProgressDisplayLevel officeSuiteInstallProgressDisplayLevelofficeSuiteInstallProgressDisplayLevel デバイス上のインストールの進行状況のセットアップ UI の表示レベルを指定します。To specify the level of display for the Installation Progress Setup UI on the Device. 可能な値は、nonefull です。Possible values are: none, full.
shouldUninstallOlderVersionsOfOfficeshouldUninstallOlderVersionsOfOffice ブール値Boolean Office365 アプリスイートがデバイスに展開されている場合に、既存の Office MSI をアンインストールするかどうかを決定するプロパティ。The property to determine whether to uninstall existing Office MSI if an Office365 app suite is deployed to the device or not.
targetVersiontargetVersion StringString デバイスに展開されたままにする必要がある、Office365 アプリスイートの特定のターゲットバージョンを表すプロパティ。The property to represent the specific target version for the Office365 app suite that should be remained deployed on the devices.
updateVersionupdateVersion StringString Office365 アプリスイートで特定のターゲットバージョンが利用可能な更新バージョンを表すプロパティ。The property to represent the update version in which the specific target version is available for the Office365 app suite.
officeConfigurationXmlofficeConfigurationXml BinaryBinary Office ProPlus アプリに指定できる XML 構成ファイルを表すプロパティ。The property to represent the XML configuration file that can be specified for Office ProPlus Apps. 他のすべてのプロパティより優先されます。Takes precedence over all other properties. 指定した場合、XML 構成ファイルを使用してアプリが作成されます。When present, the XML configuration file will be used to create the app.

応答Response

成功した場合、このメソッド201 Createdは応答コードと、応答本文でofficeSuiteAppオブジェクトを返します。If successful, this method returns a 201 Created response code and a officeSuiteApp object in the response body.

Example

要求Request

以下は、要求の例です。Here is an example of the request.

POST https://graph.microsoft.com/beta/deviceAppManagement/mobileApps
Content-type: application/json
Content-length: 1599

{
  "@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,
  "autoAcceptEula": true,
  "productIds": [
    "o365BusinessRetail"
  ],
  "excludedApps": {
    "@odata.type": "microsoft.graph.excludedApps",
    "access": 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",
  "officePlatformArchitecture": "x86",
  "localesToInstall": [
    "Locales To Install value"
  ],
  "installProgressDisplayLevel": "full",
  "shouldUninstallOlderVersionsOfOffice": true,
  "targetVersion": "Target Version value",
  "updateVersion": "Update Version value",
  "officeConfigurationXml": "b2ZmaWNlQ29uZmlndXJhdGlvblhtbA=="
}

応答Response

以下は、応答の例です。注:簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。すべてのプロパティは実際の呼び出しから返されます。Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 1771

{
  "@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,
  "autoAcceptEula": true,
  "productIds": [
    "o365BusinessRetail"
  ],
  "excludedApps": {
    "@odata.type": "microsoft.graph.excludedApps",
    "access": 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",
  "officePlatformArchitecture": "x86",
  "localesToInstall": [
    "Locales To Install value"
  ],
  "installProgressDisplayLevel": "full",
  "shouldUninstallOlderVersionsOfOffice": true,
  "targetVersion": "Target Version value",
  "updateVersion": "Update Version value",
  "officeConfigurationXml": "b2ZmaWNlQ29uZmlndXJhdGlvblhtbA=="
}