sensitivityLabel resource type (tipo de recurso sensitivityLabel)

Espaço de nomes: microsoft.graph.security

Descreve a etiqueta de proteção de informações que detalha como aplicar corretamente uma etiqueta de confidencialidade às informações.

Métodos

Propriedades

Regras de filtragem da API de etiqueta de confidencialidade

Esta secção descreve as regras de filtragem e as restrições disponíveis para aplicar a várias chamadas à API de etiquetas de confidencialidade.

Cenário 1: Devolver etiquetas de confidencialidade (1 ou mais)

O utilizador chama a API e filtra por um ou mais GUIDs de ID de etiqueta.

Exemplo

$filter=((id eq 'guid1') or (id eq 'guid2') or (id eq 'guid3'))

Regras

1. Restrição OR com isScopedToUser

   • Se isScopedToUser o parâmetro de filtro estiver presente, or não é permitido nos parâmetros de filtro

2. Comportamento de pré-filtragem com OR

   • Se or estiver presente nos parâmetros de filtro, locale os contentFormats parâmetros de filtro (se estiverem presentes) não serão utilizados para pré-filtragem

3. Exceção OR interna

   • As operações internas or que se enquadram na árvore de parâmetros são permitidas

Cenário 2: Devolver resultados para etiquetas de confidencialidade com um filtro num único ID e direito de utilizador

O utilizador chama a API e filtra por um GUID de ID de etiqueta e um direito de utilizador.

Exemplo

$filter=(id eq 'guid1' and ownerEmail eq 'ownerEmail1')

Regras

1. Restrição OR com vários parâmetros

   • Se algum dos seguintes parâmetros de filtro estiver presente: isScopedToUser, idou ownerEmail, or então não é permitido nos parâmetros de filtro

2. validação ownerEmail

   • ownerEmail presente sem id lança um ArgumentException.

3. Comportamento de pré-filtragem com OR

   • Se or estiver presente na cadeia de $filter, locale os contentFormats parâmetros de filtro são ignorados e não são utilizados para pré-filtrar os resultados.

4. Exceção OR interna

   • Pode utilizar operações internas or entre cláusulas individuais.

Cenário 2.5: Devolver resultados para etiquetas de confidencialidade com um filtro para vários IDs e direitos de utilizador

O utilizador quer chamar a API e filtrar por vários IDs e ownerEmail. Para alcançar este resultado, tem de combinar o ID da etiqueta e o ownerEmail numa cláusula booleana.

Exemplo

$filter=(
   (id eq 'guid1' and ownerEmail eq 'ownerEmail1')
  or (id eq 'guid2')
  or (id eq 'guid3' and ownerEmail eq 'ownerEmail2')
)

Este $filter padrão é uma extensão para a especificação OData padrão. No OData padrão, combinar várias cadeias de identificação com or desta forma não é normalmente suportado. No entanto, esta API permite-lhe utilizar um padrão OR baseado em cadeias de identificação, em que cada (id, ownerEmail) par é avaliado de forma independente e as informações de direitos resultantes são intercaladas. Para obter mais informações sobre o comportamento OData $filter padrão, veja a especificação OData.

Recomendamos a utilização de filtros que utilizem uma única chamada com vários IDs para obter direitos para várias etiquetas, uma vez que reduz o número de chamadas à API que precisa de fazer a partir da sua aplicação.

ownerEmail é opcional e pode ser omitido para obter apenas direitos ao nível da etiqueta.

Regras

1. Padrão OR estrito

   • Apenas a estrutura baseada em cadeias de identificação combinada por operações OR, conforme mostrado acima, é suportada.

   • Qualquer outra combinação de operações OU ou mistura de filtros não relacionados não é permitida e resulta numa ArgumentException.

2. validação ownerEmail

   • ownerEmail tem de aparecer sempre em conjunto com um id. A utilização ownerEmail individual resulta numa ArgumentException.

3. Exceção OR interna

   • Pode combinar cláusulas com subclaustas. Eis um exemplo de uma subclautilha: (id eq "guid1" e ownerEmail eq "ownerEmail1")

   • Neste exemplo, existem três subclaustas. Ao combinar o ID e o ownerEmail, utilize AND na subclausta. Não utilize OU caso contrário, gera uma exceção.

4. Comportamento de pré-filtragem

   • Quando or é utilizado, os locale parâmetros e contentFormats (se fornecido) são ignorados para pré-filtragem.

Resumo do comportamento

Cenário 3: Direitos /id/direitos da etiqueta de confidencialidade

Regras

1. Restrição OR com ownerEmail

   • or as operações com parâmetros ownerEmail de filtro resultam numa exceção.

2. Exceção OR interna

   • As operações internas or que se enquadram na árvore de parâmetros são permitidas.

isScopedToUser parameter rules (Regras de parâmetros isScopedToUser)

Esta secção descreve o comportamento e as restrições do isScopedToUser parâmetro nas APIs da etiqueta de confidencialidade.

Comportamento dos parâmetros

isScopedToUser = true

• Resultado: Mostra apenas etiquetas ativadas
• Caso de utilização: Standard filtragem para etiquetas ativadas/ativadas
• Estado: Utilização recomendada

isScopedToUser = false

• Resultado: Mostra apenas etiquetas desativadas
• Caso de utilização: Limitado – idealmente não utilizado com este valor
• Estado: Não recomendado para operações típicas

isScopedToUser não transmitido

• Resultado: Mostra todas as etiquetas (ativadas e desativadas)
• Caso de utilização: obtenção abrangente de etiquetas
• Estado: Comportamento predefinido quando o parâmetro é omitido

Restrições

Exceção de etiquetas de inquilino

• Comportamento: ao obter etiquetas de inquilino, a utilização isScopedToUser irá gerar ArgumentException
• Motivo: o parâmetro não é aplicável para operações de etiqueta ao nível do inquilino
• Solução: Omitir o isScopedToUser parâmetro ao trabalhar com etiquetas de inquilino

Relações

Representação JSON

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

{
  "@odata.type": "#microsoft.graph.security.sensitivityLabel",
  "id": "String (identifier)",
  "name": "String",
  "displayName": "String",
  "description": "String",
  "toolTip": "String",
  "isEnabled": "Boolean",
  "isEndpointProtectionEnabled": "Boolean",
  "isDefault": "Boolean",
  "applicationMode": "String",
  "priority": "Integer",
  "applicableTo": "String",
  "color": "String",
  "autoTooltip": "String",
  "locale": "String",
  "isScopedToUser": "Boolean",
  "actionSource": "String"
}