Freigeben über


Scope Access Review History Definition - Create

Erstellen einer geplanten oder einmaligen Access Review History Definition

PUT https://management.azure.com/{scope}/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 Zugriffsüberprüfungsverlaufsdefinition.

scope
path True

string

Der Bereich der Ressource.

api-version
query True

string

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

Anforderungstext

Name Typ Beschreibung
decisions

AccessReviewResult[]

Sammlung von Überprüfungsentscheidungen, nach denen die Verlaufsdaten gefiltert werden sollen. Wenn beispielsweise "Genehmigen" und "Verweigern" angegeben werden, enthalten die Daten nur Rezensionsergebnisse, in denen der Entscheidungsträger eine Überprüfungsanforderung genehmigt oder verweigert hat.

displayName

string

Der Anzeigename für die Verlaufsdefinition.

instances

AccessReviewHistoryInstance[]

Satz von Zugriffsüberprüfungsverlaufsinstanzen für diese Verlaufsdefinition.

scopes

AccessReviewScope[]

Eine Sammlung von Bereichen, die beim Auswählen von Überprüfungsverlaufsdaten verwendet werden

settings.pattern.interval

integer (int32)

Das Intervall für Serien. Bei einer vierteljährlichen Überprüfung ist das Intervall 3 für typ : absoluteMonthly.

settings.pattern.type

AccessReviewRecurrencePatternType

Der Serientyp : wöchentlich, monatlich usw.

settings.range.endDate

string (date-time)

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

settings.range.numberOfOccurrences

integer (int32)

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

settings.range.startDate

string (date-time)

DateTime, wann die Überprüfung geplant ist. Dies könnte ein Datum in der Zukunft sein. Erforderlich beim Erstellen.

settings.range.type

AccessReviewRecurrenceRangeType

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

Antworten

Name Typ Beschreibung
200 OK

AccessReviewHistoryDefinition

AccessReviewHistoryDefinition

Other Status Codes

ErrorDefinition

Unerwarteter Fehler

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

PutAccessReviewHistoryDefinition

Beispielanforderung

PUT https://management.azure.com/subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a/providers/Microsoft.Authorization/accessReviewHistoryDefinitions/44724910-d7a5-4c29-b28f-db73e717165a?api-version=2021-12-01-preview

{}

Beispiel für eine Antwort

{
  "id": "/subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a/providers/Microsoft.Authorization/accessReviewHistoryDefinitions/44724910-d7a5-4c29-b28f-db73e717165a",
  "name": "44724910-d7a5-4c29-b28f-db73e717165a",
  "type": "Microsoft.Authorization/accessReviewHistoryDefinition",
  "properties": {
    "displayName": "Hello world name",
    "reviewHistoryPeriodStartDateTime": "2021-10-01T00:00:00-07:00",
    "reviewHistoryPeriodEndDateTime": "2021-12-01T00:00:00-08:00",
    "decisions": [
      "Approve",
      "Deny",
      "NotReviewed",
      "DontKnow",
      "NotNotified"
    ],
    "status": "Requested",
    "createdDateTime": "2021-12-23T00:27:33.6905189+00:00",
    "createdBy": {
      "principalId": "673ad0d8-7b0e-4201-aaeb-74cdcbf22af9",
      "principalType": null,
      "principalName": "levi",
      "userPrincipalName": "levi"
    },
    "scopes": [
      {
        "resourceId": "/subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a",
        "roleDefinitionId": "/subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a/providers/Microsoft.Authorization/roleDefinitions",
        "principalType": "user",
        "assignmentState": null,
        "inactiveDuration": null,
        "expandNestedMemberships": true
      },
      {
        "resourceId": "/subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a",
        "roleDefinitionId": "/subscriptions/129a304b-4aea-4b86-a9f7-ba7e2b23737a/providers/Microsoft.Authorization/roleDefinitions/1562cf42-00b9-457c-86ef-5702d4132904",
        "principalType": "user",
        "assignmentState": null,
        "inactiveDuration": null,
        "expandNestedMemberships": false
      }
    ],
    "settings": {
      "range": {
        "type": "endDate",
        "numberOfOccurrences": 1,
        "startDate": "2021-12-01T00:00:00-08:00",
        "endDate": "2023-12-01T00:00:00-08:00"
      }
    },
    "instances": null
  }
}

