Access Review Schedule Definitions - List

Obter definições de agendamento de revisão de acesso

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions?api-version=2021-07-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions?api-version=2021-07-01-preview&$filter={$filter}

Parâmetros de URI

Name In Required Type Description
subscriptionId
path True
  • string

A ID da assinatura de destino.

api-version
query True
  • string

A versão da API a ser usada com a solicitação HTTP.

$filter
query
  • string

O filtro a ser aplicado na operação. Além dos filtros padrão, há suporte para uma opção de filtro personalizada: 'assignedToMeToReview()'. Quando um $filter=assignedToMeToReview() especificado, somente os itens atribuídos ao usuário de chamada para revisão são retornados

Respostas

Name Type Description
200 OK

Descreva o resultado de uma operação bem-sucedida.

Other Status Codes

Erro inesperado

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

GetAccessReviews

Sample Request

GET https://management.azure.com/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/accessReviewScheduleDefinitions?api-version=2021-07-01-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d",
      "type": "Microsoft.Authorization/accessReviewScheduleDefinitions",
      "name": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d",
      "properties": {
        "displayName": "Hello world",
        "status": "InProgress",
        "descriptionForAdmins": "asdfasdf",
        "descriptionForReviewers": "asdfasdf",
        "createdBy": {
          "principalType": "user",
          "principalId": "a6c7aecb-cbfd-4763-87ef-e91b4bd509d9",
          "principalName": "Shubham Gupta",
          "userPrincipalName": "shugup@microsoft.com"
        },
        "scope": {
          "resourceId": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d",
          "roleDefinitionId": "/subscriptions/fa73e90b-5bf1-45fd-a182-35ce5fc0674d/providers/Microsoft.Authorization/roleDefinitions/b225c7ff-4338-4cdc-a790-6b34d987f7cd"
        },
        "reviewers": [
          {
            "principalId": "fa73e90b-5bf1-45fd-a182-35ce5fc0674d ",
            "principalType": "user"
          }
        ],
        "reviewersType": "Assigned",
        "settings": {
          "mailNotificationsEnabled": true,
          "reminderNotificationsEnabled": true,
          "justificationRequiredOnApproval": true,
          "recommendationsEnabled": true,
          "instanceDurationInDays": 30,
          "recurrence": {
            "range": {
              "type": "endDate",
              "numberOfOccurrences": 1,
              "startDate": "2018-08-03T21:02:30.667Z",
              "endDate": "2018-08-03T21:17:30.513Z"
            }
          },
          "defaultDecisionEnabled": true,
          "defaultDecision": "Approve",
          "autoApplyDecisionsEnabled": true
        }
      }
    }
  ]
}

Definições

AccessReviewActorIdentityType

O tipo de identidade: user/servicePrincipal

AccessReviewInstance

Instância de Revisão de Acesso.

AccessReviewInstanceReviewersType

Este campo especifica o tipo de revisores para uma revisão. Normalmente, para uma revisão, os revisores são atribuídos explicitamente. No entanto, em alguns casos, os revisores podem não ser atribuídos e, em vez disso, ser escolhidos dinamicamente. Por exemplo, os gerentes revisam ou revisam por conta própria.

AccessReviewInstanceStatus

Este campo somente leitura especifica o status de uma instância de revisão de acesso.

AccessReviewRecurrencePatternType

O tipo de recorrência: semanal, mensal, etc.

AccessReviewRecurrenceRangeType

O tipo de intervalo de recorrência. Os valores possíveis são: endDate, noEnd, numerado.

AccessReviewReviewer

Descritor para o que precisa ser revisado

AccessReviewReviewerType

O tipo de identidade: user/servicePrincipal

AccessReviewScheduleDefinition

Definição da Agenda de Revisão de Acesso.

AccessReviewScheduleDefinitionListResult

Lista de definições de agendamento de revisão de acesso.

AccessReviewScheduleDefinitionReviewersType

Este campo especifica o tipo de revisores para uma revisão. Normalmente, para uma revisão, os revisores são atribuídos explicitamente. No entanto, em alguns casos, os revisores podem não ser atribuídos e, em vez disso, ser escolhidos dinamicamente. Por exemplo, os gerentes revisam ou revisam por conta própria.

AccessReviewScheduleDefinitionStatus

Este campo somente leitura especifica o status de um accessReview.

AccessReviewScopeAssignmentState

O estado de atribuição de função qualificado/ativo para revisão

AccessReviewScopePrincipalType

O usuário/servicePrincipal do tipo de identidade a ser revisado

DefaultDecisionType

Isso especifica o comportamento do recurso autoReview quando uma revisão de acesso é concluída.

ErrorDefinition

Erro

ErrorDefinitionProperties

Erro

AccessReviewActorIdentityType

O tipo de identidade: user/servicePrincipal

Name Type Description
servicePrincipal
  • string
user
  • string

