Role Eligibility Schedule Instances - List For Scope

Service:

Authorization

API Version:

2020-10-01

ロール適格性スケジュールのロール適格性スケジュール インスタンスを取得します。

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

With optional parameters:

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

URI パラメーター

名前	/	必須	型	説明
scope	path	True	string	ロールの適格性スケジュールのスコープ。
api-version	query	True	string	この操作に使用する API バージョン。
$filter	query		string	操作に適用するフィルター。 スコープ以上のすべてのロール割り当てスケジュールを返すには、$filter=atScope() を使用します。 指定したプリンシパルのスコープの上または下にあるすべてのロール割り当てスケジュールを返すには、$filter=principalId eq {id} を使用します。 $filter=assignedTo('{userId}') を使用して、ユーザーのすべてのロール適格性スケジュールを返します。 現在のユーザーに対して作成されたすべてのロール適格性スケジュールを返すには、$filter=asTarget() を使用します。

応答

名前	型	説明
200 OK	RoleEligibilityScheduleInstanceListResult	OK - ロールの適格性スケジュール インスタンスの配列を返します。
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

GetRoleEligibilityScheduleInstancesByScope

Sample Request

HTTP

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

Java

/** Samples for RoleEligibilityScheduleInstances ListForScope. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/
     * GetRoleEligibilityScheduleInstancesByScope.json
     */
    /**
     * Sample code: GetRoleEligibilityScheduleInstancesByScope.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getRoleEligibilityScheduleInstancesByScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.accessManagement().roleAssignments().manager().roleServiceClient().getRoleEligibilityScheduleInstances()
            .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/GetRoleEligibilityScheduleInstancesByScope.json
func ExampleRoleEligibilityScheduleInstancesClient_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.NewRoleEligibilityScheduleInstancesClient().NewListForScopePager("providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", &armauthorization.RoleEligibilityScheduleInstancesClientListForScopeOptions{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.RoleEligibilityScheduleInstanceListResult = armauthorization.RoleEligibilityScheduleInstanceListResult{
		// 	Value: []*armauthorization.RoleEligibilityScheduleInstance{
		// 		{
		// 			Name: to.Ptr("21e4b59a-0499-4fe0-a3c3-43a3055b773a"),
		// 			Type: to.Ptr("Microsoft.Authorization/RoleEligibilityScheduleInstances"),
		// 			ID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleInstances/21e4b59a-0499-4fe0-a3c3-43a3055b773a"),
		// 			Properties: &armauthorization.RoleEligibilityScheduleInstanceProperties{
		// 				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-10T00:32:36.860Z"); return t}()),
		// 				EndDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-09-10T00:31:41.477Z"); 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"),
		// 					},
		// 				},
		// 				MemberType: to.Ptr(armauthorization.MemberTypeDirect),
		// 				PrincipalID: to.Ptr("a3bb8764-cb92-4276-9d2a-ca1e895e55ea"),
		// 				PrincipalType: to.Ptr(armauthorization.PrincipalTypeUser),
		// 				RoleDefinitionID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/b24988ac-6180-42a0-ab88-20f7382dd24c"),
		// 				RoleEligibilityScheduleID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilitySchedules/b1477448-2cc6-4ceb-93b4-54a202a89413"),
		// 				Scope: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f"),
		// 				StartDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-10T00:32:36.860Z"); return t}()),
		// 				Status: to.Ptr(armauthorization.StatusProvisioned),
		// 			},
		// 	}},
		// }
	}
}

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 eligibility schedule instances of a role eligibility schedule.
 *
 * @summary Gets role eligibility schedule instances of a role eligibility schedule.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/GetRoleEligibilityScheduleInstancesByScope.json
 */
async function getRoleEligibilityScheduleInstancesByScope() {
  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.roleEligibilityScheduleInstances.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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Authorization;

// Generated from example definition: specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/GetRoleEligibilityScheduleInstancesByScope.json
// this example is just showing the usage of "RoleEligibilityScheduleInstances_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 RoleEligibilityScheduleInstanceResource
string scope = "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", scope));
RoleEligibilityScheduleInstanceCollection collection = client.GetRoleEligibilityScheduleInstances(scopeId);

