次の方法で共有


Access Review Schedule Definitions - Create Or Update By Id

アクセス レビュー スケジュール定義を作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/accessReviewScheduleDefinitions/{scheduleDefinitionId}?api-version=2021-12-01-preview

URI パラメーター

名前 / 必須 説明
scheduleDefinitionId
path True

string

アクセス レビュー スケジュール定義の ID。

subscriptionId
path True

string

ターゲット サブスクリプションの ID。

api-version
query True

string

HTTP 要求で使用される API バージョン。

要求本文

名前 説明
backupReviewers

AccessReviewReviewer[]

これはバックアップ レビュー担当者のコレクションです。

descriptionForAdmins

string

アクセス レビュー作成者によって提供され、管理者に表示される説明。

descriptionForReviewers

string

レビュー担当者に表示されるアクセス レビュー作成者によって提供される説明。

displayName

string

スケジュール定義の表示名。

instances

AccessReviewInstance[]

これは、展開時に返されるインスタンスのコレクションです。

reviewers

AccessReviewReviewer[]

これは校閲者のコレクションです。

scope.excludeResourceId

string

これは、除外するリソース ID を示すために使用されます

scope.excludeRoleDefinitionId

string

これは、除外するロール定義 ID を示すために使用されます

scope.expandNestedMemberships

boolean

入れ子になったメンバーシップを展開するかどうかを示すフラグ。

scope.inactiveDuration

string (duration)

ユーザーが非アクティブな期間。 値は ISO 8601 形式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) である必要があります。このコードを使用して、TimeSpan を有効な間隔文字列 XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) に変換できます。

scope.includeAccessBelowResource

boolean

入れ子になったメンバーシップを展開するかどうかを示すフラグ。

scope.includeInheritedAccess

boolean

入れ子になったメンバーシップを展開するかどうかを示すフラグ。

settings.autoApplyDecisionsEnabled

boolean

ターゲット オブジェクト アクセス リソースを自動的に変更する自動適用機能が有効かどうかを示すフラグ。 有効になっていない場合、ユーザーはレビューが完了したら、アクセス レビューを適用する必要があります。

settings.defaultDecision

DefaultDecisionType

これにより、アクセス レビューが完了したときの autoReview 機能の動作が指定されます。

settings.defaultDecisionEnabled

boolean

レビュー担当者がアクセスをレビューするときに正当な理由を提供する必要があるかどうかを示すフラグ。

settings.instanceDurationInDays

integer (int32)

インスタンスの期間 (日数)。

settings.justificationRequiredOnApproval

boolean

レビュー担当者が決定を記録するときに正当な理由を渡す必要があるかどうかを示すフラグ。

settings.mailNotificationsEnabled

boolean

校閲者とレビュー作成者にメールを送信するかどうかを示すフラグ。

settings.recommendationLookBackDuration

string (duration)

アクセス レビューの推奨事項は、既定で 30 日間のデータ (レビューの開始日) を振り返って計算されます。 ただし、一部のシナリオでは、顧客は、60 日、90 日などを確認し、構成する距離を変更する必要があります。 この設定により、お客様はこの期間を構成できます。 値は ISO 8601 形式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) である必要があります。このコードを使用して、TimeSpan を有効な間隔文字列 XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) に変換できます。

settings.recommendationsEnabled

boolean

レビュー担当者への推奨事項の表示が有効かどうかを示すフラグ。

settings.recurrence.pattern.interval

integer (int32)

繰り返しの間隔。 四半期ごとのレビューでは、種類 : absoluteMonthly の間隔は 3 です。

settings.recurrence.pattern.type

AccessReviewRecurrencePatternType

繰り返しの種類: 毎週、毎月など。

settings.recurrence.range.endDate

string (date-time)

レビューが終了するようにスケジュールされている DateTime。 型が endDate の場合は必須

settings.recurrence.range.numberOfOccurrences

integer (int32)

アクセス レビューを繰り返す回数。 型に番号を付ける場合は、必ず正の値を指定する必要があります。

settings.recurrence.range.startDate

string (date-time)

レビューの開始がスケジュールされている DateTime。 これは将来の日付になる可能性があります。 作成時に必要です。

