Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents an external partner on Cloud PC.
Methods
| Method | Return type | Description |
|---|---|---|
| List | cloudPcExternalPartner collection | Get a list of the cloudPcExternalPartner objects and their properties. |
| Create | cloudPcExternalPartner | Create a new cloudPcExternalPartner object. |
| Get | cloudPcExternalPartner | Read the properties and relationships of a cloudPcExternalPartner object. |
| Update | cloudPcExternalPartner | Update the properties of a cloudPcExternalPartner object. |
| Configure agent | None | Configure the agent setting of a cloudPcExternalPartner object. |
| Deploy agent | String | Trigger agent deployment for a set of Windows 365 Cloud PCs that provisioned on a cloudPcExternalPartner object. |
| Retrieve deploy agent action results | cloudPcExternalPartnerActionResult collection | Retrieve the status of deployment actions on a cloudPcExternalPartner object. |
| Retrieve action reports | cloudPcExternalPartnerActionReport collection | Retrieve action reports on a cloudPcExternalPartner object. |
Properties
| Property | Type | Description |
|---|---|---|
| connectionStatus | cloudPcExternalPartnerStatus | The status of external partner connection. Possible values are notAvailable, available, healthy, unhealthy, and unknownFutureValue. Default value is available. Read-only. |
| enableConnection | Boolean | Enable or disable the connection to an external partner. If true, an external partner API accepts incoming calls from external partners. Required. Supports $filter (eq). |
| id | String | The unique identifier for the Cloud PC external partner entity record. Automatically generated when created. Read-only. |
| lastSyncDateTime | DateTimeOffset | Last data sync time for this external partner. The timeStamp type represents date and time information in ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 looks like this: '2014-01-01T00:00:00Z'. |
| partnerId | String | The partner identifier used to identify the external partner. When the Cloud PC service is ready to integrate with a new external partner, it generates a GUID to represent this partner. The Cloud PC service provides this partner ID to the partner, which can then use it to call this Microsoft Graph API and external partner APIs. Read-only. |
| statusDetails | String | Status details message. Read-only. |
| agentSetting | cloudPcExternalPartnerAgentSetting | The agent settings associated with the external partner. |
cloudPcExternalPartnerStatus values
| Member | Description |
|---|---|
| notAvailable | The connection isn't established or the customer disabled the connection. |
| available | The connection is established, but no heartbeat received yet. |
| healthy | The connection is enabled and heartbeat is being received. |
| unhealthy | The connection is enabled and heartbeat isn't being received. |
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.cloudPcExternalPartner",
"id": "String (identifier)",
"partnerId": "String",
"enableConnection": "Boolean",
"lastSyncDateTime": "String (timestamp)",
"connectionStatus": "String",
"statusDetails": "String",
"agentSetting": {
"@odata.type": "microsoft.graph.cloudPcExternalPartnerAgentSetting"
}
}