Role Eligibility Schedule Requests - List For Scope

Service:

Authorization

API Version:

2020-10-01

Lekéri egy hatókör szerepkör-jogosultsági ütemezési kéréseit.

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

With optional parameters:

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
scope	path	True	string	A szerepkör jogosultsági ütemezési kérelmeinek hatóköre.
api-version	query	True	string	A művelethez használandó API-verzió.
$filter	query		string	A műveletre alkalmazandó szűrő. Az $filter=atScope() használatával visszaadhatja a hatókörben lévő vagy annál nagyobb szerepkör-jogosultsági ütemezési kéréseket. A $filter=principalId eq {id} használatával visszaadhatja a szerepkör-jogosultsági ütemezési kérelmeket a megadott rendszerbiztonsági tag hatóköre felett vagy alatt. Használja a $filter=asRequestor() függvényt az aktuális felhasználó által kért összes szerepkör-jogosultsági ütemezési kérés visszaadásához. Használja a $filter=asTarget() függvényt az aktuális felhasználó számára létrehozott összes szerepkör-jogosultsági ütemezési kérés visszaadásához. A $filter=asApprover() használatával visszaadhatja az összes olyan szerepkör-jogosultsági ütemezési kérést, amelyben az aktuális felhasználó jóváhagyó.

Válaszok

Name	Típus	Description
200 OK	RoleEligibilityScheduleRequestListResult	OK – A szerepkör jogosultsági ütemezési kérelmeinek tömbjét adja vissza.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

GetRoleEligibilityScheduleRequestByScope

Sample Request

HTTP

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

Java

