Role Assignment Schedule Requests - Create
创建角色分配计划请求。
PUT https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}?api-version=2020-10-01
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
role
|
path | True |
string |
要创建的角色分配的 GUID。 每个角色分配的名称必须唯一且不同。 |
|
scope
|
path | True |
string |
要创建的角色分配计划请求的范围。 范围可以是任何 REST 资源实例。 例如,对资源组使用“/subscriptions/{subscription-id}/”、“/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}”和“/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}”。 |
|
api-version
|
query | True |
string minLength: 1 |
用于此作的 API 版本。 |
请求正文
| 名称 | 必需 | 类型 | 说明 |
|---|---|---|---|
| properties.principalId | True |
string |
主体 ID。 |
| properties.requestType | True |
角色分配计划请求的类型。 例如:SelfActivate、AdminAssign 等 |
|
| properties.roleDefinitionId | True |
string |
角色定义 ID。 |
| properties.condition |
string |
角色分配的条件。 这会限制可分配给的资源。例如:@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase “foo_storage_container” |
|
| properties.conditionVersion |
string |
条件的版本。 当前接受的值为“2.0” |
|
| properties.justification |
string |
角色分配的理由 |
|
| properties.linkedRoleEligibilityScheduleId |
string |
链接的角色资格计划 ID - 激活资格。 |
|
| properties.scheduleInfo |
角色分配计划的计划信息 |
||
| properties.targetRoleAssignmentScheduleId |
string |
正在更新的结果角色分配计划 ID 或角色分配计划 ID |
|
| properties.targetRoleAssignmentScheduleInstanceId |
string |
正在更新的角色分配计划实例 ID |
|
| properties.ticketInfo |
角色分配的票证信息 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 201 Created |
创建 - 返回有关角色分配的信息。 |
|
| Other Status Codes |
描述作失败的原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
| 名称 | 说明 |
|---|---|
| user_impersonation | 模拟用户帐户 |
示例
PutRoleAssignmentScheduleRequest
示例请求
PUT https://management.azure.com/providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045?api-version=2020-10-01
{
"properties": {
"principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
"roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608",
"requestType": "SelfActivate",
"linkedRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413",
"scheduleInfo": {
"startDateTime": "2020-09-09T21:35:27.91Z",
"expiration": {
"type": "AfterDuration",
"endDateTime": null,
"duration": "PT8H"
}
},
"condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'",
"conditionVersion": "1.0"
}
}
示例响应
{
"properties": {
"targetRoleAssignmentScheduleId": "c9e264ff-3133-4776-a81a-ebc7c33c8ec6",
"targetRoleAssignmentScheduleInstanceId": null,
"scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f",
"roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608",
"principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
"principalType": "User",
"requestType": "SelfActivate",
"status": "Provisioned",
"approvalId": null,
"scheduleInfo": {
"startDateTime": "2020-09-09T21:35:27.91Z",
"expiration": {
"type": "AfterDuration",
"endDateTime": null,
"duration": "PT8H"
}
},
"ticketInfo": {
"ticketNumber": null,
"ticketSystem": null
},
"justification": null,
"requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
"createdOn": "2020-09-09T21:35:27.91Z",
"condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'",
"conditionVersion": "1.0",
"expandedProperties": {
"scope": {
"id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f",
"displayName": "Pay-As-You-Go",
"type": "subscription"
},
"roleDefinition": {
"id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608",
"displayName": "Contributor",
"type": "BuiltInRole"
},
"principal": {
"id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
"displayName": "User Account",
"email": "user@my-tenant.com",
"type": "User"
}
}
},
"name": "fea7a502-9a96-4806-a26f-eee560e52045",
"id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045",
"type": "Microsoft.Authorization/RoleAssignmentScheduleRequests"
}
定义
| 名称 | 说明 |
|---|---|
|
Cloud |
服务的错误响应。 |
|
Cloud |
服务的错误响应。 |
|
Expanded |
|
| Expiration |
角色分配计划的过期时间 |
| Principal |
主体的详细信息 |
|
principal |
分配的主体 ID 的主体类型。 |
|
Request |
角色分配计划请求的类型。 例如:SelfActivate、AdminAssign 等 |
|
Role |
角色分配计划请求 |
|
Role |
角色定义的详细信息 |
|
Schedule |
角色分配计划的计划信息 |
| Scope |
资源范围的详细信息 |
| Status |
角色分配计划请求的状态。 |
|
Ticket |
角色分配的票证信息 |
| Type |
角色分配计划过期的类型 |
CloudError
服务的错误响应。
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
服务的错误响应。 |
CloudErrorBody
服务的错误响应。
| 名称 | 类型 | 说明 |
|---|---|---|
| code |
string |
错误的标识符。 代码是固定的,旨在以编程方式使用。 |
| message |
string |
描述错误的消息,旨在适合在用户界面中显示。 |
ExpandedProperties
| 名称 | 类型 | 说明 |
|---|---|---|
| principal |
主体的详细信息 |
|
| roleDefinition |
角色定义的详细信息 |
|
| scope |
资源范围的详细信息 |
Expiration
角色分配计划的过期时间
| 名称 | 类型 | 说明 |
|---|---|---|
| duration |
string |
TimeSpan 中角色分配计划的持续时间。 |
| endDateTime |
string (date-time) |
角色分配计划的结束日期时间。 |
| type |
角色分配计划过期的类型 |
Principal
主体的详细信息
| 名称 | 类型 | 说明 |
|---|---|---|
| displayName |
string |
主体的显示名称 |
|
string |
主体的电子邮件 ID |
|
| id |
string |
主体的 ID |
| type |
string |
主体的类型 |
principalType
分配的主体 ID 的主体类型。
| 值 | 说明 |
|---|---|
| User | |
| Group | |
| ServicePrincipal | |
| ForeignGroup | |
| Device |
RequestType
角色分配计划请求的类型。 例如:SelfActivate、AdminAssign 等
| 值 | 说明 |
|---|---|
| AdminAssign | |
| AdminRemove | |
| AdminUpdate | |
| AdminExtend | |
| AdminRenew | |
| SelfActivate | |
| SelfDeactivate | |
| SelfExtend | |
| SelfRenew |
RoleAssignmentScheduleRequest
角色分配计划请求
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
角色分配计划请求 ID。 |
| name |
string |
角色分配计划请求名称。 |
| properties.approvalId |
string |
角色分配计划请求的 approvalId。 |
| properties.condition |
string |
角色分配的条件。 这会限制可分配给的资源。例如:@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase “foo_storage_container” |
| properties.conditionVersion |
string |
条件的版本。 当前接受的值为“2.0” |
| properties.createdOn |
string (date-time) |
创建角色分配计划请求时的 DateTime |
| properties.expandedProperties |
主体、范围和角色定义的其他属性 |
|
| properties.justification |
string |
角色分配的理由 |
| properties.linkedRoleEligibilityScheduleId |
string |
链接的角色资格计划 ID - 激活资格。 |
| properties.principalId |
string |
主体 ID。 |
| properties.principalType |
分配的主体 ID 的主体类型。 |
|
| properties.requestType |
角色分配计划请求的类型。 例如:SelfActivate、AdminAssign 等 |
|
| properties.requestorId |
string |
创建此请求的用户的 ID |
| properties.roleDefinitionId |
string |
角色定义 ID。 |
| properties.scheduleInfo |
角色分配计划的计划信息 |
|
| properties.scope |
string |
角色分配计划请求范围。 |
| properties.status |
角色分配计划请求的状态。 |
|
| properties.targetRoleAssignmentScheduleId |
string |
正在更新的结果角色分配计划 ID 或角色分配计划 ID |
| properties.targetRoleAssignmentScheduleInstanceId |
string |
正在更新的角色分配计划实例 ID |
| properties.ticketInfo |
角色分配的票证信息 |
|
| type |
string |
角色分配计划请求类型。 |
RoleDefinition
角色定义的详细信息
| 名称 | 类型 | 说明 |
|---|---|---|
| displayName |
string |
角色定义的显示名称 |
| id |
string |
角色定义的 ID |
| type |
string |
角色定义的类型 |
ScheduleInfo
角色分配计划的计划信息
| 名称 | 类型 | 说明 |
|---|---|---|
| expiration |
角色分配计划的过期时间 |
|
| startDateTime |
string (date-time) |
角色分配计划的开始日期时间。 |
Scope
资源范围的详细信息
| 名称 | 类型 | 说明 |
|---|---|---|
| displayName |
string |
资源的显示名称 |
| id |
string |
资源的范围 ID |
| type |
string |
资源的类型 |
Status
角色分配计划请求的状态。
| 值 | 说明 |
|---|---|
| Accepted | |
| PendingEvaluation | |
| Granted | |
| Denied | |
| PendingProvisioning | |
| Provisioned | |
| PendingRevocation | |
| Revoked | |
| Canceled | |
| Failed | |
| PendingApprovalProvisioning | |
| PendingApproval | |
| FailedAsResourceIsLocked | |
| PendingAdminDecision | |
| AdminApproved | |
| AdminDenied | |
| TimedOut | |
| ProvisioningStarted | |
| Invalid | |
| PendingScheduleCreation | |
| ScheduleCreated | |
| PendingExternalProvisioning |
TicketInfo
角色分配的票证信息
| 名称 | 类型 | 说明 |
|---|---|---|
| ticketNumber |
string |
角色分配的票证编号 |
| ticketSystem |
string |
角色分配的票证系统名称 |
Type
角色分配计划过期的类型
| 值 | 说明 |
|---|---|
| AfterDuration | |
| AfterDateTime | |
| NoExpiration |