Role Eligibility Schedule Requests - List For Scope

Service:

Authorization

API Version:

2020-10-01

Obtiene las solicitudes de programación de idoneidad de roles para un ámbito.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
scope	path	True	string	Ámbito de las solicitudes de programación de idoneidad de roles.
api-version	query	True	string	Versión de API que se usará para la operación.
$filter	query		string	Filtro que se va a aplicar en la operación. Use $filter=atScope() para devolver todas las solicitudes de programación de idoneidad de roles en o por encima del ámbito. Use $filter=principalId eq {id} para devolver todas las solicitudes de programación de idoneidad de roles en, por encima o por debajo del ámbito de la entidad de seguridad especificada. Use $filter=asRequestor() para devolver todas las solicitudes de programación de idoneidad de roles solicitadas por el usuario actual. Use $filter=asTarget() para devolver todas las solicitudes de programación de idoneidad de roles creadas para el usuario actual. Use $filter=asApprover() para devolver todas las solicitudes de programación de idoneidad de roles en las que el usuario actual es un aprobador.

Respuestas

Nombre	Tipo	Description
200 OK	RoleEligibilityScheduleRequestListResult	Aceptar: devuelve una matriz de solicitudes de programación de idoneidad de roles.
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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

Definiciones

Nombre	Description
CloudError	Respuesta de error del servicio.
CloudErrorBody	Respuesta de error del servicio.
ExpandedProperties	Información expandida de recursos, roles y entidades de seguridad
Expiration	Expiración de la programación de idoneidad del rol
Principal	Detalles de la entidad de seguridad
principalType	Tipo de entidad de seguridad del identificador de entidad de seguridad asignado.
RequestType	Tipo de la solicitud de programación de asignación de roles. Por ejemplo: SelfActivate, AdminAssign, etc.
RoleDefinition	Detalles de la definición de roles
RoleEligibilityScheduleRequest	Solicitud de programación de idoneidad de roles
RoleEligibilityScheduleRequestListResult	Resultado de la operación de lista de solicitudes de programación de idoneidad de roles.
ScheduleInfo	Información de programación de la programación de la programación de idoneidad del rol
Scope	Detalles del ámbito del recurso
Status	Estado de la solicitud de programación de idoneidad del rol.
TicketInfo	Información del vale de la idoneidad del rol
Type	Tipo de expiración de la programación de idoneidad del rol

CloudError

Respuesta de error del servicio.

Nombre	Tipo	Description
error	CloudErrorBody	Respuesta de error del servicio.

CloudErrorBody

Respuesta de error del servicio.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	string	Mensaje que describe el error, diseñado para ser adecuado para su presentación en una interfaz de usuario.

ExpandedProperties

Información expandida de recursos, roles y entidades de seguridad

Nombre	Tipo	Description
principal	Principal	Detalles de la entidad de seguridad
roleDefinition	RoleDefinition	Detalles de la definición de roles
scope	Scope	Detalles del ámbito del recurso

Expiration

Expiración de la programación de idoneidad del rol

Nombre	Tipo	Description
duration	string	Duración de la programación de idoneidad del rol en TimeSpan.
endDateTime	string	End DateTime de la programación de idoneidad del rol.
type	Type	Tipo de expiración de la programación de idoneidad del rol

Principal

Detalles de la entidad de seguridad

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la entidad de seguridad
email	string	Email id. de la entidad de seguridad
id	string	Identificador de la entidad de seguridad
type	string	Tipo de la entidad de seguridad

principalType

Tipo de entidad de seguridad del identificador de entidad de seguridad asignado.

Nombre	Tipo	Description
Device	string
ForeignGroup	string
Group	string
ServicePrincipal	string
User	string

RequestType

Tipo de la solicitud de programación de asignación de roles. Por ejemplo: SelfActivate, AdminAssign, etc.

Nombre	Tipo	Description
AdminAssign	string
AdminExtend	string
AdminRemove	string
AdminRenew	string
AdminUpdate	string
SelfActivate	string
SelfDeactivate	string
SelfExtend	string
SelfRenew	string

RoleDefinition

Detalles de la definición de roles

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la definición de rol
id	string	Identificador de la definición de roles
type	string	Tipo de la definición de roles

RoleEligibilityScheduleRequest

Solicitud de programación de idoneidad de roles

Nombre	Tipo	Description
id	string	Identificador de solicitud de programación de idoneidad del rol.
name	string	Nombre de la solicitud de programación de idoneidad del rol.
properties.approvalId	string	ApprovalId de la solicitud de programación de idoneidad del rol.
properties.condition	string	Condiciones de la asignación de roles. Esto limita los recursos a los que se puede asignar. Por ejemplo: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion	string	Versión de la condición. El valor aceptado actualmente es '2.0'
properties.createdOn	string	DateTime cuando se creó la solicitud de programación de idoneidad del rol
properties.expandedProperties	ExpandedProperties	Propiedades adicionales de la entidad de seguridad, el ámbito y la definición de roles
properties.justification	string	Justificación de la idoneidad del rol
properties.principalId	string	Identificador de entidad de seguridad.
properties.principalType	principalType	Tipo de entidad de seguridad del identificador de entidad de seguridad asignado.
properties.requestType	RequestType	Tipo de la solicitud de programación de asignación de roles. Por ejemplo: SelfActivate, AdminAssign, etc.
properties.requestorId	string	Identificador del usuario que creó esta solicitud
properties.roleDefinitionId	string	Identificador de la definición de roles.
properties.scheduleInfo	ScheduleInfo	Información de programación de la programación de la programación de idoneidad del rol
properties.scope	string	Ámbito de solicitud de programación de idoneidad del rol.
properties.status	Status	Estado de la solicitud de programación de idoneidad del rol.
properties.targetRoleEligibilityScheduleId	string	Identificador de programación de idoneidad del rol resultante o el identificador de programación de idoneidad del rol que se está actualizando.
properties.targetRoleEligibilityScheduleInstanceId	string	Identificador de instancia de programación de idoneidad de rol que se va a actualizar
properties.ticketInfo	TicketInfo	Información del vale de la idoneidad del rol
type	string	Tipo de solicitud de programación de idoneidad de rol.

RoleEligibilityScheduleRequestListResult

Resultado de la operación de lista de solicitudes de programación de idoneidad de roles.

Nombre	Tipo	Description
nextLink	string	Dirección URL que se va a usar para obtener el siguiente conjunto de resultados.
value	RoleEligibilityScheduleRequest[]	Lista de solicitudes de programación de idoneidad de roles.

ScheduleInfo

Información de programación de la programación de la programación de idoneidad del rol

Nombre	Tipo	Description
expiration	Expiration	Expiración de la programación de idoneidad del rol
startDateTime	string	Inicie DateTime de la programación de idoneidad del rol.

Scope

Detalles del ámbito del recurso

Nombre	Tipo	Description
displayName	string	Nombre para mostrar del recurso
id	string	Identificador de ámbito del recurso
type	string	Tipo de recurso

Status

Estado de la solicitud de programación de idoneidad del rol.

Nombre	Tipo	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

Información del vale de la idoneidad del rol

Nombre	Tipo	Description
ticketNumber	string	Número de vale para la idoneidad del rol
ticketSystem	string	Nombre del sistema de vales para la idoneidad del rol

Type

Tipo de expiración de la programación de idoneidad del rol

Nombre	Tipo	Description
AfterDateTime	string
AfterDuration	string
NoExpiration	string