SharePoint Online テナントのプロパティ

  • [アーティクル]

テナント プロパティを使用すると、テナント管理者は、SharePoint REST API を使用して読み取ることができるプロパティをアプリ カタログに追加できます。

テナント プロパティを操作するためのオプション

テナント管理者は、次のいずれかのオプションを使用してテナント プロパティを管理します:

SharePoint REST API

詳細情報はこちら: SharePoint REST API

Microsoft SharePoint Online 管理シェル

テナントのプロパティは、Microsoft SharePoint Online 管理シェルを使用して、テナント管理者によって管理されます。これは Office 365 で SharePoint Online サブスクリプションを管理する PowerShell モジュールです。

Microsoft SharePoint Online 管理シェル モジュールでコマンドレットを使用する前に、まず、Connect-SPOService コマンドレットを使用して SharePoint Online に接続する必要があります。 すべてのテナント プロパティは、*-SPOStorageEntity コマンドレットを使用して管理されます。

詳細はこちら: SharePoint Online 管理シェル

PnP PowerShell

PnP PowerShell の利点は、これらのプロパティを設定するのにテナントの管理者権限を必要としないことです。 アプリ カタログ サイトの所有者グループのメンバーなら、誰でもこの操作を実行できます。 これは、テナント アプリ カタログ サイトとサイト コレクション アプリ カタログに適用されます。

PnP PowerShell モジュールのいずれかのコマンドレットを使用する前に、まず Connect-PnPOnline コマンドレットを使用して SharePoint Online に接続する必要があります。 すべてのテナント プロパティは、*-PnPStorageEntity コマンドレットを使用して管理されます。

詳細情報はこちら: PnP PowerShell

重要

Connect-PnPOnline コマンドレットを使用して、任意のサイトに接続できます。 -Scope パラメーターを省略するか、Tenant (既定値) に設定すると、接続先のサイトに関係なく、すべてのコマンドレットがテナント アプリ カタログに適用されます。 -Scope パラメーターを Site に設定すると、すべてのコマンドレットが接続先のサイトのサイト コレクション アプリ カタログに適用されます。

注:

PnP PowerShell はオープン ソース ソリューションであり、アクティブなコミュニティでサポートが提供されています。 Microsoft からのオープン ソース ツールのサポート SLA はありません。

Microsoft 365 用の CLI

Microsoft 365 用の CLI を使用して、テナントのプロパティを管理できます。 Microsoft 365 用の CLI は、Windows、MacOS、Linux などのあらゆるプラットフォームで使用できるクロスプラットフォーム コマンド ライン インターフェイスです。

Microsoft 365 用の CLI でコマンドを使用する前に、まず m365 login コマンドを使用して、Microsoft 365 テナントに接続する必要があります。 すべての SharePoint Online テナント プロパティは、 spo storageentity コマンドを使用して管理されます。

詳細情報はこちら: Microsoft 365 用の CLI

重要

テナントのプロパティは、そのテナントに関連付けられているアプリ カタログ サイトに格納されます。 プロパティを設定または削除するには、アプリ カタログ サイトの絶対 URL を指定する必要があります。 アプリ カタログと異なるサイトの URL を指定すると、アクセス拒否のエラーが発生します。

注:

CLI for Microsoft 365 はオープン ソース ソリューションであり、アクティブなコミュニティでサポートが提供されています。 Microsoft からのオープン ソース ツールのサポート SLA はありません。

テナント プロパティの一覧表示

次のオプションは、SharePoint Online からテナント プロパティを一覧表示する方法を示しています。

要求

GET https://tenant.sharepoint.com/sites/site/_api/web/AllProperties?$select=storageentitiesindex

応答

HTTP/1.1 200 OK
Content-Type: application/json
{
  "key": {
    "Comment":"Tenant property comment.",
    "Description":"Tenant property description",
    "Value":"Tenant property key value"
  }
}

テナント プロパティの取得/読み取り

次のオプションは、SharePoint Online からテナント プロパティを取得する方法を示しています。

要求

GET https://tenant.sharepoint.com/sites/site/_api/web/GetStorageEntity('key')

応答

HTTP/1.1 200 OK
Content-Type: application/json
{
  "Comment":"Tenant property comment.",
  "Description":"Tenant property description",
  "Value":"Tenant property key value"
}

テナント プロパティの設定/書き込み

次のオプションは、SharePoint Online からテナント プロパティを書き込む方法を示しています。

サポートされていない

テナント プロパティの削除

次のオプションは、SharePoint Online からテナント プロパティを削除する方法を示しています。

サポートされていない

カスタム スクリプトとサイト コレクションのアプリ カタログ

カスタム スクリプトが有効になっているサイトのサイト コレクションのアプリ カタログにしかテナント プロパティを設定できません。 "スクリプトのないサイト" にテナント プロパティを設定しようとすると、次のエラーが表示されます。

Access denied. You do not have permission to perform this action or access this resource.

カスタム スクリプトの詳細については、次を参照してください。「カスタム スクリプトの許可または禁止」。

上記のエラー メッセージは、サイトの所有者またはサイト コレクション管理者でない場合にも表示されます。

関連項目