Skip to content

Commit 564758b

Browse files
authored
Update protection unit documentation for consistency
1 parent 486ea9a commit 564758b

File tree

4 files changed

+41
-63
lines changed

4 files changed

+41
-63
lines changed

api-reference/beta/resources/driveprotectionunit.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Inherits from [protectionUnitBase](../resources/protectionunitbase.md).
3737
|lastModifiedBy|[identitySet](../resources/identityset.md)|The identity of person who last modified the protection unit. Inherited from [protectionUnitBase](../resources/protectionunitbase.md).|
3838
|lastModifiedDateTime|DateTimeOffset|The time of last modification of the protection unit. Inherited from [protectionUnitBase](../resources/protectionunitbase.md).|
3939
|policyId|String|Unique identifier of the protection policy associated with this protection unit. Inherited from [protectionUnitBase](../resources/protectionunitbase.md).|
40-
|protectionSources|[protectionSource](../resources/enums.md#protectionsource-values)|Indicates the sources by which a protection unit is currently protected. Protection unit protected by multiple sources is indicated by comma separated values. The possible values are: `none`, `manual`, `dynamicRule`, `unknownFutureValue`. Inherited from [protectionUnitBase](../resources/protectionunitbase.md).|
40+
|protectionSources|protectionSource|Indicates the sources by which a protection unit is currently protected. A protection unit protected by multiple sources is indicated by comma-separated values. The possible values are: `none`, `manual`, `dynamicRule`, `unknownFutureValue`. Inherited from [protectionUnitBase](../resources/protectionunitbase.md).|
4141
|status|[protectionUnitStatus](../resources/driveprotectionunit.md#protectionunitstatus-values)|The individual enablement/disablement/removal status of the protection unit. Inherited from [protectionUnitBase](../resources/protectionunitbase.md). The possible values are: `protectRequested`, `protected`, `unprotectRequested`, `unprotected`, `removeRequested`, `unknownFutureValue`.|
4242

4343
### protectionUnitStatus values
@@ -48,7 +48,7 @@ Inherits from [protectionUnitBase](../resources/protectionunitbase.md).
4848
|unprotectRequested |A request was made to deactivate protection for the unit.|
4949
|unprotected | Protection was successfully disabled for the unit.|
5050
|removeRequested |A user requested removal of the protected unit from the policy. |
51-
|unknownFutureValue | Evolvable enumeration sentinel value. Do not use.|
51+
|unknownFutureValue | Evolvable enumeration sentinel value. Don't use.|
5252

5353
## Relationships
5454
None.
@@ -66,24 +66,18 @@ The following JSON representation shows the resource type.
6666
``` json
6767
{
6868
"@odata.type": "#microsoft.graph.driveProtectionUnit",
69-
"id": "String (identifier)",
70-
"policyId": "String",
71-
"status": "String",
69+
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
7270
"createdDateTime": "String (timestamp)",
73-
"createdBy": {
74-
"@odata.type": "microsoft.graph.identitySet"
75-
},
76-
"lastModifiedDateTime": "String (timestamp)",
77-
"lastModifiedBy": {
78-
"@odata.type": "microsoft.graph.identitySet"
79-
},
80-
"protectionSources": "String",
81-
"error": {
82-
"@odata.type": "microsoft.graph.publicError"
83-
},
8471
"directoryObjectId": "String",
8572
"displayName": "String",
86-
"email": "String"
73+
"email": "String",
74+
"error": {"@odata.type": "microsoft.graph.publicError"},
75+
"id": "String (identifier)",
76+
"lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
77+
"lastModifiedDateTime": "String (timestamp)",
78+
"policyId": "String",
79+
"protectionSources": "String",
80+
"status": "String"
8781
}
8882
```
8983

api-reference/beta/resources/mailboxprotectionunit.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Inherits from [protectionUnitBase](../resources/protectionunitbase.md).
3838
|lastModifiedDateTime|DateTimeOffset|The time the protection unit was last modified. Inherited from [protectionUnitBase](../resources/protectionunitbase.md).|
3939
|mailboxType|[mailboxType](../resources/enums.md#mailboxtype-values)|The type of mailbox which is assigned to the user with id: `directoryObjectId`.The possible values are: `unknown`, `user`, `shared`, `unknownFutureValue`.|
4040
|policyId|String|Unique identifier of the protection policy associated with this protection unit. Inherited from [protectionUnitBase](../resources/protectionunitbase.md).|
41-
|protectionSources|[protectionSource](../resources/enums.md#protectionsource-values)|Indicates the sources by which a protection unit is currently protected. The possible values are: `none`, `manual`, `dynamicRule`, `unknownFutureValue`. Protection unit protected by multiple sources have comma separated sources. Inherited from [protectionUnitBase](../resources/protectionunitbase.md).|
41+
|protectionSources|protectionSource|Indicates the sources by which a protection unit is currently protected. A protection unit protected by multiple sources is indicated by comma-separated values. The possible values are: `none`, `manual`, `dynamicRule`, `unknownFutureValue`. Inherited from [protectionUnitBase](../resources/protectionunitbase.md).|
4242
|status|[protectionUnitStatus](../resources/mailboxprotectionunit.md#protectionunitstatus-values)|The individual enable, disable, or removal status of the protection unit. Inherited from [protectionUnitBase](../resources/protectionunitbase.md).The possible values are: `protectRequested`, `protected`, `unprotectRequested`, `unprotected`, `removeRequested`, `unknownFutureValue`.|
4343

4444
### protectionUnitStatus values
@@ -67,25 +67,19 @@ The following JSON representation shows the resource type.
6767
``` json
6868
{
6969
"@odata.type": "#microsoft.graph.mailboxProtectionUnit",
70-
"id": "String (identifier)",
71-
"policyId": "String",
72-
"status": "String",
70+
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
7371
"createdDateTime": "String (timestamp)",
74-
"createdBy": {
75-
"@odata.type": "microsoft.graph.identitySet"
76-
},
77-
"lastModifiedDateTime": "String (timestamp)",
78-
"lastModifiedBy": {
79-
"@odata.type": "microsoft.graph.identitySet"
80-
},
81-
"protectionSources": "String",
82-
"error": {
83-
"@odata.type": "microsoft.graph.publicError"
84-
},
8572
"directoryObjectId": "String",
8673
"displayName": "String",
8774
"email": "String",
88-
"mailboxType": "String"
75+
"error": {"@odata.type": "microsoft.graph.publicError"},
76+
"id": "String (identifier)",
77+
"lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
78+
"lastModifiedDateTime": "String (timestamp)",
79+
"mailboxType": "String",
80+
"policyId": "String",
81+
"protectionSources": "String",
82+
"status": "String"
8983
}
9084
```
9185

api-reference/beta/resources/protectionunitbase.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ Represents a site, drive, or mailbox that's protected by a [protection policy](p
2020

2121
This resource is an abstract type.
2222

23+
Inherits from [entity](entity.md).
24+
2325
## Methods
2426
|Method|Return type|Description|
2527
|:---|:---|:---|
@@ -28,14 +30,14 @@ This resource is an abstract type.
2830
## Properties
2931
|Property|Type|Description|
3032
|:---|:---|:---|
31-
|id|String|The unique identifier of the protection unit.|
32-
|policyId|String|The unique identifier of the protection policy based on which protection unit was created.|
3333
|createdBy|[identitySet](../resources/identityset.md)|The identity of person who created the protection unit.|
3434
|createdDateTime|DateTimeOffset|The time of creation of the protection unit.|
3535
|error|[publicError](../resources/publicerror.md)|Contains error details if an error occurred while creating a protection unit.|
36+
|id|String|The unique identifier of the protection unit. Inherited from [entity](entity.md).|
3637
|lastModifiedBy|[identitySet](../resources/identityset.md)|The identity of person who last modified the protection unit.|
3738
|lastModifiedDateTime|DateTimeOffset|Timestamp of the last modification of this protection unit.|
38-
|protectionSources|[protectionSource](../resources/enums.md#protectionsource-values)|Indicates the sources by which a protection unit is currently protected. Protection unit protected by multiple sources is indicated by comma separated values. The possible values are: `none`, `manual`, `dynamicRule`, `unknownFutureValue`.|
39+
|policyId|String|The unique identifier of the protection policy based on which protection unit was created.|
40+
|protectionSources|protectionSource|Indicates the sources by which a protection unit is currently protected. A protection unit protected by multiple sources is indicated by comma-separated values. The possible values are: `none`, `manual`, `dynamicRule`, `unknownFutureValue`.|
3941
|status|[protectionUnitStatus](../resources/protectionunitbase.md#protectionunitstatus-values)|The status of the protection unit. The possible values are: `protectRequested`, `protected`, `unprotectRequested`, `unprotected`, `removeRequested`, `unknownFutureValue`.|
4042

4143
### protectionUnitStatus values
@@ -64,21 +66,15 @@ The following JSON representation shows the resource type.
6466
``` json
6567
{
6668
"@odata.type": "#microsoft.graph.protectionUnitBase",
67-
"id": "String (identifier)",
68-
"policyId": "String",
69-
"status": "String",
69+
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
7070
"createdDateTime": "String (timestamp)",
71-
"createdBy": {
72-
"@odata.type": "microsoft.graph.identitySet"
73-
},
71+
"error": {"@odata.type": "microsoft.graph.publicError"},
72+
"id": "String (identifier)",
73+
"lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
7474
"lastModifiedDateTime": "String (timestamp)",
75-
"lastModifiedBy": {
76-
"@odata.type": "microsoft.graph.identitySet"
77-
},
75+
"policyId": "String",
7876
"protectionSources": "String",
79-
"error": {
80-
"@odata.type": "microsoft.graph.publicError"
81-
}
77+
"status": "String"
8278
}
8379
```
8480

api-reference/beta/resources/siteprotectionunit.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Inherits from [protectionUnitBase](../resources/protectionunitbase.md).
3636
|lastModifiedBy|[identitySet](../resources/identityset.md)|The identity of the person who last modified the protection unit. Inherited from [protectionUnitBase](../resources/protectionunitbase.md).|
3737
|lastModifiedDateTime|DateTimeOffset|The time the protection unit was last modified. Inherited from [protectionUnitBase](../resources/protectionunitbase.md).|
3838
|policyId|String|Unique identifier of the protection policy associated with this protection unit. Inherited from [protectionUnitBase](../resources/protectionunitbase.md).|
39-
|protectionSources|protectionSource|Indicates the sources by which a protection unit is currently protected. Protection unit protected by multiple sources is indicated by comma seperated values. The possible values are: `none`, `manual`, `dynamicRule`, `unknownFutureValue`. Inherited from [protectionUnitBase](../resources/protectionunitbase.md).|
39+
|protectionSources|protectionSource|Indicates the sources by which a protection unit is currently protected. A protection unit protected by multiple sources is indicated by comma-separated values. The possible values are: `none`, `manual`, `dynamicRule`, `unknownFutureValue`. Inherited from [protectionUnitBase](../resources/protectionunitbase.md).|
4040
|siteId|String|Unique identifier of the SharePoint site.|
4141
|siteName|String|Name of the SharePoint site.|
4242
|siteWebUrl|String|The web URL of the SharePoint site.|
@@ -51,7 +51,7 @@ Inherits from [protectionUnitBase](../resources/protectionunitbase.md).
5151
|unprotectRequested |A request was made to deactivate protection for the unit.|
5252
|unprotected | Protection was successfully disabled for the unit.|
5353
|removeRequested |A user requested removal of the protected unit from the policy. |
54-
|unknownFutureValue | Evolvable enumeration sentinel value. Do not use.|
54+
|unknownFutureValue | Evolvable enumeration sentinel value. Don't use.|
5555

5656
## Relationships
5757

@@ -71,24 +71,18 @@ The following JSON representation shows the resource type.
7171
``` json
7272
{
7373
"@odata.type": "#microsoft.graph.siteProtectionUnit",
74-
"id": "String (identifier)",
75-
"policyId": "String",
76-
"status": "String",
74+
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
7775
"createdDateTime": "String (timestamp)",
78-
"createdBy": {
79-
"@odata.type": "microsoft.graph.identitySet"
80-
},
76+
"error": {"@odata.type": "microsoft.graph.publicError"},
77+
"id": "String (identifier)",
78+
"lastModifiedBy": {"@odata.type": "microsoft.graph.identitySet"},
8179
"lastModifiedDateTime": "String (timestamp)",
82-
"lastModifiedBy": {
83-
"@odata.type": "microsoft.graph.identitySet"
84-
},
80+
"policyId": "String",
8581
"protectionSources": "String",
86-
"error": {
87-
"@odata.type": "microsoft.graph.publicError"
88-
},
8982
"siteId": "String",
9083
"siteName": "String",
91-
"siteWebUrl": "String"
84+
"siteWebUrl": "String",
85+
"status": "String"
9286
}
9387
```
9488

0 commit comments

Comments
 (0)