Definitionen

Name Beschreibung
AccessReviewActorIdentityType

Der Identitätstyp : user/servicePrincipal

AccessReviewHistoryDefinition

Access Review History Definition.

AccessReviewHistoryDefinitionProperties

Access Review History Instances.

AccessReviewHistoryDefinitionStatus

Dieses schreibgeschützte Feld gibt die angeforderten Überprüfungsverlaufsdaten an. Dies wird entweder angefordert, in Bearbeitung ausgeführt, ausgeführt oder fehler.

AccessReviewHistoryInstance

Access Review History Definition Instance.

AccessReviewRecurrencePatternType

Der Serientyp : wöchentlich, monatlich usw.

AccessReviewRecurrenceRangeType

Der Serienbereichstyp. 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" angegeben werden, enthalten die Daten nur Rezensionsergebnisse, in denen der Entscheidungsträger eine Überprüfungsanforderung genehmigt oder verweigert hat.

AccessReviewScope

Beschreibung, was überprüft werden muss

AccessReviewScopeAssignmentState

Der zu überprüfende Rollenzuweisungsstatus/-aktiv

AccessReviewScopePrincipalType

Der zu überprüfende Identitätstyp "user/servicePrincipal"

ErrorDefinition

Fehler

ErrorDefinitionProperties

Fehler

AccessReviewActorIdentityType

Der Identitätstyp : user/servicePrincipal

Wert Beschreibung
servicePrincipal
user

AccessReviewHistoryDefinition

Access Review History Definition.

Name Typ Beschreibung
id

string

Die Id der Zugriffsüberprüfungsverlaufsdefinition.

name

string

Eindeutige ID der Zugriffsüberprüfungsverlaufsdefinition.

properties.createdBy.principalId

string

Die Identitäts-ID

properties.createdBy.principalName

string

Der Anzeigename der Identität

properties.createdBy.principalType

AccessReviewActorIdentityType

Der Identitätstyp : user/servicePrincipal

properties.createdBy.userPrincipalName

string

Der Benutzerprinzipalname(sofern gültig)

properties.createdDateTime

string (date-time)

Datum, zu dem die Verlaufsdefinition erstellt wurde

properties.decisions

AccessReviewResult[]

Sammlung von Überprüfungsentscheidungen, nach denen die Verlaufsdaten gefiltert werden sollen. Wenn beispielsweise "Genehmigen" und "Verweigern" angegeben werden, enthalten die Daten nur Rezensionsergebnisse, in denen der Entscheidungsträger eine Überprüfungsanforderung genehmigt oder verweigert hat.

properties.displayName

string

Der Anzeigename für die Verlaufsdefinition.

properties.instances

AccessReviewHistoryInstance[]

Satz von Zugriffsüberprüfungsverlaufsinstanzen für diese Verlaufsdefinition.

properties.reviewHistoryPeriodEndDateTime

string (date-time)

Datum, die beim Auswählen von Überprüfungsdaten verwendet wird, alle Rezensionen, die am oder vor diesem Datum im Datenende enthalten sind. Wird nur für einmalige/nicht wiederkehrende Berichte verwendet.

properties.reviewHistoryPeriodStartDateTime

string (date-time)

Datum, die beim Auswählen von Rezensionsdaten verwendet wird, alle Rezensionen, die in den Daten enthalten sind, beginnen am oder nach diesem Datum. Wird nur für einmalige/nicht wiederkehrende Berichte verwendet.

properties.scopes

AccessReviewScope[]

Eine Sammlung von Bereichen, die beim Auswählen von Überprüfungsverlaufsdaten verwendet werden

properties.settings.pattern.interval

integer (int32)

Das Intervall für Serien. Bei einer vierteljährlichen Überprüfung ist das Intervall 3 für typ : absoluteMonthly.

properties.settings.pattern.type

AccessReviewRecurrencePatternType

Der Serientyp : wöchentlich, monatlich usw.

properties.settings.range.endDate

string (date-time)

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

properties.settings.range.numberOfOccurrences

integer (int32)

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