AccessReviewInstance

Instância de Revisão de Acesso.

Name Type Description
id
  • string

A ID da instância de revisão de acesso.

name
  • string

O nome da instância de revisão de acesso.

properties.backupReviewers

Essa é a coleção de revisores de backup.

properties.endDateTime
  • string

O DateTime quando a instância de revisão está agendada para terminar.

properties.reviewers

Essa é a coleção de revisores.

properties.reviewersType

Este campo especifica o tipo de revisores para uma revisão. Normalmente, para uma revisão, os revisores são atribuídos explicitamente. No entanto, em alguns casos, os revisores podem não ser atribuídos e, em vez disso, ser escolhidos dinamicamente. Por exemplo, os gerentes revisam ou revisam por conta própria.

properties.startDateTime
  • string

O DateTime quando a instância de revisão está agendada para ser iniciada.

properties.status

Este campo somente leitura especifica o status de uma instância de revisão de acesso.

type
  • string

O tipo de recurso.

AccessReviewInstanceReviewersType

Este campo especifica o tipo de revisores para uma revisão. Normalmente, para uma revisão, os revisores são atribuídos explicitamente. No entanto, em alguns casos, os revisores podem não ser atribuídos e, em vez disso, ser escolhidos dinamicamente. Por exemplo, os gerentes revisam ou revisam por conta própria.

Name Type Description
Assigned
  • string
Managers
  • string
Self
  • string

AccessReviewInstanceStatus

Este campo somente leitura especifica o status de uma instância de revisão de acesso.

Name Type Description
Applied
  • string
Applying
  • string
AutoReviewed
  • string
AutoReviewing
  • string
Completed
  • string
Completing
  • string
InProgress
  • string
Initializing
  • string
NotStarted
  • string
Scheduled
  • string
Starting
  • string

AccessReviewRecurrencePatternType

O tipo de recorrência: semanal, mensal, etc.

Name Type Description
absoluteMonthly
  • string
weekly
  • string

AccessReviewRecurrenceRangeType

O tipo de intervalo de recorrência. Os valores possíveis são: endDate, noEnd, numerado.

Name Type Description
endDate
  • string
noEnd
  • string
numbered
  • string

AccessReviewReviewer

Descritor para o que precisa ser revisado

Name Type Description
principalId
  • string

A ID do revisor (user/servicePrincipal)

principalType

O tipo de identidade: user/servicePrincipal

AccessReviewReviewerType

O tipo de identidade: user/servicePrincipal

Name Type Description
servicePrincipal
  • string
user
  • string

AccessReviewScheduleDefinition

Definição da Agenda de Revisão de Acesso.

Name Type Description
id
  • string

A ID de definição de agendamento de revisão de acesso.

name
  • string

A ID exclusiva da definição de agendamento de revisão de acesso.

properties.backupReviewers

Essa é a coleção de revisores de backup.

properties.createdBy.principalId
  • string

A ID de identidade

properties.createdBy.principalName
  • string

O nome de exibição de identidade

properties.createdBy.principalType

O tipo de identidade: user/servicePrincipal

properties.createdBy.userPrincipalName
  • string

O nome da entidade de usuário (se válido)

properties.descriptionForAdmins
  • string

A descrição fornecida pelo criador da revisão de acesso e visível para os administradores.

properties.descriptionForReviewers
  • string

A descrição fornecida pelo criador da revisão de acesso a ser mostrada aos revisores.

properties.displayName
  • string

O nome de exibição da definição de agendamento.

properties.instances

Essa é a coleção de instâncias retornadas quando se faz uma expansão nela.

properties.reviewers

Essa é a coleção de revisores.

properties.reviewersType

Este campo especifica o tipo de revisores para uma revisão. Normalmente, para uma revisão, os revisores são atribuídos explicitamente. No entanto, em alguns casos, os revisores podem não ser atribuídos e, em vez disso, ser escolhidos dinamicamente. Por exemplo, os gerentes revisam ou revisam por conta própria.

properties.scope.assignmentState

O estado de atribuição de função qualificado/ativo para revisão

properties.scope.expandNestedMemberships
  • boolean

Sinalizador para indicar se as associações aninhadas devem ser expandidas ou não.

properties.scope.inactiveDuration
  • string

