Role Assignment Schedule Requests - List For Scope

Référence

Service:: Authorization

Version d'API:: 2020-10-01

Obtient les demandes de planification d’attribution de rôle pour une étendue.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
scope	path	True	string	Étendue des demandes de planification des attributions de rôle.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.
$filter	query		string	Filtre à appliquer à l’opération. Utilisez $filter=atScope() pour renvoyer toutes les demandes de planification d’attribution de rôle au niveau ou au-dessus de l’étendue. Utilisez $filter=principalId eq {id} pour renvoyer toutes les demandes de planification d’attribution de rôle au niveau, au-dessus ou en dessous de l’étendue du principal spécifié. Utilisez $filter=asRequestor() pour retourner toutes les demandes de planification d’attribution de rôle demandées par l’utilisateur actuel. Utilisez $filter=asTarget() pour retourner toutes les demandes de planification d’attribution de rôle créées pour l’utilisateur actuel. Utilisez $filter=asApprover() pour retourner toutes les demandes de planification d’attribution de rôle lorsque l’utilisateur actuel est un approbateur.

Réponses

Nom	Type	Description
200 OK	RoleAssignmentScheduleRequestListResult	OK : retourne un tableau de demandes de planification d’attributions de rôles.
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

GetRoleAssignmentScheduleRequestByScope

Exemple de requête

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


/**
 * 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

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

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

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://zcusa.951200.xyz/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 RoleAssignmentScheduleRequestResource
string scope = "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", scope));
RoleAssignmentScheduleRequestCollection collection = client.GetRoleAssignmentScheduleRequests(scopeId);

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

Exemple de réponse

Code d’état:: 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"
    }
  ]
}

Définitions

Nom	Description
CloudError	Réponse d’erreur du service.
CloudErrorBody	Réponse d’erreur du service.
ExpandedProperties
Expiration	Expiration de la planification d’attribution de rôle
Principal	Détails du principal
principalType	Type de principal de l’ID de principal affecté.
RequestType	Type de la demande de planification d’attribution de rôle. Par exemple : SelfActivate, AdminAssign, etc.
RoleAssignmentScheduleRequest	Demande de planification d’attribution de rôle
RoleAssignmentScheduleRequestListResult	Résultat de l’opération de liste des demandes de planification d’attribution de rôle.
RoleDefinition	Détails de la définition de rôle
ScheduleInfo	Informations de planification de la planification de l’attribution de rôle
Scope	Détails de l’étendue de la ressource
Status	Status de la demande de planification d’attribution de rôle.
TicketInfo	Informations sur le ticket de l’attribution de rôle
Type	Type d’expiration de la planification d’attribution de rôle

CloudError

Réponse d’erreur du service.

Nom	Type	Description
error	CloudErrorBody	Réponse d’erreur du service.

CloudErrorBody

Réponse d’erreur du service.

Nom	Type	Description
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
message	string	Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur.

ExpandedProperties

Nom	Type	Description
principal	Principal	Détails du principal
roleDefinition	RoleDefinition	Détails de la définition de rôle
scope	Scope	Détails de l’étendue de la ressource

Expiration

Expiration de la planification d’attribution de rôle

Nom	Type	Description
duration	string	Durée de la planification de l’attribution de rôle dans TimeSpan.
endDateTime	string	DateTime de fin de la planification d’attribution de rôle.
type	Type	Type d’expiration de la planification d’attribution de rôle

Principal

Détails du principal

Nom	Type	Description
displayName	string	Nom d’affichage du principal
email	string	id de Email du principal
id	string	ID du principal
type	string	Type du principal

principalType

Type de principal de l’ID de principal affecté.

Nom	Type	Description
Device	string
ForeignGroup	string
Group	string
ServicePrincipal	string
User	string

RequestType

Type de la demande de planification d’attribution de rôle. Par exemple : SelfActivate, AdminAssign, etc.

Nom	Type	Description
AdminAssign	string
AdminExtend	string
AdminRemove	string
AdminRenew	string
AdminUpdate	string
SelfActivate	string
SelfDeactivate	string
SelfExtend	string
SelfRenew	string