Access Review Schedule Definitions - List

Abrufen von Zugriffsüberprüfungsplandefinitionen

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}

URI-Parameter

Name In Required Type Description
subscriptionId
path True
  • string

Hierbei handelt es sich um die ID des Zielabonnements.

api-version
query True
  • string

Die API-Version, die mit der HTTP-Anforderung verwendet werden soll.

$filter
query
  • string

Der Filter, der auf den Vorgang angewendet werden soll. Neben Standardfiltern wird eine benutzerdefinierte Filteroption unterstützt: 'assignedToMeToReview()'. Wenn ein angegebenes $filter=assignedToMeToReview() angegeben wurde, werden nur Elemente zurückgegeben, die dem aufrufenden Benutzer zugewiesen sind, um die Überprüfung zu überprüfen.

Antworten

Name Type Description
200 OK

Beschreiben Sie das Ergebnis eines erfolgreichen Vorgangs.

Other Status Codes

Unerwarteter Fehler

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Scopes

Name Description
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

AccessReviewActorIdentityType

Der Identitätstyp : user/servicePrincipal

AccessReviewInstance

Access Review Instance.

AccessReviewInstanceReviewersType

Dieses Feld gibt den Typ der Prüfer für eine Überprüfung an. In der Regel werden Prüfer explizit für eine Überprüfung zugewiesen. In einigen Fällen werden die Prüfer jedoch möglicherweise nicht zugewiesen und stattdessen dynamisch ausgewählt. Beispiel: Manager überprüfen oder selbst überprüfen.

AccessReviewInstanceStatus

Dieses schreibgeschützte Feld gibt den Status einer Zugriffsüberprüfungsinstanz an.

AccessReviewRecurrencePatternType

Der Serientyp : wöchentlich, monatlich usw.

AccessReviewRecurrenceRangeType

Der Serienbereichstyp. Die möglichen Werte sind: endDate, noEnd, nummeriert.

AccessReviewReviewer

Descriptor für das, was überprüft werden muss

AccessReviewReviewerType

Der Identitätstyp : user/servicePrincipal

AccessReviewScheduleDefinition

Access Review Schedule Definition.

AccessReviewScheduleDefinitionListResult

Liste der Zeitplandefinitionen für Access-Überprüfungen.

AccessReviewScheduleDefinitionReviewersType

Dieses Feld gibt den Typ der Prüfer für eine Überprüfung an. In der Regel werden Prüfer explizit für eine Überprüfung zugewiesen. In einigen Fällen werden die Prüfer jedoch möglicherweise nicht zugewiesen und stattdessen dynamisch ausgewählt. Beispiel: Manager überprüfen oder selbst überprüfen.

AccessReviewScheduleDefinitionStatus

Dieses schreibgeschützte Feld gibt den Status einer accessReview an.

AccessReviewScopeAssignmentState

Der Rollenzuweisungsstatus ist berechtigt/aktiv, um zu überprüfen

AccessReviewScopePrincipalType

Der Identitätstyp benutzer/servicePrincipal, der überprüft werden soll

DefaultDecisionType

Dies gibt das Verhalten für das AutoReview-Feature an, wenn eine Zugriffsüberprüfung abgeschlossen ist.

ErrorDefinition

Fehler

ErrorDefinitionProperties

Fehler

AccessReviewActorIdentityType

Der Identitätstyp : user/servicePrincipal

Name Type Description
servicePrincipal
  • string
user
  • string

AccessReviewInstance

Access Review Instance.

Name Type Description
id
  • string

Die Zugriffsüberprüfungsinstanz-ID.

name
  • string

Der Name der Zugriffsüberprüfungsinstanz.

properties.backupReviewers

Dies ist die Sammlung von Sicherungsprüfern.

properties.endDateTime
  • string

DatumTime, wenn die Überprüfungsinstanz geplant ist.

properties.reviewers

Dies ist die Sammlung von Prüfern.

properties.reviewersType

Dieses Feld gibt den Typ der Prüfer für eine Überprüfung an. In der Regel werden Prüfer explizit für eine Überprüfung zugewiesen. In einigen Fällen werden die Prüfer jedoch möglicherweise nicht zugewiesen und stattdessen dynamisch ausgewählt. Beispiel: Manager überprüfen oder selbst überprüfen.

properties.startDateTime
  • string

DatumTime, wenn die Überprüfungsinstanz gestartet werden soll.

properties.status

Dieses schreibgeschützte Feld gibt den Status einer Zugriffsüberprüfungsinstanz an.

type
  • string

Der Ressourcentyp.

