Role Eligibility Schedule Requests - Validate

Ссылка

Service:: Authorization

API Version:: 2020-10-01

Проверяет новый запрос на получение прав на роль.

POST https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}/validate?api-version=2020-10-01

Параметры URI

Name	In	Required	Type	Description
roleEligibilityScheduleRequestName	path	True	string	Имя запроса на соответствие роли для проверки.
scope	path	True	string	Область запроса на соответствие роли для проверки.
api-version	query	True	string	Версия API, используемая для этой операции.

Текст запроса

Name	Required	Type	Description
properties.principalId	True	string	Идентификатор субъекта.
properties.requestType	True	RequestType	Тип запроса расписания назначения ролей. Например: SelfActivate, AdminAssign и т. д.
properties.roleDefinitionId	True	string	Идентификатор определения роли.
properties.condition		string	Условия назначения роли. Это ограничивает ресурсы, которыми его можно назначить. например: @Resource[Microsoft.служба хранилища /storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion		string	Версия условия. В настоящее время принято значение "2.0"
properties.justification		string	Обоснование соответствия роли
properties.scheduleInfo		ScheduleInfo	Планирование сведений о расписании соответствия роли
properties.targetRoleEligibilityScheduleId		string	Идентификатор расписания соответствия для результирующих ролей или идентификатор обновляемого расписания соответствия роли
properties.targetRoleEligibilityScheduleInstanceId		string	Обновляемый идентификатор экземпляра расписания соответствия роли
properties.ticketInfo		TicketInfo	Сведения о запросе на участие в роли

Ответы

Name	Type	Description
200 OK	RoleEligibilityScheduleRequest	ОК . Возвращает сведения о запросе на получение прав на роль.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Flow OAuth2 Azure Active Directory

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

Scopes

Name	Description
user_impersonation	олицетворения учетной записи пользователя

Примеры

ValidateRoleEligibilityScheduleRequestByName

Sample Request

POST https://management.azure.com/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6/validate?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": "AdminAssign",
    "scheduleInfo": {
      "startDateTime": "2020-09-09T21:31:27.91Z",
      "expiration": {
        "type": "AfterDuration",
        "endDateTime": null,
        "duration": "P365D"
      }
    },
    "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'",
    "conditionVersion": "1.0"
  }
}

import com.azure.core.util.Context;
import com.azure.resourcemanager.authorization.fluent.models.RoleEligibilityScheduleRequestInner;
import com.azure.resourcemanager.authorization.models.RequestType;
import com.azure.resourcemanager.authorization.models.RoleEligibilityScheduleRequestPropertiesScheduleInfo;
import com.azure.resourcemanager.authorization.models.RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration;
import com.azure.resourcemanager.authorization.models.Type;
import java.time.OffsetDateTime;

