cloudPcBulkAction resource type
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.
An abstract type that represents the bulk action applied to Cloud PCs specified in a parameter.
Base type of cloudPcBulkModifyDiskEncryptionType, cloudPcBulkDisasterRecoveryFailback, cloudPcBulkDisasterRecoveryFailover, cloudPcBulkPowerOff, cloudPcBulkPowerOn, cloudPcBulkReprovision, cloudPcBulkResize, cloudPcBulkRestart, cloudPcBulkRestore, and cloudPcBulkTroubleshoot.
Inherits from entity.
Methods
| Method | Return type | Description |
|---|---|---|
| List | cloudPcBulkAction collection | Get a list of the cloudPcBulkAction objects and their properties. |
| Create | cloudPcBulkAction | Create a new cloudPcBulkAction object. |
| Get | cloudPcBulkAction | Read the properties and relationships of a cloudPcBulkAction object. |
Properties
| Property | Type | Description |
|---|---|---|
| actionSummary | cloudPcBulkActionSummary | Run summary of this bulk action. |
| cloudPcIDs | String collection | IDs of the Cloud PCs the bulk action applies to. |
| createdDateTime | DateTimeOffset | The date and time when the bulk action was 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. |
| displayName | String | Name of the bulk action. |
| id | String | ID of the bulk action. Inherited from entity. |
| initiatedByUserPrincipalName | String | Indicates the user principal name (UPN) of the user who initiated this bulk action. Read-only. |
| scheduledDuringMaintenanceWindow | Boolean | Indicates whether the bulk action is scheduled according to the maintenance window. When true, the bulk action uses the maintenance window to schedule the action; false means that the bulk action doesn't use the maintenance window. The default value is false. |
| status | cloudPcBulkActionStatus | Indicates the status of bulk actions. Possible values are pending, succeeded, failed, unknownFutureValue. The default value is pending. Read-only. |
cloudPcBulkActionStatus values
| Member | Description |
|---|---|
| pending | Default. Indicates the status of the bulk action as pending because some of the bulk actions are still in progress and not yet completed. |
| succeeded | Indicates the status of the bulk action as succeeded for all associated actions. |
| failed | Indicates the status of the bulk action as failed for all associated actions. |
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.cloudPcBulkAction",
"actionSummary": {"@odata.type": "microsoft.graph.cloudPcBulkActionSummary"},
"cloudPcIds": ["String"],
"createdDateTime": "String (timestamp)",
"displayName": "String",
"id": "String (identifier)",
"initiatedByUserPrincipalName": "String",
"scheduledDuringMaintenanceWindow": "Boolean",
"status": "String"
}