tipo de recurso accessReviewScheduleDefinition

  • Artigo

Namespace: microsoft.graph

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.

Observação

Essa é a API recomendada para revisões de acesso. A versão anterior da API de revisões de acesso é preterida.

Representa o agendamento de uma revisão de acesso Microsoft Entra.

Um accessReviewScheduleDefinition contém uma lista de objetos accessReviewInstance . Cada recorrência da definição de agendamento cria uma instância. As instâncias também representam cada recurso exclusivo que está sendo revisado. Se uma definição de agendar examinar vários recursos (incluindo vários grupos), cada recurso terá uma instância exclusiva por cada recorrência. No caso de uma revisão única, apenas uma instância é criada por recurso.

Métodos

Método Tipo de retorno Descrição
Acesso de listaReviewScheduleDefinitions coleção accessReviewScheduleDefinition Listas todos os accessReviewScheduleDefinition. Não inclui o accessReviewInstance associado nos resultados.
Obter accessReviewScheduleDefinition accessReviewScheduleDefinition Obtenha um accessReviewScheduleDefinition com uma id especificada. Não inclui o accessReviewInstance associado nos resultados.
Criar accessReviewScheduleDefinition accessReviewScheduleDefinition Criar um novo accessReviewScheduleDefinition.
Excluir accessReviewScheduleDefinition Nenhuma. Excluir um accessReviewScheduleDefinition com uma id especificada.
Atualizar accessReviewScheduleDefinition Nenhuma. Atualize as propriedades de um accessReviewScheduleDefinition com uma id especificada.
filterByCurrentUser coleção accessReviewScheduleDefinition Recupera todas as definições para as quais o usuário chamador é um revisor em uma ou mais instâncias.

Propriedades

Propriedade Tipo Descrição
additionalNotificationRecipients coleção accessReviewNotificationRecipientItem Define a lista de usuários adicionais ou membros do grupo a serem notificados sobre o progresso da revisão de acesso.
createdBy userIdentity Usuário que criou essa revisão. Somente leitura.
createdDateTime DateTimeOffset Carimbo de data/hora quando a série de revisão de acesso foi criada. Oferece suporte para $select. Somente leitura.
descriptionForAdmins Cadeia de caracteres Descrição fornecida pelos criadores de revisão para fornecer mais contexto da revisão aos administradores. Oferece suporte para $select.
descriptionForReviewers Cadeia de caracteres Descrição fornecida pelos criadores de revisão para fornecer mais contexto da revisão aos revisores. Os revisores veem essa descrição no email enviado a eles solicitando sua revisão. Email notificações dão suporte a até 256 caracteres. Oferece suporte para $select.
displayName Cadeia de caracteres Nome da série de revisão de acesso. Oferece suporte para $select e $orderby. Obrigatório durante a criação.
fallbackReviewers coleção accessReviewReviewerScope Essa coleção de escopos de revisor é usada para definir a lista de revisores de fallback. Esses revisores de fallback serão notificados a agir se nenhum usuário for encontrado na lista de revisores especificados. Isso pode ocorrer quando o proprietário do grupo é especificado como o revisor, mas o proprietário do grupo não existe ou o gerenciador é especificado como revisor, mas o gerenciador de um usuário não existe. Consulte accessReviewReviewerScope. Substitui backupReviewers. Oferece suporte para $select.

NOTA: O valor dessa propriedade será ignorado se os revisores de fallback forem atribuídos por meio da propriedade stageSettings .
id Cadeia de caracteres O identificador exclusivo atribuído pelo recurso de uma revisão de acesso. Oferece suporte para $select. Somente leitura.
instanceEnumerationScope accessReviewScope Essa propriedade é necessária ao examinar o acesso dos usuários convidados em todos os grupos do Microsoft 365 e determina quais grupos do Microsoft 365 são revisados. Cada grupo se torna um acesso exclusivoReviewInstance da série de revisão de acesso. Para escopos com suporte, consulte accessReviewScope. Oferece suporte para $select. Para obter exemplos de opções para configurar instanceEnumerationScope, consulte Configurar o escopo da definição de revisão de acesso usando o microsoft API do Graph.
instances coleção accessReviewInstance Conjunto de instâncias de revisão de acesso para esta série de revisão de acesso. As revisões de acesso que não se repetirem terão apenas uma instância; caso contrário, há uma instância para cada recorrência.
lastModifiedDateTime DateTimeOffset Carimbo de data/hora quando a série de revisão de acesso foi modificada pela última vez. Oferece suporte para $select. Somente leitura.
Revisores coleção accessReviewReviewerScope Essa coleção de escopos de revisão de acesso é usada para definir quem são os revisores. A propriedade revisores só será atualizada se usuários individuais forem atribuídos como revisores. Obrigatório durante a criação. Oferece suporte para $select. Para obter exemplos de opções para atribuir revisores, consulte Atribuir revisores à definição de revisão de acesso usando o microsoft API do Graph.