settings.recurrence.range.type

AccessReviewRecurrenceRangeType

繰り返し範囲の種類。 指定できる値は、endDate、noEnd、numbered です。

settings.reminderNotificationsEnabled

boolean

レビュー担当者へのリマインダー メールの送信が有効かどうかを示すフラグ。

応答

名前 説明
200 OK

AccessReviewScheduleDefinition

正常に更新されました

Other Status Codes

ErrorDefinition

予期しないエラー

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

定義

名前 説明
AccessReviewActorIdentityType

ID の種類: user/servicePrincipal

AccessReviewInstance

アクセス レビュー インスタンス。

AccessReviewInstanceReviewersType

このフィールドは、レビュー担当者の種類を指定します。 通常、レビュー担当者には明示的に割り当てられます。 ただし、場合によっては、レビュー担当者が割り当てられず、代わりに動的に選択されることがあります。 たとえば、マネージャーはレビューや自己レビューを行います。

AccessReviewInstanceStatus

この読み取り専用フィールドは、アクセス レビュー インスタンスの状態を指定します。

AccessReviewRecurrencePatternType

繰り返しの種類: 毎週、毎月など。

AccessReviewRecurrenceRangeType

繰り返し範囲の種類。 指定できる値は、endDate、noEnd、numbered です。

AccessReviewReviewer

レビューする必要がある内容の記述子

AccessReviewReviewerType

ID の種類: user/servicePrincipal

AccessReviewScheduleDefinition

アクセス レビュー スケジュール定義。

AccessReviewScheduleDefinitionProperties

アクセス レビュー。

AccessReviewScheduleDefinitionReviewersType

このフィールドは、レビュー担当者の種類を指定します。 通常、レビュー担当者には明示的に割り当てられます。 ただし、場合によっては、レビュー担当者が割り当てられず、代わりに動的に選択されることがあります。 たとえば、マネージャーはレビューや自己レビューを行います。

AccessReviewScheduleDefinitionStatus

この読み取り専用フィールドは、accessReview の状態を指定します。

AccessReviewScopeAssignmentState

レビュー対象/アクティブなロールの割り当て状態

AccessReviewScopePrincipalType

確認する ID の種類 user/servicePrincipal

DefaultDecisionType

これにより、アクセス レビューが完了したときの autoReview 機能の動作が指定されます。

ErrorDefinition

エラー

ErrorDefinitionProperties

エラー

AccessReviewActorIdentityType

ID の種類: user/servicePrincipal

説明
servicePrincipal
user

AccessReviewInstance

アクセス レビュー インスタンス。

名前 説明
id

string

アクセス レビュー インスタンス ID。

name

string

アクセス レビュー インスタンス名。

properties.backupReviewers

AccessReviewReviewer[]

これはバックアップ レビュー担当者のコレクションです。

properties.endDateTime

string (date-time)

レビュー インスタンスが終了するようにスケジュールされている DateTime。

properties.reviewers

AccessReviewReviewer[]

これは校閲者のコレクションです。

properties.reviewersType

AccessReviewInstanceReviewersType

このフィールドは、レビュー担当者の種類を指定します。 通常、レビュー担当者には明示的に割り当てられます。 ただし、場合によっては、レビュー担当者が割り当てられず、代わりに動的に選択されることがあります。 たとえば、マネージャーはレビューや自己レビューを行います。

properties.startDateTime

string (date-time)

レビュー インスタンスの開始がスケジュールされている DateTime。

properties.status

AccessReviewInstanceStatus

この読み取り専用フィールドは、アクセス レビュー インスタンスの状態を指定します。

type

string

リソースの種類。

AccessReviewInstanceReviewersType

このフィールドは、レビュー担当者の種類を指定します。 通常、レビュー担当者には明示的に割り当てられます。 ただし、場合によっては、レビュー担当者が割り当てられず、代わりに動的に選択されることがあります。 たとえば、マネージャーはレビューや自己レビューを行います。

説明
Assigned
Managers
Self

AccessReviewInstanceStatus

この読み取り専用フィールドは、アクセス レビュー インスタンスの状態を指定します。

