cloudPcExternalPartnerSetting resource type

Article
05/24/2024

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 setting on Cloud PC.

Methods

Method	Return type	Description
List	cloudPcExternalPartnerSetting collection	Get a list of the cloudPcExternalPartnerSetting objects and their properties.
Create	cloudPcExternalPartnerSetting	Create a new cloudPcExternalPartnerSetting object.
Get	cloudPcExternalPartnerSetting	Read the properties and relationships of a cloudPcExternalPartnerSetting object.
Update	cloudPcExternalPartnerSetting	Update the properties of a cloudPcExternalPartnerSetting object.

Properties

Property	Type	Description
enableConnection	Boolean	Enable or disable the connection to an external partner. If `true`, an external partner API will accept incoming calls from external partners. Required. Supports `$filter` (`eq`).
id	String	The unique identifier for the Cloud PC external partner setting. Read-only.
lastSyncDateTime	DateTimeOffset	Last data sync time for this external partner. The Timestamp type represents the date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 looks like this: '2014-01-01T00:00:00Z'.
partnerId	String	The external partner ID.
status	cloudPcExternalPartnerStatus	The status of the connection to the external partner. The possible values are: `notAvailable`, `available`, `healthy`, `unhealthy`, `unknownFutureValue`.
statusDetails	String	Status details message.

cloudPcExternalPartnerStatus values

Member	Description
notAvailable	The connection hasn't been established or the customer disabled the connection.
available	The connection has been enabled, 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.cloudPcExternalPartnerSetting",
  "enableConnection": "Boolean",  
  "id": "String (identifier)",
  "lastSyncDateTime": "String (timestamp)",
  "partnerId": "String",
  "status": "String",
  "statusDetails": "String"
}

Share via