Aktualisieren von cloudPcOnPremisesConnection

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.

Aktualisieren Sie die Eigenschaften eines cloudPcOnPremisesConnection-Objekts .

Wichtig

Die lokale Netzwerkverbindung wurde in "Azure-Netzwerkverbindung" umbenannt. cloudPcOnPremisesConnection-Objekte entsprechen hier der Azure-Netzwerkverbindung für das Cloud-PC-Produkt.

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 Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) CloudPC.ReadWrite.All Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application Nicht unterstützt Nicht unterstützt

HTTP-Anforderung

PATCH /deviceManagement/virtualEndpoint/onPremisesConnections/{id}

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung des cloudPcOnPremisesConnection-Objekts an.

In der folgenden Tabelle sind die Eigenschaften aufgeführt, die Sie aktualisieren können. Geben Sie nur die Eigenschaften an, die Sie ändern möchten. Ausgelassene Eigenschaften behalten ihre aktuellen Werte.

Wenn Sie domainJoinCredential angeben, legen Sie dessen @odata.type auf #microsoft.graph.cloudPcPlainTextDomainJoinCredential oder #microsoft.graph.cloudPcKeyVaultDomainJoinCredentialfest. Wenn sowohl domainJoinCredential als auch adDomainPassword angegeben werden, hat domainJoinCredential Vorrang.

Verwenden Sie updateAdDomainPassword, um die Anmeldeinformationen für den Domänenbeitritt bei einer erfolgreichen Verbindung zu rotieren.

Eigenschaft Typ Beschreibung
adDomainName Zeichenfolge Der vollqualifizierte Domänenname (Fully Qualified Domain Name, FQDN) der Active Directory-Domäne, der Sie beitreten möchten.
connectionType cloudPcOnPremisesConnectionType Gibt die Methode an, mit der ein bereitgestellter Cloud-PC mit Microsoft Entra verbunden wird. Die azureADJoin Option gibt an, dass im aktuellen Mandanten kein lokales Active Directory (AD) vorhanden ist, was dazu führt, dass das Cloud-PC-Gerät nur mit Microsoft Entra verbunden wird. Die hybridAzureADJoin Option gibt an, ob im aktuellen Mandanten ein lokales AD vorhanden ist und dass der Cloud-PC sowohl dem lokalen AD als auch Microsoft Entra beitritt. Die ausgewählte Option bestimmt auch die Benutzertypen, die zugewiesen werden können und sich bei einem Cloud-PC anmelden können. Mit dieser azureADJoin Option können sowohl Nur-Cloud- als auch Hybridbenutzer zugewiesen werden und sich anmelden, während hybridAzureADJoin sie nur Hybridbenutzern vorbehalten ist. Der Standardwert ist hybridAzureADJoin. Die möglichen Werte sind: hybridAzureADJoin, azureADJoin, unknownFutureValue.
displayName Zeichenfolge Der Anzeigename für die Azure-Netzwerkverbindung.
domainJoinCredential cloudPcDomainJoinCredential Die Anmeldeinformationen für den Active Directory-Domänenbeitritt. Optional. Schließen Sie (falls angegeben) alle erforderlichen Eigenschaften des ausgewählten Anmeldeinformationstyps ein.
Organizationalunit Zeichenfolge Die Organisationseinheit (OU), in der das Computerkonto erstellt wird.
resourceGroupId Zeichenfolge Die ID der Zielressourcengruppe. Erforderliches Format: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}.
subnetId Zeichenfolge Die ID des Zielsubnetzes. Erforderliches Format: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.
subscriptionId Zeichenfolge Die ID des Azure-Zielabonnements, das Ihrem Mandanten zugeordnet ist.
virtualNetworkId Zeichenfolge Die ID des virtuellen Zielnetzwerks. Erforderliches Format: /subscriptions/{subscription-id}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}.
adDomainPassword (veraltet) Zeichenfolge Das mit adDomainUsername verknüpfte Kennwort. Diese Eigenschaft ist veraltet und wird am 31. Dezember 2026 entfernt. In Zukunft sollten Sie stattdessen die domainJoinCredential-Eigenschaft verwenden.
adDomainUsername (veraltet) Zeichenfolge Der UPN eines Active Directory-Kontos, das über Berechtigungen zum Erstellen von Computerobjekten in Active Directory verfügt, dcadmin@contoso.comz. B. . Diese Eigenschaft ist veraltet und wird am 31. Dezember 2026 entfernt. In Zukunft verwenden Sie stattdessen die domainJoinCredential/domainUserPrincipalName-Eigenschaft .
Typ (veraltet) cloudPcOnPremisesConnectionType Gibt an, wie der bereitgestellte Cloud-PC der Microsoft Entra ID beitritt. Der Standardwert ist hybridAzureADJoin. Die möglichen Werte sind: hybridAzureADJoin, azureADJoin, unknownFutureValue. Die type-Eigenschaft ist veraltet und gibt seit dem 31. Januar 2024 keine Daten mehr zurück. Verwenden Sie stattdessen connectionType .

Antwort

Bei erfolgreicher Ausführung gibt diese Methode einen 200 OK Antwortcode und ein aktualisiertes cloudPcOnPremisesConnection-Objekt im Antworttext zurück.

Beispiele

Beispiel 1: Aktualisieren von Verbindungseigenschaften mithilfe von adDomainPassword und adDomainUsername

