Role Eligibility Schedule Requests - List For Scope

Service:

Authorization

API Version:

2020-10-01

Hämtar begäranden om rollberättigande för ett omfång.

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-parametrar

Name	I	Obligatorisk	Typ	Description
scope	path	True	string	Omfånget för begäranden om behörighetsschema för rollen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.
$filter	query		string	Filtret som ska tillämpas på åtgärden. Använd $filter=atScope() för att returnera alla begäranden om rollberättigande schema vid eller över omfånget. Använd $filter=principalId eq {id} för att returnera alla begäranden om rollberättigande vid, ovanför eller under omfånget för det angivna huvudkontot. Använd $filter=asRequestor() för att returnera alla begäranden om behörighetsschema för roller som begärs av den aktuella användaren. Använd $filter=asTarget() för att returnera alla begäranden om rollberättigande som skapats för den aktuella användaren. Använd $filter=asApprover() för att returnera alla begäranden om behörighetsschema för roller där den aktuella användaren är godkännare.

Svar

Name	Typ	Description
200 OK	RoleEligibilityScheduleRequestListResult	OK – Returnerar en matris med begäranden om rollberättigandescheman.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

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"
    }
  ]
}

Definitioner

Name	Description
CloudError	Ett felsvar från tjänsten.
CloudErrorBody	Ett felsvar från tjänsten.
ExpandedProperties	Utökad information om resurs, roll och huvudnamn
Expiration	Förfallodatum för behörighetsschemat för rollen
Principal	Information om huvudkontot
principalType	Huvudtypen för det tilldelade huvudnamns-ID:t.
RequestType	Typ av begäran om rolltilldelningsschema. T.ex. SelfActivate, AdminAssign osv.
RoleDefinition	Information om rolldefinition
RoleEligibilityScheduleRequest	Begäran om schema för rollberättigande
RoleEligibilityScheduleRequestListResult	Resultat av åtgärden Förfrågningslista för rollberättigande schemaläggs.
ScheduleInfo	Schemalägg information om behörighetsschemat för rollen
Scope	Information om resursomfånget
Status	Status för begäran om behörighetsschema för rollen.
TicketInfo	Biljettinformation för rollens berättigande
Type	Typ av förfallodatum för rollberättigandeschemat

CloudError

Ett felsvar från tjänsten.

Name	Typ	Description
error	CloudErrorBody	Ett felsvar från tjänsten.

CloudErrorBody

Ett felsvar från tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	string	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.

ExpandedProperties

Utökad information om resurs, roll och huvudnamn

Name	Typ	Description
principal	Principal	Information om huvudkontot
roleDefinition	RoleDefinition	Information om rolldefinition
scope	Scope	Information om resursomfånget

Expiration

Förfallodatum för behörighetsschemat för rollen

Name	Typ	Description
duration	string	Varaktighet för behörighetsschemat för rollen i TimeSpan.
endDateTime	string	SlutdatumTid för behörighetsschemat för rollen.
type	Type	Typ av förfallodatum för rollberättigandeschemat

Principal

Information om huvudkontot

Name	Typ	Description
displayName	string	Huvudnamnets visningsnamn
email	string	Email ID för huvudkontot
id	string	ID för huvudkontot
type	string	Typ av huvudnamn

principalType

Huvudtypen för det tilldelade huvudnamns-ID:t.

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

RequestType

Typ av begäran om rolltilldelningsschema. T.ex. SelfActivate, AdminAssign osv.

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

RoleDefinition

Information om rolldefinition

Name	Typ	Description
displayName	string	Visningsnamn för rolldefinitionen
id	string	ID för rolldefinitionen
type	string	Typ av rolldefinition

RoleEligibilityScheduleRequest

Begäran om schema för rollberättigande

Name	Typ	Description
id	string	Begärans-ID för schemaläggning av rollberättigande.
name	string	Namnet på begäran om programbegäran för rollberättigande.
properties.approvalId	string	ApprovalId för begäran om behörighetsschema för rollen.
properties.condition	string	Villkoren för rolltilldelningen. Detta begränsar de resurser som den kan tilldelas till. t.ex. @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container"
properties.conditionVersion	string	Version av villkoret. För närvarande accepteras värdet "2.0"
properties.createdOn	string	DateTime när begäran om schema för rollberättigande skapades
properties.expandedProperties	ExpandedProperties	Ytterligare egenskaper för huvudnamn, omfång och rolldefinition
properties.justification	string	Motivering för rollens berättigande
properties.principalId	string	Huvud-ID:t.
properties.principalType	principalType	Huvudtypen för det tilldelade huvudnamns-ID:t.
properties.requestType	RequestType	Typ av begäran om rolltilldelningsschema. T.ex. SelfActivate, AdminAssign osv.
properties.requestorId	string	ID för användaren som skapade den här begäran
properties.roleDefinitionId	string	Rolldefinitions-ID.
properties.scheduleInfo	ScheduleInfo	Schemalägg information om behörighetsschemat för rollen
properties.scope	string	Rollberättigande schemalägger omfånget för begäran.
properties.status	Status	Status för begäran om behörighetsschema för rollen.
properties.targetRoleEligibilityScheduleId	string	Det resulterande schema-ID:t för rollberättigande eller det schema-ID för rollberättigande som uppdateras
properties.targetRoleEligibilityScheduleInstanceId	string	Schemalägg instans-ID för rollberättigande som uppdateras
properties.ticketInfo	TicketInfo	Biljettinformation för rollens berättigande
type	string	Typ av begäran om schema för rollberättigande.

RoleEligibilityScheduleRequestListResult

Resultat av åtgärden Förfrågningslista för rollberättigande schemaläggs.

Name	Typ	Description
nextLink	string	Url:en som ska användas för att hämta nästa uppsättning resultat.
value	RoleEligibilityScheduleRequest[]	Lista över begäranden om behörighetsschema för roll.

ScheduleInfo

Schemalägg information om behörighetsschemat för rollen

Name	Typ	Description
expiration	Expiration	Förfallodatum för behörighetsschemat för rollen
startDateTime	string	Starta DateTime för behörighetsschemat för rollen.

Scope

Information om resursomfånget

Name	Typ	Description
displayName	string	Resursens visningsnamn
id	string	Resursens omfångs-ID
type	string	Resurstyp

Status

Status för begäran om behörighetsschema för rollen.

Name	Typ	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

Biljettinformation för rollens berättigande

Name	Typ	Description
ticketNumber	string	Biljettnummer för rollens berättigande
ticketSystem	string	Biljettsystemnamn för rollens berättigande

Type

Typ av förfallodatum för rollberättigandeschemat

Name	Typ	Description
AfterDateTime	string
AfterDuration	string
NoExpiration	string