// invoke the operation and iterate over the result
string filter = "assignedTo('a3bb8764-cb92-4276-9d2a-ca1e895e55ea')";
await foreach (RoleEligibilityScheduleInstanceResource 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
    RoleEligibilityScheduleInstanceData 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

Sample Response

Status code:

200

{
  "value": [
    {
      "properties": {
        "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f",
        "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/b24988ac-6180-42a0-ab88-20f7382dd24c",
        "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
        "principalType": "User",
        "status": "Provisioned",
        "roleEligibilityScheduleId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilitySchedules/b1477448-2cc6-4ceb-93b4-54a202a89413",
        "startDateTime": "2020-09-10T00:32:36.86Z",
        "endDateTime": "2021-09-10T00:31:41.477Z",
        "memberType": "Direct",
        "createdOn": "2020-09-10T00:32:36.86Z",
        "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": "21e4b59a-0499-4fe0-a3c3-43a3055b773a",
      "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleInstances/21e4b59a-0499-4fe0-a3c3-43a3055b773a",
      "type": "Microsoft.Authorization/RoleEligibilityScheduleInstances"
    }
  ]
}

定義

名前	説明
CloudError	サービスからのエラー応答。
CloudErrorBody	サービスからのエラー応答。
ExpandedProperties
MemberType	ロールの適格性スケジュールのメンバーシップの種類
Principal	プリンシパルの詳細
principalType	割り当てられたプリンシパル ID のプリンシパルの種類。
RoleDefinition	ロール定義の詳細
RoleEligibilityScheduleInstance	現在または今後のロールの適格性スケジュール インスタンスに関する情報
RoleEligibilityScheduleInstanceListResult	ロールの適格性スケジュール インスタンス一覧操作の結果。
Scope	リソース スコープの詳細
Status	ロールの適格性スケジュール インスタンスの状態

CloudError

サービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	サービスからのエラー応答。

CloudErrorBody

サービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。 コードは不変であり、プログラムによって使用されることを意図しています。
message	string	ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。

ExpandedProperties

名前	型	説明
principal	Principal	プリンシパルの詳細
roleDefinition	RoleDefinition	ロール定義の詳細
scope	Scope	リソース スコープの詳細

MemberType

ロールの適格性スケジュールのメンバーシップの種類

名前	型	説明
Direct	string
Group	string
Inherited	string

Principal

プリンシパルの詳細

名前	型	説明
displayName	string	プリンシパルの表示名
email	string	プリンシパルのEmail ID
id	string	プリンシパルの ID
type	string	プリンシパルの種類

principalType

割り当てられたプリンシパル ID のプリンシパルの種類。

名前	型	説明
Device	string
ForeignGroup	string
Group	string
ServicePrincipal	string
User	string

RoleDefinition

ロール定義の詳細

名前	型	説明
displayName	string	ロール定義の表示名
id	string	ロール定義の ID
type	string	ロール定義の種類

RoleEligibilityScheduleInstance

現在または今後のロールの適格性スケジュール インスタンスに関する情報

名前	型	説明
id	string	ロールの適格性スケジュール インスタンス ID。
name	string	ロールの適格性スケジュール インスタンス名。
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
properties.expandedProperties	ExpandedProperties	プリンシパル、スコープ、ロール定義の追加プロパティ
properties.memberType	MemberType	ロールの適格性スケジュールのメンバーシップの種類
properties.principalId	string	プリンシパル ID。
properties.principalType	principalType	割り当てられたプリンシパル ID のプリンシパルの種類。
properties.roleDefinitionId	string	ロール定義 ID
properties.roleEligibilityScheduleId	string	マスター ロールの適格性スケジュールの ID
properties.scope	string	ロールの適格性スケジュール スコープ。
properties.startDateTime	string	ロールの適格性スケジュール インスタンスの startDateTime
properties.status	Status	ロールの適格性スケジュール インスタンスの状態
type	string	ロールの適格性スケジュール インスタンスの種類。

RoleEligibilityScheduleInstanceListResult

ロールの適格性スケジュール インスタンス一覧操作の結果。

名前	型	説明
nextLink	string	次の結果セットを取得するために使用する URL。
value	RoleEligibilityScheduleInstance[]	ロールの適格性スケジュール インスタンスの一覧。

Scope

リソース スコープの詳細

名前	型	説明
displayName	string	リソースの表示名
id	string	リソースのスコープ ID
type	string	リソースの種類

Status

ロールの適格性スケジュール インスタンスの状態

名前	型	説明
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