Im folgenden Beispiel wird gezeigt, wie Verbindungseigenschaften mithilfe von adDomainPassword und adDomainUsername aktualisiert werden. Verwenden Sie für zukünftige Änderungen an Anmeldeinformationen domainJoinCredential , wie in den folgenden Beispielen gezeigt.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

PATCH https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/onPremisesConnections/{id}
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
  "displayName": "Display Name value",
  "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
  "subscriptionName": "Subscription Name value",
  "adDomainName": "Active Directory Domain Name value",
  "adDomainUsername": "Active Directory Domain User Name value",
  "organizationalUnit": "Organization Unit value",
  "resourceGroupId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ffff/resourceGroups/ExampleRG",
  "virtualNetworkId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet",
  "subnetId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ffff/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default"
}

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
  "id": "9ec90ff8-fd63-4fb9-ab5a-aa4fdcc4ffff",
  "managedBy": "windows365",
  "type": "hybridAzureADJoin",
  "connectionType": "hybridAzureADJoin",
  "displayName": "Display Name value",
  "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ffff",
  "subscriptionName": "Subscription Name value",
  "adDomainName": "Active Directory Domain Name value",
  "adDomainUsername": "Active Directory Domain User Name value",
  "organizationalUnit": "Organization Unit value",
  "resourceGroupId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ffff/resourceGroups/ExampleRG",
  "virtualNetworkId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet",
  "subnetId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ffff/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default",
  "healthCheckStatus": "running",
  "virtualNetworkLocation": "westus2"
}

Beispiel 2: Verwenden eines in Azure Key Vault gespeicherten Kennworts

Im folgenden Beispiel wird gezeigt, wie Sie die Anmeldeinformationen für den Domänenbeitritt so aktualisieren, dass sie auf ein Azure Key Vault Geheimnis verweisen.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

PATCH https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/onPremisesConnections/9ec90ff8-fd63-4fb9-ab5a-aa4fdcc4ffff
Content-Type: application/json

{
  "domainJoinCredential": {
    "@odata.type": "#microsoft.graph.cloudPcKeyVaultDomainJoinCredential",
    "keyVaultResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/contoso-rg/providers/Microsoft.KeyVault/vaults/contoso-kv",
    "secretName": "ad-domain-join-password",
    "serviceConnectorResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/contoso-rg/providers/Microsoft.Windows365/serviceConnectors/anc-kv-connector",
    "keyVaultIntentConfiguration": {
      "@odata.type": "#microsoft.graph.cloudPcDomainJoinKeyVaultPasswordConfiguration",
      "userIdentity": {
        "@odata.type": "#microsoft.graph.cloudPcDomainJoinPlainTextUserIdentity",
        "domainUserPrincipalName": "dcadmin@contoso.com"
      }
    }
  }
}

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
  "id": "9ec90ff8-fd63-4fb9-ab5a-aa4fdcc4ffff",
  "managedBy": "windows365",
  "connectionType": "hybridAzureADJoin",
  "displayName": "Contoso Azure network connection",
  "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c585ad47",
  "subscriptionName": "Contoso subscription",
  "adDomainName": "contoso.com",
  "adDomainUsername": "dcadmin@contoso.com",
  "domainJoinCredential": {
    "@odata.type": "#microsoft.graph.cloudPcKeyVaultDomainJoinCredential",
    "keyVaultResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/contoso-rg/providers/Microsoft.KeyVault/vaults/contoso-kv",
    "secretName": "ad-domain-join-password",
    "serviceConnectorResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/contoso-rg/providers/Microsoft.Windows365/serviceConnectors/anc-kv-connector",
    "keyVaultIntentConfiguration": {
      "@odata.type": "#microsoft.graph.cloudPcDomainJoinKeyVaultPasswordConfiguration",
      "userIdentity": {
        "@odata.type": "#microsoft.graph.cloudPcDomainJoinPlainTextUserIdentity",
        "domainUserPrincipalName": "dcadmin@contoso.com"
      }
    }
  },
  "organizationalUnit": "OU=Cloud PCs,DC=contoso,DC=com",
  "resourceGroupId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/ExampleRG",
  "virtualNetworkId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet",
  "subnetId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c585ad47/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default",
  "healthCheckStatus": "running",
  "virtualNetworkLocation": "westus2"
}

Beispiel 3: Aktualisieren von Nur-Text-Anmeldeinformationen

Das folgende Beispiel stellt den Prinzipalnamen und das Kennwort des Domänenbeitrittsbenutzers über domainJoinCredential bereit.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

PATCH https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/onPremisesConnections/9ec90ff8-fd63-4fb9-ab5a-aa4fdcc4ffff
Content-Type: application/json

{
  "domainJoinCredential": {
    "@odata.type": "#microsoft.graph.cloudPcPlainTextDomainJoinCredential",
    "domainUserPrincipalName": "dcadmin@contoso.com",
    "domainPassword": "ExamplePassword!42"
  }
}

Antwort

Das folgende Beispiel zeigt die Antwort. Die domainPassword-Eigenschaft wird nicht zurückgegeben.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.cloudPcOnPremisesConnection",
  "id": "9ec90ff8-fd63-4fb9-ab5a-aa4fdcc4ffff",
  "displayName": "Contoso Azure network connection",
  "connectionType": "hybridAzureADJoin",
  "adDomainName": "contoso.com",
  "adDomainUsername": "dcadmin@contoso.com",
  "domainJoinCredential": {
    "@odata.type": "#microsoft.graph.cloudPcPlainTextDomainJoinCredential",
    "domainUserPrincipalName": "dcadmin@contoso.com"
  },
  "healthCheckStatus": "running"
}