NOTA: O valor dessa propriedade será ignorado se os revisores forem atribuídos por meio da propriedade stageSettings .
scope accessReviewScope Define as entidades cujo acesso é revisado. Para escopos com suporte, consulte accessReviewScope. Obrigatório durante a criação. $select Dá suporte e $filter (contains somente). Para obter exemplos de opções para configurar o escopo, consulte Configurar o escopo da definição de revisão de acesso usando o microsoft API do Graph.
stageSettings coleção accessReviewStageSettings Necessário apenas para uma revisão de acesso em vários estágios para definir os estágios e suas configurações. Você pode dividir cada instância de revisão em até três estágios sequenciais, em que cada estágio pode ter um conjunto diferente de revisores, revisores de fallback e configurações. Os estágios são criados sequencialmente com base na propriedade dependOn . Opcional.

Quando essa propriedade é definida, suas configurações são usadas em vez das configurações correspondentes no objeto accessReviewScheduleDefinition e suas configurações, revisores e propriedades fallbackReviewers .
settings accessReviewScheduleSettings As configurações de uma série de revisão de acesso, confira definição de tipo abaixo. Oferece suporte para $select. Obrigatório durante a criação.
status Cadeia de caracteres Este campo somente leitura especifica o status de uma revisão de acesso. Os estados típicos incluem Initializing, NotStarted, Starting, InProgress, Completing, Completed, , AutoReviewinge AutoReviewed.
$selectDá suporte a , $orderbye $filter (eq somente). Somente leitura.
backupReviewers (preteridos) coleção accessReviewReviewerScope Essa coleção de escopos de revisor é usada para definir a lista de revisores de fallback. Esses revisores de fallback serão notificados a agir se nenhum usuário for encontrado na lista de revisores especificados. Isso pode ocorrer quando o proprietário do grupo é especificado como o revisor, mas o proprietário do grupo não existe ou o gerenciador é especificado como revisor, mas o gerenciador de um usuário não existe. Oferece suporte para $select.
Nota: Essa propriedade foi substituída por fallbackReviewers. No entanto, especificar backupReviewers ou fallbackReviewers preenche automaticamente os mesmos valores para a outra propriedade.

Relações

Relação Tipo Descrição
instances coleção accessReviewInstance Se o accessReviewScheduleDefinition for uma revisão de acesso recorrente, as instâncias representarão cada recorrência. Uma revisão que não se repetir terá exatamente uma instância. As instâncias também representam cada recurso exclusivo em revisão no accessReviewScheduleDefinition. Se uma revisão tiver vários recursos e várias instâncias, cada recurso terá uma instância exclusiva para cada recorrência.

Representação JSON

A representação JSON a seguir mostra o tipo de recurso.

{
  "@odata.type": "#microsoft.graph.accessReviewScheduleDefinition",
  "id": "String (identifier)",
  "displayName": "String",
  "createdDateTime": "String (timestamp)",
  "lastModifiedDateTime": "String (timestamp)",
  "status": "String",
  "descriptionForAdmins": "String",
  "descriptionForReviewers": "String",
  "createdBy": {
    "@odata.type": "microsoft.graph.userIdentity"
  },
  "scope": {
    "@odata.type": "microsoft.graph.accessReviewScope"
  },
  "reviewers": [
    {
      "@odata.type": "microsoft.graph.accessReviewReviewerScope"
    }
  ],
  "fallbackReviewers": [
    {
      "@odata.type": "microsoft.graph.accessReviewReviewerScope"
    }
  ],
  "backupReviewers": [
    {
      "@odata.type": "microsoft.graph.accessReviewReviewerScope"
    }
  ],
  "instanceEnumerationScope": {
    "@odata.type": "microsoft.graph.accessReviewScope"
  },
  "stageSettings": [
    {
      "@odata.type": "microsoft.graph.accessReviewStageSettings"
    }
  ],
  "settings": {
    "@odata.type": "microsoft.graph.accessReviewScheduleSettings"
  },
  "additionalNotificationRecipients": [
    {
        "@odata.type": "microsoft.graph.accessReviewNotificationRecipientItem"
    }
  ]
}