Update servicePrincipal

Namespace: microsoft.graph

Aktualisieren Sie die Eigenschaften des servicePrincipal-Objekts.

Wichtig

Die Verwendung von PATCH zum Festlegen vob passwordCredential wird nicht unterstützt. Verwenden Sie die addPassword- und removePassword-Methoden zum Aktualisieren des Kennworts für einen servicePrincipal.

Berechtigungen

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.

Berechtigungstyp	Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)
Delegiert (Geschäfts-, Schul- oder Unikonto)	Application.ReadWrite.All
Delegiert (persönliches Microsoft-Konto)	Nicht unterstützt
Anwendung	Application.ReadWrite.OwnedBy, Application.ReadWrite.All

HTTP-Anforderung

PATCH /servicePrincipals/{id}

Anforderungsheader

Name	Beschreibung
Authorization	Bearer {token}. Erforderlich.
Content-Type	application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext die Werte für die relevanten Felder an, die aktualisiert werden sollen. Vorhandene Eigenschaften, die nicht im Anforderungstext enthalten sind, behalten ihre vorherigen Werte oder werden basierend auf Änderungen an anderen Eigenschaftswerten neu berechnet. Aus Gründen der Leistung sollten Sie vorhandene Werte, die nicht geändert wurden, nicht angeben.

Eigenschaft	Typ	Beschreibung
accountEnabled	Boolescher Wert	True, wenn das Dienstprinzipalkonto aktiviert ist; andernfalls false.
addIns	addIn	Definiert benutzerdefiniertes Verhalten, das von einem Verbraucherdienst verwendet werden kann, um eine App in bestimmten Kontexten aufzurufen. Beispielsweise können Anwendungen, die Datei-Streams rendern können, die addIns-Eigenschaft für deren "FileHandler"-Funktionalität festlegen. Dadurch können Dienste wie Microsoft 365 die Anwendung im Kontext eines Dokuments, an dem der Benutzer arbeitet, aufrufen.
alternativeNames	Zeichenfolgenauflistung	Wird zum Abrufen von Dienstprinzipalen nach Abonnement und zum Identifizieren von Ressourcengruppen und vollständigen Ressourcen-IDs für verwaltete Identitäten verwendet.
appRoleAssignmentRequired	Boolescher Wert	Gibt an, ob eine eppRoleAssignment für einen Benutzer oder eine Gruppe erforderlich ist, bevor Azure Active Directory einen Benutzer- oder Zugriffstoken für die Anwendung ausstellt. Lässt keine NULL-Werte zu.
appRoles	appRole-Auflistung	Die von der verknüpften Anwendung verfügbar gemachten Anwendungsrollen. Weitere Informationen finden Sie in der appRoles-Eigenschaftsdefinition in der application-Ressource. Lässt keine NULL-Werte zu.
displayName	Zeichenfolge	Der Anzeigename für den Dienstprinzipal.
homepage	String	Startseite der Anwendung.
keyCredentials	keyCredential-Auflistung	Die Sammlung der wichtigsten Anmeldeinformationen, die mit dem Dienstprinzipal verknüpft sind. Lässt keine NULL-Werte zu.
logoutUrl	Zeichenfolge	Gibt die URL an, die vom Autorisierungsdienst von Microsoft verwendet wird, um einen Benutzer mithilfe von front-channel-, back-channel- oder SAML-Abmeldeprotokollen abzumelden.
oauth2PermissionScopes	permissionScope-Sammlung	Die von der verknüpften Anwendung verfügbar gemachten OAuth 2.0-Berechtigungsbereiche. Weitere Informationen finden Sie in der oauth2PermissionScopes-Eigenschaftsdefinition in der application-Ressource. Lässt keine NULL-Werte zu.
preferredSingleSignOnMode	Zeichenfolge	Gibt den Modus für einmaliges Anmelden an, der für diese Anwendung konfiguriert ist. Azure AD verwendet den bevorzugten Modus für einmaliges Anmelden zum Starten der Anwendung von Microsoft 365 oder von Azure AD My Apps aus. Unterstützte Werte sind: password, saml, external und oidc.
replyUrls	Zeichenfolgenauflistung	Die URLs, an die Benutzertoken zur Anmeldung bei der verknüpften Anwendung gesendet werden, oder die Umleitungs-URIs, an die die OAuth 2.0-Autorisierungscodes und Zugriffstoken für die verknüpfte Anwendung gesendet werden. Lässt keine NULL-Werte zu.
servicePrincipalNames	Zeichenfolgenauflistung	Enthält die Liste der identifiersUris-, die aus der zugehörigen Anwendung kopiert werden. Hybridanwendungen können zusätzliche Werte hinzugefügt werden. Mithilfe dieser Werte können Sie die Berechtigungen identifizieren, die von dieser App in Azure AD verfügbar gemacht werden. Beispiel: Client-Apps, die Berechtigungen für diese Ressource anfordern, können diese URIs verwenden, um die erforderlichen Berechtigungen in der requiredResourceAccess-Eigenschaft des Anwendungsmanifests oder im Blatt „API-Berechtigungen“ in der App-Registrierungsoberfläche anzugeben. Client-Apps können einen Ressourcen-URI angeben, der auf den Werten dieser Eigenschaft basiert, um ein Zugriffstoken zu erhalten. Dies ist der im "aud"-Anspruch zurückgegebene URI. Der Any-Operator ist für Filterausdrücke für mehrwertige Eigenschaften erforderlich. Lässt keine NULL-Werte zu.
tags	String-Sammlung	Benutzerdefinierte Zeichenfolgen, die zum Kategorisieren und Identifizieren der Anwendung verwendet werden können. Lässt keine NULL-Werte zu.
tokenEncryptionKeyId	Zeichenfolge	Gibt die keyId eines öffentlichen Schlüssels aus der keyCredentials-Sammlung an. Sofern konfiguriert, gibt Azure AD Token für diese Anwendung aus, die mit dem durch diese Eigenschaft angegebenen Schlüssel verschlüsselt sind. Der Anwendungscode, der das verschlüsselte Token erhält, muss das Token mit dem zugehörigen privaten Schlüssel entschlüsseln, bevor es für den angemeldeten Benutzer verwendet werden kann.

