你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Role Assignment Schedules - Get

Service:

Authorization

API Version:

2020-10-01

获取资源范围的指定角色分配计划

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

URI 参数

名称	在	必需	类型	说明
roleAssignmentScheduleName	path	True	string	要获取的角色分配计划的名称 (guid) 。
scope	path	True	string	角色分配计划的范围。
api-version	query	True	string	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	RoleAssignmentSchedule	正常 - 返回有关角色分配计划的信息。
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

GetRoleAssignmentScheduleByName

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleAssignmentSchedules/c9e264ff-3133-4776-a81a-ebc7c33c8ec6?api-version=2020-10-01

Java

/** Samples for RoleAssignmentSchedules Get. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/
     * GetRoleAssignmentScheduleByName.json
     */
    /**
     * Sample code: GetRoleAssignmentScheduleByName.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getRoleAssignmentScheduleByName(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.accessManagement().roleAssignments().manager().roleServiceClient().getRoleAssignmentSchedules()
            .getWithResponse("providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f",
                "c9e264ff-3133-4776-a81a-ebc7c33c8ec6", 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/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/GetRoleAssignmentScheduleByName.json
func ExampleRoleAssignmentSchedulesClient_Get() {
	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)
	}
	res, err := clientFactory.NewRoleAssignmentSchedulesClient().Get(ctx, "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", "c9e264ff-3133-4776-a81a-ebc7c33c8ec6", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.RoleAssignmentSchedule = 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 Get the specified role assignment schedule for a resource scope
 *
 * @summary Get the specified role assignment schedule for a resource scope
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/GetRoleAssignmentScheduleByName.json
 */
async function getRoleAssignmentScheduleByName() {
  const subscriptionId =
    process.env["AUTHORIZATION_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const scope =
    "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f";
  const roleAssignmentScheduleName = "c9e264ff-3133-4776-a81a-ebc7c33c8ec6";
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential, subscriptionId);
  const result = await client.roleAssignmentSchedules.get(scope, roleAssignmentScheduleName);
  console.log(result);
}

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 Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Authorization;

// Generated from example definition: specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/GetRoleAssignmentScheduleByName.json
// this example is just showing the usage of "RoleAssignmentSchedules_Get" 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 RoleAssignmentScheduleResource created on azure
// for more information of creating RoleAssignmentScheduleResource, please refer to the document of RoleAssignmentScheduleResource
string scope = "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f";
string roleAssignmentScheduleName = "c9e264ff-3133-4776-a81a-ebc7c33c8ec6";
ResourceIdentifier roleAssignmentScheduleResourceId = RoleAssignmentScheduleResource.CreateResourceIdentifier(scope, roleAssignmentScheduleName);
RoleAssignmentScheduleResource roleAssignmentSchedule = client.GetRoleAssignmentScheduleResource(roleAssignmentScheduleResourceId);

// invoke the operation
RoleAssignmentScheduleResource result = await roleAssignmentSchedule.GetAsync();

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "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	分配的主体 ID 的主体类型。
RoleAssignmentSchedule	角色分配计划
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
id	string	主体的 ID
type	string	主体的类型

principalType

分配的主体 ID 的主体类型。

名称	类型	说明
Device	string
ForeignGroup	string
Group	string
ServicePrincipal	string
User	string

RoleAssignmentSchedule

角色分配计划

名称	类型	说明
id	string	角色分配计划 ID。
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	创建角色分配计划时的 DateTime
properties.endDateTime	string	结束角色分配计划时的 DateTime
properties.expandedProperties	ExpandedProperties	主体、范围和角色定义的附加属性
properties.linkedRoleEligibilityScheduleId	string	用于激活此 roleAssignmentSchedule 的 roleEligibilitySchedule 的 ID
properties.memberType	MemberType	角色分配计划的成员身份类型
properties.principalId	string	主体 ID。
properties.principalType	principalType	分配的主体 ID 的主体类型。
properties.roleAssignmentScheduleRequestId	string	用于创建此角色的 roleAssignmentScheduleRequest 的 ID
properties.roleDefinitionId	string	角色定义 ID。
properties.scope	string	角色分配计划范围。
properties.startDateTime	string	角色分配计划时的开始日期时间
properties.status	Status	角色分配计划的状态。
properties.updatedOn	string	修改角色分配计划时的 DateTime
type	string	角色分配计划类型。

RoleDefinition

角色定义的详细信息

名称	类型	说明
displayName	string	角色定义的显示名称
id	string	角色定义的 ID
type	string	角色定义的类型

Scope

资源范围的详细信息

名称	类型	说明
displayName	string	资源的显示名称
id	string	资源的范围 ID
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