Access Review Schedule Definitions - List

Ottenere le definizioni di pianificazione delle verifiche di accesso

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}

Parametri dell'URI

Name In Required Type Description
subscriptionId
path True
  • string

ID della sottoscrizione di destinazione.

api-version
query True
  • string

Versione dell'API da usare con la richiesta HTTP.

$filter
query
  • string

Filtro da applicare all'operazione. Oltre ai filtri standard, è supportata un'opzione di filtro personalizzata: 'assignedToMeToReview()'. Quando viene restituito un $filter specificato=assignedToMeToReview(), vengono restituiti solo gli elementi assegnati all'utente chiamante da rivedere

Risposte

Name Type Description
200 OK

Descrivere il risultato di un'operazione riuscita.

Other Status Codes

Errore imprevisto

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Name Description
user_impersonation rappresentare l'account utente

Esempio

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
        }
      }
    }
  ]
}

Definizioni

AccessReviewActorIdentityType

Tipo di identità : user/servicePrincipal

AccessReviewInstance

Istanza di Verifica di accesso.

AccessReviewInstanceReviewersType

Questo campo specifica il tipo di revisori per una revisione. In genere per una revisione, i revisori vengono assegnati in modo esplicito. In alcuni casi, tuttavia, è possibile che i revisori non vengano assegnati e che vengano scelti in modo dinamico. Ad esempio, i manager esaminano o si autovalutano.

AccessReviewInstanceStatus

Questo campo di sola lettura specifica lo stato di un'istanza di verifica di accesso.

AccessReviewRecurrencePatternType

Tipo di ricorrenza: settimanale, mensile e così via.

AccessReviewRecurrenceRangeType

Tipo di intervallo di ricorrenza. I valori possibili sono: endDate, noEnd, numerato.

AccessReviewReviewer

Descrittore per gli elementi da rivedere

AccessReviewReviewerType

Tipo di identità : user/servicePrincipal

AccessReviewScheduleDefinition

Definizione della pianificazione della verifica di accesso.

AccessReviewScheduleDefinitionListResult

Elenco delle definizioni di pianificazione delle verifiche di accesso.

AccessReviewScheduleDefinitionReviewersType

Questo campo specifica il tipo di revisori per una revisione. In genere per una revisione, i revisori vengono assegnati in modo esplicito. In alcuni casi, tuttavia, è possibile che i revisori non vengano assegnati e che vengano scelti in modo dinamico. Ad esempio, i manager esaminano o si autovalutano.

AccessReviewScheduleDefinitionStatus

Questo campo di sola lettura specifica lo stato di un oggetto accessReview.

AccessReviewScopeAssignmentState

Stato dell'assegnazione di ruolo idoneo/attivo da esaminare

AccessReviewScopePrincipalType

Tipo di identità utente/servicePrincipal da esaminare

DefaultDecisionType

Specifica il comportamento per la funzionalità autoReview al termine di una verifica di accesso.

ErrorDefinition

Errore

ErrorDefinitionProperties

Errore

AccessReviewActorIdentityType

Tipo di identità : user/servicePrincipal

Name Type Description
servicePrincipal
  • string
user
  • string

AccessReviewInstance

Istanza di Verifica di accesso.

Name Type Description
id
  • string

ID istanza della verifica di accesso.

name
  • string

Nome dell'istanza di verifica di accesso.

properties.backupReviewers

Questa è la raccolta di revisori di backup.

properties.endDateTime
  • string

DateTime quando l'istanza di revisione è pianificata per terminare.

properties.reviewers

Questa è la raccolta di revisori.

properties.reviewersType

Questo campo specifica il tipo di revisori per una revisione. In genere per una revisione, i revisori vengono assegnati in modo esplicito. In alcuni casi, tuttavia, è possibile che i revisori non vengano assegnati e che vengano scelti in modo dinamico. Ad esempio, i manager esaminano o si autovalutano.

properties.startDateTime
  • string

