Role Eligibility Schedules - Get

Serviço:

Authorization

Versão da API:

2020-10-01

Obter o agendamento de qualificação de função especificado para um escopo de recurso

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
roleEligibilityScheduleName	path	True	string	O nome (guid) do agendamento de qualificação de função a ser obtido.
scope	path	True	string	O escopo do agendamento de qualificação de função.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	RoleEligibilitySchedule	OK – retorna informações sobre o agendamento de qualificação de função.
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

GetRoleEligibilityScheduleByName

Solicitação de exemplo

HTTP

GET https://management.azure.com/providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleEligibilitySchedules/b1477448-2cc6-4ceb-93b4-54a202a89413?api-version=2020-10-01

Java

/**
 * Samples for RoleEligibilitySchedules Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/
     * GetRoleEligibilityScheduleByName.json
     */
    /**
     * Sample code: GetRoleEligibilityScheduleByName.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getRoleEligibilityScheduleByName(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.accessManagement().roleAssignments().manager().roleServiceClient().getRoleEligibilitySchedules()
            .getWithResponse("providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f",
                "b1477448-2cc6-4ceb-93b4-54a202a89413", 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/GetRoleEligibilityScheduleByName.json
func ExampleRoleEligibilitySchedulesClient_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.NewRoleEligibilitySchedulesClient().Get(ctx, "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", "b1477448-2cc6-4ceb-93b4-54a202a89413", 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.RoleEligibilitySchedule = armauthorization.RoleEligibilitySchedule{
	// 	Name: to.Ptr("b1477448-2cc6-4ceb-93b4-54a202a89413"),
	// 	Type: to.Ptr("Microsoft.Authorization/RoleEligibilitySchedules"),
	// 	ID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilitySchedules/b1477448-2cc6-4ceb-93b4-54a202a89413"),
	// 	Properties: &armauthorization.RoleEligibilityScheduleProperties{
	// 		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:33:06.300Z"); return t}()),
	// 		EndDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-09-09T21:32:28.490Z"); 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"),
	// 			},
	// 		},
	// 		MemberType: to.Ptr(armauthorization.MemberTypeDirect),
	// 		PrincipalID: to.Ptr("a3bb8764-cb92-4276-9d2a-ca1e895e55ea"),
	// 		PrincipalType: to.Ptr(armauthorization.PrincipalTypeUser),
	// 		RoleDefinitionID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/b24988ac-6180-42a0-ab88-20f7382dd24c"),
	// 		RoleEligibilityScheduleRequestID: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6"),
	// 		Scope: to.Ptr("/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f"),
	// 		StartDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-09T21:33:14.557Z"); return t}()),
	// 		Status: to.Ptr(armauthorization.StatusProvisioned),
	// 		UpdatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-09T22:27:00.513Z"); 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 eligibility schedule for a resource scope
 *
 * @summary Get the specified role eligibility schedule for a resource scope
 * x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2020-10-01/examples/GetRoleEligibilityScheduleByName.json
 */
