Namespace: microsoft.graph
Wichtig
Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.
Konfigurieren Sie cloudPcExternalPartnerAgentSetting des cloudPcExternalPartner-Objekts . Diese Einstellung wird für die Installation des RMM-Partner-Agents verwendet. RMM-Partner müssen das Microsoft-Team kontaktieren, um das Onboarding abzuschließen und das Agent-URL-Präfix zur Zulassungsliste hinzuzufügen, bevor sie diese API verwenden. Wenn autoDeploymentEnabled aktiviert ist, wird die Agent-Bereitstellung des neu bereitgestellten Cloud-PCs automatisch ausgelöst. Unterstützt derzeit nur Windows 365 Business Cloud-PC.
Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.
| Weltweiter Service |
US Government L4 |
US Government L5 (DOD) |
China, betrieben von 21Vianet |
| ✅ |
✅ |
✅ |
❌ |
Berechtigungen
Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.
| Berechtigungstyp |
Berechtigung mit den geringsten Rechten |
Berechtigungen mit höheren Berechtigungen |
| Delegiert (Geschäfts-, Schul- oder Unikonto) |
Globaler Administrator |
Nicht verfügbar. |
| Delegiert (persönliches Microsoft-Konto) |
Nicht unterstützt |
Nicht unterstützt |
| Application |
Nicht unterstützt |
Nicht unterstützt |
HTTP-Anforderung
POST /deviceManagement/virtualEndpoint/externalPartners/{cloudPcExternalPartnerId}/configureAgent
Anforderungstext
Geben Sie im Anforderungstext eine JSON-Darstellung der Parameter an.
In der folgenden Tabelle sind die Parameter aufgeführt, die beim Aufrufen dieser Aktion erforderlich sind.
Antwort
Wenn die Aktion erfolgreich verläuft, wird der Antwortcode 204 No Content zurückgegeben.
Beispiele
Anforderung
Das folgende Beispiel zeigt eine Anfrage.
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/externalPartners/b3548526-e615-3785-3118-be70b3968ec5/configureAgent
Content-Type: application/json
{
"agentSetting": {
"agentUrl": "https://rmmExample.microsoft.com/agent/rmmExampleAgent.msi",
"agentSha256": "EC6AF1EA0367D16DDE6639A89A080A524CEBC4D4BEDFE00ED0CAC4B865A918D8",
"installParameters": [
"/quiet",
"/norestart",
"TOKENID=e69c1577-d465-4e57-af33-0ddea43feeb1"
],
"autoDeploymentEnabled": true
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.DeviceManagement.VirtualEndpoint.ExternalPartners.Item.ConfigureAgent;
using Microsoft.Graph.Beta.Models;
var requestBody = new ConfigureAgentPostRequestBody
{
AgentSetting = new CloudPcExternalPartnerAgentSetting
{
AgentUrl = "https://rmmExample.microsoft.com/agent/rmmExampleAgent.msi",
AgentSha256 = "EC6AF1EA0367D16DDE6639A89A080A524CEBC4D4BEDFE00ED0CAC4B865A918D8",
InstallParameters = new List<string>
{
"/quiet",
"/norestart",
"TOKENID=e69c1577-d465-4e57-af33-0ddea43feeb1",
},
AutoDeploymentEnabled = true,
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.DeviceManagement.VirtualEndpoint.ExternalPartners["{cloudPcExternalPartner-id}"].ConfigureAgent.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphdevicemanagement "github.com/microsoftgraph/msgraph-beta-sdk-go/devicemanagement"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphdevicemanagement.NewConfigureAgentPostRequestBody()
agentSetting := graphmodels.NewCloudPcExternalPartnerAgentSetting()
agentUrl := "https://rmmExample.microsoft.com/agent/rmmExampleAgent.msi"
agentSetting.SetAgentUrl(&agentUrl)
agentSha256 := "EC6AF1EA0367D16DDE6639A89A080A524CEBC4D4BEDFE00ED0CAC4B865A918D8"
agentSetting.SetAgentSha256(&agentSha256)
installParameters := []string {
"/quiet",
"/norestart",
"TOKENID=e69c1577-d465-4e57-af33-0ddea43feeb1",
}
agentSetting.SetInstallParameters(installParameters)
autoDeploymentEnabled := true
agentSetting.SetAutoDeploymentEnabled(&autoDeploymentEnabled)
requestBody.SetAgentSetting(agentSetting)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.DeviceManagement().VirtualEndpoint().ExternalPartners().ByCloudPcExternalPartnerId("cloudPcExternalPartner-id").ConfigureAgent().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.devicemanagement.virtualendpoint.externalpartners.item.configureagent.ConfigureAgentPostRequestBody configureAgentPostRequestBody = new com.microsoft.graph.beta.devicemanagement.virtualendpoint.externalpartners.item.configureagent.ConfigureAgentPostRequestBody();
CloudPcExternalPartnerAgentSetting agentSetting = new CloudPcExternalPartnerAgentSetting();
agentSetting.setAgentUrl("https://rmmExample.microsoft.com/agent/rmmExampleAgent.msi");
agentSetting.setAgentSha256("EC6AF1EA0367D16DDE6639A89A080A524CEBC4D4BEDFE00ED0CAC4B865A918D8");
LinkedList<String> installParameters = new LinkedList<String>();
installParameters.add("/quiet");
installParameters.add("/norestart");
installParameters.add("TOKENID=e69c1577-d465-4e57-af33-0ddea43feeb1");
agentSetting.setInstallParameters(installParameters);
agentSetting.setAutoDeploymentEnabled(true);
configureAgentPostRequestBody.setAgentSetting(agentSetting);
graphClient.deviceManagement().virtualEndpoint().externalPartners().byCloudPcExternalPartnerId("{cloudPcExternalPartner-id}").configureAgent().post(configureAgentPostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const configureAgent = {
agentSetting: {
agentUrl: 'https://rmmExample.microsoft.com/agent/rmmExampleAgent.msi',
agentSha256: 'EC6AF1EA0367D16DDE6639A89A080A524CEBC4D4BEDFE00ED0CAC4B865A918D8',
installParameters: [
'/quiet',
'/norestart',
'TOKENID=e69c1577-d465-4e57-af33-0ddea43feeb1'
],
autoDeploymentEnabled: true
}
};
await client.api('/deviceManagement/virtualEndpoint/externalPartners/b3548526-e615-3785-3118-be70b3968ec5/configureAgent')
.version('beta')
.post(configureAgent);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\DeviceManagement\VirtualEndpoint\ExternalPartners\Item\ConfigureAgent\ConfigureAgentPostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\CloudPcExternalPartnerAgentSetting;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ConfigureAgentPostRequestBody();
$agentSetting = new CloudPcExternalPartnerAgentSetting();
$agentSetting->setAgentUrl('https://rmmExample.microsoft.com/agent/rmmExampleAgent.msi');
$agentSetting->setAgentSha256('EC6AF1EA0367D16DDE6639A89A080A524CEBC4D4BEDFE00ED0CAC4B865A918D8');
$agentSetting->setInstallParameters(['/quiet', '/norestart', 'TOKENID=e69c1577-d465-4e57-af33-0ddea43feeb1', ]);
$agentSetting->setAutoDeploymentEnabled(true);
$requestBody->setAgentSetting($agentSetting);
$graphServiceClient->deviceManagement()->virtualEndpoint()->externalPartners()->byCloudPcExternalPartnerId('cloudPcExternalPartner-id')->configureAgent()->post($requestBody)->wait();
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.devicemanagement.virtualendpoint.externalpartners.item.configure_agent.configure_agent_post_request_body import ConfigureAgentPostRequestBody
from msgraph_beta.generated.models.cloud_pc_external_partner_agent_setting import CloudPcExternalPartnerAgentSetting
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ConfigureAgentPostRequestBody(
agent_setting = CloudPcExternalPartnerAgentSetting(
agent_url = "https://rmmExample.microsoft.com/agent/rmmExampleAgent.msi",
agent_sha256 = "EC6AF1EA0367D16DDE6639A89A080A524CEBC4D4BEDFE00ED0CAC4B865A918D8",
install_parameters = [
"/quiet",
"/norestart",
"TOKENID=e69c1577-d465-4e57-af33-0ddea43feeb1",
],
auto_deployment_enabled = True,
),
)
await graph_client.device_management.virtual_endpoint.external_partners.by_cloud_pc_external_partner_id('cloudPcExternalPartner-id').configure_agent.post(request_body)
Antwort
Das folgende Beispiel zeigt die Antwort.
Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.
HTTP/1.1 204 No Content