Antwort

Wenn die Methode erfolgreich verläuft, werden der Antwortcode 204 No Content und ein aktualisiertes servicePrincipal-Objekt im Antworttext zurückgegeben.

Beispiel

Anforderung

Nachfolgend sehen Sie ein Beispiel der Anforderung.

HTTP

PATCH https://graph.microsoft.com/v1.0/servicePrincipals/{id}
Content-type: application/json

{
  "appRoleAssignmentRequired": true
}

C#

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var servicePrincipal = new ServicePrincipal
{
    AppRoleAssignmentRequired = true
};

await graphClient.ServicePrincipals["{servicePrincipal-id}"]
    .Request()
    .UpdateAsync(servicePrincipal);

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

JavaScript

const options = {
    authProvider,
};

const client = Client.init(options);

const servicePrincipal = {
  appRoleAssignmentRequired: true
};

await client.api('/servicePrincipals/{id}')
    .update(servicePrincipal);

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

Objective-C

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/servicePrincipals/{id}"]]];
[urlRequest setHTTPMethod:@"PATCH"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

MSGraphServicePrincipal *servicePrincipal = [[MSGraphServicePrincipal alloc] init];
[servicePrincipal setAppRoleAssignmentRequired: true];

NSError *error;
NSData *servicePrincipalData = [servicePrincipal getSerializedDataWithError:&error];
[urlRequest setHTTPBody:servicePrincipalData];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

ServicePrincipal servicePrincipal = new ServicePrincipal();
servicePrincipal.appRoleAssignmentRequired = true;

graphClient.servicePrincipals("{id}")
    .buildRequest()
    .patch(servicePrincipal);

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.NewServicePrincipal()
appRoleAssignmentRequired := true
requestBody.SetAppRoleAssignmentRequired(&appRoleAssignmentRequired)
servicePrincipalId := "servicePrincipal-id"
graphClient.ServicePrincipalsById(&servicePrincipalId).Patch(requestBody)

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

PowerShell

Import-Module Microsoft.Graph.Applications

$params = @{
    AppRoleAssignmentRequired = $true
}

Update-MgServicePrincipal -ServicePrincipalId $servicePrincipalId -BodyParameter $params

Ausführliche Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider-Instanz finden Sie in der SDK-Dokumentation.

Antwort

Hier ist ein Beispiel für die Antwort. Hinweis: Das hier gezeigte Antwortobjekt wird möglicherweise zur besseren Lesbarkeit verkürzt.

HTTP/1.1 204 No Content