tipo de recurso retentionLabel
Namespace: microsoft.graph.security
Representa como as organizações, para fins de conformidade e governança, podem gerenciar seus dados em um nível de item (email ou documento), incluindo se e por quanto tempo manter ou excluir o item.
As organizações podem usar rótulos de retenção para diferentes tipos de conteúdo que exigem diferentes configurações de retenção. Por exemplo, eles podem aplicar um rótulo de retenção a formulários fiscais e documentos de suporte para mantê-los pelo período exigido por lei.
As organizações podem configurar rótulos de retenção com os períodos de retenção e ações com base em fatores como a data modificada ou criada pela última vez. Eles também podem iniciar períodos de retenção diferentes especificando um evento que pode disparar a retenção quando o evento ocorre.
Para obter mais informações sobre como os rótulos de retenção funcionam, quando usá-los e como o Microsoft Purview dá suporte a rótulos de retenção para permitir que você configure as configurações de retenção e exclusão, consulte Saiba mais sobre políticas de retenção e rótulos de retenção.
Métodos
| Método | Tipo de retorno | Descrição |
|---|---|---|
| Retenção de listaLabels | coleção microsoft.graph.security.retentionLabel | Obtenha uma lista dos objetos retentionLabel e suas propriedades. |
| retenção de Create Label | microsoft.graph.security.retentionLabel | Create um novo objeto retentionLabel. |
| Obter retentionLabel | microsoft.graph.security.retentionLabel | Leia as propriedades e as relações de um objeto retentionLabel . |
| Atualizar retentionLabel | microsoft.graph.security.retentionLabel | Atualize as propriedades de um objeto retentionLabel . |
| Excluir retentionLabel | Nenhum | Excluir um objeto retentionLabel . |
| Retenção de listaEventType | coleção microsoft.graph.security.retentionEventType | Obtenha os recursos retentionEventType da propriedade de navegação exapnd eventType. |
| Adicionar retentionEventType | microsoft.graph.security.retentionEventType | Adicione eventType adicionando a propriedade odata relevante ao criar um rótulo. |
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
| actionAfterRetentionPeriod | microsoft.graph.security.actionAfterRetentionPeriod | Especifica a ação a ser executada no documento rotulado 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 como o comportamento de um documento com esse rótulo deve ser durante o período de retenção. Os valores possíveis são: doNotRetain, retain, retainAsRecord, retainAsRegulatoryRecord, unknownFutureValue. |
| createdBy | microsoft.graph.identitySet | Representa o usuário que criou a retentionLabel. |
| createdDateTime | DateTimeOffset | Representa a data e a hora em que a retençãoLabel é criada. |
| descriptionForAdmins | Cadeia de caracteres | Fornece informações de rótulo para o administrador. Opcional. |
| descriptionForUsers | Cadeia de caracteres | Fornece as informações de rótulo para o usuário. Opcional. |
| displayName | Cadeia de caracteres | Cadeia de caracteres exclusiva que define um nome de rótulo. |
| id | Cadeia de caracteres | ID exclusiva da retentionLabel. |
| isInUse | Booliano | Especifica se o rótulo está sendo usado no momento. |
| lastModifiedBy | microsoft.graph.identitySet | O usuário que modificou pela última vez a retençãoLabel. |
| lastModifiedDateTime | DateTimeOffset | A data mais recente em que a retençãoLabel foi modificada. |
| 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 rotulada ou 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 gravadora quando ele é criado. Os valores possíveis são: startLocked, , unknownFutureValuestartUnlocked. |
| labelToBeApplied | Cadeia de caracteres | Especifica o rótulo de substituição a ser aplicado automaticamente após o término do período de retenção do rótulo atual. |
Relações
| Relação | Tipo | Descrição |
|---|---|---|
| dispositionReviewStages | coleção microsoft.graph.security.dispositionReviewStage | Quando a ação no final da retenção é escolhida como 'dispositionReview', dispositionReviewStages especifica um conjunto sequencial de estágios com pelo menos um revisor em cada estágio. |
| retentionEventType | microsoft.graph.security.retentionEventType | Representa o tipo associado a um evento de retenção. |
| Descritores | microsoft.graph.security.filePlanDescriptor | Representa valores fora da caixa que fornecem mais opções para melhorar a capacidade de gerenciamento e a organização do conteúdo que você precisa rotular. |
Representação JSON
Aqui está uma representação JSON do 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"
}