/** Samples for RoleEligibilityScheduleRequests Validate. */
public final class Main {
    /*
     * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/ValidateRoleEligibilityScheduleRequestByName.json
     */
    /**
     * Sample code: ValidateRoleEligibilityScheduleRequestByName.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void validateRoleEligibilityScheduleRequestByName(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .accessManagement()
            .roleAssignments()
            .manager()
            .roleServiceClient()
            .getRoleEligibilityScheduleRequests()
            .validateWithResponse(
                "subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f",
                "64caffb6-55c0-4deb-a585-68e948ea1ad6",
                new RoleEligibilityScheduleRequestInner()
                    .withRoleDefinitionId(
                        "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608")
                    .withPrincipalId("a3bb8764-cb92-4276-9d2a-ca1e895e55ea")
                    .withRequestType(RequestType.ADMIN_ASSIGN)
                    .withScheduleInfo(
                        new RoleEligibilityScheduleRequestPropertiesScheduleInfo()
                            .withStartDateTime(OffsetDateTime.parse("2020-09-09T21:31:27.91Z"))
                            .withExpiration(
                                new RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration()
                                    .withType(Type.AFTER_DURATION)
                                    .withDuration("P365D")))
                    .withCondition(
                        "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName]"
                            + " StringEqualsIgnoreCase 'foo_storage_container'")
                    .withConditionVersion("1.0"),
                Context.NONE);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

package armauthorization_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/ValidateRoleEligibilityScheduleRequestByName.json
func ExampleRoleEligibilityScheduleRequestsClient_Validate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armauthorization.NewRoleEligibilityScheduleRequestsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Validate(ctx,
		"subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f",
		"64caffb6-55c0-4deb-a585-68e948ea1ad6",
		armauthorization.RoleEligibilityScheduleRequest{
			Properties: &armauthorization.RoleEligibilityScheduleRequestProperties{
				Condition:        to.Ptr("@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'"),
				ConditionVersion: to.Ptr("1.0"),
				PrincipalID:      to.Ptr("a3bb8764-cb92-4276-9d2a-ca1e895e55ea"),
				RequestType:      to.Ptr(armauthorization.RequestTypeAdminAssign),
				RoleDefinitionID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608"),
				ScheduleInfo: &armauthorization.RoleEligibilityScheduleRequestPropertiesScheduleInfo{
					Expiration: &armauthorization.RoleEligibilityScheduleRequestPropertiesScheduleInfoExpiration{
						Type:     to.Ptr(armauthorization.TypeAfterDuration),
						Duration: to.Ptr("P365D"),
					},
					StartDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-09T21:31:27.91Z"); return t }()),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 200

{
  "properties": {
    "targetRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413",
    "targetRoleEligibilityScheduleInstanceId": 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": "AdminAssign",
    "status": "Provisioned",
    "approvalId": null,
    "scheduleInfo": {
      "startDateTime": "2020-09-09T21:31:27.91Z",
      "expiration": {
        "type": "AfterDuration",
        "endDateTime": null,
        "duration": "P365D"
      }
    },
    "ticketInfo": {
      "ticketNumber": null,
      "ticketSystem": null
    },
    "justification": null,
    "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
    "createdOn": "2020-09-09T21:32: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": "64caffb6-55c0-4deb-a585-68e948ea1ad6",
  "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6",
  "type": "Microsoft.Authorization/RoleEligibilityScheduleRequests"
}

Определения

CloudError	Ответ об ошибке службы.
CloudErrorBody	Ответ об ошибке службы.
ExpandedProperties	Расширенная информация о ресурсе, роли и субъекте
Expiration	Истечение срока действия расписания соответствия роли
Principal	Сведения о субъекте
principalType	Тип субъекта назначенного идентификатора участника.
RequestType	Тип запроса расписания назначения ролей. Например: SelfActivate, AdminAssign и т. д.
RoleDefinition	Сведения об определении роли
RoleEligibilityScheduleRequest	Запрос на получение прав на роль
ScheduleInfo	Планирование сведений о расписании соответствия роли
Scope	Сведения о области ресурса
Status	Состояние запроса на получение прав на роль.
TicketInfo	Сведения о запросе на участие в роли
Type	Тип срока действия расписания соответствия роли

CloudError

Ответ об ошибке службы.

Name	Type	Description
error	CloudErrorBody	Ответ об ошибке службы.

CloudErrorBody

Ответ об ошибке службы.

Name	Type	Description
code	string	Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.

ExpandedProperties

Расширенная информация о ресурсе, роли и субъекте

Name	Type	Description
principal	Principal	Сведения о субъекте
roleDefinition	RoleDefinition	Сведения об определении роли
scope	Scope	Сведения о области ресурса

Expiration

Истечение срока действия расписания соответствия роли

Name	Type	Description
duration	string	Длительность расписания соответствия роли в TimeSpan.
endDateTime	string	Окончание даты и времени расписания соответствия роли.
type	Type	Тип срока действия расписания соответствия роли

Principal

Сведения о субъекте

Name	Type	Description
displayName	string	Отображаемое имя участника
email	string	Идентификатор электронной почты участника
id	string	Идентификатор субъекта
type	string	Тип субъекта

principalType

Тип субъекта назначенного идентификатора участника.

Name	Type	Description
Device	string
ForeignGroup	string
Group	string
ServicePrincipal	string
User	string

RequestType

Тип запроса расписания назначения ролей. Например: SelfActivate, AdminAssign и т. д.

Name	Type	Description
AdminAssign	string
AdminExtend	string
AdminRemove	string
AdminRenew	string
AdminUpdate	string
SelfActivate	string
SelfDeactivate	string
SelfExtend	string
SelfRenew	string

RoleDefinition

Сведения об определении роли

Name	Type	Description
displayName	string	Отображаемое имя определения роли
id	string	Идентификатор определения роли
type	string	Тип определения роли

RoleEligibilityScheduleRequest

Запрос на получение прав на роль

Name	Type	Description
id	string	Идентификатор запроса на получение прав на роль.
name	string	Имя запроса на получение прав на роль.
properties.approvalId	string	Идентификатор утверждения запроса на получение прав на роль.
properties.condition	string	Условия назначения роли. Это ограничивает ресурсы, которыми его можно назначить. например: @Resource[Microsoft.служба хранилища /storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion	string	Версия условия. В настоящее время принято значение "2.0"
properties.createdOn	string	DateTime при создании запроса на получение прав на роль
properties.expandedProperties	ExpandedProperties	Дополнительные свойства определения субъекта, области и роли
properties.justification	string	Обоснование соответствия роли
properties.principalId	string	Идентификатор субъекта.
properties.principalType	principalType	Тип субъекта назначенного идентификатора участника.
properties.requestType	RequestType	Тип запроса расписания назначения ролей. Например: SelfActivate, AdminAssign и т. д.
properties.requestorId	string	Идентификатор пользователя, создавшего этот запрос
properties.roleDefinitionId	string	Идентификатор определения роли.
properties.scheduleInfo	ScheduleInfo	Планирование сведений о расписании соответствия роли
properties.scope	string	Область запроса на получение прав на роль.
properties.status	Status	Состояние запроса на получение прав на роль.
properties.targetRoleEligibilityScheduleId	string	Идентификатор расписания соответствия для результирующих ролей или идентификатор обновляемого расписания соответствия роли
properties.targetRoleEligibilityScheduleInstanceId	string	Обновляемый идентификатор экземпляра расписания соответствия роли
properties.ticketInfo	TicketInfo	Сведения о запросе на участие в роли
type	string	Тип запроса на получение прав на роль.

ScheduleInfo

Планирование сведений о расписании соответствия роли

Name	Type	Description
expiration	Expiration	Истечение срока действия расписания соответствия роли
startDateTime	string	Даты и времени начала расписания соответствия роли.

Scope

Сведения о области ресурса

Name	Type	Description
displayName	string	Отображаемое имя ресурса
id	string	Идентификатор области ресурса
type	string	Тип ресурса

Status

Состояние запроса на получение прав на роль.

Name	Type	Description
Accepted	string
AdminApproved	string
AdminDenied	string
Canceled	string
Denied	string
Failed	string
FailedAsResourceIsLocked	string
Granted	string
Invalid	string
PendingAdminDecision	string
PendingApproval	string
PendingApprovalProvisioning	string
PendingEvaluation	string
PendingExternalProvisioning	string
PendingProvisioning	string
PendingRevocation	string
PendingScheduleCreation	string
Provisioned	string
ProvisioningStarted	string
Revoked	string
ScheduleCreated	string
TimedOut	string

TicketInfo

Сведения о запросе на участие в роли

Name	Type	Description
ticketNumber	string	Номер билета для права на роль
ticketSystem	string	Имя системы билетов для права на роль

Type

Тип срока действия расписания соответствия роли

Name	Type	Description
AfterDateTime	string
AfterDuration	string
NoExpiration	string