Role Assignment Schedule Requests - List For Scope

サービス:

Authorization

API バージョン:

2020-10-01

スコープのロール割り当てスケジュール要求を取得します。

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

省略可能なパラメーターを含む:

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

URI パラメーター

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

応答

名前	型	説明
200 OK	RoleAssignmentScheduleRequestListResult	OK - ロールの割り当てスケジュール要求の配列を返します。
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

例

GetRoleAssignmentScheduleRequestByScope

要求のサンプル

HTTP

GET https://management.azure.com/providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleAssignmentScheduleRequests?$filter=assignedTo('A3BB8764-CB92-4276-9D2A-CA1E895E55EA')&api-version=2020-10-01

Java

/**
 * Samples for RoleAssignmentScheduleRequests ListForScope.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/
     * GetRoleAssignmentScheduleRequestByScope.json
     */
    /**
     * Sample code: GetRoleAssignmentScheduleRequestByScope.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getRoleAssignmentScheduleRequestByScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.accessManagement().roleAssignments().manager().roleServiceClient().getRoleAssignmentScheduleRequests()
            .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/GetRoleAssignmentScheduleRequestByScope.json
func ExampleRoleAssignmentScheduleRequestsClient_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.NewRoleAssignmentScheduleRequestsClient().NewListForScopePager("providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", &armauthorization.RoleAssignmentScheduleRequestsClientListForScopeOptions{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.RoleAssignmentScheduleRequestListResult = armauthorization.RoleAssignmentScheduleRequestListResult{
		// 	Value: []*armauthorization.RoleAssignmentScheduleRequest{
		// 		{
		// 			Name: to.Ptr("fea7a502-9a96-4806-a26f-eee560e52045"),
		// 			Type: to.Ptr("Microsoft.Authorization/RoleAssignmentScheduleRequests"),
		// 			ID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045"),
		// 			Properties: &armauthorization.RoleAssignmentScheduleRequestProperties{
		// 				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}()),
		// 				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"),
		// 					},
		// 				},
		// 				PrincipalID: to.Ptr("a3bb8764-cb92-4276-9d2a-ca1e895e55ea"),
		// 				PrincipalType: to.Ptr(armauthorization.PrincipalTypeUser),
		// 				RequestType: to.Ptr(armauthorization.RequestTypeSelfActivate),
		// 				RequestorID: to.Ptr("a3bb8764-cb92-4276-9d2a-ca1e895e55ea"),
		// 				RoleDefinitionID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608"),
		// 				ScheduleInfo: &armauthorization.RoleAssignmentScheduleRequestPropertiesScheduleInfo{
		// 					Expiration: &armauthorization.RoleAssignmentScheduleRequestPropertiesScheduleInfoExpiration{
		// 						Type: to.Ptr(armauthorization.TypeAfterDuration),
		// 						Duration: to.Ptr("PT8H"),
		// 					},
		// 					StartDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-09T21:35:27.910Z"); return t}()),
		// 				},
		// 				Scope: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f"),
		// 				Status: to.Ptr(armauthorization.StatusProvisioned),
		// 				TargetRoleAssignmentScheduleID: to.Ptr("b1477448-2cc6-4ceb-93b4-54a202a89413"),
		// 				TicketInfo: &armauthorization.RoleAssignmentScheduleRequestPropertiesTicketInfo{
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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 requests for a scope.
 *
 * @summary Gets role assignment schedule requests for a scope.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/GetRoleAssignmentScheduleRequestByScope.json
 */
async function getRoleAssignmentScheduleRequestByScope() {
  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.roleAssignmentScheduleRequests.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 System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Authorization.Models;
using Azure.ResourceManager.Authorization;

// Generated from example definition: specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/GetRoleAssignmentScheduleRequestByScope.json
// this example is just showing the usage of "RoleAssignmentScheduleRequests_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);

// get the collection of this RoleAssignmentScheduleRequestResource
string scope = "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f";
RoleAssignmentScheduleRequestCollection collection = client.GetRoleAssignmentScheduleRequests(new ResourceIdentifier(scope));

// invoke the operation and iterate over the result
string filter = "assignedTo('A3BB8764-CB92-4276-9D2A-CA1E895E55EA')";
await foreach (RoleAssignmentScheduleRequestResource 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
    RoleAssignmentScheduleRequestData 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": {
        "targetRoleAssignmentScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413",
        "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"
    }
  ]
}

定義

