Propriétés du client SharePoint Online

  • Article

Les propriétés du client permettent aux administrateurs du client d’ajouter dans le catalogue d’applications des propriétés qui peuvent être lues à l’aide de l’API REST SharePoint.

Options d’utilisation des propriétés du client

Les propriétés du client sont gérées par les administrateurs client à l’aide de l’une des options suivantes :

API REST SharePoint

En savoir plus ici : l’API REST SharePoint

Microsoft SharePoint Online Management Shell

Les propriétés du client sont gérées par les administrateurs du client à l’aide de Microsoft SharePoint Online Management Shell, un module PowerShell de Microsoft utilisé pour gère votre abonnement SharePoint Online dans Office 365.

Avant d’utiliser l’une des applets de commande dans le module Microsoft SharePoint Online Management Shell, vous devez d’abord vous connecter à SharePoint Online à l’aide de l’applet de commande Connect-SPOService. Toutes les propriétés du client sont gérées à l’aide des applets de commande *-SPOStorageEntity.

En savoir plus ici : Microsoft SharePoint Online Management Shell

PnP PowerShell

L’avantage de PowerShell PnP est qu’il ne nécessite pas de privilèges d’administrateur de locataire pour la définition de ces propriétés. Les membres du groupe propriétaires d’un site de catalogue d’applications peuvent effectuer cette opération. Cela s’applique au site de catalogue d’applications locataire, ainsi qu'aux catalogues d’applications de collection de sites.

Avant d’utiliser l’une des applets de commande dans le module PowerShell PnP, vous devez d’abord vous connecter à SharePoint Online à l’aide de l’applet de commande Connect-PnPOnline. Toutes les propriétés du client sont gérées à l’aide des applets de commande *-PnPStorageEntity.

En savoir plus ici : PowerShell PnP

Importante

Vous pouvez vous connecter à n’importe quel site à l’aide de l’applet de commande Connect-PnPOnline. Lorsque vous omettez le paramètre -Scope ou le configurez sur Tenant (valeur par défaut), toutes les applets de commande s’appliquent au catalogue d’applications du locataire, quel que soit le site auquel vous vous êtes connecté. Si vous configurez le paramètre -Scope sur Site toutes les applets de commande s’appliquent au catalogue d’applications de la collection de sites du site auquel vous vous êtes connecté.

Remarque

PnP PowerShell est une solution open source pour laquelle un support est assuré par la communauté active. Il n’existe pas de contrat SLA Microsoft pour le support technique relatif à cet outil open source.

Interface CLI pour Microsoft 365

L’interface CLI pour Microsoft 365 peut être utilisée pour gérer les propriétés du client. L’interface CLI pour Microsoft 365 est une interface de ligne de commande multiplateforme qui peut être utilisée sur n’importe quelle plateforme, y compris Windows, macOS et Linux.

Avant d’utiliser l’une des commandes de l’interface CLI pour Microsoft 365, vous devez d’abord vous connecter à votre client Microsoft 365 à l’aide de la commande m365 login. Toutes les propriétés du client SharePoint Online sont gérées à l’aide des commandes spo storageentity .

En savoir plus ici : CLI pour Microsoft 365

Importante

Les propriétés client sont stockées dans le site de catalogue d’application associé à ce client. Pour définir ou supprimer une propriété, vous devez spécifier l’URL absolue du site de catalogue d’applications. Si vous spécifiez une URL d’un site différente de celle figurant dans le catalogue d’applications, vous obtenez une erreur et l’accès vous est refusé.

Remarque

L’interface CLI pour Microsoft 365 est une solution open source pour laquelle un support est assuré par la communauté active. Il n’existe pas de contrat SLA Microsoft pour le support technique relatif à cet outil open source.

Répertorier les propriétés du client

Les options suivantes montrent comment répertorier les propriétés du client à partir de SharePoint Online.

Demande

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

Réponse

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

Obtenir/lire les propriétés du locataire

Les options suivantes montrent comment obtenir les propriétés du client à partir de SharePoint Online.

Demande

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

Réponse

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

Définir/écrire les propriétés du client

Les options suivantes montrent comment écrire les propriétés du client à partir de SharePoint Online.

Non pris en charge

Supprimer les propriétés du client

Les options suivantes montrent comment supprimer les propriétés du client à partir de SharePoint Online.

Non pris en charge

Catalogues d’applications de scripts personnalisés et de collection de sites

Il est uniquement possible de créer des propriétés de locataire sur des catalogues d’applications de collection de sites dans des sites pour lesquels des scripts personnalisés sont activés. Lorsque vous tentez de créer une propriété de locataire dans un « site non-script », l’erreur suivante s’affiche :

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

Vous pouvez en savoir plus sur les scripts personnalisés ici : Activer ou désactiver les scripts personnalisés.

Le message d’erreur ci-dessus s’affiche également si vous n’êtes pas le propriétaire ou l’administrateur de la collection de sites du site.

Voir aussi