Atualizar governanceRoleSetting

Artigo
08/23/2023

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Cuidado

Esta versão do Privileged Identity Management (PIM) API para recursos Azure será depreciada em breve. Use a nova API DE PIM REST do Azure para funções de recurso do Azure.

Atualize as propriedades de governanceRoleSetting.

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global	Governo dos EUA L4	GOVERNO DOS EUA L5 (DOD)	China operada pela 21Vianet
✅	✅	✅	❌

Permissões

A tabela a seguir mostra a permissão ou permissões menos privilegiadas necessárias para chamar essa API em cada tipo de recurso com suporte. Siga as práticas recomendadas para solicitar permissões menos privilegiadas. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Recurso com suporte	Delegada (conta corporativa ou de estudante)	Delegada (conta pessoal da Microsoft)	Aplicativo
Microsoft Entra ID	PrivilegedAccess.ReadWrite.AzureAD	Sem suporte.	Sem suporte.
Recursos do Azure	PrivilegedAccess.ReadWrite.AzureResources	Sem suporte.	Sem suporte.
group	PrivilegedAccess.ReadWrite.AzureADGroup	Sem suporte.	Sem suporte.

O solicitante também deve ter pelo menos uma atribuição de função de administrador ativo (owner ou user access administrator) no recurso.

Solicitação HTTP

PATCH /privilegedAccess/azureResources/roleSettings/{id}

Cabeçalhos de solicitação

Nome	Descrição
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-type	application/json

Corpo da solicitação

No corpo da solicitação, forneça os valores para governanceRuleSettings que precisam ser atualizados.

Propriedade	Tipo	Descrição
adminEligibleSettings	coleção governanceRuleSetting	As configurações de regra avaliadas quando um administrador tenta adicionar uma atribuição de função qualificada.
adminMemberSettings	coleção governanceRuleSetting	As configurações de regra avaliadas quando um administrador tenta adicionar uma atribuição de função de membro direta.
userEligibleSettings	coleção governanceRuleSetting	As configurações de regra avaliadas quando um usuário tenta adicionar uma atribuição de função qualificada.
userMemberSettings	coleção governanceRuleSetting	As configurações de regra avaliadas quando um usuário tenta ativar sua atribuição de função.

Resposta

Se tiver êxito, este método retornará um código de resposta 204 NoContent. Ele não retorna nada no corpo da resposta.

Códigos de erro

Essa API retorna os códigos de erro HTTP padrão. Além disso, ele retorna os seguintes códigos de erro personalizados.

Código de erro	Mensagem de erro	Detalhes
400 BadRequest	RoleSettingNotFound	O governanceRoleSetting não existe no sistema.
400 BadRequest	InvalidRoleSetting	Os valores de governanceRuleSettings fornecidos no corpo da solicitação não são válidos.

Exemplo

Este exemplo atualiza a configuração de função para a Função Personalizada 3 na assinatura Wingtip Toys – Prod.

Solicitação

PATCH https://graph.microsoft.com/beta/privilegedAccess/azureResources/roleSettings/5fb5aef8-1081-4b8e-bb16-9d5d0385bab5
Content-type: application/json