properties.settings.range.startDate

string (date-time)

DateTime, wann die Überprüfung geplant ist. Dies könnte ein Datum in der Zukunft sein. Erforderlich beim Erstellen.

properties.settings.range.type

AccessReviewRecurrenceRangeType

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

properties.status

AccessReviewHistoryDefinitionStatus

Dieses schreibgeschützte Feld gibt die angeforderten Überprüfungsverlaufsdaten an. Dies wird entweder angefordert, in Bearbeitung ausgeführt, ausgeführt oder fehler.

type

string

Der Ressourcentyp.

AccessReviewHistoryDefinitionProperties

Access Review History Instances.

Name Typ Beschreibung
createdBy.principalId

string

Die Identitäts-ID

createdBy.principalName

string

Der Anzeigename der Identität

createdBy.principalType

AccessReviewActorIdentityType

Der Identitätstyp : user/servicePrincipal

createdBy.userPrincipalName

string

Der Benutzerprinzipalname(sofern gültig)

createdDateTime

string (date-time)

Datum, zu dem die Verlaufsdefinition erstellt wurde

decisions

AccessReviewResult[]

Sammlung von Überprüfungsentscheidungen, nach denen die Verlaufsdaten gefiltert werden sollen. Wenn beispielsweise "Genehmigen" und "Verweigern" angegeben werden, enthalten die Daten nur Rezensionsergebnisse, in denen der Entscheidungsträger eine Überprüfungsanforderung genehmigt oder verweigert hat.

displayName

string

Der Anzeigename für die Verlaufsdefinition.

instances

AccessReviewHistoryInstance[]

Satz von Zugriffsüberprüfungsverlaufsinstanzen für diese Verlaufsdefinition.

reviewHistoryPeriodEndDateTime

string (date-time)

Datum, die beim Auswählen von Überprüfungsdaten verwendet wird, alle Rezensionen, die am oder vor diesem Datum im Datenende enthalten sind. Wird nur für einmalige/nicht wiederkehrende Berichte verwendet.

reviewHistoryPeriodStartDateTime

string (date-time)

Datum, die beim Auswählen von Rezensionsdaten verwendet wird, alle Rezensionen, die in den Daten enthalten sind, beginnen am oder nach diesem Datum. Wird nur für einmalige/nicht wiederkehrende Berichte verwendet.

scopes

AccessReviewScope[]

Eine Sammlung von Bereichen, die beim Auswählen von Überprüfungsverlaufsdaten verwendet werden

settings.pattern.interval

integer (int32)

Das Intervall für Serien. Bei einer vierteljährlichen Überprüfung ist das Intervall 3 für typ : absoluteMonthly.

settings.pattern.type

AccessReviewRecurrencePatternType

Der Serientyp : wöchentlich, monatlich usw.

settings.range.endDate

string (date-time)

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

settings.range.numberOfOccurrences

integer (int32)

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

settings.range.startDate

string (date-time)

DateTime, wann die Überprüfung geplant ist. Dies könnte ein Datum in der Zukunft sein. Erforderlich beim Erstellen.

settings.range.type

AccessReviewRecurrenceRangeType

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

status

AccessReviewHistoryDefinitionStatus

Dieses schreibgeschützte Feld gibt die angeforderten Überprüfungsverlaufsdaten an. Dies wird entweder angefordert, in Bearbeitung ausgeführt, ausgeführt oder fehler.

AccessReviewHistoryDefinitionStatus

Dieses schreibgeschützte Feld gibt die angeforderten Überprüfungsverlaufsdaten an. Dies wird entweder angefordert, in Bearbeitung ausgeführt, ausgeführt oder fehler.

Wert Beschreibung
Done
Error
InProgress
Requested

AccessReviewHistoryInstance

Access Review History Definition Instance.

Name Typ Beschreibung
id

string

Die Id der Zugriffsüberprüfungsverlaufsdefinitionsinstanz.

name

string

Die eindeutige ID der Zugriffsüberprüfungsverlaufsdefinitionsinstanz.

properties.displayName

string

Der Anzeigename für die übergeordnete Verlaufsdefinition.

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 sehen, indem Sie den Parameter "se" im generierten URI betrachten.

