Propriedades de locatário do SharePoint Online

  • Artigo

As propriedades de locatário permitem que os administradores de locatários adicionem propriedades ao catálogo de aplicativos que podem ser lidas usando o SharePoint.

Opções para trabalhar com propriedades de locatário

As propriedades do locatário são gerenciadas por administradores de locatários usando uma das seguintes opções:

API REST do Microsoft Office SharePoint Online

Saiba mais aqui: API REST do Microsoft Office SharePoint Online

Shell de Gerenciamento do Microsoft SharePoint Online

As propriedades de locatário são gerenciadas por administradores de locatários usando o Shell de Gerenciamento do Microsoft SharePoint Online, um módulo do PowerShell da Microsoft para gerenciar sua assinatura do SharePoint Online no Office 365.

Antes de usar qualquer um dos cmdlets no módulo Shell de Gerenciamento do Microsoft SharePoint Online, você deve primeiro se conectar ao SharePoint Online usando o cmdlet Connect-SPOService. Todas as propriedades de locatário são gerenciadas usando cmdlets *-SPOStorageEntity.

Saiba mais aqui: Shell de Gerenciamento do Microsoft SharePoint Online

PowerShell PnP

A vantagem do PnP PowerShell é que ele não exige privilégios de administrador de locatários para definir essas propriedades. Qualquer membro do grupo Proprietários de um site de catálogo de aplicativos pode fazer isso. Isso se aplica ao site do catálogo de aplicativos de locatários e aos catálogos de aplicativos do conjunto de sites.

Antes de usar qualquer um dos cmdlets no módulo PowerShell PnP, você deve primeiro se conectar ao Microsoft Office SharePoint Online usando o cmdlet Connect-PnPOnline. Todas as propriedades de locatário são gerenciadas usando cmdlets *-PnPStorageEntity.

Saiba mais aqui: PowerShell PnP

Importante

Você pode se conectar a qualquer site usando o cmdlet Connect-PnPOnline. Quando você omite o parâmetro -Scope ou o define como Tenant, que é o valor padrão. Todos os cmdlets se aplicam ao catálogo de aplicativos do locatário, independentemente do site ao qual você se conectou. Se você definir o parâmetro -Scope como Site, todos os cmdlets serão aplicados ao catálogo de aplicativos do conjunto de sites do site ao qual você se. T conectou.

Observação

O PnP PowerShell é uma solução de software livre com uma comunidade ativa de suporte. Não há nenhuma SLA para o suporte da ferramenta de software livre por parte da Microsoft.

CLI para Microsoft 365

A CLI para Microsoft 365 pode ser usada para gerenciar as propriedades do locatário. A CLI para Microsoft 365 é uma interface de linha de comando de plataforma cruzada que pode ser usada em qualquer plataforma, como Windows, MacOS e Linux.

Antes de usar qualquer um dos comandos na CLI para Microsoft 365, você deve primeiro conectar seu locatário Microsoft 365 usando o comando m365 login. Todas as propriedades de locatário do SharePoint Online são gerenciadas usando os comandos spo storageentity.

Saiba mais aqui: CLI para Microsoft 365

Importante

As propriedades do locatário são armazenadas no site de catálogo de aplicativos associado ao locatário. Para definir ou remover uma propriedade, você precisa especificar a URL absoluta do site de catálogo de aplicativos. Se você especificar a URL de um site diferente do catálogo de aplicativos, receberá um erro de acesso negado.

Observação

A CLI do Microsoft 365 é uma solução de software livre com uma comunidade ativa oferecendo suporte. Não há nenhuma SLA para o suporte da ferramenta de software livre por parte da Microsoft.

Listar propriedades do locatário

As opções a seguir demonstram como listar propriedades de locatário do SharePoint Online.

Solicitação

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

Resposta

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

Obter/ler propriedades do locatário

As opções a seguir demonstram como obter propriedades de locatário do SharePoint Online.

Solicitação

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

Resposta

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

Definir/gravar propriedades do locatário

As opções a seguir demonstram como escrever propriedades de locatário do SharePoint Online.

Sem suporte

Remover propriedades do locatário

As opções a seguir demonstram como remover propriedades de locatário do SharePoint Online.

Sem suporte

Catálogos de aplicativos de script e conjunto de sites personalizados

Só é permitido definir propriedades de locatário em catálogos de aplicativos de conjuntos de sites em sites com scripts personalizados ativados. Quando você tenta definir uma propriedade de locatário em um site "sem script", o seguinte erro será mostrado:

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

Você pode aprender mais sobre scripts personalizados aqui: Permitir ou impedir script personalizado.

A mensagem de erro acima também será mostrada se você não for o proprietário ou administrador do conjunto de sites.

Confira também