{
   "adminEligibleSettings":[
      {
         "ruleIdentifier":"ExpirationRule",
         "setting":"{\"permanentAssignment\":false,\"maximumGrantPeriodInMinutes\":129600}"
      }
   ]
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new GovernanceRoleSetting
{
	AdminEligibleSettings = new List<GovernanceRuleSetting>
	{
		new GovernanceRuleSetting
		{
			RuleIdentifier = "ExpirationRule",
			Setting = "{\"permanentAssignment\":false,\"maximumGrantPeriodInMinutes\":129600}",
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.PrivilegedAccess["{privilegedAccess-id}"].RoleSettings["{governanceRoleSetting-id}"].PatchAsync(requestBody);

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta privileged-access role-settings patch --privileged-access-id {privilegedAccess-id} --governance-role-setting-id {governanceRoleSetting-id} --body '{\
   "adminEligibleSettings":[\
      {\
         "ruleIdentifier":"ExpirationRule",\
         "setting":"{\"permanentAssignment\":false,\"maximumGrantPeriodInMinutes\":129600}"\
      }\
   ]\
}\
'

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewGovernanceRoleSetting()


governanceRuleSetting := graphmodels.NewGovernanceRuleSetting()
ruleIdentifier := "ExpirationRule"
governanceRuleSetting.SetRuleIdentifier(&ruleIdentifier) 
setting := "{\"permanentAssignment\":false,\"maximumGrantPeriodInMinutes\":129600}"
governanceRuleSetting.SetSetting(&setting) 

adminEligibleSettings := []graphmodels.GovernanceRuleSettingable {
	governanceRuleSetting,
}
requestBody.SetAdminEligibleSettings(adminEligibleSettings)

roleSettings, err := graphClient.PrivilegedAccess().ByPrivilegedAccessId("privilegedAccess-id").RoleSettings().ByGovernanceRoleSettingId("governanceRoleSetting-id").Patch(context.Background(), requestBody, nil)

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

GovernanceRoleSetting governanceRoleSetting = new GovernanceRoleSetting();
LinkedList<GovernanceRuleSetting> adminEligibleSettings = new LinkedList<GovernanceRuleSetting>();
GovernanceRuleSetting governanceRuleSetting = new GovernanceRuleSetting();
governanceRuleSetting.setRuleIdentifier("ExpirationRule");
governanceRuleSetting.setSetting("{\"permanentAssignment\":false,\"maximumGrantPeriodInMinutes\":129600}");
adminEligibleSettings.add(governanceRuleSetting);
governanceRoleSetting.setAdminEligibleSettings(adminEligibleSettings);
GovernanceRoleSetting result = graphClient.privilegedAccess().byPrivilegedAccessId("{privilegedAccess-id}").roleSettings().byGovernanceRoleSettingId("{governanceRoleSetting-id}").patch(governanceRoleSetting);

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

const governanceRoleSetting = {
   adminEligibleSettings: [
      {
         ruleIdentifier: 'ExpirationRule',
         setting: '{\"permanentAssignment\':false,\'maximumGrantPeriodInMinutes\':129600}"
      }
   ]
};

await client.api('/privilegedAccess/azureResources/roleSettings/5fb5aef8-1081-4b8e-bb16-9d5d0385bab5')
	.version('beta')
	.update(governanceRoleSetting);

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\GovernanceRoleSetting;
use Microsoft\Graph\Generated\Models\GovernanceRuleSetting;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new GovernanceRoleSetting();
$adminEligibleSettingsGovernanceRuleSetting1 = new GovernanceRuleSetting();
$adminEligibleSettingsGovernanceRuleSetting1->setRuleIdentifier('ExpirationRule');
$adminEligibleSettingsGovernanceRuleSetting1->setSetting('{\"permanentAssignment\":false,\"maximumGrantPeriodInMinutes\":129600}');
$adminEligibleSettingsArray []= $adminEligibleSettingsGovernanceRuleSetting1;
$requestBody->setAdminEligibleSettings($adminEligibleSettingsArray);


$result = $graphServiceClient->privilegedAccess()->byPrivilegedAccessId('privilegedAccess-id')->roleSettings()->byGovernanceRoleSettingId('governanceRoleSetting-id')->patch($requestBody)->wait();

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


Import-Module Microsoft.Graph.Beta.Identity.Governance

$params = @{
	adminEligibleSettings = @(
		@{
			ruleIdentifier = "ExpirationRule"
			setting = '{"permanentAssignment":false,"maximumGrantPeriodInMinutes":129600}'
		}
	)
}

Update-MgBetaPrivilegedAccessRoleSetting -PrivilegedAccessId $privilegedAccessId -GovernanceRoleSettingId $governanceRoleSettingId -BodyParameter $params

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


from msgraph import GraphServiceClient
from msgraph.generated.models.governance_role_setting import GovernanceRoleSetting
from msgraph.generated.models.governance_rule_setting import GovernanceRuleSetting

graph_client = GraphServiceClient(credentials, scopes)

request_body = GovernanceRoleSetting(
	admin_eligible_settings = [
		GovernanceRuleSetting(
			rule_identifier = "ExpirationRule",
			setting = "{\"permanentAssignment\":false,\"maximumGrantPeriodInMinutes\":129600}",
		),
	],
)

result = await graph_client.privileged_access.by_privileged_access_id('privilegedAccess-id').role_settings.by_governance_role_setting_id('governanceRoleSetting-id').patch(request_body)

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

HTTP/1.1 204 No Content

Atualizar governanceRoleSetting

Permissões

Solicitação HTTP

Cabeçalhos de solicitação

Corpo da solicitação

Resposta

Códigos de erro

Exemplo

Solicitação

Resposta

Comentários

Comentários

Recursos adicionais