Access Review Schedule Definitions - List

액세스 검토 일정 정의 가져오기

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 매개 변수

Name In Required Type Description
subscriptionId
path True
  • string

대상 구독의 ID입니다.

api-version
query True
  • string

HTTP 요청과 함께 사용할 API 버전입니다.

$filter
query
  • string

작업에 적용할 필터입니다. 표준 필터 외에 하나의 사용자 지정 필터 옵션인 'assignedToMeToReview()'가 지원됩니다. 지정된 $filter=assignedToMeToReview()를 지정하면 검토할 호출 사용자에게 할당된 항목만 반환됩니다.

응답

Name Type Description
200 OK

성공적인 작업의 결과를 설명합니다.

Other Status Codes

예기치 않은 오류

보안

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation 사용자 계정 가장

예제

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

정의

AccessReviewActorIdentityType

ID 유형: user/servicePrincipal

AccessReviewInstance

Access Review Instance.

AccessReviewInstanceReviewersType

이 필드는 검토에 대한 검토자의 유형을 지정합니다. 일반적으로 검토의 경우 검토자가 명시적으로 할당됩니다. 그러나 경우에 따라 검토자가 할당되지 않고 동적으로 선택될 수 있습니다. 예를 들어 관리자는 검토하거나 자체 검토합니다.

AccessReviewInstanceStatus

이 읽기 전용 필드는 액세스 검토 인스턴스의 상태를 지정합니다.

AccessReviewRecurrencePatternType

되풀이 유형: 매주, 매월 등

AccessReviewRecurrenceRangeType

되풀이 범위 유형입니다. 가능한 값은 endDate, noEnd, numbered입니다.

AccessReviewReviewer

검토해야 하는 내용에 대한 설명자

AccessReviewReviewerType

ID 유형: user/servicePrincipal

AccessReviewScheduleDefinition

액세스 검토 일정 정의

AccessReviewScheduleDefinitionListResult

액세스 검토 일정 정의 목록입니다.

AccessReviewScheduleDefinitionReviewersType

이 필드는 검토에 대한 검토자의 유형을 지정합니다. 일반적으로 검토의 경우 검토자가 명시적으로 할당됩니다. 그러나 경우에 따라 검토자가 할당되지 않고 동적으로 선택될 수 있습니다. 예를 들어 관리자는 검토하거나 자체 검토합니다.

AccessReviewScheduleDefinitionStatus

이 읽기 전용 필드는 accessReview의 상태를 지정합니다.

AccessReviewScopeAssignmentState

검토할 적격/활성 역할 할당 상태

AccessReviewScopePrincipalType

검토할 ID 유형 사용자/servicePrincipal

DefaultDecisionType

액세스 검토가 완료되면 autoReview 기능에 대한 동작을 지정합니다.

ErrorDefinition

Error

ErrorDefinitionProperties

Error

AccessReviewActorIdentityType

ID 유형: user/servicePrincipal

Name Type Description
servicePrincipal
  • string
user
  • string

AccessReviewInstance

Access Review Instance.

Name Type Description
id
  • string

액세스 검토 인스턴스 ID입니다.

name
  • string

액세스 검토 인스턴스 이름입니다.

properties.backupReviewers

백업 검토자의 컬렉션입니다.

properties.endDateTime
  • string

검토 인스턴스가 종료되도록 예약된 DateTime입니다.

properties.reviewers

검토자의 컬렉션입니다.

properties.reviewersType

이 필드는 검토에 대한 검토자의 유형을 지정합니다. 일반적으로 검토의 경우 검토자가 명시적으로 할당됩니다. 그러나 경우에 따라 검토자가 할당되지 않고 동적으로 선택될 수 있습니다. 예를 들어 관리자는 검토하거나 자체 검토합니다.

properties.startDateTime
  • string

검토 인스턴스가 시작되도록 예약된 DateTime입니다.

properties.status

이 읽기 전용 필드는 액세스 검토 인스턴스의 상태를 지정합니다.

