Skip to content

Commit 8b8caf6

Browse files
github-actions[bot]Microsoft Graph DevX Toolingpeombwa
authored
Docs Generation (#1723)
* Weekly OpenApiDocs Download. * Add generated MgCommandMetadata.json. [run ci] * Docs Generation for 12-30-2022 [run ci] Co-authored-by: Microsoft Graph DevX Tooling <GraphTooling@service.microsoft.com> Co-authored-by: Peter Ombwa <peombwa@microsoft.com>
1 parent 354abe0 commit 8b8caf6

File tree

465 files changed

+6166
-5792
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

465 files changed

+6166
-5792
lines changed

src/ChangeNotifications/ChangeNotifications/docs/v1.0-beta/Microsoft.Graph.ChangeNotifications.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Module Name: Microsoft.Graph.ChangeNotifications
3-
Module Guid: 3dce2198-8bda-4ce9-8850-4d186f51efeb
3+
Module Guid: fe84888e-b132-42c6-b154-591e21144bda
44
Download Help Link: https://docs.microsoft.com/en-us/powershell/module/microsoft.graph.changenotifications
55
Help Version: 1.0.0.0
66
Locale: en-US

src/ChangeNotifications/ChangeNotifications/docs/v1.0-beta/New-MgSubscription.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ Accept wildcard characters: False
273273
274274
### -LifecycleNotificationUrl
275275
Optional.
276-
The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved and missed notifications.
276+
The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved, reauthorizationRequired, and missed notifications.
277277
This URL must make use of the HTTPS protocol.
278278
279279
```yaml
@@ -311,6 +311,8 @@ OData query options for specifying the value for the targeting resource.
311311
Clients receive notifications when the resource reaches the state matching the query options provided here.
312312
With this new property in the subscription creation payload along with all existing properties, Webhooks will deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property.
313313
For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc.
314+
Supported only for Universal Print Service.
315+
For more information, see Subscribe to change notifications from cloud printing APIs using Microsoft Graph.
314316
315317
```yaml
316318
Type: System.String
@@ -439,9 +441,9 @@ BODYPARAMETER <IMicrosoftGraphSubscription1>: subscription
439441
- `[ExpirationDateTime <DateTime?>]`: Required. Specifies the date and time when the webhook subscription expires. The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. For the maximum supported subscription length of time, see the table below.
440442
- `[IncludeResourceData <Boolean?>]`: Optional. When set to true, change notifications include resource data (such as content of a chat message).
441443
- `[LatestSupportedTlsVersion <String>]`: Optional. Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by notificationUrl, supports. The possible values are: v1_0, v1_1, v1_2, v1_3. For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2. For these subscribers, not setting this property per the timeline would result in subscription operations failing. For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional. In such cases, Microsoft Graph defaults the property to v1_2.
442-
- `[LifecycleNotificationUrl <String>]`: Optional. The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved and missed notifications. This URL must make use of the HTTPS protocol.
444+
- `[LifecycleNotificationUrl <String>]`: Optional. The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved, reauthorizationRequired, and missed notifications. This URL must make use of the HTTPS protocol.
443445
- `[NotificationContentType <String>]`: Optional. Desired content-type for Microsoft Graph change notifications for supported resource types. The default content-type is application/json.
444-
- `[NotificationQueryOptions <String>]`: Optional. OData query options for specifying the value for the targeting resource. Clients receive notifications when the resource reaches the state matching the query options provided here. With this new property in the subscription creation payload along with all existing properties, Webhooks will deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property. For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc.
446+
- `[NotificationQueryOptions <String>]`: Optional. OData query options for specifying the value for the targeting resource. Clients receive notifications when the resource reaches the state matching the query options provided here. With this new property in the subscription creation payload along with all existing properties, Webhooks will deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property. For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc. Supported only for Universal Print Service. For more information, see Subscribe to change notifications from cloud printing APIs using Microsoft Graph.
445447
- `[NotificationUrl <String>]`: Required. The URL of the endpoint that receives the change notifications. This URL must make use of the HTTPS protocol.
446448
- `[NotificationUrlAppId <String>]`: Optional. The app ID that the subscription service can use to generate the validation token. This allows the client to validate the authenticity of the notification received.
447449
- `[Resource <String>]`: Required. Specifies the resource that will be monitored for changes. Do not include the base URL (https://graph.microsoft.com/beta/). See the possible resource path values for each supported resource.

src/ChangeNotifications/ChangeNotifications/docs/v1.0-beta/Update-MgSubscription.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ Accept wildcard characters: False
302302
303303
### -LifecycleNotificationUrl
304304
Optional.
305-
The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved and missed notifications.
305+
The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved, reauthorizationRequired, and missed notifications.
306306
This URL must make use of the HTTPS protocol.
307307
308308
```yaml
@@ -340,6 +340,8 @@ OData query options for specifying the value for the targeting resource.
340340
Clients receive notifications when the resource reaches the state matching the query options provided here.
341341
With this new property in the subscription creation payload along with all existing properties, Webhooks will deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property.
342342
For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc.
343+
Supported only for Universal Print Service.
344+
For more information, see Subscribe to change notifications from cloud printing APIs using Microsoft Graph.
343345
344346
```yaml
345347
Type: System.String
@@ -500,9 +502,9 @@ BODYPARAMETER <IMicrosoftGraphSubscription1>: subscription
500502
- `[ExpirationDateTime <DateTime?>]`: Required. Specifies the date and time when the webhook subscription expires. The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. For the maximum supported subscription length of time, see the table below.
501503
- `[IncludeResourceData <Boolean?>]`: Optional. When set to true, change notifications include resource data (such as content of a chat message).
502504
- `[LatestSupportedTlsVersion <String>]`: Optional. Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by notificationUrl, supports. The possible values are: v1_0, v1_1, v1_2, v1_3. For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2. For these subscribers, not setting this property per the timeline would result in subscription operations failing. For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional. In such cases, Microsoft Graph defaults the property to v1_2.
503-
- `[LifecycleNotificationUrl <String>]`: Optional. The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved and missed notifications. This URL must make use of the HTTPS protocol.
505+
- `[LifecycleNotificationUrl <String>]`: Optional. The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved, reauthorizationRequired, and missed notifications. This URL must make use of the HTTPS protocol.
504506
- `[NotificationContentType <String>]`: Optional. Desired content-type for Microsoft Graph change notifications for supported resource types. The default content-type is application/json.
505-
- `[NotificationQueryOptions <String>]`: Optional. OData query options for specifying the value for the targeting resource. Clients receive notifications when the resource reaches the state matching the query options provided here. With this new property in the subscription creation payload along with all existing properties, Webhooks will deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property. For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc.
507+
- `[NotificationQueryOptions <String>]`: Optional. OData query options for specifying the value for the targeting resource. Clients receive notifications when the resource reaches the state matching the query options provided here. With this new property in the subscription creation payload along with all existing properties, Webhooks will deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property. For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc. Supported only for Universal Print Service. For more information, see Subscribe to change notifications from cloud printing APIs using Microsoft Graph.
506508
- `[NotificationUrl <String>]`: Required. The URL of the endpoint that receives the change notifications. This URL must make use of the HTTPS protocol.
507509
- `[NotificationUrlAppId <String>]`: Optional. The app ID that the subscription service can use to generate the validation token. This allows the client to validate the authenticity of the notification received.
508510
- `[Resource <String>]`: Required. Specifies the resource that will be monitored for changes. Do not include the base URL (https://graph.microsoft.com/beta/). See the possible resource path values for each supported resource.

src/ChangeNotifications/ChangeNotifications/docs/v1.0/Microsoft.Graph.ChangeNotifications.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Module Name: Microsoft.Graph.ChangeNotifications
3-
Module Guid: 3dce2198-8bda-4ce9-8850-4d186f51efeb
3+
Module Guid: fe84888e-b132-42c6-b154-591e21144bda
44
Download Help Link: https://docs.microsoft.com/en-us/powershell/module/microsoft.graph.changenotifications
55
Help Version: 1.0.0.0
66
Locale: en-US

src/ChangeNotifications/ChangeNotifications/docs/v1.0/New-MgSubscription.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ Accept wildcard characters: False
272272
273273
### -LifecycleNotificationUrl
274274
Optional.
275-
The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved and missed notifications.
275+
The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved, reauthorizationRequired, and missed notifications.
276276
This URL must make use of the HTTPS protocol.
277277
278278
```yaml
@@ -293,6 +293,8 @@ OData query options for specifying value for the targeting resource.
293293
Clients receive notifications when resource reaches the state matching the query options provided here.
294294
With this new property in the subscription creation payload along with all existing properties, Webhooks will deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property.
295295
For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc.
296+
Supported only for Universal Print Service.
297+
For more information, see Subscribe to change notifications from cloud printing APIs using Microsoft Graph.
296298
297299
```yaml
298300
Type: System.String
@@ -421,8 +423,8 @@ BODYPARAMETER <IMicrosoftGraphSubscription>: subscription
421423
- `[ExpirationDateTime <DateTime?>]`: Required. Specifies the date and time when the webhook subscription expires. The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. For the maximum supported subscription length of time, see the table below.
422424
- `[IncludeResourceData <Boolean?>]`: Optional. When set to true, change notifications include resource data (such as content of a chat message).
423425
- `[LatestSupportedTlsVersion <String>]`: Optional. Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by notificationUrl, supports. The possible values are: v1_0, v1_1, v1_2, v1_3. For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2. For these subscribers, not setting this property per the timeline would result in subscription operations failing. For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional. In such cases, Microsoft Graph defaults the property to v1_2.
424-
- `[LifecycleNotificationUrl <String>]`: Optional. The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved and missed notifications. This URL must make use of the HTTPS protocol.
425-
- `[NotificationQueryOptions <String>]`: Optional. OData query options for specifying value for the targeting resource. Clients receive notifications when resource reaches the state matching the query options provided here. With this new property in the subscription creation payload along with all existing properties, Webhooks will deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property. For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc.
426+
- `[LifecycleNotificationUrl <String>]`: Optional. The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved, reauthorizationRequired, and missed notifications. This URL must make use of the HTTPS protocol.
427+
- `[NotificationQueryOptions <String>]`: Optional. OData query options for specifying value for the targeting resource. Clients receive notifications when resource reaches the state matching the query options provided here. With this new property in the subscription creation payload along with all existing properties, Webhooks will deliver notifications whenever a resource reaches the desired state mentioned in the notificationQueryOptions property. For example, when the print job is completed or when a print job resource isFetchable property value becomes true etc. Supported only for Universal Print Service. For more information, see Subscribe to change notifications from cloud printing APIs using Microsoft Graph.
426428
- `[NotificationUrl <String>]`: Required. The URL of the endpoint that will receive the change notifications. This URL must make use of the HTTPS protocol.
427429
- `[NotificationUrlAppId <String>]`: Optional. The app ID that the subscription service can use to generate the validation token. This allows the client to validate the authenticity of the notification received.
428430
- `[Resource <String>]`: Required. Specifies the resource that will be monitored for changes. Do not include the base URL (https://graph.microsoft.com/v1.0/). See the possible resource path values for each supported resource.

0 commit comments

Comments
 (0)