async function getRoleEligibilityScheduleByName() {
  const subscriptionId =
    process.env["AUTHORIZATION_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const scope =
    "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f";
  const roleEligibilityScheduleName = "b1477448-2cc6-4ceb-93b4-54a202a89413";
  const credential = new DefaultAzureCredential();
  const client = new AuthorizationManagementClient(credential, subscriptionId);
  const result = await client.roleEligibilitySchedules.get(scope, roleEligibilityScheduleName);
  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 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/GetRoleEligibilityScheduleByName.json
// this example is just showing the usage of "RoleEligibilitySchedules_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 RoleEligibilityScheduleResource created on azure
// for more information of creating RoleEligibilityScheduleResource, please refer to the document of RoleEligibilityScheduleResource
string scope = "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f";
string roleEligibilityScheduleName = "b1477448-2cc6-4ceb-93b4-54a202a89413";
ResourceIdentifier roleEligibilityScheduleResourceId = RoleEligibilityScheduleResource.CreateResourceIdentifier(scope, roleEligibilityScheduleName);
RoleEligibilityScheduleResource roleEligibilitySchedule = client.GetRoleEligibilityScheduleResource(roleEligibilityScheduleResourceId);

// invoke the operation
RoleEligibilityScheduleResource result = await roleEligibilitySchedule.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
RoleEligibilityScheduleData 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

Resposta de exemplo

Código de status:

200

{
  "properties": {
    "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f",
    "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/b24988ac-6180-42a0-ab88-20f7382dd24c",
    "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea",
    "principalType": "User",
    "status": "Provisioned",
    "roleEligibilityScheduleRequestId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6",
    "startDateTime": "2020-09-09T21:33:14.557Z",
    "endDateTime": "2021-09-09T21:32:28.49Z",
    "memberType": "Direct",
    "createdOn": "2020-09-09T21:33:06.3Z",
    "updatedOn": "2020-09-09T22:27:00.513Z",
    "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": "b1477448-2cc6-4ceb-93b4-54a202a89413",
  "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilitySchedules/b1477448-2cc6-4ceb-93b4-54a202a89413",
  "type": "Microsoft.Authorization/RoleEligibilitySchedules"
}

Definições

Nome	Description
CloudError	Uma resposta de erro do serviço.
CloudErrorBody	Uma resposta de erro do serviço.
ExpandedProperties
MemberType	Tipo de associação do agendamento de qualificação de função
Principal	Detalhes da entidade de segurança
principalType	O tipo de entidade de segurança da ID da entidade de segurança atribuída.
RoleDefinition	Detalhes da definição de função
RoleEligibilitySchedule	Agendamento de qualificação de função
Scope	Detalhes do escopo do recurso
Status	O status do agendamento de qualificação de função.

CloudError

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do serviço.

CloudErrorBody

Uma resposta de erro do serviço.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.

ExpandedProperties

Nome	Tipo	Description
principal	Principal	Detalhes da entidade de segurança
roleDefinition	RoleDefinition	Detalhes da definição de função
scope	Scope	Detalhes do escopo do recurso

MemberType

Tipo de associação do agendamento de qualificação de função

Nome	Tipo	Description
Direct	string
Group	string
Inherited	string

Principal

Detalhes da entidade de segurança

Nome	Tipo	Description
displayName	string	Nome de exibição da entidade de segurança
email	string	Email id da entidade de segurança
id	string	ID da entidade de segurança
type	string	Tipo da entidade de segurança

principalType

O tipo de entidade de segurança da ID da entidade de segurança atribuída.

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

RoleDefinition

Detalhes da definição de função

Nome	Tipo	Description
displayName	string	Nome de exibição da definição de função
id	string	ID da definição de função
type	string	Tipo da definição de função

RoleEligibilitySchedule

Agendamento de qualificação de função

Nome	Tipo	Description
id	string	A ID do agendamento de qualificação da função.
name	string	O nome do agendamento de qualificação da função.
properties.condition	string	As condições na atribuição de função. Isso limita os recursos aos quais ele pode ser atribuído. por exemplo: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion	string	Versão da condição. O valor atualmente aceito é '2.0'
properties.createdOn	string	DateTime quando o agendamento de qualificação de função foi criado
properties.endDateTime	string	End DateTime quando o agendamento de qualificação de função
properties.expandedProperties	ExpandedProperties	Propriedades adicionais da definição de entidade de segurança, escopo e função
properties.memberType	MemberType	Tipo de associação do agendamento de qualificação de função
properties.principalId	string	A ID da entidade de segurança.
properties.principalType	principalType	O tipo de entidade de segurança da ID da entidade de segurança atribuída.
properties.roleDefinitionId	string	A ID de definição de função.
properties.roleEligibilityScheduleRequestId	string	A ID de roleEligibilityScheduleRequest usada para criar este roleAssignmentSchedule
properties.scope	string	O escopo do agendamento de qualificação de função.
properties.startDateTime	string	Iniciar DateTime quando o agendamento de qualificação de função
properties.status	Status	O status do agendamento de qualificação de função.
properties.updatedOn	string	DateTime quando o agendamento de qualificação de função foi modificado
type	string	O tipo de agendamento de qualificação de função.

Scope

Detalhes do escopo do recurso

Nome	Tipo	Description
displayName	string	Nome de exibição do recurso
id	string	ID de escopo do recurso
type	string	Tipo do recurso

Status

O status do agendamento de qualificação de função.

Nome	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