名前	説明
CloudError	サービスからのエラー応答。
CloudErrorBody	サービスからのエラー応答。
ExpandedProperties
Expiration	ロールの割り当てスケジュールの有効期限
Principal	プリンシパルの詳細
principalType	割り当てられたプリンシパル ID のプリンシパルの種類。
RequestType	ロールの割り当てスケジュール要求の種類。 例: SelfActivate、AdminAssign など
RoleAssignmentScheduleRequest	ロールの割り当てスケジュール要求
RoleAssignmentScheduleRequestListResult	ロールの割り当てスケジュール要求の一覧操作の結果。
RoleDefinition	ロール定義の詳細
ScheduleInfo	ロールの割り当てスケジュールのスケジュール情報
Scope	リソース スコープの詳細
Status	ロールの割り当てスケジュール要求の状態。
TicketInfo	ロールの割り当てのチケット情報
Type	ロールの割り当てスケジュールの有効期限の種類

CloudError

Object

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

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

CloudErrorBody

Object

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

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

ExpandedProperties

Object

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

Expiration

Object

ロールの割り当てスケジュールの有効期限

名前	型	説明
duration	string	TimeSpan でのロールの割り当てスケジュールの期間。
endDateTime	string (date-time)	ロールの割り当てスケジュールの終了日時。
type	Type	ロールの割り当てスケジュールの有効期限の種類

Principal

Object

プリンシパルの詳細

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

principalType

列挙

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

値	説明
Device
ForeignGroup
Group
ServicePrincipal
User

RequestType

列挙

ロールの割り当てスケジュール要求の種類。 例: SelfActivate、AdminAssign など

値	説明
AdminAssign
AdminExtend
AdminRemove
AdminRenew
AdminUpdate
SelfActivate
SelfDeactivate
SelfExtend
SelfRenew

RoleAssignmentScheduleRequest

Object

ロールの割り当てスケジュール要求

名前	型	説明
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)	ロールの割り当てスケジュール要求が作成された日時
properties.expandedProperties	ExpandedProperties	プリンシパル、スコープ、ロール定義の追加プロパティ
properties.justification	string	ロールの割り当ての理由
properties.linkedRoleEligibilityScheduleId	string	リンクされたロールの適格性スケジュール ID - 適格性をアクティブ化します。
properties.principalId	string	プリンシパル ID。
properties.principalType	principalType	割り当てられたプリンシパル ID のプリンシパルの種類。
properties.requestType	RequestType	ロールの割り当てスケジュール要求の種類。 例: SelfActivate、AdminAssign など
properties.requestorId	string	この要求を作成したユーザーの ID
properties.roleDefinitionId	string	ロール定義 ID。
properties.scheduleInfo	ScheduleInfo	ロールの割り当てスケジュールのスケジュール情報
properties.scope	string	ロールの割り当てスケジュール要求スコープ。
properties.status	Status	ロールの割り当てスケジュール要求の状態。
properties.targetRoleAssignmentScheduleId	string	結果のロール割り当てスケジュール ID または更新されるロールの割り当てスケジュール ID
properties.targetRoleAssignmentScheduleInstanceId	string	更新されるロールの割り当てスケジュール インスタンス ID
properties.ticketInfo	TicketInfo	ロールの割り当てのチケット情報
type	string	ロールの割り当てスケジュール要求の種類。

RoleAssignmentScheduleRequestListResult

Object

ロールの割り当てスケジュール要求の一覧操作の結果。

名前	型	説明
nextLink	string	次の結果セットの取得に使用する URL。
value	RoleAssignmentScheduleRequest[]	ロールの割り当てスケジュール要求の一覧。

RoleDefinition

Object

ロール定義の詳細

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

ScheduleInfo

Object

ロールの割り当てスケジュールのスケジュール情報

名前	型	説明
expiration	Expiration	ロールの割り当てスケジュールの有効期限
startDateTime	string (date-time)	ロールの割り当てスケジュールの DateTime を開始します。

Scope

Object

リソース スコープの詳細

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

Status

列挙

ロールの割り当てスケジュール要求の状態。

値	説明
Accepted
AdminApproved
AdminDenied
Canceled
Denied
Failed
FailedAsResourceIsLocked
Granted
Invalid
PendingAdminDecision
PendingApproval
PendingApprovalProvisioning
PendingEvaluation
PendingExternalProvisioning
PendingProvisioning
PendingRevocation
PendingScheduleCreation
Provisioned
ProvisioningStarted
Revoked
ScheduleCreated
TimedOut

TicketInfo

Object

ロールの割り当てのチケット情報

名前	型	説明
ticketNumber	string	ロールの割り当てのチケット番号
ticketSystem	string	ロールの割り当てのチケット システム名

Type

列挙

ロールの割り当てスケジュールの有効期限の種類

値	説明
AfterDateTime
AfterDuration
NoExpiration