type
  • string

리소스 종류입니다.

AccessReviewInstanceReviewersType

이 필드는 검토에 대한 검토자의 유형을 지정합니다. 일반적으로 검토의 경우 검토자가 명시적으로 할당됩니다. 그러나 경우에 따라 검토자가 할당되지 않고 동적으로 선택될 수 있습니다. 예를 들어 관리자는 검토하거나 자체 검토합니다.

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

AccessReviewInstanceStatus

이 읽기 전용 필드는 액세스 검토 인스턴스의 상태를 지정합니다.

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

되풀이 유형: 매주, 매월 등

Name Type Description
absoluteMonthly
  • string
weekly
  • string

AccessReviewRecurrenceRangeType

되풀이 범위 유형입니다. 가능한 값은 endDate, noEnd, numbered입니다.

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

AccessReviewReviewer

검토해야 하는 내용에 대한 설명자

Name Type Description
principalId
  • string

검토자(user/servicePrincipal)의 ID입니다.

principalType

ID 유형: user/servicePrincipal

AccessReviewReviewerType

ID 유형: user/servicePrincipal

Name Type Description
servicePrincipal
  • string
user
  • string

AccessReviewScheduleDefinition

액세스 검토 일정 정의

Name Type Description
id
  • string

액세스 검토 일정 정의 ID입니다.

name
  • string

액세스 검토 일정 정의 고유 ID입니다.

properties.backupReviewers

백업 검토자의 컬렉션입니다.

properties.createdBy.principalId
  • string

ID ID

properties.createdBy.principalName
  • string

ID 표시 이름

properties.createdBy.principalType

ID 유형: user/servicePrincipal

properties.createdBy.userPrincipalName
  • string

사용자 계정 이름(유효한 경우)

properties.descriptionForAdmins
  • string

액세스 검토 작성자가 제공하고 관리자에게 표시되는 설명입니다.

properties.descriptionForReviewers
  • string

검토자에게 표시할 액세스 검토 작성자가 제공한 설명입니다.

properties.displayName
  • string

일정 정의의 표시 이름입니다.

properties.instances

확장할 때 반환되는 인스턴스의 컬렉션입니다.

properties.reviewers

검토자의 컬렉션입니다.

properties.reviewersType

이 필드는 검토에 대한 검토자의 유형을 지정합니다. 일반적으로 검토의 경우 검토자가 명시적으로 할당됩니다. 그러나 경우에 따라 검토자가 할당되지 않고 동적으로 선택될 수 있습니다. 예를 들어 관리자는 검토하거나 자체 검토합니다.

properties.scope.assignmentState

검토할 적격/활성 역할 할당 상태

properties.scope.expandNestedMemberships
  • boolean

중첩 멤버 자격을 확장할지 여부를 나타내는 플래그입니다.

properties.scope.inactiveDuration
  • string

