Freigeben über


Access Review History Definitions - Get By Id

Abrufen der Definition des Zugriffsüberprüfungsverlaufs nach Definition ID

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewHistoryDefinitions/{historyDefinitionId}?api-version=2021-12-01-preview

URI-Parameter

Name In Erforderlich Typ Beschreibung
historyDefinitionId
path True

string

Die ID der Definition des Zugriffsüberprüfungsverlaufs.

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.

Antworten

Name Typ Beschreibung
200 OK

AccessReviewHistoryDefinition

AccessReviewHistoryDefinition

Other Status Codes

ErrorDefinition

Unerwarteter Fehler

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Definitionen

Name Beschreibung
AccessReviewActorIdentityType

Der Identitätstyp : user/servicePrincipal

AccessReviewHistoryDefinition

Definition des Zugriffsüberprüfungsverlaufs.

AccessReviewHistoryDefinitionStatus

Dieses schreibgeschützte Feld gibt die der angeforderten Überprüfungsverlaufsdaten an. Dies ist entweder angefordert, in Bearbeitung, fertig oder fehler.

AccessReviewHistoryInstance

Zugriffsüberprüfungsverlaufsdefinitionsinstanz.

AccessReviewRecurrencePatternType

Der Wiederholungstyp: wöchentlich, monatlich usw.

AccessReviewRecurrenceRangeType

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

AccessReviewResult

Sammlung von Überprüfungsentscheidungen, nach denen die Verlaufsdaten gefiltert werden sollen. Wenn beispielsweise Genehmigen und Verweigern bereitgestellt werden, enthalten die Daten nur Überprüfungsergebnisse, bei denen der Entscheidungsträger eine Überprüfungsanforderung genehmigt oder abgelehnt hat.

AccessReviewScope

Deskriptor für zu überprüfende Elemente

AccessReviewScopeAssignmentState

Der Zu überprüfende Rollenzuweisungsstatus ist berechtigt/aktiv

AccessReviewScopePrincipalType

Der Zu überprüfende Identitätstyp "Benutzer/DienstPrincipal"

ErrorDefinition

Fehler

ErrorDefinitionProperties

Fehler

AccessReviewActorIdentityType

Der Identitätstyp : user/servicePrincipal

Name Typ Beschreibung
servicePrincipal

string

user

string

AccessReviewHistoryDefinition

Definition des Zugriffsüberprüfungsverlaufs.

Name Typ Beschreibung
id

string

Die Zugriffsüberprüfungsverlaufsdefinitions-ID.

name

string

Die eindeutige ID der Definition des Zugriffsüberprüfungsverlaufs.

properties.createdBy.principalId

string

Die Identitäts-ID

properties.createdBy.principalName

string

Der Identitätsanzeigename

properties.createdBy.principalType

AccessReviewActorIdentityType

Der Identitätstyp : user/servicePrincipal

properties.createdBy.userPrincipalName

string

Der Benutzerprinzipalname (sofern gültig)

properties.createdDateTime

string

Datum der Erstellung der Verlaufsdefinition

properties.decisions

AccessReviewResult[]

Sammlung von Überprüfungsentscheidungen, nach denen die Verlaufsdaten gefiltert werden sollen. Wenn beispielsweise Genehmigen und Verweigern bereitgestellt werden, enthalten die Daten nur Überprüfungsergebnisse, bei denen der Entscheidungsträger eine Überprüfungsanforderung genehmigt oder abgelehnt hat.

properties.displayName

string

Der Anzeigename für die Verlaufsdefinition.

properties.instances

AccessReviewHistoryInstance[]

Eine Gruppe von Zugriffsüberprüfungsverlaufsinstanzen für diese Verlaufsdefinition.

properties.reviewHistoryPeriodEndDateTime

string

Datumszeit, die bei der Auswahl von Überprüfungsdaten verwendet wird, alle überprüfungen, die in Daten enthalten sind, enden am oder vor diesem Datum. Nur zur Verwendung mit einmaligen/nicht wiederkehrenden Berichten.

properties.reviewHistoryPeriodStartDateTime

string

Datum, die bei der Auswahl von Überprüfungsdaten verwendet wird, beginnen alle überprüfungen, die in den Daten enthalten sind, ab oder nach diesem Datum. Nur zur Verwendung mit einmaligen/nicht wiederkehrenden Berichten.

properties.scopes

AccessReviewScope[]

Eine Sammlung von Bereichen, die bei der Auswahl von Überprüfungsverlaufsdaten verwendet werden

properties.settings.pattern.interval

integer

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

properties.settings.pattern.type

AccessReviewRecurrencePatternType

Der Wiederholungstyp: wöchentlich, monatlich usw.

properties.settings.range.endDate

string

Die DateTime, wenn das Ende der Überprüfung geplant ist. Erforderlich, wenn der Typ endDate ist

properties.settings.range.numberOfOccurrences

integer

Die Anzahl der Wiederholungen der Zugriffsüberprüfung. Erforderlich und muss positiv sein, wenn der Typ nummeriert ist.

properties.settings.range.startDate

string

Die DateTime, bei der die Überprüfung gestartet werden soll. Dies könnte ein Datum in der Zukunft sein. Erforderlich beim Erstellen.

properties.settings.range.type

AccessReviewRecurrenceRangeType

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

properties.status

