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.windowsUpdates
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.
An abstract type that governs the update deployment ring. An update deployment ring supports only devices and is used to phase a rollout strategy for Windows updates. You can't instantiate this resource directly; use one of its derived types.
Base type of driverUpdateRing, featureUpdateRing, and qualityUpdateRing. Instances in a ring collection are differentiated by the @odata.type property, which identifies the derived type of each object.
Methods
| Method | Return type | Description |
|---|---|---|
| List rings | microsoft.graph.windowsUpdates.ring collection | Get a list of the ring objects and their properties. |
| Create ring | microsoft.graph.windowsUpdates.ring | Create a new ring object. |
| Get ring | microsoft.graph.windowsUpdates.ring | Read the properties and relationships of ring object. |
| Update ring | microsoft.graph.windowsUpdates.ring | Update the properties of a ring object. |
| Delete ring | None | Delete a ring object. |
Properties
| Property | Type | Description |
|---|---|---|
| createdDateTime | DateTimeOffset | The date and time when the ring is created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only |
| deferralInDays | Int32 | The update deferral period in days. The value must be between 0 and 30. Optional. |
| description | String | The ring description. The maximum length is 1,500 characters. Required |
| displayName | String | The ring display name. The maximum length is 200 characters. Required. |
| excludedGroupAssignment | microsoft.graph.windowsUpdates.excludedGroupAssignment | Governs the update deployment audience with excluded groups. Groups are logical containers of devices represented by Microsoft Entra groups. |
| id | String | The unique identifier for the ring object. |
| includedGroupAssignment | microsoft.graph.windowsUpdates.includedGroupAssignment | Governs the update deployment audience with included groups. Groups are logical containers of devices represented by Microsoft Entra groups. |
| isPaused | Boolean | The pause action for the update ring. Required. |
| lastModifiedDateTime | DateTimeOffset | The date and time when the ring was last modified. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.windowsUpdates.ring",
"createdDateTime": "String (timestamp)",
"deferralInDays": "Int32",
"description": "String",
"displayName": "String",
"excludedGroupAssignment": {"@odata.type": "microsoft.graph.windowsUpdates.excludedGroupAssignment"},
"id": "String (identifier)",
"includedGroupAssignment": {"@odata.type": "microsoft.graph.windowsUpdates.includedGroupAssignment"},
"isPaused": "Boolean",
"lastModifiedDateTime": "String (timestamp)"
}