DateTime quando l'istanza di revisione è pianificata per l'avvio.

properties.status

Questo campo di sola lettura specifica lo stato di un'istanza di verifica di accesso.

type
  • string

Tipo di risorsa.

AccessReviewInstanceReviewersType

Questo campo specifica il tipo di revisori per una revisione. In genere per una revisione, i revisori vengono assegnati in modo esplicito. In alcuni casi, tuttavia, è possibile che i revisori non vengano assegnati e che vengano scelti in modo dinamico. Ad esempio, i manager esaminano o si autovalutano.

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

AccessReviewInstanceStatus

Questo campo di sola lettura specifica lo stato di un'istanza di verifica di accesso.

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

Tipo di ricorrenza: settimanale, mensile e così via.

Name Type Description
absoluteMonthly
  • string
weekly
  • string

AccessReviewRecurrenceRangeType

Tipo di intervallo di ricorrenza. I valori possibili sono: endDate, noEnd, numerato.

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

AccessReviewReviewer

Descrittore per gli elementi da rivedere

Name Type Description
principalId
  • string

ID del revisore(user/servicePrincipal)

principalType

Tipo di identità : user/servicePrincipal

AccessReviewReviewerType

Tipo di identità : user/servicePrincipal

Name Type Description
servicePrincipal
  • string
user
  • string

AccessReviewScheduleDefinition

Definizione della pianificazione della verifica di accesso.

Name Type Description
id
  • string

ID definizione della pianificazione della verifica di accesso.

name
  • string

ID univoco della definizione della pianificazione della verifica di accesso.

properties.backupReviewers

Questa è la raccolta di revisori di backup.

properties.createdBy.principalId
  • string

ID identità

properties.createdBy.principalName
  • string

Nome visualizzato dell'identità

properties.createdBy.principalType

Tipo di identità : user/servicePrincipal

properties.createdBy.userPrincipalName
  • string

Nome dell'entità utente(se valido)

properties.descriptionForAdmins
  • string

Descrizione fornita dall'autore della verifica di accesso e visibile agli amministratori.

properties.descriptionForReviewers
  • string

Descrizione fornita dall'autore della verifica di accesso da visualizzare ai revisori.

properties.displayName
  • string

Nome visualizzato per la definizione della pianificazione.

properties.instances

Si tratta della raccolta di istanze restituite quando ne viene eseguita un'espansione.

properties.reviewers

Questa è la raccolta di revisori.

properties.reviewersType

Questo campo specifica il tipo di revisori per una revisione. In genere per una revisione, i revisori vengono assegnati in modo esplicito. In alcuni casi, tuttavia, è possibile che i revisori non vengano assegnati e che vengano scelti in modo dinamico. Ad esempio, i manager esaminano o si autovalutano.

properties.scope.assignmentState

Stato dell'assegnazione di ruolo idoneo/attivo da esaminare

properties.scope.expandNestedMemberships
  • boolean

Flag per indicare se espandere o meno le appartenenze annidate.

properties.scope.inactiveDuration
  • string

