Mettre à jour governanceRoleSetting

Article
08/23/2023

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Attention

Cette version de l’API Privileged Identity Management (PIM) pour les ressources Azure sera bientôt déconseillée. Utilisez la nouvelle API PIM REST Azure pour les rôles de ressources Azure.

Mettez à jour les propriétés de governanceRoleSetting.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	✅	✅	❌

Autorisations

Le tableau suivant indique l’autorisation ou les autorisations les moins privilégiées requises pour appeler cette API sur chaque type de ressource pris en charge. Suivez les bonnes pratiques pour demander des autorisations minimales. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Ressource prise en charge	Déléguée (compte professionnel ou scolaire)	Déléguée (compte Microsoft personnel)	Application
Identifiant Microsoft Entra	PrivilegedAccess.ReadWrite.AzureAD	Non prise en charge.	Non prise en charge.
Ressources Azure	PrivilegedAccess.ReadWrite.AzureResources	Non prise en charge.	Non prise en charge.
groupe	PrivilegedAccess.ReadWrite.AzureADGroup	Non prise en charge.	Non prise en charge.

Le demandeur doit également avoir au moins une attribution de rôle administrateur active (owner ou user access administrator) sur la ressource.

Requête HTTP

PATCH /privilegedAccess/azureResources/roleSettings/{id}

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-type	application/json

Corps de la demande

Dans le corps de la demande, fournissez les valeurs de governanceRuleSettings qui doivent être mises à jour.

Propriété	Type	Description
admin EligibleSettings	collection governanceRuleSetting	Paramètres de règle qui sont évalués lorsqu’un administrateur tente d’ajouter une attribution de rôle éligible.
adminMemberSettings	collection governanceRuleSetting	Paramètres de règle qui sont évalués lorsqu’un administrateur tente d’ajouter une attribution de rôle de membre direct.
userEligibleSettings	collection governanceRuleSetting	Paramètres de règle qui sont évalués lorsqu’un utilisateur tente d’ajouter une attribution de rôle éligible.
userMemberSettings	collection governanceRuleSetting	Paramètres de règle qui sont évalués lorsqu’un utilisateur tente d’activer son attribution de rôle.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 204 NoContent. Il ne retourne rien dans le corps de la réponse.

Codes d’erreur

Cette API retourne les codes d’erreur HTTP standard. En outre, elle retourne les codes d’erreur personnalisés suivants.

Code d’erreur	Message d’erreur	Détails
400 BadRequest	RoleSettingNotFound	Le governanceRoleSetting n’existe pas dans le système.
400 BadRequest	InvalidRoleSetting	Les valeurs governanceRuleSettings fournies dans le corps de la demande ne sont pas valides.

Exemple

Cet exemple met à jour le paramètre de rôle pour rôle personnalisé 3 dans l’abonnement Wingtip Toys - Prod.

Demande

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

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (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



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


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


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


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


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


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

Réponse

HTTP/1.1 204 No Content

Mettre à jour governanceRoleSetting

Autorisations

Requête HTTP

En-têtes de demande

Corps de la demande

Réponse

Codes d’erreur

Exemple

Demande

Réponse

Commentaires

Commentaires

Ressources supplémentaires