Mettre à jour directorySetting

Article
03/02/2024

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 .

Mettez à jour les propriétés d’un objet de paramètre de répertoire spécifique.

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

Les tableaux suivants indiquent 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.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	Directory.ReadWrite.All	Policy.ReadWrite.Authorization
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	Directory.ReadWrite.All	Policy.ReadWrite.Authorization

Les autorisations suivantes sont requises pour mettre à jour l’objet directorySetting « Paramètres de stratégie de consentement ».

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	Directory.ReadWrite.All	Policy.ReadWrite.Authorization
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	Directory.ReadWrite.All	Policy.ReadWrite.Authorization

Pour les scénarios délégués, l’utilisateur appelant a besoin d’au moins l’un des rôles Microsoft Entra suivants.

Microsoft Entra rôle	Privilèges autorisés
Microsoft Entra Administrateur local de l’appareil joint Lecteurs d’annuaire Lecteur général	Lire les propriétés de base sur la définition des modèles et des paramètres
Administrateur de groupes Rédacteurs d'annuaires	Gérer tous les paramètres de groupe
Administrateur de stratégie d’authentification	Mettre à jour `Password Rule Settings`
Administrateur d’utilisateurs	Lire les propriétés de base sur la définition des modèles et des paramètres Définir les paramètres de mise à jour

Requête HTTP

Mettre à jour un paramètre à l’échelle du locataire.

PATCH /settings/{directorySettingId}

Mettez à jour un paramètre spécifique au groupe.

PATCH /groups/{groupId}/settings/{directorySettingId}

En-têtes de demande facultatifs

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.

Corps de la demande

Dans le corps de la demande, fournissez les valeurs pour les champs appropriés qui doivent être mis à jour.

Propriété	Type	Description
values	collection settingValue	Ensemble de valeurs mis à jour. REMARQUE : vous devez fournir l’ensemble de la collection. Vous ne pouvez pas mettre à jour un seul ensemble de valeurs.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 204 No Content.

Exemple

Demande

L’exemple suivant illustre une demande.

PATCH https://graph.microsoft.com/beta/settings/3c105fc3-2254-4861-9e2d-d59e2126f3ef
Content-type: application/json

{
    "values": [
        {
            "name": "CustomBlockedWordsList",
            "value": "Contoso"
        }
    ]
}


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

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

var requestBody = new DirectorySetting
{
	Values = new List<SettingValue>
	{
		new SettingValue
		{
			Name = "CustomBlockedWordsList",
			Value = "Contoso",
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Settings["{directorySetting-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 settings patch --directory-setting-id {directorySetting-id} --body '{\
    "values": [\
        {\
            "name": "CustomBlockedWordsList",\
            "value": "Contoso"\
        }\
    ]\
}\
'

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.NewDirectorySetting()


settingValue := graphmodels.NewSettingValue()
name := "CustomBlockedWordsList"
settingValue.SetName(&name) 
value := "Contoso"
settingValue.SetValue(&value) 

values := []graphmodels.SettingValueable {
	settingValue,
}
requestBody.SetValues(values)

settings, err := graphClient.Settings().ByDirectorySettingId("directorySetting-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);

DirectorySetting directorySetting = new DirectorySetting();
LinkedList<SettingValue> values = new LinkedList<SettingValue>();
SettingValue settingValue = new SettingValue();
settingValue.setName("CustomBlockedWordsList");
settingValue.setValue("Contoso");
values.add(settingValue);
directorySetting.setValues(values);
DirectorySetting result = graphClient.settings().byDirectorySettingId("{directorySetting-id}").patch(directorySetting);

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

const directorySetting = {
    values: [
        {
            name: 'CustomBlockedWordsList',
            value: 'Contoso'
        }
    ]
};

await client.api('/settings/3c105fc3-2254-4861-9e2d-d59e2126f3ef')
	.version('beta')
	.update(directorySetting);

Importante


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\DirectorySetting;
use Microsoft\Graph\Generated\Models\SettingValue;


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

$requestBody = new DirectorySetting();
$valuesSettingValue1 = new SettingValue();
$valuesSettingValue1->setName('CustomBlockedWordsList');
$valuesSettingValue1->setValue('Contoso');
$valuesArray []= $valuesSettingValue1;
$requestBody->setValues($valuesArray);


$result = $graphServiceClient->settings()->byDirectorySettingId('directorySetting-id')->patch($requestBody)->wait();

Importante


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

$params = @{
	values = @(
		@{
			name = "CustomBlockedWordsList"
			value = "Contoso"
		}
	)
}

Update-MgBetaDirectorySetting -DirectorySettingId $directorySettingId -BodyParameter $params

Importante


from msgraph import GraphServiceClient
from msgraph.generated.models.directory_setting import DirectorySetting
from msgraph.generated.models.setting_value import SettingValue

graph_client = GraphServiceClient(credentials, scopes)

request_body = DirectorySetting(
	values = [
		SettingValue(
			name = "CustomBlockedWordsList",
			value = "Contoso",
		),
	],
)

result = await graph_client.settings.by_directory_setting_id('directorySetting-id').patch(request_body)

Importante

Réponse

HTTP/1.1 204 No Content

Mettre à jour directorySetting

Autorisations

Requête HTTP

En-têtes de demande facultatifs

Corps de la demande

Réponse

Exemple

Demande

Réponse

Commentaires

Commentaires

Ressources supplémentaires

Mettre à jour directorySetting

Autorisations

Pour tous les paramètres à l’exception de l’objet Paramètres de stratégie de consentement

Pour l’objet Paramètres de stratégie de consentement

Requête HTTP

En-têtes de demande facultatifs

Corps de la demande

Réponse

Exemple

Demande

Réponse

Commentaires

Commentaires

Ressources supplémentaires