Durata per cui gli utenti sono inattivi. Il valore deve essere in formato ISO 8601 (http://en.wikipedia.org/wiki/ISO_8601#Durations). Questo codice può essere usato per convertire TimeSpan in una stringa di intervallo valida: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))

properties.scope.principalType

Tipo di identità utente/servicePrincipal da esaminare

properties.scope.resourceId
  • string

ResourceId in cui viene creata questa revisione

properties.scope.roleDefinitionId
  • string

Viene usato per indicare il ruolo da rivedere

properties.settings.autoApplyDecisionsEnabled
  • boolean

Flag per indicare se la funzionalità di applicazione automatica, per modificare automaticamente la risorsa di accesso agli oggetti di destinazione, è abilitata. Se non è abilitato, un utente deve, al termine della verifica, applicare la verifica di accesso.

properties.settings.defaultDecision

Specifica il comportamento per la funzionalità autoReview al termine di una verifica di accesso.

properties.settings.defaultDecisionEnabled
  • boolean

Flag per indicare se i revisori devono fornire una giustificazione durante la verifica dell'accesso.

properties.settings.instanceDurationInDays
  • integer

Durata in giorni per un'istanza di .

properties.settings.justificationRequiredOnApproval
  • boolean

Flag per indicare se il revisore deve superare la giustificazione durante la registrazione di una decisione.

properties.settings.mailNotificationsEnabled
  • boolean

Flag per indicare se l'invio di messaggi di posta elettronica ai revisori e l'autore della revisione è abilitato.

properties.settings.recommendationLookBackDuration
  • string

Le raccomandazioni per le verifiche di accesso vengono calcolate esaminando 30 giorni di dati (w.r.t la data di inizio della revisione) per impostazione predefinita. In alcuni scenari, tuttavia, i clienti vogliono cambiare la distanza da esaminare e vogliono configurare invece 60 giorni, 90 giorni e così via. Questa impostazione consente ai clienti di configurare questa durata. Il valore deve essere in formato ISO 8601 (http://en.wikipedia.org/wiki/ISO_8601#Durations). Questo codice può essere usato per convertire TimeSpan in una stringa di intervallo valida: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))

properties.settings.recommendationsEnabled
  • boolean

Flag per indicare se visualizzare le raccomandazioni per i revisori è abilitato.

properties.settings.recurrence.pattern.interval
  • integer

Intervallo per la ricorrenza. Per una revisione trimestrale, l'intervallo è 3 per il tipo : absoluteMonthly.

properties.settings.recurrence.pattern.type

Tipo di ricorrenza: settimanale, mensile e così via.

properties.settings.recurrence.range.endDate
  • string

DateTime al termine della revisione. Obbligatorio se il tipo è endDate

properties.settings.recurrence.range.numberOfOccurrences
  • integer

Numero di volte in cui ripetere la verifica di accesso. Obbligatorio e deve essere positivo se il tipo è numerato.

properties.settings.recurrence.range.startDate
  • string

DateTime quando la revisione è pianificata per l'avvio. Potrebbe trattarsi di una data futura. Obbligatorio in caso di creazione.

properties.settings.recurrence.range.type

Tipo di intervallo di ricorrenza. I valori possibili sono: endDate, noEnd, numerato.

properties.settings.reminderNotificationsEnabled
  • boolean

Flag per indicare se l'invio di messaggi di posta elettronica di promemoria ai revisori è abilitato.

properties.status

Questo campo di sola lettura specifica lo stato di un oggetto accessReview.

type
  • string

Tipo di risorsa.

AccessReviewScheduleDefinitionListResult

Elenco delle definizioni di pianificazione delle verifiche di accesso.

Name Type Description
nextLink
  • string

URL da usare per ottenere il set di risultati successivo.

value

Elenco delle definizioni di pianificazione della verifica di accesso.

AccessReviewScheduleDefinitionReviewersType

Questo campo specifica il tipo di revisori per una revisione. In genere per una revisione, i revisori vengono assegnati in modo esplicito. In alcuni casi, tuttavia, è possibile che i revisori non vengano assegnati e che vengano scelti in modo dinamico. Ad esempio, i manager esaminano o si autovalutano.

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

AccessReviewScheduleDefinitionStatus

Questo campo di sola lettura specifica lo stato di un oggetto 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

Stato dell'assegnazione di ruolo idoneo/attivo da esaminare

Name Type Description
active
  • string
eligible
  • string

AccessReviewScopePrincipalType

Tipo di identità utente/servicePrincipal da esaminare

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

DefaultDecisionType

Specifica il comportamento per la funzionalità autoReview al termine di una verifica di accesso.

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

ErrorDefinition

Errore

Name Type Description
error

Errore
Errore dello stato del gateway di elenco.

ErrorDefinitionProperties

Errore

Name Type Description
code
  • string

Codice di errore del gateway di elenco.

message
  • string

Descrizione dell'errore.