Os usuários de duração estão inativos. O valor deve estar no formato ISO 8601 (http://en.wikipedia.org/wiki/ISO_8601#Durations). Esse código pode ser usado para converter TimeSpan em uma cadeia de caracteres de intervalo válida: XmlConvert.ToString(novo TimeSpan(horas, minutos, segundos))

properties.scope.principalType

O usuário/servicePrincipal do tipo de identidade a ser revisado

properties.scope.resourceId
  • string

ResourceId no qual esta revisão está sendo criada

properties.scope.roleDefinitionId
  • string

Isso é usado para indicar a função que está sendo revisada

properties.settings.autoApplyDecisionsEnabled
  • boolean

Sinalizador para indicar se a funcionalidade de aplicação automática, para alterar automaticamente o recurso de acesso ao objeto de destino, está habilitada. Se não estiver habilitado, um usuário deverá, após a conclusão da revisão, aplicar a revisão de acesso.

properties.settings.defaultDecision

Isso especifica o comportamento do recurso autoReview quando uma revisão de acesso é concluída.

properties.settings.defaultDecisionEnabled
  • boolean

Sinalizador para indicar se os revisores são obrigados a fornecer uma justificativa ao revisar o acesso.

properties.settings.instanceDurationInDays
  • integer

A duração em dias para uma instância.

properties.settings.justificationRequiredOnApproval
  • boolean

Sinalizador para indicar se o revisor é necessário para passar justificativa ao gravar uma decisão.

properties.settings.mailNotificationsEnabled
  • boolean

Sinalizar para indicar se o envio de emails para revisores e o criador da revisão está habilitado.

properties.settings.recommendationLookBackDuration
  • string

As recomendações para revisões de acesso são calculadas olhando para trás em 30 dias de dados (w.r.t a data de início da revisão) por padrão. No entanto, em alguns cenários, os clientes desejam alterar o quão longe você pode ver e deseja configurar 60 dias, 90 dias etc. Essa configuração permite que os clientes configurem essa duração. O valor deve estar no formato ISO 8601 (http://en.wikipedia.org/wiki/ISO_8601#Durations). Esse código pode ser usado para converter TimeSpan em uma cadeia de caracteres de intervalo válida: XmlConvert.ToString(novo TimeSpan(horas, minutos, segundos))

properties.settings.recommendationsEnabled
  • boolean

Sinalizar para indicar se a exibição de recomendações para revisores está habilitada.

properties.settings.recurrence.pattern.interval
  • integer

O intervalo para recorrência. Para uma revisão trimestral, o intervalo é 3 para o tipo : absoluteMonthly.

properties.settings.recurrence.pattern.type

O tipo de recorrência: semanal, mensal, etc.

properties.settings.recurrence.range.endDate
  • string

O DateTime quando a revisão está agendada para terminar. Obrigatório se o tipo for endDate

properties.settings.recurrence.range.numberOfOccurrences
  • integer

O número de vezes que a revisão de acesso será repetida. Obrigatório e deve ser positivo se o tipo estiver numerado.

properties.settings.recurrence.range.startDate
  • string

O DateTime quando a revisão está agendada para ser iniciada. Isso pode ser uma data no futuro. Obrigatório na criação.

properties.settings.recurrence.range.type

O tipo de intervalo de recorrência. Os valores possíveis são: endDate, noEnd, numerado.

properties.settings.reminderNotificationsEnabled
  • boolean

Sinalizar para indicar se o envio de emails de lembrete para revisores está habilitado.

properties.status

Este campo somente leitura especifica o status de um accessReview.

type
  • string

O tipo de recurso.

AccessReviewScheduleDefinitionListResult

Lista de definições de agendamento de revisão de acesso.

Name Type Description
nextLink
  • string

A URL a ser usada para obter o próximo conjunto de resultados.

value

Lista de definição de agendamento de revisão de acesso.

AccessReviewScheduleDefinitionReviewersType

Este campo especifica o tipo de revisores para uma revisão. Normalmente, para uma revisão, os revisores são atribuídos explicitamente. No entanto, em alguns casos, os revisores podem não ser atribuídos e, em vez disso, ser escolhidos dinamicamente. Por exemplo, os gerentes revisam ou revisam por conta própria.

Name Type Description
Assigned
  • string
Managers
  • string
Self
  • string

AccessReviewScheduleDefinitionStatus

Este campo somente leitura especifica o status de um accessReview.

Name Type Description
Applied
  • string
Applying
  • string
AutoReviewed
  • string
AutoReviewing
  • string
Completed
  • string
Completing
  • string
InProgress
  • string
Initializing
  • string
NotStarted
  • string
Scheduled
  • string
Starting
  • string

AccessReviewScopeAssignmentState

O estado de atribuição de função qualificado/ativo para revisão

Name Type Description
active
  • string
eligible
  • string

AccessReviewScopePrincipalType

O usuário/servicePrincipal do tipo de identidade a ser revisado

Name Type Description
guestUser
  • string
redeemedGuestUser
  • string
servicePrincipal
  • string
user
  • string
user,group
  • string

DefaultDecisionType

Isso especifica o comportamento do recurso autoReview quando uma revisão de acesso é concluída.

Name Type Description
Approve
  • string
Deny
  • string
Recommendation
  • string

ErrorDefinition

Erro

Name Type Description
error

Erro
Erro do status do gateway de lista.

ErrorDefinitionProperties

Erro

Name Type Description
code
  • string

Código de erro do gateway de lista.

message
  • string

Descrição do erro.