AccessReviewInstanceReviewersType

Dieses Feld gibt den Typ der Prüfer für eine Überprüfung an. In der Regel werden Prüfer explizit für eine Überprüfung zugewiesen. In einigen Fällen werden die Prüfer jedoch möglicherweise nicht zugewiesen und stattdessen dynamisch ausgewählt. Beispiel: Manager überprüfen oder selbst überprüfen.

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

AccessReviewInstanceStatus

Dieses schreibgeschützte Feld gibt den Status einer Zugriffsüberprüfungsinstanz an.

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

Der Serientyp : wöchentlich, monatlich usw.

Name Type Description
absoluteMonthly
  • string
weekly
  • string

AccessReviewRecurrenceRangeType

Der Serienbereichstyp. Die möglichen Werte sind: endDate, noEnd, nummeriert.

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

AccessReviewReviewer

Descriptor für das, was überprüft werden muss

Name Type Description
principalId
  • string

Die ID des Prüfers(user/servicePrincipal)

principalType

Der Identitätstyp : user/servicePrincipal

AccessReviewReviewerType

Der Identitätstyp : user/servicePrincipal

Name Type Description
servicePrincipal
  • string
user
  • string

AccessReviewScheduleDefinition

Access Review Schedule Definition.

Name Type Description
id
  • string

Die Zugriffsüberprüfungsdefinitions-ID.

name
  • string

Die eindeutige ID der Zugriffsüberprüfungsplanung.

properties.backupReviewers

Dies ist die Sammlung von Sicherungsprüfern.

properties.createdBy.principalId
  • string

Die Identitäts-ID

properties.createdBy.principalName
  • string

Der Identitätsanzeigename

properties.createdBy.principalType

Der Identitätstyp : user/servicePrincipal

properties.createdBy.userPrincipalName
  • string

Der Benutzerprinzipalname(falls gültig)

properties.descriptionForAdmins
  • string

Die Beschreibung, die vom Zugriffsüberprüfungs-Ersteller bereitgestellt wird und für Administratoren sichtbar ist.

properties.descriptionForReviewers
  • string

Die Beschreibung, die vom Zugriffsüberprüfungs-Ersteller bereitgestellt wird, der den Prüfern angezeigt werden soll.

properties.displayName
  • string

Der Anzeigename für die Zeitplandefinition.

properties.instances

Dies ist die Auflistung von Instanzen, die zurückgegeben werden, wenn eine Erweiterung ausgeführt wird.

properties.reviewers

Dies ist die Sammlung von Prüfern.

properties.reviewersType

Dieses Feld gibt den Typ der Prüfer für eine Überprüfung an. In der Regel werden Prüfer explizit für eine Überprüfung zugewiesen. In einigen Fällen werden die Prüfer jedoch möglicherweise nicht zugewiesen und stattdessen dynamisch ausgewählt. Beispiel: Manager überprüfen oder selbst überprüfen.

properties.scope.assignmentState

Der Rollenzuweisungsstatus ist berechtigt/aktiv, um zu überprüfen

properties.scope.expandNestedMemberships
  • boolean

Kennzeichnen Sie, um anzugeben, ob geschachtelte Mitgliedschaften erweitert werden sollen oder nicht.

properties.scope.inactiveDuration
  • string