説明
Applied
Applying
AutoReviewed
AutoReviewing
Completed
Completing
InProgress
Initializing
NotStarted
Scheduled
Starting

AccessReviewRecurrencePatternType

繰り返しの種類: 毎週、毎月など。

説明
absoluteMonthly
weekly

AccessReviewRecurrenceRangeType

繰り返し範囲の種類。 指定できる値は、endDate、noEnd、numbered です。

説明
endDate
noEnd
numbered

AccessReviewReviewer

レビューする必要がある内容の記述子

名前 説明
principalId

string

reviewer(user/servicePrincipal) の ID

principalType

AccessReviewReviewerType

ID の種類: user/servicePrincipal

AccessReviewReviewerType

ID の種類: user/servicePrincipal

説明
servicePrincipal
user

AccessReviewScheduleDefinition

アクセス レビュー スケジュール定義。

名前 説明
id

string

アクセス レビュー スケジュール定義 ID。

name

string

アクセス レビュー スケジュール定義の一意の ID。

properties.backupReviewers

AccessReviewReviewer[]

これはバックアップ レビュー担当者のコレクションです。

properties.createdBy.principalId

string

ID ID

properties.createdBy.principalName

string

ID の表示名

properties.createdBy.principalType

AccessReviewActorIdentityType

ID の種類: user/servicePrincipal

properties.createdBy.userPrincipalName

string

ユーザー プリンシパル名 (有効な場合)

properties.descriptionForAdmins

string

アクセス レビュー作成者によって提供され、管理者に表示される説明。

properties.descriptionForReviewers

string

レビュー担当者に表示されるアクセス レビュー作成者によって提供される説明。

properties.displayName

string

スケジュール定義の表示名。

properties.instances

AccessReviewInstance[]

これは、展開時に返されるインスタンスのコレクションです。

properties.reviewers

AccessReviewReviewer[]

これは校閲者のコレクションです。

properties.reviewersType

AccessReviewScheduleDefinitionReviewersType

このフィールドは、レビュー担当者の種類を指定します。 通常、レビュー担当者には明示的に割り当てられます。 ただし、場合によっては、レビュー担当者が割り当てられず、代わりに動的に選択されることがあります。 たとえば、マネージャーはレビューや自己レビューを行います。

properties.scope.assignmentState

AccessReviewScopeAssignmentState

レビュー対象/アクティブなロールの割り当て状態

properties.scope.excludeResourceId

string

これは、除外するリソース ID を示すために使用されます

properties.scope.excludeRoleDefinitionId

string

これは、除外するロール定義 ID を示すために使用されます

properties.scope.expandNestedMemberships

boolean

入れ子になったメンバーシップを展開するかどうかを示すフラグ。

properties.scope.inactiveDuration

string (duration)

ユーザーが非アクティブな期間。 値は ISO 8601 形式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) である必要があります。このコードを使用して、TimeSpan を有効な間隔文字列 XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) に変換できます。

properties.scope.includeAccessBelowResource

boolean

入れ子になったメンバーシップを展開するかどうかを示すフラグ。

properties.scope.includeInheritedAccess

boolean

入れ子になったメンバーシップを展開するかどうかを示すフラグ。

properties.scope.principalType

AccessReviewScopePrincipalType

確認する ID の種類 user/servicePrincipal

properties.scope.resourceId

string

このレビューが作成される ResourceId

properties.scope.roleDefinitionId

string

これは、レビュー中のロールを示すために使用されます

properties.settings.autoApplyDecisionsEnabled

boolean

ターゲット オブジェクト アクセス リソースを自動的に変更する自動適用機能が有効かどうかを示すフラグ。 有効になっていない場合、ユーザーはレビューが完了したら、アクセス レビューを適用する必要があります。

properties.settings.defaultDecision

DefaultDecisionType

これにより、アクセス レビューが完了したときの autoReview 機能の動作が指定されます。

properties.settings.defaultDecisionEnabled

boolean

レビュー担当者がアクセスをレビューするときに正当な理由を提供する必要があるかどうかを示すフラグ。

properties.settings.instanceDurationInDays

integer (int32)

インスタンスの期間 (日数)。

properties.settings.justificationRequiredOnApproval

