accessReviewScheduleDefinition resource type (Tipo de recurso accessReviewScheduleDefinition)

Artigo
05/24/2024

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

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

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

Um accessReviewScheduleDefinition contém uma lista de objetos accessReviewInstance . Cada periodicidade da definição de agenda cria uma instância. As instâncias também representam cada recurso exclusivo que está a ser revisto. Se uma definição de agenda rever vários recursos (incluindo vários grupos), cada recurso tem uma instância exclusiva por cada periodicidade. No caso de uma revisão única, só é criada uma instância por recurso.

Métodos

Método	Tipo de retorno	Descrição
List	accessReviewScheduleDefinition collection	Listas cada accessReviewScheduleDefinition. Não inclui objetos accessReviewInstance associados nos resultados.
Get	accessReviewScheduleDefinition	Obtenha um accessReviewScheduleDefinition com um ID especificado. Não inclui objetos accessReviewInstance associados nos resultados.
Create	accessReviewScheduleDefinition	Create um novo accessReviewScheduleDefinition.
Delete	Nenhuma.	Elimine um accessReviewScheduleDefinition com um ID especificado.
Atualizar	Nenhuma.	Atualize as propriedades de um accessReviewScheduleDefinition com um ID especificado.
Filtrar por utilizador atual	accessReviewScheduleDefinition collection	Obtém todas as definições para as quais o utilizador que chama é revisor numa ou mais instâncias.

Propriedades

Propriedade	Tipo	Descrição
additionalNotificationRecipients	accessReviewNotificationRecipientItem collection (coleção accessReviewNotificationRecipientItem )	Define a lista de utilizadores ou membros do grupo adicionais a notificar sobre o progresso da revisão de acesso.
createdBy	userIdentity	Utilizador que criou esta 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 da revisão para fornecer mais contexto da revisão aos administradores. Oferece suporte para `$select`.
descriptionForReviewers	Cadeia de caracteres	Descrição fornecida pelos criadores da revisão para fornecer mais contexto da revisão aos revisores. Os revisores veem esta descrição no e-mail que lhes foi enviado a pedir a revisão. Email notificações suportam até 256 carateres. 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	accessReviewReviewerScope collection (coleção accessReviewReviewerScope )	Esta coleção de âmbitos de revisores é utilizada para definir a lista de revisores de contingência. Estes revisores de contingência serão notificados para tomar medidas se não forem encontrados utilizadores na lista de revisores especificados. Isto pode ocorrer quando o proprietário do grupo é especificado como revisor, mas o proprietário do grupo não existe ou o gestor é especificado como revisor, mas o gestor de um utilizador não existe. Veja accessReviewReviewerScope. Substitui backupReviewers. Oferece suporte para `$select`. NOTA: O valor desta propriedade será ignorado se os revisores de contingência forem atribuídos através da propriedade stageSettings .
id	Cadeia de caracteres	O identificador exclusivo atribuído pela funcionalidade de uma revisão de acesso. Oferece suporte para `$select`. Somente leitura.
instanceEnumerationScope	accessReviewScope	Esta propriedade é necessária ao analisar o acesso dos utilizadores convidados a todos os grupos do Microsoft 365 e determina quais os grupos do Microsoft 365 que são revistos. Cada grupo torna-se um accessReviewInstance exclusivo da série de revisão de acesso. Para obter os âmbitos suportados, veja accessReviewScope. Oferece suporte para `$select`. Para obter exemplos de opções para configurar instanceEnumerationScope, veja Configurar o âmbito da definição de revisão de acesso com o microsoft API do Graph.
instances	accessReviewInstance collection (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 repetem terão apenas uma instância; caso contrário, existe uma instância para cada periodicidade.
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	accessReviewReviewerScope collection (coleção accessReviewReviewerScope )	Esta coleção de âmbitos de revisão de acesso é utilizada para definir quem são os revisores. A propriedade revisores só é atualizável se os utilizadores 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 com o microsoft API do Graph. NOTA: O valor desta propriedade será ignorado se os revisores forem atribuídos através da propriedade stageSettings .
scope	accessReviewScope	Define as entidades cujo acesso é revisto. Para obter os âmbitos suportados, veja accessReviewScope. Obrigatório durante a criação. `$select` Suporta e `$filter` (`contains` apenas). Para obter exemplos de opções para configurar o âmbito, veja Configurar o âmbito da definição de revisão de acesso com o microsoft API do Graph.
stageSettings	accessReviewStageSettings collection (coleção accessReviewStageSettings)	Necessário apenas para uma revisão de acesso em várias fases para definir as fases e as respetivas definições. Pode dividir cada instância de revisão em até três fases sequenciais, em que cada fase pode ter um conjunto diferente de revisores, revisores de contingência e definições. As fases são criadas sequencialmente com base na propriedade dependsOn . Opcional. Quando esta propriedade é definida, as respetivas definições são utilizadas em vez das definições correspondentes no objeto accessReviewScheduleDefinition e nas respetivas definições, revisores e fallbackPropriedades dos respetivos revisores .
settings	accessReviewScheduleSettings	As definições de uma série de revisão de acesso, veja a definição do tipo abaixo. Oferece suporte para `$select`. Obrigatório durante a criação.
status	Cadeia de caracteres	Este campo só de leitura especifica a status de uma revisão de acesso. Os estados típicos incluem `Initializing`, `NotStarted`, `Starting`, `InProgress`, `Completing`, , `Completed`, `AutoReviewing`e `AutoReviewed`. `$select`Suporta apenas , `$orderby`e `$filter` (`eq` ). Somente leitura.
backupReviewers (preterido)	accessReviewReviewerScope collection (coleção accessReviewReviewerScope )	Esta coleção de âmbitos de revisores é utilizada para definir a lista de revisores de contingência. Estes revisores de contingência são notificados para tomar medidas se não forem encontrados utilizadores na lista de revisores especificados. Isto pode ocorrer quando o proprietário do grupo é especificado como revisor, mas o proprietário do grupo não existe ou o gestor é especificado como revisor, mas o gestor de um utilizador não existe. Oferece suporte para `$select`. Nota: Esta 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`	accessReviewInstance collection (coleção accessReviewInstance )	Se for `accessReviewScheduleDefinition` uma revisão de acesso periódica, as instâncias representam cada periodicidade. Uma revisão que não se repita terá exatamente uma instância. As instâncias também representam cada recurso exclusivo em análise no `accessReviewScheduleDefinition`. Se uma revisão tiver vários recursos e múltiplas instâncias, cada recurso tem uma instância exclusiva para cada periodicidade.

Representação JSON

A representação JSON seguinte 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"
    }
  ]
}

Compartilhar via