Role Assignment Schedules - List For Scope

Tjänst:

Authorization

API-version:

2020-10-01

Hämtar rolltilldelningsscheman för ett resursomfång.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
scope	path	True	string	Omfånget för scheman för rolltilldelningar.
api-version	query	True	string minLength: 1	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 rolltilldelningsscheman vid eller över omfånget. Använd $filter=principalId eq {id} för att returnera alla rolltilldelningsscheman vid, ovanför eller under omfånget för det angivna huvudkontot. Använd $filter=assignedTo('{userId}') för att returnera alla rolltilldelningsscheman för den aktuella användaren. Använd $filter=asTarget() för att returnera alla rolltilldelningsscheman som skapats för den aktuella användaren.

Svar

Name	Typ	Description
200 OK	RoleAssignmentScheduleListResult	OK – Returnerar en matris med scheman för rolltilldelningar.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

GetRoleAssignmentSchedulesByScope

Exempelbegäran

HTTP

GET https://management.azure.com/providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleAssignmentSchedules?$filter=assignedTo('a3bb8764-cb92-4276-9d2a-ca1e895e55ea')&api-version=2020-10-01

Java

/**
 * Samples for RoleAssignmentSchedules ListForScope.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/
     * GetRoleAssignmentSchedulesByScope.json
     */
    /**
     * Sample code: GetRoleAssignmentSchedulesByScope.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getRoleAssignmentSchedulesByScope(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.accessManagement().roleAssignments().manager().roleServiceClient().getRoleAssignmentSchedules()
            .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/GetRoleAssignmentSchedulesByScope.json
func ExampleRoleAssignmentSchedulesClient_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.NewRoleAssignmentSchedulesClient().NewListForScopePager("providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", &armauthorization.RoleAssignmentSchedulesClientListForScopeOptions{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.RoleAssignmentScheduleListResult = armauthorization.RoleAssignmentScheduleListResult{
		// 	Value: []*armauthorization.RoleAssignmentSchedule{
		// 		{
		// 			Name: to.Ptr("c9e264ff-3133-4776-a81a-ebc7c33c8ec6"),
		// 			Type: to.Ptr("Microsoft.Authorization/RoleAssignmentSchedules"),
		// 			ID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentSchedules/c9e264ff-3133-4776-a81a-ebc7c33c8ec6"),
		// 			Properties: &armauthorization.RoleAssignmentScheduleProperties{
		// 				AssignmentType: to.Ptr(armauthorization.AssignmentTypeAssigned),
		// 				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}()),
		// 				EndDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-10T05:35:17.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"),
		// 					},
		// 				},
		// 				LinkedRoleEligibilityScheduleID: to.Ptr("b1477448-2cc6-4ceb-93b4-54a202a89413"),
		// 				MemberType: to.Ptr(armauthorization.MemberTypeDirect),
		// 				PrincipalID: to.Ptr("a3bb8764-cb92-4276-9d2a-ca1e895e55ea"),
		// 				PrincipalType: to.Ptr(armauthorization.PrincipalTypeUser),
		// 				RoleAssignmentScheduleRequestID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045"),
		// 				RoleDefinitionID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608"),
		// 				Scope: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f"),
		// 				StartDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-09T21:35:27.910Z"); return t}()),
		// 				Status: to.Ptr(armauthorization.StatusProvisioned),
		// 				UpdatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-09T21:35:27.910Z"); return t}()),
		// 			},
		// 	}},
		// }
	}
}

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 schedules for a resource scope.
 *
 * @summary Gets role assignment schedules for a resource scope.
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/GetRoleAssignmentSchedulesByScope.json
 */