기간 사용자가 비활성 상태입니다. 값은 ISO 8601 형식(http://en.wikipedia.org/wiki/ISO_8601#Durations)이어야 합니다. 이 코드를 사용하여 TimeSpan을 유효한 간격 문자열인 XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))으로 변환할 수 있습니다.

properties.scope.principalType

검토할 ID 유형 사용자/servicePrincipal

properties.scope.resourceId
  • string

이 검토가 만들어지는 ResourceId

properties.scope.roleDefinitionId
  • string

검토 중인 역할을 나타내는 데 사용됩니다.

properties.settings.autoApplyDecisionsEnabled
  • boolean

대상 개체 액세스 리소스를 자동으로 변경하는 자동 적용 기능을 사용할 수 있는지 여부를 나타내는 플래그입니다. 사용하도록 설정하지 않은 경우 사용자는 검토가 완료된 후 액세스 검토를 적용해야 합니다.

properties.settings.defaultDecision

액세스 검토가 완료되면 autoReview 기능에 대한 동작을 지정합니다.

properties.settings.defaultDecisionEnabled
  • boolean

액세스를 검토할 때 검토자가 근거를 제공해야 하는지 여부를 나타내는 플래그입니다.

properties.settings.instanceDurationInDays
  • integer

인스턴스의 기간(일)입니다.

properties.settings.justificationRequiredOnApproval
  • boolean

결정을 기록할 때 검토자가 근거를 전달해야 하는지 여부를 나타내는 플래그입니다.

properties.settings.mailNotificationsEnabled
  • boolean

검토자와 검토 작성자에게 메일을 보낼 수 있는지 여부를 나타내는 플래그입니다.

properties.settings.recommendationLookBackDuration
  • string

액세스 검토에 대한 권장 사항은 기본적으로 30일의 데이터(검토 시작 날짜 w.r.t)를 다시 확인하여 계산됩니다. 그러나 일부 시나리오에서 고객은 60일, 90일 등을 구성하는 방법을 변경하려고 합니다. 이 설정을 통해 고객은 이 기간을 구성할 수 있습니다. 값은 ISO 8601 형식(http://en.wikipedia.org/wiki/ISO_8601#Durations)이어야 합니다. 이 코드를 사용하여 TimeSpan을 유효한 간격 문자열인 XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))으로 변환할 수 있습니다.

properties.settings.recommendationsEnabled
  • boolean

검토자에게 권장 사항을 표시할 수 있는지 여부를 나타내는 플래그입니다.

properties.settings.recurrence.pattern.interval
  • integer

되풀이 간격입니다. 분기별 검토의 경우 간격은 형식: absoluteMonthly에 대해 3입니다.

properties.settings.recurrence.pattern.type

되풀이 유형: 매주, 매월 등

properties.settings.recurrence.range.endDate
  • string

검토가 종료될 예정인 DateTime입니다. type이 endDate인 경우 필수

properties.settings.recurrence.range.numberOfOccurrences
  • integer

액세스 검토를 반복할 횟수입니다. 필수이며 형식 번호가 매겨진 경우 양수여야 합니다.

properties.settings.recurrence.range.startDate
  • string

검토가 시작되도록 예약된 DateTime입니다. 이것은 미래의 날짜가 될 수 있습니다. 만들기에 필요합니다.

properties.settings.recurrence.range.type

되풀이 범위 유형입니다. 가능한 값은 endDate, noEnd, numbered입니다.

properties.settings.reminderNotificationsEnabled
  • boolean

검토자에게 미리 알림 이메일을 보낼 수 있는지 여부를 나타내는 플래그입니다.

properties.status

이 읽기 전용 필드는 accessReview의 상태를 지정합니다.

type
  • string

리소스 종류입니다.

AccessReviewScheduleDefinitionListResult

액세스 검토 일정 정의 목록입니다.

Name Type Description
nextLink
  • string

다음 결과 집합을 가져오는 데 사용할 URL입니다.

value

액세스 검토 일정 정의 목록

AccessReviewScheduleDefinitionReviewersType

이 필드는 검토에 대한 검토자의 유형을 지정합니다. 일반적으로 검토의 경우 검토자가 명시적으로 할당됩니다. 그러나 경우에 따라 검토자가 할당되지 않고 동적으로 선택될 수 있습니다. 예를 들어 관리자는 검토하거나 자체 검토합니다.

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

AccessReviewScheduleDefinitionStatus

이 읽기 전용 필드는 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

검토할 적격/활성 역할 할당 상태

Name Type Description
active
  • string
eligible
  • string

AccessReviewScopePrincipalType

검토할 ID 유형 사용자/servicePrincipal

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

DefaultDecisionType

액세스 검토가 완료되면 autoReview 기능에 대한 동작을 지정합니다.

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

ErrorDefinition

Error

Name Type Description
error

Error
목록 게이트웨이 상태의 오류입니다.

ErrorDefinitionProperties

Error

Name Type Description
code
  • string

목록 게이트웨이의 오류 코드입니다.

message
  • string

오류 설명입니다.