retentionLabel resource type (tipo de recurso retentionLabel)

Espaço de nomes: microsoft.graph.security

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Representa a forma como as organizações, para fins de conformidade e governação, podem gerir os respetivos dados ao nível do item (e-mail ou documento), incluindo se e durante quanto tempo reter ou eliminar o item.

As organizações podem utilizar etiquetas de retenção para diferentes tipos de conteúdo que requerem definições de retenção diferentes. Por exemplo, podem aplicar uma etiqueta de retenção a formulários fiscais e documentos de suporte para mantê-los durante o período exigido por lei.

As organizações podem configurar etiquetas de retenção com os períodos de retenção e as ações com base em fatores como a data da última modificação ou criação. Também podem iniciar diferentes períodos de retenção ao especificar um evento que pode acionar a retenção quando o evento ocorre.

Para obter mais informações sobre como funcionam as etiquetas de retenção, quando utilizá-las e como o Microsoft Purview suporta etiquetas de retenção para lhe permitir configurar as definições de retenção e eliminação, consulte Saiba mais sobre políticas de retenção e etiquetas de retenção.

Métodos

Método	Tipo de retorno	Descrição
Retenção da listaAsbelas	coleção microsoft.graph.security.retentionLabel	Obtenha uma lista dos objetos retentionLabel e respetivas propriedades.
Criar retentionLabel	microsoft.graph.security.retentionLabel	Crie um novo objeto retentionLabel .
Obter retentionLabel	microsoft.graph.security.retentionLabel	Leia as propriedades e relações de um objeto retentionLabel .
Retenção da atualizaçãoAbela	microsoft.graph.security.retentionLabel	Atualize as propriedades de um objeto retentionLabel .
Eliminar retençãoAbela	Nenhum	Eliminar um objeto retentionLabel .
Retenção de listaSventType	microsoft.graph.security.retentionEventType collection	Obtenha os recursos retentionEventType da propriedade de navegação exapnd eventType.
Adicionar retentionEventType	microsoft.graph.security.retentionEventType	Adicione eventType ao adicionar a propriedade odata relevante ao criar uma etiqueta.

Propriedades

Propriedade	Tipo	Descrição
actionAfterRetentionPeriod	microsoft.graph.security.actionAfterRetentionPeriod	Especifica a ação a tomar no documento etiquetado após o período especificado pela propriedade retentionDuration expirar. Os valores possíveis são: none, delete, startDispositionReview, unknownFutureValue.
behaviorDuringRetentionPeriod	microsoft.graph.security.behaviorDuringRetentionPeriod	Especifica o comportamento de um documento com esta etiqueta durante o período de retenção. Os valores possíveis são: doNotRetain, retain, retainAsRecord, retainAsRegulatoryRecord, unknownFutureValue.
createdBy	microsoft.graph.identitySet	Representa o utilizador que criou a retentionLabel.
createdDateTime	DateTimeOffset	Representa a data e hora em que a retentionLabel é criada.
descriptionForAdmins	Cadeia de caracteres	Fornece informações de etiqueta para o administrador. Opcional.
descriptionForUsers	Cadeia de caracteres	Fornece as informações de etiqueta para o utilizador. Opcional.
displayName	Cadeia de caracteres	Cadeia exclusiva que define um nome de etiqueta.
id	Cadeia de caracteres	ID exclusivo da retentionLabel.
isInUse	Booliano	Especifica se a etiqueta está atualmente a ser utilizada.
lastModifiedBy	microsoft.graph.identitySet	O utilizador que modificou pela última vez a retentionLabel.
lastModifiedDateTime	DateTimeOffset	A hora da data mais recente em que retentionLabel foi modificado.
retentionDuration	microsoft.graph.security.retentionDuration	Especifica o número de dias para manter o conteúdo.
retentionTrigger	microsoft.graph.security.retentionTrigger	Especifica se a duração da retenção é calculada a partir da data de criação do conteúdo, da data etiquetada ou da data da última modificação. Os valores possíveis são: dateLabeled, dateCreated, dateModified, dateOfEvent, unknownFutureValue.
defaultRecordBehavior	microsoft.graph.security.defaultRecordBehavior	Especifica o estado bloqueado ou desbloqueado de uma etiqueta de registo quando é criada. Os valores possíveis são: startLocked, startUnlocked, unknownFutureValue.
labelToBeApplied	Cadeia de caracteres	Especifica a etiqueta de substituição a ser aplicada automaticamente após o fim do período de retenção da etiqueta atual.

Relações

Relação	Tipo	Descrição
dispositionReviewStages	microsoft.graph.security.dispositionReviewStage collection	Quando a ação no final da retenção é escolhida como "dispositionReview", dispositionReviewStages especifica um conjunto sequencial de fases com, pelo menos, um revisor em cada fase.
retentionEventType	microsoft.graph.security.retentionEventType	Representa o tipo associado a um evento de retenção.
descritores	microsoft.graph.security.filePlanDescriptor	Representa valores de configuração inicial que fornecem mais opções para melhorar a capacidade de gestão e a organização dos conteúdos que precisa de etiquetar.

Representação JSON

A representação JSON seguinte mostra o tipo de recurso.

{
  "@odata.type": "#microsoft.graph.security.retentionLabel",
  "id": "String (identifier)",
  "displayName": "String",
  "behaviorDuringRetentionPeriod": "String",
  "actionAfterRetentionPeriod": "String",
  "retentionTrigger": "String",
  "retentionDuration": {
    "@odata.type": "microsoft.graph.security.retentionDuration"
  },
  "isInUse": "Boolean",
  "descriptionForAdmins": "String",
  "descriptionForUsers": "String",
  "createdBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "createdDateTime": "String (timestamp)",
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "lastModifiedDateTime": "String (timestamp)",
  "labelToBeApplied": "String",
  "defaultRecordBehavior": "String"
}