async function getRoleAssignmentSchedulesByScope() {
  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.roleAssignmentSchedules.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 Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Authorization;

// Generated from example definition: specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/GetRoleAssignmentSchedulesByScope.json
// this example is just showing the usage of "RoleAssignmentSchedules_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 RoleAssignmentScheduleResource
string scope = "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f";
RoleAssignmentScheduleCollection collection = client.GetRoleAssignmentSchedules(new ResourceIdentifier(scope));

// invoke the operation and iterate over the result
string filter = "assignedTo('a3bb8764-cb92-4276-9d2a-ca1e895e55ea')";
await foreach (RoleAssignmentScheduleResource 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
    RoleAssignmentScheduleData 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

Exempelsvar

Statuskod:

200

{
  "value": [
    {
      "properties": {
        "linkedRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413",
        "assignmentType": "Assigned",
        "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",
        "status": "Provisioned",
        "roleAssignmentScheduleRequestId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045",
        "startDateTime": "2020-09-09T21:35:27.91Z",
        "endDateTime": "2020-09-10T05:35:17.91Z",
        "memberType": "Direct",
        "createdOn": "2020-09-09T21:35:27.91Z",
        "updatedOn": "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": "c9e264ff-3133-4776-a81a-ebc7c33c8ec6",
      "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentSchedules/c9e264ff-3133-4776-a81a-ebc7c33c8ec6",
      "type": "Microsoft.Authorization/RoleAssignmentSchedules"
    }
  ]
}

Definitioner

Name	Description
AssignmentType	Tilldelningstyp för rolltilldelningsschemat
CloudError	Ett felsvar från tjänsten.
CloudErrorBody	Ett felsvar från tjänsten.
ExpandedProperties
MemberType	Medlemskapstyp för rolltilldelningsschemat
Principal	Information om huvudkontot
principalType	Huvudtypen för det tilldelade huvudnamns-ID:t.
RoleAssignmentSchedule	Schema för rolltilldelning
RoleAssignmentScheduleListResult	Resultat av liståtgärden lista över rolltilldelningsscheman.
RoleDefinition	Information om rolldefinition
Scope	Information om resursomfånget
Status	Status för rolltilldelningsschemat.

AssignmentType

Uppräkning

Tilldelningstyp för rolltilldelningsschemat

Värde	Description
Activated
Assigned

CloudError

Objekt

Ett felsvar från tjänsten.

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

CloudErrorBody

Objekt

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

Objekt

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

MemberType

Uppräkning

Medlemskapstyp för rolltilldelningsschemat

Värde	Description
Direct
Group
Inherited

Principal

Objekt

Information om huvudkontot

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

principalType

Uppräkning

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

Värde	Description
Device
ForeignGroup
Group
ServicePrincipal
User

RoleAssignmentSchedule

Objekt

Schema för rolltilldelning

Name	Typ	Description
id	string	Schema-ID för rolltilldelning.
name	string	Namnet på rolltilldelningsschemat.
properties.assignmentType	AssignmentType	Tilldelningstyp för rolltilldelningsschemat
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. Det godkända värdet är för närvarande "2.0"
properties.createdOn	string (date-time)	DateTime när rolltilldelningsschemat skapades
properties.endDateTime	string (date-time)	End DateTime när rolltilldelningsschema
properties.expandedProperties	ExpandedProperties	Ytterligare egenskaper för huvudnamn, omfång och rolldefinition
properties.linkedRoleEligibilityScheduleId	string	ID:t för roleEligibilitySchedule som används för att aktivera den här rollenAssignmentSchedule
properties.memberType	MemberType	Medlemskapstyp för rolltilldelningsschemat
properties.principalId	string	Huvud-ID:t.
properties.principalType	principalType	Huvudtypen för det tilldelade huvudnamns-ID:t.
properties.roleAssignmentScheduleRequestId	string	ID:t för roleAssignmentScheduleRequest som används för att skapa den här rollenAssignmentSchedule
properties.roleDefinitionId	string	Rolldefinitions-ID.
properties.scope	string	Omfånget för rolltilldelningsschemat.
properties.startDateTime	string (date-time)	Starta DateTime när rolltilldelningsschema
properties.status	Status	Status för rolltilldelningsschemat.
properties.updatedOn	string (date-time)	DateTime när rolltilldelningsschemat ändrades
type	string	Typ av schema för rolltilldelning.

RoleAssignmentScheduleListResult

Objekt

Resultat av liståtgärden lista över rolltilldelningsscheman.

Name	Typ	Description
nextLink	string	Den URL som ska användas för att hämta nästa uppsättning resultat.
value	RoleAssignmentSchedule[]	Schemalista för rolltilldelning.

RoleDefinition

Objekt

Information om rolldefinition

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

Scope

Objekt

Information om resursomfånget

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

Status

Uppräkning

Status för rolltilldelningsschemat.

Värde	Description
Accepted
AdminApproved
AdminDenied
Canceled
Denied
Failed
FailedAsResourceIsLocked
Granted
Invalid
PendingAdminDecision
PendingApproval
PendingApprovalProvisioning
PendingEvaluation
PendingExternalProvisioning
PendingProvisioning
PendingRevocation
PendingScheduleCreation
Provisioned
ProvisioningStarted
Revoked
ScheduleCreated
TimedOut