boolean

レビュー担当者が決定を記録するときに正当な理由を渡す必要があるかどうかを示すフラグ。

properties.settings.mailNotificationsEnabled

boolean

校閲者とレビュー作成者にメールを送信するかどうかを示すフラグ。

properties.settings.recommendationLookBackDuration

string (duration)

アクセス レビューの推奨事項は、既定で 30 日間のデータ (レビューの開始日) を振り返って計算されます。 ただし、一部のシナリオでは、顧客は、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 (int32)

繰り返しの間隔。 四半期ごとのレビューでは、種類 : absoluteMonthly の間隔は 3 です。

properties.settings.recurrence.pattern.type

AccessReviewRecurrencePatternType

繰り返しの種類: 毎週、毎月など。

properties.settings.recurrence.range.endDate

string (date-time)

レビューが終了するようにスケジュールされている DateTime。 型が endDate の場合は必須

properties.settings.recurrence.range.numberOfOccurrences

integer (int32)

アクセス レビューを繰り返す回数。 型に番号を付ける場合は、必ず正の値を指定する必要があります。

properties.settings.recurrence.range.startDate

string (date-time)

レビューの開始がスケジュールされている DateTime。 これは将来の日付になる可能性があります。 作成時に必要です。

properties.settings.recurrence.range.type

AccessReviewRecurrenceRangeType

繰り返し範囲の種類。 指定できる値は、endDate、noEnd、numbered です。

properties.settings.reminderNotificationsEnabled

boolean

レビュー担当者へのリマインダー メールの送信が有効かどうかを示すフラグ。

properties.status

AccessReviewScheduleDefinitionStatus

この読み取り専用フィールドは、accessReview の状態を指定します。

type

string

リソースの種類。

AccessReviewScheduleDefinitionProperties

アクセス レビュー。

名前 説明
backupReviewers

AccessReviewReviewer[]

これはバックアップ レビュー担当者のコレクションです。

createdBy.principalId

string

ID ID

createdBy.principalName

string

ID の表示名

createdBy.principalType

AccessReviewActorIdentityType

ID の種類: user/servicePrincipal

createdBy.userPrincipalName

string

ユーザー プリンシパル名 (有効な場合)

descriptionForAdmins

string

アクセス レビュー作成者によって提供され、管理者に表示される説明。

descriptionForReviewers

string

レビュー担当者に表示されるアクセス レビュー作成者によって提供される説明。

displayName

string

スケジュール定義の表示名。

instances

AccessReviewInstance[]

これは、展開時に返されるインスタンスのコレクションです。

reviewers

AccessReviewReviewer[]

これは校閲者のコレクションです。

reviewersType

AccessReviewScheduleDefinitionReviewersType

このフィールドは、レビュー担当者の種類を指定します。 通常、レビュー担当者には明示的に割り当てられます。 ただし、場合によっては、レビュー担当者が割り当てられず、代わりに動的に選択されることがあります。 たとえば、マネージャーはレビューや自己レビューを行います。

scope.assignmentState

AccessReviewScopeAssignmentState

レビュー対象/アクティブなロールの割り当て状態

scope.excludeResourceId

string

これは、除外するリソース ID を示すために使用されます

scope.excludeRoleDefinitionId

string

これは、除外するロール定義 ID を示すために使用されます

scope.expandNestedMemberships

boolean

入れ子になったメンバーシップを展開するかどうかを示すフラグ。

scope.inactiveDuration

string (duration)

ユーザーが非アクティブな期間。 値は ISO 8601 形式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) である必要があります。このコードを使用して、TimeSpan を有効な間隔文字列 XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) に変換できます。

scope.includeAccessBelowResource

boolean

入れ子になったメンバーシップを展開するかどうかを示すフラグ。

scope.includeInheritedAccess

boolean

入れ子になったメンバーシップを展開するかどうかを示すフラグ。

scope.principalType

AccessReviewScopePrincipalType

確認する ID の種類 user/servicePrincipal

scope.resourceId

string

このレビューが作成される ResourceId

scope.roleDefinitionId

string

これは、レビュー中のロールを示すために使用されます

settings.autoApplyDecisionsEnabled

