Role Assignment Schedule Instances - List For Scope

서비스:

Authorization

API 버전:

2020-10-01

역할 할당 일정의 역할 할당 일정 인스턴스를 가져옵니다.

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances?api-version=2020-10-01

선택적 매개 변수:

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances?$filter={$filter}&api-version=2020-10-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
scope	path	True	string	역할 할당 일정의 scope.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.
$filter	query		string	작업에 적용할 필터입니다. $filter=atScope()를 사용하여 scope 이상에서 모든 역할 할당 일정을 반환합니다. $filter=principalId eq {id}를 사용하여 지정된 보안 주체에 대한 scope 위 또는 아래에서 모든 역할 할당 일정을 반환합니다. $filter=assignedTo('{userId}')를 사용하여 사용자의 모든 역할 할당 일정 인스턴스를 반환합니다. $filter=asTarget()을 사용하여 현재 사용자에 대해 만든 모든 역할 할당 일정 인스턴스를 반환합니다.

응답

Name	형식	Description
200 OK	RoleAssignmentScheduleInstanceListResult	확인 - 역할 할당 일정 인스턴스의 배열을 반환합니다.
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

GetRoleAssignmentScheduleInstancesByScope

샘플 요청

HTTP

GET https://management.azure.com/providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleAssignmentScheduleInstances?$filter=assignedTo('a3bb8764-cb92-4276-9d2a-ca1e895e55ea')&api-version=2020-10-01

Java

/**
 * Samples for RoleAssignmentScheduleInstances ListForScope.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/
     * GetRoleAssignmentScheduleInstancesByScope.json
     */
    /**
     * Sample code: GetRoleAssignmentScheduleInstancesByScope.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getRoleAssignmentScheduleInstancesByScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.accessManagement().roleAssignments().manager().roleServiceClient().getRoleAssignmentScheduleInstances()
            .listForScope("providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f",
                "assignedTo('a3bb8764-cb92-4276-9d2a-ca1e895e55ea')", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armauthorization_test

import (
	"context"
	"log"

	"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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/53b1affe357b3bfbb53721d0a2002382a046d3b0/specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/GetRoleAssignmentScheduleInstancesByScope.json
func ExampleRoleAssignmentScheduleInstancesClient_NewListForScopePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armauthorization.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewRoleAssignmentScheduleInstancesClient().NewListForScopePager("providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", &armauthorization.RoleAssignmentScheduleInstancesClientListForScopeOptions{Filter: to.Ptr("assignedTo('a3bb8764-cb92-4276-9d2a-ca1e895e55ea')")})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RoleAssignmentScheduleInstanceListResult = armauthorization.RoleAssignmentScheduleInstanceListResult{
		// 	Value: []*armauthorization.RoleAssignmentScheduleInstance{
		// 		{
		// 			Name: to.Ptr("ed9b8180-cef7-4c77-a63c-b8566ecfc412"),
		// 			Type: to.Ptr("Microsoft.Authorization/RoleAssignmentScheduleInstances"),
		// 			ID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleInstances/ed9b8180-cef7-4c77-a63c-b8566ecfc412"),
		// 			Properties: &armauthorization.RoleAssignmentScheduleInstanceProperties{
		// 				AssignmentType: to.Ptr(armauthorization.AssignmentTypeAssigned),
		// 				Condition: to.Ptr("@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'"),
		// 				ConditionVersion: to.Ptr("1.0"),
		// 				CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-09T21:35:27.910Z"); return t}()),
		// 				EndDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-10T05:35:17.910Z"); return t}()),
		// 				ExpandedProperties: &armauthorization.ExpandedProperties{
		// 					Principal: &armauthorization.ExpandedPropertiesPrincipal{
		// 						Type: to.Ptr("User"),
		// 						DisplayName: to.Ptr("User Account"),
		// 						Email: to.Ptr("user@my-tenant.com"),
		// 						ID: to.Ptr("a3bb8764-cb92-4276-9d2a-ca1e895e55ea"),
		// 					},
		// 					RoleDefinition: &armauthorization.ExpandedPropertiesRoleDefinition{
		// 						Type: to.Ptr("BuiltInRole"),
		// 						DisplayName: to.Ptr("Contributor"),
		// 						ID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608"),
		// 					},
		// 					Scope: &armauthorization.ExpandedPropertiesScope{
		// 						Type: to.Ptr("subscription"),
		// 						DisplayName: to.Ptr("Pay-As-You-Go"),
		// 						ID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f"),
		// 					},
		// 				},
		// 				LinkedRoleEligibilityScheduleID: to.Ptr("b1477448-2cc6-4ceb-93b4-54a202a89413"),
		// 				LinkedRoleEligibilityScheduleInstanceID: to.Ptr("21e4b59a-0499-4fe0-a3c3-43a3055b773a"),
		// 				MemberType: to.Ptr(armauthorization.MemberTypeDirect),
		// 				OriginRoleAssignmentID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleAssignments/ed9b8180-cef7-4c77-a63c-b8566ecfc412"),
		// 				PrincipalID: to.Ptr("a3bb8764-cb92-4276-9d2a-ca1e895e55ea"),
		// 				PrincipalType: to.Ptr(armauthorization.PrincipalTypeUser),
		// 				RoleAssignmentScheduleID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentSchedules/c9e264ff-3133-4776-a81a-ebc7c33c8ec6"),
		// 				RoleDefinitionID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608"),
		// 				Scope: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f"),
		// 				StartDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-09T21:35:27.910Z"); return t}()),
		// 				Status: to.Ptr(armauthorization.StatusAccepted),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AuthorizationManagementClient } = require("@azure/arm-authorization");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets role assignment schedule instances of a role assignment schedule.
 *
 * @summary Gets role assignment schedule instances of a role assignment schedule.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/GetRoleAssignmentScheduleInstancesByScope.json
 */