properties.expiration

string (date-time)

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

properties.fulfilledDateTime

string (date-time)

Datum, zu dem der Verlaufsdatenbericht generiert werden soll.

properties.reviewHistoryPeriodEndDateTime

string (date-time)

Datum, die beim Auswählen von Überprüfungsdaten verwendet wird, alle Rezensionen, die am oder vor diesem Datum im Datenende enthalten sind. Wird nur für einmalige/nicht wiederkehrende Berichte verwendet.

properties.reviewHistoryPeriodStartDateTime

string (date-time)

Datum, die beim Auswählen von Rezensionsdaten verwendet wird, alle Rezensionen, die in den Daten enthalten sind, beginnen am oder nach diesem Datum. Wird nur für einmalige/nicht wiederkehrende Berichte verwendet.

properties.runDateTime

string (date-time)

Datum, zu dem der Verlaufsdatenbericht generiert werden soll.

properties.status

AccessReviewHistoryDefinitionStatus

Status der angeforderten Überprüfungsverlaufsinstanzdaten. Dies wird entweder angefordert, in Bearbeitung ausgeführt, ausgeführt oder fehler. Die Statusübergänge sind wie folgt : Angefordert -> InProgress -> Done -> Abgelaufen

type

string

Der Ressourcentyp.

AccessReviewRecurrencePatternType

Der Serientyp : wöchentlich, monatlich usw.

Wert Beschreibung
absoluteMonthly
weekly

AccessReviewRecurrenceRangeType

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

Wert Beschreibung
endDate
noEnd
numbered

AccessReviewResult

Sammlung von Überprüfungsentscheidungen, nach denen die Verlaufsdaten gefiltert werden sollen. Wenn beispielsweise "Genehmigen" und "Verweigern" angegeben werden, enthalten die Daten nur Rezensionsergebnisse, in denen der Entscheidungsträger eine Überprüfungsanforderung genehmigt oder verweigert hat.

Wert Beschreibung
Approve
Deny
DontKnow
NotNotified
NotReviewed

AccessReviewScope

Beschreibung, was überprüft werden muss

Name Typ Beschreibung
assignmentState

AccessReviewScopeAssignmentState

Der zu überprüfende Rollenzuweisungsstatus/-aktiv

excludeResourceId

string

Dies wird verwendet, um die auszuschließenden Ressourcen-IDs anzugeben.

excludeRoleDefinitionId

string

Dies wird verwendet, um die auszuschließenden Rollendefinitions-IDs anzugeben.

expandNestedMemberships

boolean

Kennzeichnen, um anzugeben, ob geschachtelte Mitgliedschaften erweitert werden sollen.

inactiveDuration

string (duration)

Dauer, für die Benutzer inaktiv sind. Der Wert sollte im ISO 8601-Format (http://en.wikipedia.org/wiki/ISO_8601#Durations) sein. Dieser Code kann verwendet werden, um TimeSpan in eine gültige Intervallzeichenfolge zu konvertieren: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))

includeAccessBelowResource

boolean

Kennzeichnen, um anzugeben, ob geschachtelte Mitgliedschaften erweitert werden sollen.

includeInheritedAccess

boolean

Kennzeichnen, um anzugeben, ob geschachtelte Mitgliedschaften erweitert werden sollen.

principalType

AccessReviewScopePrincipalType

Der zu überprüfende Identitätstyp "user/servicePrincipal"

resourceId

string

ResourceId, in der diese Überprüfung erstellt wird

roleDefinitionId

string

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

AccessReviewScopeAssignmentState

Der zu überprüfende Rollenzuweisungsstatus/-aktiv

Wert Beschreibung
active
eligible

AccessReviewScopePrincipalType

Der zu überprüfende Identitätstyp "user/servicePrincipal"

Wert Beschreibung
guestUser
redeemedGuestUser
servicePrincipal
user
user,group

ErrorDefinition

Fehler

Name Typ Beschreibung
error

ErrorDefinitionProperties

Fehler
Fehler des Listengatewaystatus.

ErrorDefinitionProperties

Fehler

Name Typ Beschreibung
code

string

Fehlercode des Listengateways.

message

string

Beschreibung des Fehlers.