Свойства клиента SharePoint Online

  • Статья

Свойства клиента позволяют администраторам добавлять свойства в каталог приложений, которые можно прочитать с помощью REST API SharePoint.

Варианты работы со свойствами клиента

Администраторы управляют свойствами клиента с помощью одного из следующих инструментов:

REST API SharePoint

Дополнительные сведения: REST API SharePoint

Командная консоль Microsoft Office SharePoint Online

Для управления свойствами клиента администраторы используют командную консоль Microsoft Office SharePoint Online. Это модуль PowerShell от Майкрософт, используемый для управления подпиской на SharePoint Online в Office 365.

Перед использованием командлетов в модуле командной консоли Microsoft Office SharePoint Online сначала подключитесь к SharePoint Online с помощью командлета Connect-SPOService. Всеми свойствами клиента можно управлять с помощью следующих командлетов: *-SPOStorageEntity.

Дополнительные сведения: командная консоль Microsoft Office SharePoint Online

PnP PowerShell

Преимущество PnP PowerShell заключается в том, что ему не требуются права администратора клиента для установки этих свойств. Любой участник группы владельцев сайта каталога приложений может сделать это. Это относится как к сайту каталога приложений клиента, так и к каталогам приложений семейства веб-сайтов.

Перед использованием командлетов в модуле PnP PowerShell сначала подключитесь к SharePoint Online с помощью командлета Connect-PnPOnline. Всеми свойствами клиента можно управлять с помощью следующих командлетов: *-PnPStorageEntity.

Дополнительные сведения: PnP PowerShell

Важно!

Вы можете подключиться к любому сайту с помощью командлета Connect-PnPOnline. Если вы пропустите параметр -Scope или установите для него значение Tenant (является значением по умолчанию), все командлеты будут применяться к каталогу приложений клиента независимо от сайта, к которому вы подключены. Если для параметра -Scope установлено значение Site, все командлеты будут применяться к каталогу приложений семейства сайтов сайта, к которому вы подключены.

Примечание.

PnP PowerShell — это решение с открытым исходным кодом, поддержка которого предоставляется активным сообществом. Для инструментов с открытым исходным кодом не существует соглашения об уровне обслуживания в отношении поддержки корпорацией Майкрософт.

Интерфейс командной строки для Microsoft 365

Чтобы управлять свойствами клиента, можно использовать интерфейс командной строки для Microsoft 365. Интерфейс командной строки для Microsoft 365 — это кроссплатформенный интерфейс командной строки, который можно использовать на любой платформе, в том числе Windows, macOS и Linux.

Перед использованием команд в интерфейсе командной строки для Microsoft 365 сначала необходимо подключиться к клиенту Microsoft 365 с помощью команды m365 login. Всеми свойствами клиента SharePoint Online можно управлять с помощью следующих команд: spo storageentity.

Дополнительные сведения: Интерфейс командной строки для Microsoft 365

Важно!

Свойства клиента хранятся на сайте каталога приложений, связанном с этим клиентом. Чтобы задать или удалить свойство, необходимо указать абсолютный URL-адрес сайта каталога приложений. Если вы укажете URL-адрес сайта, отличный от каталога приложений, вам будет отказано в доступе.

Примечание.

CLI для Microsoft 365 — это решение с открытым исходным кодом, поддерживаемое активным сообществом. 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.

Дополнительные сведения о настраиваемых сценариях см. здесь: Разрешение и запрет настраиваемых сценариев.

Сообщение об ошибке также будет отображаться, если вы не являетесь владельцем или администратором сайта семейства сайтов.

См. также