Dauer benutzer sind inaktiv für. Der Wert sollte im ISO 8601-Format (http://en.wikipedia.org/wiki/ISO_8601#Durations) enthalten sein. Dieser Code kann zum Konvertieren von TimeSpan in eine gültige Intervallzeichenfolge verwendet werden: XmlConvert.ToString(new TimeSpan(Stunden, Minuten, Sekunden))

properties.scope.principalType

Der Identitätstyp benutzer/servicePrincipal, der überprüft werden soll

properties.scope.resourceId
  • string

ResourceId, in der diese Überprüfung erstellt wird

properties.scope.roleDefinitionId
  • string

Dies wird verwendet, um anzugeben, welche Rolle überprüft wird

properties.settings.autoApplyDecisionsEnabled
  • boolean

Kennzeichnen Sie, um anzugeben, ob die Funktion automatisch angewendet wird, um die Zielobjektzugriffsressource automatisch zu ändern, aktiviert ist. Wenn dies nicht aktiviert ist, muss ein Benutzer nach Abschluss der Überprüfung die Zugriffsüberprüfung anwenden.

properties.settings.defaultDecision

Dies gibt das Verhalten für das AutoReview-Feature an, wenn eine Zugriffsüberprüfung abgeschlossen ist.

properties.settings.defaultDecisionEnabled
  • boolean

Kennzeichnen Sie, um anzugeben, ob Prüfer beim Überprüfen des Zugriffs eine Begründung bereitstellen müssen.

properties.settings.instanceDurationInDays
  • integer

Die Dauer in Tagen für eine Instanz.

properties.settings.justificationRequiredOnApproval
  • boolean

Kennzeichnen Sie, um anzugeben, ob der Prüfer die Begründung beim Aufzeichnen einer Entscheidung übergeben muss.

properties.settings.mailNotificationsEnabled
  • boolean

Kennzeichnen Sie, um anzugeben, ob E-Mails an Prüfer und der Prüfersteller aktiviert sind.

properties.settings.recommendationLookBackDuration
  • string

Empfehlungen für Zugriffsüberprüfungen werden anhand von 30 Tagen Daten (w.r.t der Starttermin der Überprüfung) standardmäßig berechnet. In einigen Szenarien möchten Kunden jedoch ändern, wie weit zurück sie aussehen und stattdessen 60 Tage, 90 Tage usw. konfigurieren möchten. Mit dieser Einstellung können Kunden diese Dauer konfigurieren. Der Wert sollte im ISO 8601-Format (http://en.wikipedia.org/wiki/ISO_8601#Durations) enthalten sein. Dieser Code kann zum Konvertieren von TimeSpan in eine gültige Intervallzeichenfolge verwendet werden: XmlConvert.ToString(new TimeSpan(Stunden, Minuten, Sekunden))

properties.settings.recommendationsEnabled
  • boolean

Kennzeichnen Sie, um anzugeben, ob Empfehlungen für Prüfer aktiviert sind.

properties.settings.recurrence.pattern.interval
  • integer

Das Intervall für Serienserien. Für eine vierteljährliche Überprüfung ist das Intervall 3 für den Typ : absoluteMonthly.

properties.settings.recurrence.pattern.type

Der Serientyp : wöchentlich, monatlich usw.

properties.settings.recurrence.range.endDate
  • string

DatumTime, wenn die Überprüfung geplant ist. Erforderlich, wenn der Typ endDate ist

properties.settings.recurrence.range.numberOfOccurrences
  • integer

Die Anzahl der Zeiten, um die Zugriffsüberprüfung zu wiederholen. Erforderlich und muss positiv sein, wenn der Typ nummeriert ist.

properties.settings.recurrence.range.startDate
  • string

DatumTime, wenn die Überprüfung gestartet werden soll. Dies könnte ein Datum in der Zukunft sein. Erforderlich zum Erstellen.

properties.settings.recurrence.range.type

Der Serienbereichstyp. Die möglichen Werte sind: endDate, noEnd, nummeriert.

properties.settings.reminderNotificationsEnabled
  • boolean

Kennzeichnen Sie, um anzugeben, ob Erinnerungs-E-Mails an Prüfer aktiviert sind.

properties.status

Dieses schreibgeschützte Feld gibt den Status einer accessReview an.

type
  • string

Der Ressourcentyp.

AccessReviewScheduleDefinitionListResult

Liste der Zeitplandefinitionen für Access-Überprüfungen.

Name Type Description
nextLink
  • string

Die URL, die zum Abrufen der nächsten Gruppe von Ergebnissen verwendet werden soll.

value

Liste der Zugriffsüberprüfungsplandefinitionen.

AccessReviewScheduleDefinitionReviewersType

Dieses Feld gibt den Typ der Prüfer für eine Überprüfung an. In der Regel werden Prüfer explizit für eine Überprüfung zugewiesen. In einigen Fällen werden die Prüfer jedoch möglicherweise nicht zugewiesen und stattdessen dynamisch ausgewählt. Beispiel: Manager überprüfen oder selbst überprüfen.

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

AccessReviewScheduleDefinitionStatus

Dieses schreibgeschützte Feld gibt den Status einer accessReview an.

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

Der Rollenzuweisungsstatus ist berechtigt/aktiv, um zu überprüfen

Name Type Description
active
  • string
eligible
  • string

AccessReviewScopePrincipalType

Der Identitätstyp benutzer/servicePrincipal, der überprüft werden soll

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

DefaultDecisionType

Dies gibt das Verhalten für das AutoReview-Feature an, wenn eine Zugriffsüberprüfung abgeschlossen ist.

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

ErrorDefinition

Fehler

Name Type Description
error

Fehler
Fehler des Listengatewaystatus.

ErrorDefinitionProperties

Fehler

Name Type Description
code
  • string

Fehlercode des Listengateways.

message
  • string

Beschreibung des Fehlers