Role Assignment Schedules - List For Scope

Служба:

Authorization

Версия API:

2020-10-01

Возвращает расписания назначения ролей для область ресурса.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
scope	path	True	string	Область расписаний назначений ролей.
api-version	query	True	string	Версия API, используемая для данной операции.
$filter	query		string	Фильтр, применяемый к операции. Используйте $filter=atScope(), чтобы вернуть все расписания назначения ролей в область или выше. Используйте $filter=principalId eq {id}, чтобы вернуть все расписания назначения ролей на область или ниже указанного субъекта. Используйте $filter=assignedTo('{userId}'), чтобы вернуть все расписания назначения ролей для текущего пользователя. Используйте $filter=asTarget(), чтобы вернуть все расписания назначения ролей, созданные для текущего пользователя.

Ответы

Имя	Тип	Описание
200 OK	RoleAssignmentScheduleListResult	ОК. Возвращает массив расписаний назначений ролей.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

GetRoleAssignmentSchedulesByScope

Образец запроса

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);

// 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 RoleAssignmentScheduleResource
string scope = "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", scope));
RoleAssignmentScheduleCollection collection = client.GetRoleAssignmentSchedules(scopeId);

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

Пример ответа

Код состояния:

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

Определения

Имя	Описание
AssignmentType	Тип назначения расписания назначения ролей
CloudError	Ответ об ошибке от службы.
CloudErrorBody	Ответ об ошибке от службы.
ExpandedProperties
MemberType	Тип членства в расписании назначения ролей
Principal	Сведения о субъекте
principalType	Тип субъекта назначенного идентификатора субъекта.
RoleAssignmentSchedule	Расписание назначения ролей
RoleAssignmentScheduleListResult	Результат операции со списком расписания назначения ролей.
RoleDefinition	Сведения об определении роли
Scope	Сведения о область ресурса
Status	Состояние расписания назначения ролей.

AssignmentType

Тип назначения расписания назначения ролей

Имя	Тип	Описание
Activated	string
Assigned	string

CloudError

Ответ об ошибке от службы.

Имя	Тип	Описание
error	CloudErrorBody	Ответ об ошибке от службы.

CloudErrorBody

Ответ об ошибке от службы.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
message	string	Сообщение с описанием ошибки, предназначенное для отображения в пользовательском интерфейсе.

ExpandedProperties

Имя	Тип	Описание
principal	Principal	Сведения о субъекте
roleDefinition	RoleDefinition	Сведения об определении роли
scope	Scope	Сведения о область ресурса

MemberType

Тип членства в расписании назначения ролей

Имя	Тип	Описание
Direct	string
Group	string
Inherited	string

Principal

Сведения о субъекте

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта
email	string	Email идентификатор субъекта
id	string	Идентификатор субъекта
type	string	Тип субъекта

principalType

Тип субъекта назначенного идентификатора субъекта.

Имя	Тип	Описание
Device	string
ForeignGroup	string
Group	string
ServicePrincipal	string
User	string

RoleAssignmentSchedule

Расписание назначения ролей

Имя	Тип	Описание
id	string	Идентификатор расписания назначения ролей.
name	string	Имя расписания назначения ролей.
properties.assignmentType	AssignmentType	Тип назначения расписания назначения ролей
properties.condition	string	Условия назначения роли. Это ограничивает ресурсы, которым они могут быть назначены. Например: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion	string	Версия условия. В настоящее время принимается значение 2.0.
properties.createdOn	string	Дата и время создания расписания назначения ролей
properties.endDateTime	string	Окончание даты и времени при планировании назначения ролей
properties.expandedProperties	ExpandedProperties	Дополнительные свойства определения субъекта, область и роли
properties.linkedRoleEligibilityScheduleId	string	Идентификатор roleEligibilitySchedule, используемый для активации этой ролиAssignmentSchedule.
properties.memberType	MemberType	Тип членства в расписании назначения ролей
properties.principalId	string	Идентификатор субъекта.
properties.principalType	principalType	Тип субъекта назначенного идентификатора субъекта.
properties.roleAssignmentScheduleRequestId	string	Идентификатор roleAssignmentScheduleRequest, используемый для создания этой ролиAssignmentSchedule.
properties.roleDefinitionId	string	Идентификатор определения роли.
properties.scope	string	Расписание назначения ролей область.
properties.startDateTime	string	Начало даты и времени при планировании назначения ролей
properties.status	Status	Состояние расписания назначения ролей.
properties.updatedOn	string	Дата и время изменения расписания назначения ролей
type	string	Тип расписания назначения ролей.

RoleAssignmentScheduleListResult

Результат операции со списком расписания назначения ролей.

Имя	Тип	Описание
nextLink	string	URL-адрес, используемый для получения следующего набора результатов.
value	RoleAssignmentSchedule[]	Список расписаний назначения ролей.

RoleDefinition

Сведения об определении роли

Имя	Тип	Описание
displayName	string	Отображаемое имя определения роли
id	string	Идентификатор определения роли
type	string	Тип определения роли

Scope

Сведения о область ресурса

Имя	Тип	Описание
displayName	string	Отображаемое имя ресурса
id	string	Идентификатор области ресурса
type	string	Тип ресурса

Status

Состояние расписания назначения ролей.

Имя	Тип	Описание
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