/** Samples for RoleEligibilityScheduleRequests ListForScope. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/
     * GetRoleEligibilityScheduleRequestByScope.json
     */
    /**
     * Sample code: GetRoleEligibilityScheduleRequestByScope.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getRoleEligibilityScheduleRequestByScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.accessManagement().roleAssignments().manager().roleServiceClient().getRoleEligibilityScheduleRequests()
            .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/GetRoleEligibilityScheduleRequestByScope.json
func ExampleRoleEligibilityScheduleRequestsClient_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.NewRoleEligibilityScheduleRequestsClient().NewListForScopePager("providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", &armauthorization.RoleEligibilityScheduleRequestsClientListForScopeOptions{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.RoleEligibilityScheduleRequestListResult = armauthorization.RoleEligibilityScheduleRequestListResult{
		// 	Value: []*armauthorization.RoleEligibilityScheduleRequest{
		// 		{
		// 			Name: to.Ptr("64caffb6-55c0-4deb-a585-68e948ea1ad6"),
		// 			Type: to.Ptr("Microsoft.Authorization/RoleEligibilityRequests"),
		// 			ID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6"),
		// 			Properties: &armauthorization.RoleEligibilityScheduleRequestProperties{
		// 				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:32: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.RequestTypeAdminAssign),
		// 				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.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.910Z"); return t}()),
		// 				},
		// 				Scope: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f"),
		// 				Status: to.Ptr(armauthorization.StatusProvisioned),
		// 				TargetRoleEligibilityScheduleID: to.Ptr("b1477448-2cc6-4ceb-93b4-54a202a89413"),
		// 				TicketInfo: &armauthorization.RoleEligibilityScheduleRequestPropertiesTicketInfo{
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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

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

// invoke the operation and iterate over the result
string filter = "assignedTo('A3BB8764-CB92-4276-9D2A-CA1E895E55EA')";
await foreach (RoleEligibilityScheduleRequestResource 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
    RoleEligibilityScheduleRequestData 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": {
        "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/RoleEligibilityRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6",
      "type": "Microsoft.Authorization/RoleEligibilityRequests"
    }
  ]
}

Definíciók

Name	Description
CloudError	Hibaválasz a szolgáltatástól.
CloudErrorBody	Hibaválasz a szolgáltatástól.
ExpandedProperties	Bővített információ az erőforrásról, a szerepkörről és a rendszerbiztonsági tagról
Expiration	A szerepkör jogosultsági ütemezésének lejárata
Principal	A rendszerbiztonsági tag adatai
principalType	A hozzárendelt rendszerbiztonsági tag azonosítójának egyszerű típusa.
RequestType	A szerepkör-hozzárendelés ütemezési kérésének típusa. Például: SelfActivate, AdminAssign stb.
RoleDefinition	A szerepkör-definíció részletei
RoleEligibilityScheduleRequest	Szerepkör jogosultsági ütemezésére vonatkozó kérés
RoleEligibilityScheduleRequestListResult	A szerepkör jogosultsági ütemezésének kéréslistájára vonatkozó művelet eredménye.
ScheduleInfo	A szerepkör jogosultsági ütemezésének ütemezési adatai
Scope	Az erőforrás hatókörének részletei
Status	A szerepkör jogosultsági ütemezésére vonatkozó kérés állapota.
TicketInfo	A szerepkör-jogosultság jegyadatai
Type	A szerepkör jogosultsági ütemezésének lejárati típusa

CloudError

Hibaválasz a szolgáltatástól.

Name	Típus	Description
error	CloudErrorBody	Hibaválasz a szolgáltatástól.

CloudErrorBody

Hibaválasz a szolgáltatástól.

Name	Típus	Description
code	string	A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.
message	string	A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.

ExpandedProperties

Bővített információ az erőforrásról, a szerepkörről és a rendszerbiztonsági tagról

Name	Típus	Description
principal	Principal	A rendszerbiztonsági tag adatai
roleDefinition	RoleDefinition	A szerepkör-definíció részletei
scope	Scope	Az erőforrás hatókörének részletei

Expiration

A szerepkör jogosultsági ütemezésének lejárata

Name	Típus	Description
duration	string	A szerepkör jogosultsági ütemezésének időtartama a TimeSpanban.
endDateTime	string	A szerepkör jogosultsági ütemezésének befejezési dátumideje.
type	Type	A szerepkör jogosultsági ütemezésének lejárati típusa

Principal

A rendszerbiztonsági tag adatai

Name	Típus	Description
displayName	string	A rendszerbiztonsági tag megjelenítendő neve
email	string	Email résztvevő azonosítója
id	string	A rendszerbiztonsági tag azonosítója
type	string	A rendszerbiztonsági tag típusa

principalType

A hozzárendelt rendszerbiztonsági tag azonosítójának egyszerű típusa.

Name	Típus	Description
Device	string
ForeignGroup	string
Group	string
ServicePrincipal	string
User	string

RequestType

A szerepkör-hozzárendelés ütemezési kérésének típusa. Például: SelfActivate, AdminAssign stb.

Name	Típus	Description
AdminAssign	string
AdminExtend	string
AdminRemove	string
AdminRenew	string
AdminUpdate	string
SelfActivate	string
SelfDeactivate	string
SelfExtend	string
SelfRenew	string

RoleDefinition

A szerepkör-definíció részletei

Name	Típus	Description
displayName	string	A szerepkör-definíció megjelenítendő neve
id	string	A szerepkör-definíció azonosítója
type	string	A szerepkör-definíció típusa

RoleEligibilityScheduleRequest

Szerepkör jogosultsági ütemezésére vonatkozó kérés

Name	Típus	Description
id	string	A szerepkör jogosultsági ütemezésének kérésazonosítója.
name	string	A szerepkör jogosultsági ütemezési kérésének neve.
properties.approvalId	string	A szerepkör jogosultsági ütemezésére vonatkozó kérelem jóváhagyási azonosítója.
properties.condition	string	A szerepkör-hozzárendelés feltételei. Ez korlátozza az erőforrásokat, amelyekhez hozzárendelhető. Például: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container"
properties.conditionVersion	string	A feltétel verziója. Jelenleg elfogadott érték: "2.0"
properties.createdOn	string	DateTime a szerepkör jogosultsági ütemezési kérésének létrehozásakor
properties.expandedProperties	ExpandedProperties	A rendszerbiztonsági tag, a hatókör és a szerepkör-definíció további tulajdonságai
properties.justification	string	A szerepkör-jogosultság indoklása
properties.principalId	string	A rendszerbiztonsági tag azonosítója.
properties.principalType	principalType	A hozzárendelt rendszerbiztonsági tag azonosítójának egyszerű típusa.
properties.requestType	RequestType	A szerepkör-hozzárendelés ütemezési kérésének típusa. Például: SelfActivate, AdminAssign stb.
properties.requestorId	string	A kérést létrehozó felhasználó azonosítója
properties.roleDefinitionId	string	A szerepkör-definíció azonosítója.
properties.scheduleInfo	ScheduleInfo	A szerepkör jogosultsági ütemezésének ütemezési adatai
properties.scope	string	A szerepkör jogosultsági ütemezésének kérési hatóköre.
properties.status	Status	A szerepkör jogosultsági ütemezésére vonatkozó kérés állapota.
properties.targetRoleEligibilityScheduleId	string	Az eredményül kapott szerepkör jogosultsági ütemezésének azonosítója vagy a szerepkör jogosultsági ütemezésének frissítése folyamatban van
properties.targetRoleEligibilityScheduleInstanceId	string	A szerepkör jogosultsági ütemezésének példányazonosítója frissítve van
properties.ticketInfo	TicketInfo	A szerepkör-jogosultság jegyadatai
type	string	A szerepkör jogosultsági ütemezésének kéréstípusa.

RoleEligibilityScheduleRequestListResult

A szerepkör jogosultsági ütemezésének kéréslistájára vonatkozó művelet eredménye.

Name	Típus	Description
nextLink	string	A következő találatkészlet lekéréséhez használandó URL-cím.
value	RoleEligibilityScheduleRequest[]	Szerepkör jogosultsági ütemezésének kéréslistája.

ScheduleInfo

A szerepkör jogosultsági ütemezésének ütemezési adatai

Name	Típus	Description
expiration	Expiration	A szerepkör jogosultsági ütemezésének lejárata
startDateTime	string	Indítsa el a szerepkör jogosultsági ütemezésének DateTime dátumát.

Scope

Az erőforrás hatókörének részletei

Name	Típus	Description
displayName	string	Az erőforrás megjelenített neve
id	string	Az erőforrás hatókör-azonosítója
type	string	Az erőforrás típusa

Status

A szerepkör jogosultsági ütemezésére vonatkozó kérés állapota.

Name	Típus	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

A szerepkör-jogosultság jegyadatai

Name	Típus	Description
ticketNumber	string	A szerepkör-jogosultság jegyszáma
ticketSystem	string	A szerepkör-jogosultság jegyrendszerneve

Type

A szerepkör jogosultsági ütemezésének lejárati típusa

Name	Típus	Description
AfterDateTime	string
AfterDuration	string
NoExpiration	string