Access Review Schedule Definitions - List
Abrufen von Zugriffsüberprüfungszeitplandefinitionen
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions?api-version=2021-12-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions?api-version=2021-12-01-preview&$filter={$filter}
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
subscription
|
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. Abgesehen von Standardfiltern wird eine benutzerdefinierte Filteroption unterstützt: "assignedToMeToReview()". Wenn eine angegebene $filter=assignedToMeToReview() angegeben wurde, werden nur Elemente zurückgegeben, die dem aufrufenden Benutzer zur Überprüfung zugewiesen sind. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Beschreiben sie das Ergebnis eines erfolgreichen Vorgangs. |
|
Other Status Codes |
Unerwarteter Fehler |
Sicherheit
azure_auth
Azure Active Directory-OAuth2-Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel Ihres Benutzerkontos |
Definitionen
Name | Beschreibung |
---|---|
Access |
Der Identitätstyp : user/servicePrincipal |
Access |
Access Review-Instanz. |
Access |
Dieses Feld gibt den Typ der Prüfer für eine Überprüfung an. Normalerweise werden Prüfer für eine Überprüfung explizit zugewiesen. In einigen Fällen werden die Prüfer jedoch möglicherweise nicht zugewiesen und stattdessen dynamisch ausgewählt. Beispielsweise überprüfen Manager oder sich selbst. |
Access |
Dieses schreibgeschützte Feld gibt die status einer Zugriffsüberprüfung instance an. |
Access |
Der Wiederholungstyp: wöchentlich, monatlich usw. |
Access |
Der Serienbereichstyp. Die möglichen Werte sind: endDate, noEnd, nummeriert. |
Access |
Deskriptor für zu überprüfende Elemente |
Access |
Der Identitätstyp : user/servicePrincipal |
Access |
Definition des Zugriffsüberprüfungszeitplans. |
Access |
Liste der Definitionen des Zugriffsüberprüfungszeitplans. |
Access |
Dieses Feld gibt den Typ der Prüfer für eine Überprüfung an. Normalerweise werden Prüfer für eine Überprüfung explizit zugewiesen. In einigen Fällen werden die Prüfer jedoch möglicherweise nicht zugewiesen und stattdessen dynamisch ausgewählt. Beispielsweise überprüfen Manager oder sich selbst. |
Access |
Dieses schreibgeschützte Feld gibt die status einer accessReview an. |
Access |
Der Status der Rollenzuweisung, der für die Überprüfung berechtigt/aktiv ist |
Access |
Der zu überprüfende Identitätstyp user/servicePrincipal |
Default |
Dies gibt das Verhalten für die AutoReview-Funktion an, wenn eine Zugriffsüberprüfung abgeschlossen ist. |
Error |
Fehler |
Error |
Fehler |
AccessReviewActorIdentityType
Der Identitätstyp : user/servicePrincipal
Name | Typ | Beschreibung |
---|---|---|
servicePrincipal |
string |
|
user |
string |
AccessReviewInstance
Access Review-Instanz.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Die Zugriffsüberprüfung instance ID. |
name |
string |
Die Zugriffsüberprüfung instance Namen. |
properties.backupReviewers |
Dies ist die Sammlung von Sicherungsprüfern. |
|
properties.endDateTime |
string |
DateTime, wenn das Ende der Überprüfung instance 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. Normalerweise werden Prüfer für eine Überprüfung explizit zugewiesen. In einigen Fällen werden die Prüfer jedoch möglicherweise nicht zugewiesen und stattdessen dynamisch ausgewählt. Beispielsweise überprüfen Manager oder sich selbst. |
|
properties.startDateTime |
string |
DateTime, wenn der Start der Überprüfung instance geplant ist. |
properties.status |
Dieses schreibgeschützte Feld gibt die status einer Zugriffsüberprüfung instance an. |
|
type |
string |
Der Ressourcentyp. |
AccessReviewInstanceReviewersType
Dieses Feld gibt den Typ der Prüfer für eine Überprüfung an. Normalerweise werden Prüfer für eine Überprüfung explizit zugewiesen. In einigen Fällen werden die Prüfer jedoch möglicherweise nicht zugewiesen und stattdessen dynamisch ausgewählt. Beispielsweise überprüfen Manager oder sich selbst.
Name | Typ | Beschreibung |
---|---|---|
Assigned |
string |
|
Managers |
string |
|
Self |
string |
AccessReviewInstanceStatus
Dieses schreibgeschützte Feld gibt die status einer Zugriffsüberprüfung instance an.
Name | Typ | Beschreibung |
---|---|---|
Applied |
string |
|
Applying |
string |
|
AutoReviewed |
string |
|
AutoReviewing |
string |
|
Completed |
string |
|
Completing |
string |
|
InProgress |
string |
|
Initializing |
string |
|
NotStarted |
string |
|
Scheduled |
string |
|
Starting |
string |
AccessReviewRecurrencePatternType
Der Wiederholungstyp: wöchentlich, monatlich usw.
Name | Typ | Beschreibung |
---|---|---|
absoluteMonthly |
string |
|
weekly |
string |
AccessReviewRecurrenceRangeType
Der Serienbereichstyp. Die möglichen Werte sind: endDate, noEnd, nummeriert.
Name | Typ | Beschreibung |
---|---|---|
endDate |
string |
|
noEnd |
string |
|
numbered |
string |
AccessReviewReviewer
Deskriptor für zu überprüfende Elemente
Name | Typ | Beschreibung |
---|---|---|
principalId |
string |
Die ID des Prüfers(user/servicePrincipal) |
principalType |
Der Identitätstyp : user/servicePrincipal |
AccessReviewReviewerType
Der Identitätstyp : user/servicePrincipal
Name | Typ | Beschreibung |
---|---|---|
servicePrincipal |
string |
|
user |
string |
AccessReviewScheduleDefinition
Definition des Zugriffsüberprüfungszeitplans.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Die Definitions-ID des Zugriffsüberprüfungszeitplans. |
name |
string |
Die eindeutige ID der Definition des Zugriffsüberprüfungszeitplans. |
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 Ersteller der Zugriffsüberprüfung bereitgestellt und für Administratoren sichtbar ist. |
properties.descriptionForReviewers |
string |
Die Vom Ersteller der Zugriffsüberprüfung bereitgestellte Beschreibung, die 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 sie erweitert werden. |
|
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. Normalerweise werden Prüfer für eine Überprüfung explizit zugewiesen. In einigen Fällen werden die Prüfer jedoch möglicherweise nicht zugewiesen und stattdessen dynamisch ausgewählt. Beispielsweise überprüfen Manager oder sich selbst. |
|
properties.scope.assignmentState |
Der Status der Rollenzuweisung, der für die Überprüfung berechtigt/aktiv ist |
|
properties.scope.excludeResourceId |
string |
Dies wird verwendet, um die auszuschließenden Ressourcen-IDs anzugeben. |
properties.scope.excludeRoleDefinitionId |
string |
Dies wird verwendet, um die auszuschließenden Rollendefinitions-IDs anzugeben. |
properties.scope.expandNestedMemberships |
boolean |
Flag, um anzugeben, ob geschachtelte Mitgliedschaften erweitert werden sollen. |
properties.scope.inactiveDuration |
string |
Dauer, für die Benutzer inaktiv sind. Der Wert sollte im ISO 8601-Format (http://en.wikipedia.org/wiki/ISO_8601#Durations) vorliegen. Dieser Code kann verwendet werden, um TimeSpan in eine gültige Intervallzeichenfolge zu konvertieren: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) |
properties.scope.includeAccessBelowResource |
boolean |
Flag, um anzugeben, ob geschachtelte Mitgliedschaften erweitert werden sollen. |
properties.scope.includeInheritedAccess |
boolean |
Flag, um anzugeben, ob geschachtelte Mitgliedschaften erweitert werden sollen. |
properties.scope.principalType |
Der zu überprüfende Identitätstyp user/servicePrincipal |
|
properties.scope.resourceId |
string |
ResourceId, in der diese Überprüfung erstellt wird |
properties.scope.roleDefinitionId |
string |
Dies wird verwendet, um die zu überprüfende Rolle anzugeben. |
properties.settings.autoApplyDecisionsEnabled |
boolean |
Flag, um anzugeben, ob die Automatisch anwendende Funktion zum automatischen Ändern der Zielobjektzugriffsressource 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 die AutoReview-Funktion an, wenn eine Zugriffsüberprüfung abgeschlossen ist. |
|
properties.settings.defaultDecisionEnabled |
boolean |
Flag, um anzugeben, ob Prüfer beim Überprüfen des Zugriffs eine Begründung angeben müssen. |
properties.settings.instanceDurationInDays |
integer |
Die Dauer in Tagen für eine instance. |
properties.settings.justificationRequiredOnApproval |
boolean |
Flag, um anzugeben, ob der Prüfer beim Aufzeichnen einer Entscheidung eine Begründung übergeben muss. |
properties.settings.mailNotificationsEnabled |
boolean |
Flag, um anzugeben, ob das Senden von E-Mails an Prüfer und den Ersteller der Überprüfung aktiviert ist. |
properties.settings.recommendationLookBackDuration |
string |
Empfehlungen für Zugriffsüberprüfungen werden standardmäßig anhand von Daten von 30 Tagen (mit dem Startdatum der Überprüfung) berechnet. In einigen Szenarien möchten Kunden jedoch ändern, wie weit zurück zu betrachten ist, und möchten stattdessen 60 Tage, 90 Tage usw. konfigurieren. Mit dieser Einstellung können Kunden diese Dauer konfigurieren. Der Wert sollte im ISO 8601-Format (http://en.wikipedia.org/wiki/ISO_8601#Durations) vorliegen. Dieser Code kann verwendet werden, um TimeSpan in eine gültige Intervallzeichenfolge zu konvertieren: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) |
properties.settings.recommendationsEnabled |
boolean |
Flag, um anzugeben, ob das Anzeigen von Empfehlungen für Prüfer aktiviert ist. |
properties.settings.recurrence.pattern.interval |
integer |
Das Intervall für die Wiederholung. Für eine vierteljährliche Überprüfung ist das Intervall 3 für den Typ : absoluteMonat. |
properties.settings.recurrence.pattern.type |
Der Wiederholungstyp: wöchentlich, monatlich usw. |
|
properties.settings.recurrence.range.endDate |
string |
DateTime, wenn das Ende der Überprüfung geplant ist. Erforderlich, wenn type endDate ist |
properties.settings.recurrence.range.numberOfOccurrences |
integer |
Die Anzahl der Wiederholungen der Zugriffsüberprüfung. Erforderlich und muss positiv sein, wenn der Typ nummeriert ist. |
properties.settings.recurrence.range.startDate |
string |
Der DateTime-Wert, wenn der Start der Überprüfung geplant ist. Dies könnte ein Datum in der Zukunft sein. Erforderlich beim Erstellen. |
properties.settings.recurrence.range.type |
Der Serienbereichstyp. Die möglichen Werte sind: endDate, noEnd, nummeriert. |
|
properties.settings.reminderNotificationsEnabled |
boolean |
Flag, um anzugeben, ob das Senden von Erinnerungs-E-Mails an Prüfer aktiviert ist. |
properties.status |
Dieses schreibgeschützte Feld gibt die status einer accessReview an. |
|
type |
string |
Der Ressourcentyp. |
AccessReviewScheduleDefinitionListResult
Liste der Definitionen des Zugriffsüberprüfungszeitplans.
Name | Typ | Beschreibung |
---|---|---|
nextLink |
string |
Die URL, die zum Abrufen des nächsten Resultsets verwendet werden soll. |
value |
Liste der Zugriffsüberprüfungszeitplandefinitionen |
AccessReviewScheduleDefinitionReviewersType
Dieses Feld gibt den Typ der Prüfer für eine Überprüfung an. Normalerweise werden Prüfer für eine Überprüfung explizit zugewiesen. In einigen Fällen werden die Prüfer jedoch möglicherweise nicht zugewiesen und stattdessen dynamisch ausgewählt. Beispielsweise überprüfen Manager oder sich selbst.
Name | Typ | Beschreibung |
---|---|---|
Assigned |
string |
|
Managers |
string |
|
Self |
string |
AccessReviewScheduleDefinitionStatus
Dieses schreibgeschützte Feld gibt die status einer accessReview an.
Name | Typ | Beschreibung |
---|---|---|
Applied |
string |
|
Applying |
string |
|
AutoReviewed |
string |
|
AutoReviewing |
string |
|
Completed |
string |
|
Completing |
string |
|
InProgress |
string |
|
Initializing |
string |
|
NotStarted |
string |
|
Scheduled |
string |
|
Starting |
string |
AccessReviewScopeAssignmentState
Der Status der Rollenzuweisung, der für die Überprüfung berechtigt/aktiv ist
Name | Typ | Beschreibung |
---|---|---|
active |
string |
|
eligible |
string |
AccessReviewScopePrincipalType
Der zu überprüfende Identitätstyp user/servicePrincipal
Name | Typ | Beschreibung |
---|---|---|
guestUser |
string |
|
redeemedGuestUser |
string |
|
servicePrincipal |
string |
|
user |
string |
|
user,group |
string |
DefaultDecisionType
Dies gibt das Verhalten für die AutoReview-Funktion an, wenn eine Zugriffsüberprüfung abgeschlossen ist.
Name | Typ | Beschreibung |
---|---|---|
Approve |
string |
|
Deny |
string |
|
Recommendation |
string |
ErrorDefinition
Fehler
Name | Typ | Beschreibung |
---|---|---|
error |
Fehler |
ErrorDefinitionProperties
Fehler
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Fehlercode des Listengateways. |
message |
string |
Beschreibung des Fehlers |