async function getRoleAssignmentScheduleInstancesByScope() {
  const subscriptionId =
    process.env["AUTHORIZATION_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const scope =
    "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f";
  const filter = "assignedTo('a3bb8764-cb92-4276-9d2a-ca1e895e55ea')";
  const options = {
    filter,
  };
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.roleAssignmentScheduleInstances.listForScope(scope, options)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Authorization;

// Generated from example definition: specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/GetRoleAssignmentScheduleInstancesByScope.json
// this example is just showing the usage of "RoleAssignmentScheduleInstances_ListForScope" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ArmResource created on azure
// for more information of creating ArmResource, please refer to the document of ArmResource

// get the collection of this RoleAssignmentScheduleInstanceResource
string scope = "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", scope));
RoleAssignmentScheduleInstanceCollection collection = client.GetRoleAssignmentScheduleInstances(scopeId);

// invoke the operation and iterate over the result
string filter = "assignedTo('a3bb8764-cb92-4276-9d2a-ca1e895e55ea')";
await foreach (RoleAssignmentScheduleInstanceResource item in collection.GetAllAsync(filter: filter))
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    RoleAssignmentScheduleInstanceData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

샘플 응답

상태 코드:

200

{
  "value": [
    {
      "properties": {
        "originRoleAssignmentId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleAssignments/ed9b8180-cef7-4c77-a63c-b8566ecfc412",
        "linkedRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413",
        "linkedRoleEligibilityScheduleInstanceId": "21e4b59a-0499-4fe0-a3c3-43a3055b773a",
        "assignmentType": "Assigned",
        "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",
        "status": "Accepted",
        "roleAssignmentScheduleId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentSchedules/c9e264ff-3133-4776-a81a-ebc7c33c8ec6",
        "startDateTime": "2020-09-09T21:35:27.91Z",
        "endDateTime": "2020-09-10T05:35:17.91Z",
        "memberType": "Direct",
        "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": "ed9b8180-cef7-4c77-a63c-b8566ecfc412",
      "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleInstances/ed9b8180-cef7-4c77-a63c-b8566ecfc412",
      "type": "Microsoft.Authorization/RoleAssignmentScheduleInstances"
    }
  ]
}

정의

Name	Description
AssignmentType	역할 할당 일정의 할당 유형
CloudError	서비스의 오류 응답입니다.
CloudErrorBody	서비스의 오류 응답입니다.
ExpandedProperties
MemberType	역할 할당 일정의 멤버 자격 유형
Principal	보안 주체의 세부 정보
principalType	할당된 보안 주체 ID의 보안 주체 유형입니다.
RoleAssignmentScheduleInstance	현재 또는 예정된 역할 할당 일정에 대한 정보 instance
RoleAssignmentScheduleInstanceListResult	역할 할당 일정 instance 작업 결과를 나열합니다.
RoleDefinition	역할 정의에 대한 세부 정보
Scope	리소스 scope 세부 정보
Status	역할 할당 일정의 상태 instance.

AssignmentType

역할 할당 일정의 할당 유형

Name	형식	Description
Activated	string
Assigned	string

CloudError

서비스의 오류 응답입니다.

Name	형식	Description
error	CloudErrorBody	서비스의 오류 응답입니다.

CloudErrorBody

서비스의 오류 응답입니다.

Name	형식	Description
code	string	오류의 식별자입니다. 코드는 고정이며 프로그래밍 방식으로 사용하기 위한 것입니다.
message	string	사용자 인터페이스에 표시하기에 적합한 오류를 설명하는 메시지입니다.

ExpandedProperties

Name	형식	Description
principal	Principal	보안 주체의 세부 정보
roleDefinition	RoleDefinition	역할 정의에 대한 세부 정보
scope	Scope	리소스 scope 세부 정보

MemberType

역할 할당 일정의 멤버 자격 유형

Name	형식	Description
Direct	string
Group	string
Inherited	string

Principal

보안 주체의 세부 정보

Name	형식	Description
displayName	string	보안 주체의 표시 이름
email	string	보안 주체의 Email ID
id	string	보안 주체의 ID
type	string	보안 주체의 유형

principalType

할당된 보안 주체 ID의 보안 주체 유형입니다.

Name	형식	Description
Device	string
ForeignGroup	string
Group	string
ServicePrincipal	string
User	string

RoleAssignmentScheduleInstance

현재 또는 예정된 역할 할당 일정에 대한 정보 instance

Name	형식	Description
id	string	역할 할당 일정 instance ID입니다.
name	string	역할 할당 일정은 이름을 instance.
properties.assignmentType	AssignmentType	역할 할당 일정의 할당 유형
properties.condition	string	역할 할당에 대한 조건입니다. 이렇게 하면 할당할 수 있는 리소스가 제한됩니다. 예: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion	string	조건의 버전입니다. 현재 허용되는 값은 '2.0'입니다.
properties.createdOn	string	역할 할당 일정이 만들어진 날짜/시간
properties.endDateTime	string	역할 할당 일정의 endDateTime은 instance
properties.expandedProperties	ExpandedProperties	보안 주체, scope 및 역할 정의의 추가 속성
properties.linkedRoleEligibilityScheduleId	string	roleEligibilityScheduleId를 활성화하는 데 사용됨
properties.linkedRoleEligibilityScheduleInstanceId	string	roleEligibilityScheduleInstanceId가 이 roleAssignmentScheduleInstance에 연결됨
properties.memberType	MemberType	역할 할당 일정의 멤버 자격 유형
properties.originRoleAssignmentId	string	외부 시스템의 역할 할당 ID
properties.principalId	string	보안 주체 ID입니다.
properties.principalType	principalType	할당된 보안 주체 ID의 보안 주체 유형입니다.
properties.roleAssignmentScheduleId	string	master 역할 할당 일정의 ID
properties.roleDefinitionId	string	역할 정의 ID입니다.
properties.scope	string	역할 할당 일정이 scope.
properties.startDateTime	string	역할 할당 일정의 startDateTime은 instance
properties.status	Status	역할 할당 일정의 상태 instance.
type	string	역할 할당 일정 instance 유형입니다.

RoleAssignmentScheduleInstanceListResult

역할 할당 일정 instance 작업 결과를 나열합니다.

Name	형식	Description
nextLink	string	다음 결과 집합을 가져오는 데 사용할 URL입니다.
value	RoleAssignmentScheduleInstance[]	역할 할당 일정 instance 목록입니다.

RoleDefinition

역할 정의에 대한 세부 정보

Name	형식	Description
displayName	string	역할 정의의 표시 이름
id	string	역할 정의의 ID
type	string	역할 정의의 유형

Scope

리소스 scope 세부 정보

Name	형식	Description
displayName	string	리소스의 표시 이름
id	string	리소스의 범위 ID
type	string	리소스 종류

Status

역할 할당 일정의 상태 instance.

Name	형식	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