boolean

ターゲット オブジェクト アクセス リソースを自動的に変更する自動適用機能が有効かどうかを示すフラグ。 有効になっていない場合、ユーザーはレビューが完了したら、アクセス レビューを適用する必要があります。

settings.defaultDecision

DefaultDecisionType

これにより、アクセス レビューが完了したときの autoReview 機能の動作が指定されます。

settings.defaultDecisionEnabled

boolean

レビュー担当者がアクセスをレビューするときに正当な理由を提供する必要があるかどうかを示すフラグ。

settings.instanceDurationInDays

integer (int32)

インスタンスの期間 (日数)。

settings.justificationRequiredOnApproval

boolean

レビュー担当者が決定を記録するときに正当な理由を渡す必要があるかどうかを示すフラグ。

settings.mailNotificationsEnabled

boolean

校閲者とレビュー作成者にメールを送信するかどうかを示すフラグ。

settings.recommendationLookBackDuration

string (duration)

アクセス レビューの推奨事項は、既定で 30 日間のデータ (レビューの開始日) を振り返って計算されます。 ただし、一部のシナリオでは、顧客は、60 日、90 日などを確認し、構成する距離を変更する必要があります。 この設定により、お客様はこの期間を構成できます。 値は ISO 8601 形式 (http://en.wikipedia.org/wiki/ISO_8601#Durations) である必要があります。このコードを使用して、TimeSpan を有効な間隔文字列 XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) に変換できます。

settings.recommendationsEnabled

boolean

レビュー担当者への推奨事項の表示が有効かどうかを示すフラグ。

settings.recurrence.pattern.interval

integer (int32)

繰り返しの間隔。 四半期ごとのレビューでは、種類 : absoluteMonthly の間隔は 3 です。

settings.recurrence.pattern.type

AccessReviewRecurrencePatternType

繰り返しの種類: 毎週、毎月など。

settings.recurrence.range.endDate

string (date-time)

レビューが終了するようにスケジュールされている DateTime。 型が endDate の場合は必須

settings.recurrence.range.numberOfOccurrences

integer (int32)

アクセス レビューを繰り返す回数。 型に番号を付ける場合は、必ず正の値を指定する必要があります。

settings.recurrence.range.startDate

string (date-time)

レビューの開始がスケジュールされている DateTime。 これは将来の日付になる可能性があります。 作成時に必要です。

settings.recurrence.range.type

AccessReviewRecurrenceRangeType

繰り返し範囲の種類。 指定できる値は、endDate、noEnd、numbered です。

settings.reminderNotificationsEnabled

boolean

レビュー担当者へのリマインダー メールの送信が有効かどうかを示すフラグ。

status

AccessReviewScheduleDefinitionStatus

この読み取り専用フィールドは、accessReview の状態を指定します。

AccessReviewScheduleDefinitionReviewersType

このフィールドは、レビュー担当者の種類を指定します。 通常、レビュー担当者には明示的に割り当てられます。 ただし、場合によっては、レビュー担当者が割り当てられず、代わりに動的に選択されることがあります。 たとえば、マネージャーはレビューや自己レビューを行います。

説明
Assigned
Managers
Self

AccessReviewScheduleDefinitionStatus

この読み取り専用フィールドは、accessReview の状態を指定します。

説明
Applied
Applying
AutoReviewed
AutoReviewing
Completed
Completing
InProgress
Initializing
NotStarted
Scheduled
Starting

AccessReviewScopeAssignmentState

レビュー対象/アクティブなロールの割り当て状態

説明
active
eligible

AccessReviewScopePrincipalType

確認する ID の種類 user/servicePrincipal

説明
guestUser
redeemedGuestUser
servicePrincipal
user
user,group

DefaultDecisionType

これにより、アクセス レビューが完了したときの autoReview 機能の動作が指定されます。

説明
Approve
Deny
Recommendation

ErrorDefinition

エラー

名前 説明
error

ErrorDefinitionProperties

エラー
ゲートウェイの状態の一覧のエラー。

ErrorDefinitionProperties

エラー

名前 説明
code

string

リスト ゲートウェイのエラー コード。

message

string

エラーの説明。