AccessReviewHistoryDefinitionStatus

Dieses schreibgeschützte Feld gibt die der angeforderten Überprüfungsverlaufsdaten an. Dies ist entweder angefordert, in Bearbeitung, fertig oder fehler.

type

string

Der Ressourcentyp.

AccessReviewHistoryDefinitionStatus

Dieses schreibgeschützte Feld gibt die der angeforderten Überprüfungsverlaufsdaten an. Dies ist entweder angefordert, in Bearbeitung, fertig oder fehler.

Name Typ Beschreibung
Done

string

Error

string

InProgress

string

Requested

string

AccessReviewHistoryInstance

Zugriffsüberprüfungsverlaufsdefinitionsinstanz.

Name Typ Beschreibung
id

string

Die Definition des Zugriffsüberprüfungsverlaufs instance ID.

name

string

Die Definition des Zugriffsüberprüfungsverlaufs instance eindeutige ID.

properties.displayName

string

Der Anzeigename für die definition des übergeordneten Verlaufs.

properties.downloadUri

string

URI, der zum Abrufen von Überprüfungsverlaufsdaten verwendet werden kann. Um diesen Uri zu generieren, muss generateDownloadUri() für eine bestimmte accessReviewHistoryDefinitionInstance aufgerufen werden. Der Link läuft nach einem Zeitraum von 24 Stunden ab. Aufrufer können die Ablaufdatumszeit anzeigen, indem sie den Parameter "se" im generierten URI betrachten.

properties.expiration

string

Datum, zu der der Verlaufsdatenbericht abläuft und die zugehörigen Daten gelöscht werden.

properties.fulfilledDateTime

string

Datum, zu der der Verlaufsdatenbericht generiert werden soll.

properties.reviewHistoryPeriodEndDateTime

string

Datumszeit, die bei der Auswahl von Überprüfungsdaten verwendet wird, alle überprüfungen, die in Daten enthalten sind, enden am oder vor diesem Datum. Nur zur Verwendung mit einmaligen/nicht wiederkehrenden Berichten.

properties.reviewHistoryPeriodStartDateTime

string

Datum, die bei der Auswahl von Überprüfungsdaten verwendet wird, beginnen alle überprüfungen, die in den Daten enthalten sind, ab oder nach diesem Datum. Nur zur Verwendung mit einmaligen/nicht wiederkehrenden Berichten.

properties.runDateTime

string

Datum, zu der der Verlaufsdatenbericht generiert werden soll.

properties.status

AccessReviewHistoryDefinitionStatus

Status des angeforderten Überprüfungsverlaufs instance Daten. Dies ist entweder angefordert, in Bearbeitung, fertig oder fehler. Die Zustandsübergänge sind wie folgt: Angefordert –> InProgress –> Done –> Expired

type

string

Der Ressourcentyp.

AccessReviewRecurrencePatternType

Der Wiederholungstyp: wöchentlich, monatlich usw.

Name Typ Beschreibung
absoluteMonthly

string

weekly

string

AccessReviewRecurrenceRangeType

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

Name Typ Beschreibung
endDate

string

noEnd

string

numbered

string

AccessReviewResult

Sammlung von Überprüfungsentscheidungen, nach denen die Verlaufsdaten gefiltert werden sollen. Wenn beispielsweise Genehmigen und Verweigern bereitgestellt werden, enthalten die Daten nur Überprüfungsergebnisse, bei denen der Entscheidungsträger eine Überprüfungsanforderung genehmigt oder abgelehnt hat.

Name Typ Beschreibung
Approve

string

Deny

string

DontKnow

string

NotNotified

string

NotReviewed

string

AccessReviewScope

Deskriptor für zu überprüfende Elemente

Name Typ Beschreibung
assignmentState

AccessReviewScopeAssignmentState

Der Zu überprüfende Rollenzuweisungsstatus ist berechtigt/aktiv

excludeResourceId

string

Dies wird verwendet, um die auszuschließenden Ressourcen-ID(en) anzugeben.

excludeRoleDefinitionId

string

Dies wird verwendet, um die auszuschließenden Rollendefinitions-ID(en) anzugeben.

expandNestedMemberships

boolean

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

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))

includeAccessBelowResource

boolean

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

includeInheritedAccess

boolean

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

principalType

AccessReviewScopePrincipalType

Der Zu überprüfende Identitätstyp "Benutzer/DienstPrincipal"

resourceId

string

ResourceId, in der diese Überprüfung erstellt wird

roleDefinitionId

string

Dies wird verwendet, um die zu überprüfende Rolle anzugeben.

AccessReviewScopeAssignmentState

Der Zu überprüfende Rollenzuweisungsstatus ist berechtigt/aktiv

Name Typ Beschreibung
active

string

eligible

string

AccessReviewScopePrincipalType

Der Zu überprüfende Identitätstyp "Benutzer/DienstPrincipal"

Name Typ Beschreibung
guestUser

string

redeemedGuestUser

string

servicePrincipal

string

user

string

user,group

string

ErrorDefinition

Fehler

Name Typ Beschreibung
error

ErrorDefinitionProperties

Fehler
Fehler des listengateways status.

ErrorDefinitionProperties

Fehler

Name Typ Beschreibung
code

string

Fehlercode des Listengateways.

message

string

Beschreibung des Fehlers